# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Assistants API
  version: 1.0.0
extends: openapi/qliksense-assistants-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['/api/v1/assistants'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI assistants
      effect: read
      questions:
      - Which Qlik Answers assistants exist in my tenant?
      - Can I list only the assistants in a particular space?
      instructions:
      - text: List my assistants.
      - text: List the assistants in space {spaceId}, {limit} per page.
        slots:
          spaceId: query.spaceId
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AI assistant
      effect: write
      questions:
      - Can I set up a new assistant backed by my knowledge bases?
      - What do I need to provide, such as a welcome message, when creating an assistant?
      instructions:
      - text: Create an assistant named {name} titled {title} in space {spaceId} using knowledge bases {knowledgeBases}.
        slots:
          name: requestBody.name
          title: requestBody.title
          spaceId: requestBody.spaceId
          knowledgeBases: requestBody.knowledgeBases
      - text: Set up assistant {name} with welcome message {welcomeMessage} and description {description}.
        slots:
          name: requestBody.name
          welcomeMessage: requestBody.welcomeMessage
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/feedback'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an assistant's feedback summary
      effect: read
      questions:
      - Are users giving my assistant thumbs up or thumbs down?
      - Where can I see a summary of feedback for one assistant?
      instructions:
      - text: Show the feedback summary for assistant {assistantId}.
        slots:
          assistantId: path.assistantId
      - text: Summarize how users rated answers from assistant {assistantId}.
        slots:
          assistantId: path.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/sources/plaintexts'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch source chunk text for an assistant
      effect: read
      questions:
      - Can I see the original source text behind the chunks an assistant cited?
      - Is there a bulk lookup for the plaintext of several source chunks at once?
      instructions:
      - text: Get the plaintext of chunks {chunkIds} for assistant {assistantId}.
        slots:
          chunkIds: requestBody.chunkIds
          assistantId: path.assistantId
      - text: Look up the cited source passages {chunkIds} behind assistant {assistantId}.
        slots:
          chunkIds: requestBody.chunkIds
          assistantId: path.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an assistant
      effect: read
      questions:
      - Can I view the configuration of one specific assistant?
      - Which knowledge bases and messages is a given assistant set up with?
      instructions:
      - text: Show assistant {id}.
        slots:
          id: path.id
      - text: Get the configuration of assistant {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an assistant
      effect: destructive
      questions:
      - Can I remove an assistant I no longer use?
      - Does deleting an assistant also remove its threads and resources?
      instructions:
      - text: Delete assistant {id}.
        slots:
          id: path.id
      - text: Remove assistant {id} and all of its resources.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an assistant's properties
      effect: write
      questions:
      - Can I change an assistant's title or system message after creating it?
      - What format does an assistant property update use?
      instructions:
      - text: Update assistant {id} with a JSON Patch.
        slots:
          id: path.id
      - text: Patch the properties of assistant {id} if it matches version {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.if-match
      method: generated
      generated: '2026-10-01'