# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for llm-api Knowledge Base API
  version: 1.0.0
extends: openapi/treasure-data-knowledge-base-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: 6
- target: $.paths['/api/knowledge_bases'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge bases
      effect: read
      questions:
      - Which knowledge bases do my Treasure Data AI agents have?
      - Can I sort my knowledge bases?
      instructions:
      - text: List all my knowledge bases.
      - text: List knowledge bases sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/knowledge_bases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a knowledge base
      effect: write
      questions:
      - How do I give an AI agent a knowledge base backed by my data?
      - What is needed to create a new knowledge base?
      instructions:
      - text: Create a knowledge base with {data}.
        slots:
          data: requestBody.data
      - text: Set up a new knowledge base for my agents using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/knowledge_bases/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge base
      effect: read
      questions:
      - How is a particular knowledge base configured?
      - Can I look up a knowledge base by its ID?
      instructions:
      - text: Show knowledge base {id}.
        slots:
          id: path.id
      - text: Fetch the configuration of knowledge base {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/knowledge_bases/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a knowledge base
      effect: destructive
      questions:
      - How do I remove a knowledge base I no longer need?
      - Will agents lose access once a knowledge base is deleted?
      instructions:
      - text: Delete knowledge base {id}.
        slots:
          id: path.id
      - text: Remove the outdated knowledge base {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/knowledge_bases/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a knowledge base
      effect: write
      questions:
      - Can I change the settings of an existing knowledge base?
      - What can I edit on a knowledge base after creating it?
      instructions:
      - text: Update knowledge base {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit the configuration of existing knowledge base {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/knowledge_bases/{id}/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query a knowledge base
      effect: read
      questions:
      - Can I run a query against a knowledge base directly?
      - What function and arguments does a knowledge base query take?
      instructions:
      - text: Query knowledge base {id} by calling {function} with {arguments}.
        slots:
          id: path.id
          function: requestBody.function
          arguments: requestBody.arguments
      - text: Run function {function} against knowledge base {id}.
        slots:
          id: path.id
          function: requestBody.function
      method: generated
      generated: '2026-10-01'