# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for External Knowledge bases API
  version: 1.0.0
extends: openapi/profound-knowledge-bases-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: 7
- target: $.paths['/v1/knowledge-bases'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge bases
      effect: read
      questions:
      - Which knowledge bases can my API key access?
      - Can I list the knowledge bases for one organization?
      instructions:
      - text: List my knowledge bases.
      - text: Show the knowledge bases for organization {organization_id}.
        slots:
          organization_id: query.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge-bases/{knowledge_base_id}/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a knowledge base
      effect: read
      questions:
      - How do I find passages in my knowledge base that answer a question?
      - Can a knowledge base search return whole pages instead of snippets?
      instructions:
      - text: Search knowledge base {knowledge_base_id} for {query} and return the top {top_k} results.
        slots:
          knowledge_base_id: path.knowledge_base_id
          query: requestBody.query
          top_k: requestBody.top_k
      - text: Look up {query} in knowledge base {knowledge_base_id}, top {top_k}, with return_full_page {return_full_page}.
        slots:
          knowledge_base_id: path.knowledge_base_id
          query: requestBody.query
          top_k: requestBody.top_k
          return_full_page: requestBody.return_full_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge-bases/{knowledge_base_id}/documents'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite a knowledge base document
      effect: write
      questions:
      - How do I update the contents of a document that's already in my knowledge base?
      - Can I replace a knowledge base document with an uploaded file?
      instructions:
      - text: 'Overwrite document {name} in knowledge base {knowledge_base_id} with this text: {text}'
        slots:
          name: requestBody.name
          knowledge_base_id: path.knowledge_base_id
          text: requestBody.text
      - text: Replace existing knowledge base {knowledge_base_id} document {name} with the uploaded file {file}.
        slots:
          name: requestBody.name
          knowledge_base_id: path.knowledge_base_id
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge-bases/{knowledge_base_id}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a document to a knowledge base
      effect: write
      questions:
      - How do I add a new document to my knowledge base?
      - Can I put a new knowledge base document inside a specific folder?
      instructions:
      - text: Add a new document {name} to knowledge base {knowledge_base_id} containing {text}.
        slots:
          name: requestBody.name
          knowledge_base_id: path.knowledge_base_id
          text: requestBody.text
      - text: Upload file {file} as new document {name} into folder {folder} of knowledge base {knowledge_base_id}.
        slots:
          file: requestBody.file
          name: requestBody.name
          folder: requestBody.folder
          knowledge_base_id: path.knowledge_base_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge-bases/{knowledge_base_id}/documents'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document from a knowledge base
      effect: destructive
      questions:
      - How do I remove a document from my knowledge base?
      - Can I delete a single knowledge base file by its name?
      instructions:
      - text: Delete document {name} from knowledge base {knowledge_base_id}.
        slots:
          name: requestBody.name
          knowledge_base_id: path.knowledge_base_id
      - text: Remove the file called {name} out of knowledge base {knowledge_base_id}.
        slots:
          name: requestBody.name
          knowledge_base_id: path.knowledge_base_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge-bases/{knowledge_base_id}/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder in a knowledge base
      effect: write
      questions:
      - Can I organize my knowledge base into folders?
      - How do I create an empty folder at a given path?
      instructions:
      - text: Create folder {path} in knowledge base {knowledge_base_id}.
        slots:
          path: requestBody.path
          knowledge_base_id: path.knowledge_base_id
      - text: Make an empty directory at {path} inside knowledge base {knowledge_base_id}.
        slots:
          path: requestBody.path
          knowledge_base_id: path.knowledge_base_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge-bases/{knowledge_base_id}/folders'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a folder from a knowledge base
      effect: destructive
      questions:
      - How do I remove a folder and everything in it from my knowledge base?
      - What happens if I try to delete a non-empty folder without recursive?
      instructions:
      - text: Delete the empty folder {path} from knowledge base {knowledge_base_id}.
        slots:
          path: requestBody.path
          knowledge_base_id: path.knowledge_base_id
      - text: Recursively delete folder {path} and its contents in knowledge base {knowledge_base_id} (recursive {recursive}).
        slots:
          path: requestBody.path
          knowledge_base_id: path.knowledge_base_id
          recursive: requestBody.recursive
      method: generated
      generated: '2026-10-01'