# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Relevance AI Endpoints Knowledge API
  version: 1.0.0
extends: openapi/relevance-ai-knowledge-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 20
- target: $.paths['/knowledge/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add documents to a knowledge set
      effect: write
      questions:
      - How do I add new data to a Relevance AI knowledge base?
      - Can I set an expiry date on knowledge I add so it drops off later?
      - Will rows be chunked and vectorized automatically when I upload them?
      instructions:
      - text: Add {data} to knowledge set {knowledge_set}.
        slots:
          data: requestBody.data
          knowledge_set: requestBody.knowledge_set
      - text: Add {data} to knowledge set {knowledge_set}, expiring on {expiry_date}.
        slots:
          data: requestBody.data
          knowledge_set: requestBody.knowledge_set
          expiry_date: requestBody.expiry_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/chunk_and_vectorize'].post
  update:
    x-apievangelist-phrasing:
      intent: Chunk and vectorize uploaded knowledge
      effect: write
      questions:
      - I uploaded knowledge with vectorizing turned off, how do I embed it now?
      - Can I chunk and vectorize everything in a knowledge set after the fact?
      instructions:
      - text: Chunk and vectorize knowledge set {knowledge_set}.
        slots:
          knowledge_set: requestBody.knowledge_set
      - text: Embed all the rows already uploaded to {knowledge_set}.
        slots:
          knowledge_set: requestBody.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/bulk_update'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk update rows in a knowledge set
      effect: write
      questions:
      - How do I edit many existing knowledge rows at once?
      - Can I remove fields from knowledge documents in a bulk update?
      instructions:
      - text: Apply updates {updates} to knowledge set {knowledge_set}.
        slots:
          updates: requestBody.updates
          knowledge_set: requestBody.knowledge_set
      - text: Update rows in {knowledge_set} with {updates} and drop fields {fields_to_remove}.
        slots:
          knowledge_set: requestBody.knowledge_set
          updates: requestBody.updates
          fields_to_remove: requestBody.fields_to_remove
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List documents in a knowledge set
      effect: read
      questions:
      - What documents are stored in a knowledge set?
      - Can I filter and sort the rows of a knowledge set page by page?
      instructions:
      - text: List the documents in knowledge set {knowledge_set}.
        slots:
          knowledge_set: requestBody.knowledge_set
      - text: Show document {document_id} from knowledge set {knowledge_set}.
        slots:
          document_id: requestBody.document_id
          knowledge_set: requestBody.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/chunk_list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search chunks in a knowledge set
      effect: read
      questions:
      - How do I run a vector search over the chunks of a knowledge set?
      - Can I use exact search instead of approximate when querying knowledge chunks?
      instructions:
      - text: Search chunks in knowledge set {knowledge_set} for {query}.
        slots:
          knowledge_set: requestBody.knowledge_set
          query: requestBody.query
      - text: List the text chunks of document {document_id} in {knowledge_set}.
        slots:
          document_id: requestBody.document_id
          knowledge_set: requestBody.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete documents from a knowledge set
      effect: destructive
      questions:
      - How do I delete specific documents from a knowledge set without removing the set?
      - Can I delete knowledge rows that match a filter?
      instructions:
      - text: Delete document {document_id} from knowledge set {knowledge_set}.
        slots:
          document_id: requestBody.document_id
          knowledge_set: requestBody.knowledge_set
      - text: Delete rows in {knowledge_set} matching {filters}.
        slots:
          knowledge_set: requestBody.knowledge_set
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/sets/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an entire knowledge set
      effect: destructive
      questions:
      - How do I delete a whole knowledge set?
      - Is removing a knowledge set and everything in it permanent?
      instructions:
      - text: Delete knowledge set {knowledge_set} entirely.
        slots:
          knowledge_set: requestBody.knowledge_set
      - text: Remove the {knowledge_set} knowledge set and all its data.
        slots:
          knowledge_set: requestBody.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate rows within a knowledge set
      effect: read
      questions:
      - Can I group and count the rows inside a knowledge set?
      - How do I run an aggregation query over my knowledge data?
      instructions:
      - text: Aggregate knowledge set {knowledge_set} with {aggregation_query}.
        slots:
          knowledge_set: requestBody.knowledge_set
          aggregation_query: requestBody.aggregation_query
      - text: Group rows in {knowledge_set} matching {filters} using {aggregation_query}.
        slots:
          knowledge_set: requestBody.knowledge_set
          filters: requestBody.filters
          aggregation_query: requestBody.aggregation_query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/chunks/count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count chunks in a knowledge set
      effect: read
      questions:
      - How many chunks does a knowledge set contain?
      - Can I count the chunks of just one document?
      instructions:
      - text: Count the chunks in knowledge set {knowledge_set}.
        slots:
          knowledge_set: requestBody.knowledge_set
      - text: Count chunks for document {document_id} in {knowledge_set}.
        slots:
          document_id: requestBody.document_id
          knowledge_set: requestBody.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/sets/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List knowledge sets
      effect: read
      questions:
      - Which knowledge sets exist in my project?
      - Can I include hidden sets and row counts when listing knowledge sets?
      instructions:
      - text: List my knowledge sets.
      - text: Find knowledge sets named like {query}, including counts {include_counts}.
        slots:
          query: requestBody.query
          include_counts: requestBody.include_counts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/sets/taken_names'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which knowledge set names are taken
      effect: read
      questions:
      - Which knowledge set names are already in use?
      - Is there a way to avoid picking a duplicate knowledge set name?
      instructions:
      - text: List all knowledge set names that are already taken.
      - text: Show me the used knowledge set names so I can pick a new one.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/sets/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate across knowledge sets
      effect: read
      questions:
      - Can I aggregate statistics across all my knowledge sets?
      - How do I group knowledge sets by a field and count them?
      instructions:
      - text: Aggregate my knowledge sets with {aggregation_query}.
        slots:
          aggregation_query: requestBody.aggregation_query
      - text: Group knowledge sets matching {filters} using {aggregation_query}.
        slots:
          filters: requestBody.filters
          aggregation_query: requestBody.aggregation_query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/sets/aggregate/conversations'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize agent conversation task statuses
      effect: read
      questions:
      - How many agent conversations are in each task status?
      - Can I group agent task statuses by a field?
      instructions:
      - text: Summarize agent task statuses grouped by {groupby}.
        slots:
          groupby: requestBody.groupby
      - text: Count agent conversations by status for {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/sets/{knowledge_set}/get_metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge set's metadata
      effect: read
      questions:
      - Where can I see the metadata attached to a knowledge set?
      - What settings are stored on a given knowledge set?
      instructions:
      - text: Get metadata for knowledge set {knowledge_set}.
        slots:
          knowledge_set: path.knowledge_set
      - text: Show the settings stored on {knowledge_set}.
        slots:
          knowledge_set: path.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/sets/{knowledge_set}/update_metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a knowledge set's metadata
      effect: write
      questions:
      - How do I change the metadata on a knowledge set?
      - Can I remove table metadata fields from a knowledge set?
      instructions:
      - text: Update metadata of knowledge set {knowledge_set} with {updates}.
        slots:
          knowledge_set: path.knowledge_set
          updates: requestBody.updates
      - text: Remove metadata fields {fields_to_remove} from {knowledge_set}.
        slots:
          fields_to_remove: requestBody.fields_to_remove
          knowledge_set: path.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/sets/{knowledge_set}/mark_rows_for_bulk_run'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark knowledge rows for a bulk run
      effect: write
      questions:
      - How do I queue rows of a table for a bulk run on one column?
      - Can I choose which rows the bulk run worker processes with a filter?
      instructions:
      - text: Mark rows in {knowledge_set} for a bulk run of column {column}.
        slots:
          knowledge_set: path.knowledge_set
          column: requestBody.column
      - text: Queue rows matching {filters} in {knowledge_set} for bulk run on {column}.
        slots:
          filters: requestBody.filters
          knowledge_set: path.knowledge_set
          column: requestBody.column
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/get_file_url'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the file URL for a knowledge set
      effect: read
      questions:
      - How do I get a downloadable file link for a knowledge set?
      - Can I choose the file extension of a knowledge set's file URL?
      instructions:
      - text: Get the file URL for knowledge set {knowledge_set}.
        slots:
          knowledge_set: requestBody.knowledge_set
      - text: Get the {extension} file link for {knowledge_set}.
        slots:
          extension: requestBody.extension
          knowledge_set: requestBody.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/get_perm_files_urls'].post
  update:
    x-apievangelist-phrasing:
      intent: Get permanent URLs of knowledge files
      effect: read
      questions:
      - Where can I find permanent links to the original files uploaded to a knowledge set?
      - Do uploaded knowledge files have lasting URLs?
      instructions:
      - text: List permanent URLs of the uploaded files in {knowledge_set}.
        slots:
          knowledge_set: requestBody.knowledge_set
      - text: Get lasting links to every source file in knowledge set {knowledge_set}.
        slots:
          knowledge_set: requestBody.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/upload/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload and process files into knowledge
      effect: write
      questions:
      - How do I load a batch of files into a knowledge set from URLs?
      - Can I run OCR on files while uploading them to knowledge?
      instructions:
      - text: Upload files {file_urls} into dataset {dataset}.
        slots:
          file_urls: requestBody.file_urls
          dataset: requestBody.dataset
      - text: Import {file_urls} into {dataset} with OCR set to {use_ocr}.
        slots:
          file_urls: requestBody.file_urls
          dataset: requestBody.dataset
          use_ocr: requestBody.use_ocr
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledge/export/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a knowledge set to CSV
      effect: read
      questions:
      - Can I export a knowledge set to a CSV file?
      - How do I export only certain columns from knowledge?
      instructions:
      - text: Export knowledge set {knowledge_set} to CSV.
        slots:
          knowledge_set: requestBody.knowledge_set
      - text: Export fields {select_fields} of {knowledge_set} as {export_extension}.
        slots:
          select_fields: requestBody.select_fields
          knowledge_set: requestBody.knowledge_set
          export_extension: requestBody.export_extension
      method: generated
      generated: '2026-09-26'