Perigon · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Perigon Wikipedia API

3 actions 3 updates phrasing extends openapi/perigon-wikipedia-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Perigon's API. It is a proposal applied on top of the contract, not a document Perigon publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/vector/wikipedia/all'].post
$.paths['/v1/wikipedia/all'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Perigon Wikipedia API
  version: 1.0.0
extends: openapi/perigon-wikipedia-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/vector/wikipedia/all'].post
  update:
    x-apievangelist-phrasing:
      intent: Semantic search over Wikipedia
      effect: read
      questions:
      - Can I ask a natural-language question and get the most relevant Wikipedia sections?
      - Is there a way to favor popular Wikipedia pages in a semantic search?
      instructions:
      - text: Run a semantic Wikipedia search for {prompt}.
        slots:
          prompt: requestBody.prompt
      - text: Find Wikipedia sections relevant to {prompt} on pages with at least {pageviewsFrom} pageviews.
        slots:
          prompt: requestBody.prompt
          pageviewsFrom: requestBody.pageviewsFrom
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/wikipedia/all'].get
  update:
    x-apievangelist-phrasing:
      intent: Search and filter Wikipedia pages
      effect: read
      questions:
      - How do I keyword-search Wikipedia pages by title or text?
      - Can I find the Wikipedia page for a specific Wikidata ID?
      instructions:
      - text: Search Wikipedia pages for {q}.
        slots:
          q: query.q
      - text: Find Wikipedia pages titled {title}.
        slots:
          title: query.title
      - text: Get the Wikipedia page linked to Wikidata ID {wikidataId}.
        slots:
          wikidataId: query.wikidataId
      method: generated
      generated: '2026-10-01'