# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for assistants Threads API
  version: 1.0.0
extends: openapi/qliksense-threads-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: 12
- target: $.paths['/api/v1/assistants/{assistantId}/threads'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversation threads of an assistant
      effect: read
      questions:
      - Which conversation threads exist on an assistant?
      - Can I filter an assistant's threads?
      instructions:
      - text: List threads for assistant {assistantId}.
        slots:
          assistantId: path.assistantId
      - text: List threads of assistant {assistantId} matching {filter}.
        slots:
          assistantId: path.assistantId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new conversation thread
      effect: write
      questions:
      - Can I start a fresh conversation thread with an assistant?
      - Can a thread answer in the user's preferred language?
      instructions:
      - text: Create a thread named {name} on assistant {assistantId}.
        slots:
          name: requestBody.name
          assistantId: path.assistantId
      - text: Start thread {name} with assistant {assistantId} using preferred language {useUserPreferredLanguage}.
        slots:
          name: requestBody.name
          assistantId: path.assistantId
          useUserPreferredLanguage: requestBody.useUserPreferredLanguage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantid}/threads/{threadid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conversation thread
      effect: read
      questions:
      - Can I view the details of one conversation thread?
      - Where do I look up a thread by its ID?
      instructions:
      - text: Show thread {threadid} of assistant {assistantid}.
        slots:
          threadid: path.threadid
          assistantid: path.assistantid
      - text: Get the conversation thread {threadid} on assistant {assistantid}.
        slots:
          threadid: path.threadid
          assistantid: path.assistantid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantid}/threads/{threadid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a conversation thread
      effect: destructive
      questions:
      - Can I delete a whole conversation thread with an assistant?
      - Are all interactions removed when a thread is deleted?
      instructions:
      - text: Delete thread {threadid} of assistant {assistantid}.
        slots:
          threadid: path.threadid
          assistantid: path.assistantid
      - text: Remove conversation {threadid} and all its interactions from assistant {assistantid}.
        slots:
          threadid: path.threadid
          assistantid: path.assistantid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantid}/threads/{threadid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a conversation thread
      effect: write
      questions:
      - Can I rename a conversation thread?
      - Which format is used to update thread properties?
      instructions:
      - text: Rename thread {threadid} of assistant {assistantid}.
        slots:
          threadid: path.threadid
          assistantid: path.assistantid
      - text: Patch the properties of thread {threadid} on assistant {assistantid}.
        slots:
          threadid: path.threadid
          assistantid: path.assistantid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/interactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List interactions in a thread
      effect: read
      questions:
      - Can I see every question and answer exchanged in a thread?
      - Is it possible to page through a long conversation's interactions?
      instructions:
      - text: List interactions in thread {threadId} of assistant {assistantId}.
        slots:
          threadId: path.threadId
          assistantId: path.assistantId
      - text: Show the last {limit} exchanges in thread {threadId} on assistant {assistantId}.
        slots:
          limit: query.limit
          threadId: path.threadId
          assistantId: path.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/interactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an interaction in a thread
      effect: write
      questions:
      - Can I save a question, answer and its sources as an interaction in a thread?
      - Is it possible to record that an answer was rejected?
      instructions:
      - text: Add an interaction to thread {threadId} of assistant {assistantId} with request {request} and response {response}.
        slots:
          threadId: path.threadId
          assistantId: path.assistantId
          request: requestBody.request
          response: requestBody.response
      - text: Record request {request}, response {response} and sources {sources} in thread {threadId} on assistant {assistantId}.
        slots:
          request: requestBody.request
          response: requestBody.response
          sources: requestBody.sources
          threadId: path.threadId
          assistantId: path.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one interaction
      effect: read
      questions:
      - Can I look up a single question and answer from a thread?
      - Which sources were cited in one particular interaction?
      instructions:
      - text: Show interaction {interactionId} in thread {threadId} of assistant {assistantId}.
        slots:
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
      - text: Get the sources cited in interaction {interactionId} of thread {threadId} on assistant {assistantId}.
        slots:
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one interaction
      effect: destructive
      questions:
      - Can I remove a single exchange from a conversation thread?
      - Does deleting an interaction keep the rest of the thread?
      instructions:
      - text: Delete interaction {interactionId} from thread {threadId} of assistant {assistantId}.
        slots:
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
      - text: Remove just exchange {interactionId}, keeping thread {threadId} on assistant {assistantId}.
        slots:
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback'].post
  update:
    x-apievangelist-phrasing:
      intent: Rate an assistant answer
      effect: write
      questions:
      - Can I give a thumbs up or down on an answer from an assistant?
      - Is a reason required when leaving feedback on an answer?
      instructions:
      - text: Vote {vote} on interaction {interactionId} in thread {threadId} of assistant {assistantId} because {reason}.
        slots:
          vote: requestBody.vote
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
          reason: requestBody.reason
      - text: Leave feedback {vote} with reason {reason} and comment {comment} on answer {interactionId} in thread {threadId}, assistant {assistantId}.
        slots:
          vote: requestBody.vote
          reason: requestBody.reason
          comment: requestBody.comment
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback/{feedbackId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change feedback I already left
      effect: write
      questions:
      - Can I change my rating on an answer after submitting it?
      - Is existing feedback on an interaction editable?
      instructions:
      - text: Update feedback {feedbackId} on interaction {interactionId} in thread {threadId} of assistant {assistantId}.
        slots:
          feedbackId: path.feedbackId
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
      - text: Edit my earlier feedback {feedbackId} on answer {interactionId}, thread {threadId}, assistant {assistantId}.
        slots:
          feedbackId: path.feedbackId
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/reviews'].post
  update:
    x-apievangelist-phrasing:
      intent: Review feedback on an answer
      effect: write
      questions:
      - Can a reviewer mark user feedback on an answer as reviewed?
      - Which review statuses can be set on feedback?
      instructions:
      - text: Set review status {reviewStatus} on interaction {interactionId} in thread {threadId} of assistant {assistantId}.
        slots:
          reviewStatus: requestBody.reviewStatus
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
      - text: Mark the feedback on answer {interactionId} in thread {threadId}, assistant {assistantId}, as {reviewStatus}.
        slots:
          interactionId: path.interactionId
          threadId: path.threadId
          assistantId: path.assistantId
          reviewStatus: requestBody.reviewStatus
      method: generated
      generated: '2026-10-01'