Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Text Knowledge Base API

5 actions 5 updates phrasing extends openapi/treasure-data-textknowledgebase-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Treasure Data's API. It is a proposal applied on top of the contract, not a document Treasure Data publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/text_knowledge_bases'].post
$.paths['/api/text_knowledge_bases/{id}'].get
$.paths['/api/text_knowledge_bases/{id}'].delete
$.paths['/api/text_knowledge_bases/{id}'].patch

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 llm-api Text Knowledge Base API
  version: 1.0.0
extends: openapi/treasure-data-textknowledgebase-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: 4
- target: $.paths['/api/text_knowledge_bases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a text knowledge base
      effect: write
      questions:
      - Can I build a knowledge base from plain text for an AI agent?
      - What is needed to create a text knowledge base?
      instructions:
      - text: Create a text knowledge base with {data}.
        slots:
          data: requestBody.data
      - text: Set up a new text-based knowledge base using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/text_knowledge_bases/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a text knowledge base
      effect: read
      questions:
      - What is in a particular text knowledge base?
      - Can I fetch one text knowledge base by ID?
      instructions:
      - text: Show text knowledge base {id}.
        slots:
          id: path.id
      - text: Fetch the contents and settings of text knowledge base {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/text_knowledge_bases/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a text knowledge base
      effect: destructive
      questions:
      - How do I remove a text knowledge base?
      - Is deleting a text knowledge base permanent?
      instructions:
      - text: Delete text knowledge base {id}.
        slots:
          id: path.id
      - text: Remove the outdated text knowledge base {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/text_knowledge_bases/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a text knowledge base
      effect: write
      questions:
      - Can I change the text in an existing text knowledge base?
      - What can I edit on a text knowledge base?
      instructions:
      - text: Update text knowledge base {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit the existing text knowledge base {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'