API Evangelist conversational phrasing for Microsoft Azure QnAMaker Client Knowledgebases API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure QnAMaker Client Knowledgebases API
  version: 1.0.0
extends: openapi/microsoft-azure-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: 10
- target: $.paths['/knowledgebases'].get
  update:
    x-apievangelist-phrasing:
      intent: List all my QnA Maker knowledge bases
      effect: read
      questions:
      - Which QnA Maker knowledge bases do I have?
      - Can I see every knowledge base under my QnA Maker resource at once?
      instructions:
      - text: List all my knowledge bases.
      - text: Show every QnA Maker knowledge base I own.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/{kbId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge base's details
      effect: read
      questions:
      - How do I see the name, sources and last-published date of one knowledge base?
      - What details does QnA Maker hold about a specific knowledge base ID?
      instructions:
      - text: Get the details of knowledge base {kbId}.
        slots:
          kbId: path.kbId
      - text: Show when knowledge base {kbId} was last changed and published.
        slots:
          kbId: path.kbId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/{kbId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a knowledge base's contents
      effect: destructive
      questions:
      - Can I overwrite every question and answer in a knowledge base with a new list?
      - How do I wipe a knowledge base's QnA pairs and load a fresh set?
      instructions:
      - text: Replace the contents of knowledge base {kbId} with {replaceKb}.
        slots:
          kbId: path.kbId
          replaceKb: body.replaceKb
      - text: 'Overwrite all QnA pairs in {kbId} with this new list: {replaceKb}.'
        slots:
          kbId: path.kbId
          replaceKb: body.replaceKb
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/{kbId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a knowledge base to production
      effect: write
      questions:
      - How do I push the test edits in my knowledge base live to the production index?
      - Can I publish all pending changes in a QnA Maker knowledge base?
      instructions:
      - text: Publish knowledge base {kbId}.
        slots:
          kbId: path.kbId
      - text: Copy the test index of {kbId} to production.
        slots:
          kbId: path.kbId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/{kbId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a knowledge base
      effect: destructive
      questions:
      - How do I permanently delete a knowledge base and all of its data?
      - Can a QnA Maker knowledge base be removed once it is retired?
      instructions:
      - text: Delete knowledge base {kbId}.
        slots:
          kbId: path.kbId
      - text: Remove {kbId} and everything in it.
        slots:
          kbId: path.kbId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/{kbId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add, edit or remove items in a knowledge base
      effect: write
      questions:
      - How do I add a few new QnA pairs to an existing knowledge base without replacing it?
      - Can I edit or delete individual questions in a knowledge base asynchronously?
      instructions:
      - text: 'Apply these add, update and delete changes to knowledge base {kbId}: {updateKb}.'
        slots:
          kbId: path.kbId
          updateKb: body.updateKb
      - text: Modify some QnA pairs in {kbId} using {updateKb}.
        slots:
          kbId: path.kbId
          updateKb: body.updateKb
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new knowledge base
      effect: write
      questions:
      - How do I create a new QnA Maker knowledge base from URLs, files or QnA pairs?
      - Is creating a knowledge base an asynchronous operation I need to poll?
      instructions:
      - text: Create a new knowledge base from {createKbPayload}.
        slots:
          createKbPayload: body.createKbPayload
      - text: 'Start building a knowledge base with this name and sources: {createKbPayload}.'
        slots:
          createKbPayload: body.createKbPayload
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/{kbId}/{environment}/qna'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a knowledge base's QnA pairs
      effect: read
      questions:
      - Can I export all the QnA pairs from the test or prod version of a knowledge base?
      - Is it possible to download only the QnAs that changed since a certain date?
      instructions:
      - text: Download knowledge base {kbId} from the {environment} environment.
        slots:
          kbId: path.kbId
          environment: path.environment
      - text: Export QnAs from {kbId} in {environment} changed since {changedSince}.
        slots:
          kbId: path.kbId
          environment: path.environment
          changedSince: query.changedSince
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/{kbId}/generateAnswer'].post
  update:
    x-apievangelist-phrasing:
      intent: Ask a knowledge base a question
      effect: read
      questions:
      - How do I send a user's question to my knowledge base and get the best answer back?
      - Can I query a managed QnA Maker knowledge base for ranked answers?
      instructions:
      - text: Ask knowledge base {kbId} the question in {generateAnswerPayload}.
        slots:
          kbId: path.kbId
          generateAnswerPayload: body.generateAnswerPayload
      - text: Get the top answer from {kbId} for {generateAnswerPayload}.
        slots:
          kbId: path.kbId
          generateAnswerPayload: body.generateAnswerPayload
      method: generated
      generated: '2026-10-01'
- target: $.paths['/knowledgebases/{kbId}/train'].post
  update:
    x-apievangelist-phrasing:
      intent: Send active-learning feedback to a knowledge base
      effect: write
      questions:
      - How do I feed user click feedback back into a QnA Maker knowledge base?
      - Can I add alternate-question suggestions to a managed knowledge base through training?
      instructions:
      - text: Train knowledge base {kbId} with feedback {trainPayload}.
        slots:
          kbId: path.kbId
          trainPayload: body.trainPayload
      - text: Submit active learning suggestions {trainPayload} to {kbId}.
        slots:
          kbId: path.kbId
          trainPayload: body.trainPayload
      method: generated
      generated: '2026-10-01'