API Evangelist conversational phrasing for TextQL Chat Service API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL Chat Service API
  version: 1.0.0
extends: openapi/textql-chatservice-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: 38
- target: $.paths['/textql.rpc.public.chat.ChatService/ApproveContextPromptChange'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a proposed context prompt change
      effect: write
      questions:
      - Can I accept the context prompt edit the agent suggested in a chat, with my own tweaks?
      - What happens when I approve a context prompt change proposed inside a TextQL chat cell?
      instructions:
      - text: 'Approve the context prompt change in cell {cell} using this edited context: {edited_context}.'
        slots:
          cell: requestBody.cellId
          edited_context: requestBody.editedContext
      - text: Accept the agent's suggested context update on cell {cell} with text {edited_context}.
        slots:
          cell: requestBody.cellId
          edited_context: requestBody.editedContext
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/ApproveOntologyChange'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a proposed ontology change
      effect: write
      questions:
      - How do I accept an ontology change the agent proposed during a chat?
      - Can I sign off on the semantic model edit suggested in a chat cell?
      instructions:
      - text: Approve the ontology change proposed in cell {cell}.
        slots:
          cell: requestBody.cellId
      - text: Accept the agent's ontology edit from chat cell {cell}.
        slots:
          cell: requestBody.cellId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/AttachAgentToChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach an agent to a chat
      effect: write
      questions:
      - Can I bring one of my saved agents into an existing chat conversation?
      - How do I hook a specific agent up to a chat thread I already started?
      instructions:
      - text: Attach agent {agent} to chat {chat}.
        slots:
          agent: requestBody.agentId
          chat: requestBody.chatId
      - text: Add agent {agent} to the conversation in chat {chat}.
        slots:
          agent: requestBody.agentId
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/AttachApp'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach an app to a chat
      effect: write
      questions:
      - How do I add a TextQL app to a chat so the analysis can use it?
      - Can a chat thread be linked to one of my apps?
      instructions:
      - text: Attach app {app} to chat {chat}.
        slots:
          app: requestBody.appId
          chat: requestBody.chatId
      - text: Link the app {app} into chat thread {chat}.
        slots:
          app: requestBody.appId
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/AttachDashboard'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a dashboard to a chat
      effect: write
      questions:
      - Can I give a chat access to an existing dashboard as context?
      - How do I link a dashboard to a chat conversation?
      instructions:
      - text: Attach dashboard {dashboard} to chat {chat}.
        slots:
          dashboard: requestBody.dashboardId
          chat: requestBody.chatId
      - text: Bring dashboard {dashboard} into the chat {chat} as context.
        slots:
          dashboard: requestBody.dashboardId
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/AttachDataset'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a dataset to a chat
      effect: write
      questions:
      - How do I make an uploaded dataset available inside a chat?
      - Can a chat analyze a specific dataset I attach to it?
      instructions:
      - text: Attach dataset {dataset} to chat {chat}.
        slots:
          dataset: requestBody.datasetId
          chat: requestBody.chatId
      - text: Add the dataset {dataset} to chat {chat} so it can be queried.
        slots:
          dataset: requestBody.datasetId
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/BookmarkChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Bookmark a chat
      effect: write
      questions:
      - Can I bookmark a chat so it's easy to find later?
      - How do I star a conversation I want to keep handy?
      instructions:
      - text: Bookmark chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Save chat {chat} to my bookmarks.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/CancelStream'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running chat response
      effect: destructive
      questions:
      - How do I stop the agent mid-answer through the Connect chat service?
      - Can I cancel a chat that's still generating a response over RPC?
      instructions:
      - text: Cancel the in-progress response stream for chat {chat} via the chat service RPC.
        slots:
          chat: requestBody.chatId
      - text: Stop chat {chat} from generating any further output using the RPC cancel call.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/CheckChatPermissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Check my permissions on a chat
      effect: read
      questions:
      - What am I allowed to do on a given chat, like edit or share it?
      - How can I tell whether I have access to a particular chat?
      instructions:
      - text: Check what permissions I have on chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Tell me my access level for chat {chat}.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/CheckHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Check chat model health
      effect: read
      questions:
      - Is the chat model currently healthy and answering?
      - Can I run a functional health check against a specific chat model?
      instructions:
      - text: Run a health check on chat model {model}.
        slots:
          model: requestBody.model
      - text: Do a functional health check of model {model} with functional set to {functional}.
        slots:
          model: requestBody.model
          functional: requestBody.functional
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/CheckStreamlitHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a Streamlit app's health in a chat
      effect: read
      questions:
      - Is the Streamlit app generated in my chat cell still running?
      - How do I check whether a chat's Streamlit output is healthy?
      instructions:
      - text: Check the Streamlit health for cell {cell} in chat {chat}.
        slots:
          cell: requestBody.cellId
          chat: requestBody.chatId
      - text: Verify the Streamlit app from chat {chat}, cell {cell}, is up.
        slots:
          chat: requestBody.chatId
          cell: requestBody.cellId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/CreateChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new chat with a paradigm and model
      effect: write
      questions:
      - How do I open a new chat session with a chosen paradigm and model over the Connect RPC?
      - Can I start a chat in research mode or fast mode from the start?
      - Can a new chat be started from a playbook?
      instructions:
      - text: Start a new RPC chat using paradigm {paradigm} with opening message {message}.
        slots:
          paradigm: requestBody.paradigm
          message: requestBody.message
      - text: Create a chat with paradigm {paradigm} on model {model} in research mode.
        slots:
          paradigm: requestBody.paradigm
          model: requestBody.model
      - text: Open a chat for playbook {playbook} using paradigm {paradigm}.
        slots:
          playbook: requestBody.playbookId
          paradigm: requestBody.paradigm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/DeleteChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a chat
      effect: destructive
      questions:
      - How do I delete a chat conversation I no longer need?
      - Can I permanently remove a chat thread?
      instructions:
      - text: Delete chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Remove the conversation {chat} from my chats.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/DismissQuestions'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss the agent's clarifying questions
      effect: write
      questions:
      - What happens if I dismiss the agent's clarifying questions instead of answering them?
      - Can I skip a halted questions cell without resuming the agent?
      instructions:
      - text: Dismiss the questions in cell {cell} without resuming the agent.
        slots:
          cell: requestBody.cellId
      - text: 'Skip the clarifying questions in cell {cell}, keeping only these partial answers: {answers}.'
        slots:
          cell: requestBody.cellId
          answers: requestBody.answers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/DuplicateChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a chat
      effect: write
      questions:
      - Can I copy a chat to branch off a conversation?
      - Is it possible to duplicate a chat only up to a certain cell?
      instructions:
      - text: Duplicate chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Copy chat {chat} up to cell {cell} and switch the copy to model {model}.
        slots:
          chat: requestBody.chatId
          cell: requestBody.upToCellId
          model: requestBody.model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetAPIChatAnswer'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the final answer of an API chat
      effect: read
      questions:
      - How do I fetch the final answer for a chat I started through the API?
      - Where can I read the answer text a programmatic chat produced?
      instructions:
      - text: Get the API chat answer for chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Fetch just the final answer produced in chat {chat}.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetArtifact'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an artifact from a chat
      effect: read
      questions:
      - How do I retrieve a single chart or file the agent generated in a chat?
      - Can I download one specific artifact from a conversation?
      instructions:
      - text: Get artifact {artifact} from chat {chat}.
        slots:
          artifact: requestBody.artifactId
          chat: requestBody.chatId
      - text: Open the generated artifact {artifact} in chat {chat}.
        slots:
          artifact: requestBody.artifactId
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a chat's details over RPC
      effect: read
      questions:
      - How do I look up a chat's settings and metadata through the Connect chat service?
      - What paradigm and model is a given chat using?
      instructions:
      - text: Get the RPC chat record for {chat}.
        slots:
          chat: requestBody.chatId
      - text: Show the settings of chat {chat}.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetChatArtifactsSummary'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize the artifacts in a chat
      effect: read
      questions:
      - Which charts, tables and files did a chat produce overall?
      - Can I get an overview of every artifact generated in one conversation?
      instructions:
      - text: Summarize all artifacts generated in chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: List the outputs chat {chat} has produced so far.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetChatExecutionTiming'].post
  update:
    x-apievangelist-phrasing:
      intent: Get execution timing for a chat
      effect: read
      questions:
      - Why was my chat slow, and where did the time go?
      - How long did each step of a chat take to execute?
      instructions:
      - text: Show execution timing for chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Break down how long chat {chat} spent running.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetChatHistory'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a chat's message history
      effect: read
      questions:
      - How do I read back the full conversation history of a chat?
      - Can I page through older messages in a long chat?
      instructions:
      - text: Get the history of chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Show {limit} messages from chat {chat}, skipping the first {skip}.
        slots:
          limit: requestBody.limit
          chat: requestBody.chatId
          skip: requestBody.skip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetChats'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and filter chats
      effect: read
      questions:
      - Can I find chats created by a specific teammate within a date range?
      - Which chats have I bookmarked or had shared with me?
      - How do I search my conversations by keyword across the whole workspace?
      instructions:
      - text: Search the workspace's chats for {search_term}.
        slots:
          search_term: requestBody.searchTerm
      - text: List chats created by member {creator} after {created_after}.
        slots:
          creator: requestBody.creatorMemberId
          created_after: requestBody.createdAfter
      - text: Show only my bookmarked chats, up to {limit}.
        slots:
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetCompletionParameters'].post
  update:
    x-apievangelist-phrasing:
      intent: Get completion parameters for a chat cell
      effect: read
      questions:
      - What model settings were used to generate a particular chat cell?
      - Can I inspect the LLM completion parameters behind one answer?
      instructions:
      - text: Get the completion parameters for cell {cell} in chat {chat}.
        slots:
          cell: requestBody.cellId
          chat: requestBody.chatId
      - text: Show which LLM settings produced cell {cell} of chat {chat}.
        slots:
          cell: requestBody.cellId
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetCompletionParametersBatch'].post
  update:
    x-apievangelist-phrasing:
      intent: Get completion parameters for many cells
      effect: read
      questions:
      - Can I fetch the LLM settings for several chat cells in one call?
      - How do I compare completion parameters across multiple cells of a chat?
      instructions:
      - text: Get completion parameters in batch for cells {cells} in chat {chat}.
        slots:
          cells: requestBody.cellIds
          chat: requestBody.chatId
      - text: Pull the model settings for every listed cell {cells} of chat {chat} at once.
        slots:
          cells: requestBody.cellIds
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetLlmUsage'].post
  update:
    x-apievangelist-phrasing:
      intent: Get LLM usage and cost for a chat
      effect: read
      questions:
      - How many tokens did a chat consume?
      - Can I see what a single conversation cost in LLM spend?
      instructions:
      - text: Show LLM usage for chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: 'Get token usage for chat {chat} with costs included: {include_costs}.'
        slots:
          chat: requestBody.chatId
          include_costs: requestBody.includeCosts
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetMembersWithChats'].post
  update:
    x-apievangelist-phrasing:
      intent: List members who have chats
      effect: read
      questions:
      - Which people in my organization have created chats?
      - Who are the distinct chat creators I can filter by?
      instructions:
      - text: List the members who have chats, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Show me every chat creator I can access, with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/GetPlaybookChats'].post
  update:
    x-apievangelist-phrasing:
      intent: List the chats a playbook produced
      effect: read
      questions:
      - Which chat runs has a scheduled playbook generated?
      - How do I see past executions of a playbook as chats?
      instructions:
      - text: List the chats for playbook {playbook}.
        slots:
          playbook: requestBody.playbookId
      - text: Show {limit} runs of playbook {playbook}.
        slots:
          limit: requestBody.limit
          playbook: requestBody.playbookId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/PollChatEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Poll for new events in a chat
      effect: read
      questions:
      - How do I poll for progress updates while a chat is running instead of streaming?
      - Can I resume reading chat events from where I left off?
      instructions:
      - text: Poll for new events on chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Poll chat {chat} for events after cursor {cursor}.
        slots:
          chat: requestBody.chatId
          cursor: requestBody.resumeCursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/QueryOneShot'].post
  update:
    x-apievangelist-phrasing:
      intent: Ask a one-shot data question
      effect: write
      questions:
      - Can I ask a single question about my data and get an answer without managing a conversation?
      - What's the quickest way to get a one-off answer from TextQL?
      instructions:
      - text: Ask the one-shot question {question} using paradigm {paradigm}.
        slots:
          question: requestBody.question
          paradigm: requestBody.paradigm
      - text: Get a single answer to {question} with paradigm {paradigm} on model {model}.
        slots:
          question: requestBody.question
          paradigm: requestBody.paradigm
          model: requestBody.model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/RateChatCell'].post
  update:
    x-apievangelist-phrasing:
      intent: Rate an answer in a chat
      effect: write
      questions:
      - How do I give a thumbs up or thumbs down to an agent's answer?
      - Can I explain why a chat response was wrong when I rate it?
      instructions:
      - text: Rate cell {cell} in chat {chat} as {rating}.
        slots:
          cell: requestBody.cellId
          chat: requestBody.chatId
          rating: requestBody.rating
      - text: Give cell {cell} of chat {chat} a {rating} rating because {reason}.
        slots:
          cell: requestBody.cellId
          chat: requestBody.chatId
          rating: requestBody.rating
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/RejectContextPromptChange'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a proposed context prompt change
      effect: destructive
      questions:
      - Can I turn down a context prompt edit the agent proposed?
      - What if I don't want the agent's suggested context update applied?
      instructions:
      - text: Reject the context prompt change in cell {cell}.
        slots:
          cell: requestBody.cellId
      - text: Decline the agent's context edit proposed in cell {cell}.
        slots:
          cell: requestBody.cellId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/RejectOntologyChange'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a proposed ontology change
      effect: destructive
      questions:
      - How do I discard an ontology change the agent proposed in a chat?
      - Can I refuse a semantic model edit without it being applied?
      instructions:
      - text: Reject the ontology change proposed in cell {cell}.
        slots:
          cell: requestBody.cellId
      - text: Discard the ontology edit from chat cell {cell}.
        slots:
          cell: requestBody.cellId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/RunChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Run or resume a chat
      effect: write
      questions:
      - How do I kick off the agent on a chat I already created?
      - Can I rerun a chat from its latest complete cell with a different model?
      instructions:
      - text: Run chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Resume chat {chat} from cell {cell} using model {model}.
        slots:
          chat: requestBody.chatId
          cell: requestBody.latestCompleteCellId
          model: requestBody.model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/SendMessage'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a follow-up message in a chat
      effect: write
      questions:
      - How do I ask a follow-up question in an existing chat?
      - Can I include image URLs with a message to the agent?
      - Is there a way to steer the agent while it's already working?
      instructions:
      - text: Send {message} to chat {chat}.
        slots:
          message: requestBody.message
          chat: requestBody.chatId
      - text: Post {message} to chat {chat} with images {image_urls}.
        slots:
          message: requestBody.message
          chat: requestBody.chatId
          image_urls: requestBody.imageUrls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/SubmitContextPromptChange'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an edited context prompt
      effect: write
      questions:
      - Can I submit my own version of a context prompt change from a chat cell?
      - How do I hand back an edited context to the agent for review?
      instructions:
      - text: Submit edited context {edited_context} for cell {cell}.
        slots:
          edited_context: requestBody.editedContext
          cell: requestBody.cellId
      - text: Send my revised context prompt {edited_context} back on cell {cell}.
        slots:
          edited_context: requestBody.editedContext
          cell: requestBody.cellId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/SubmitQuestions'].post
  update:
    x-apievangelist-phrasing:
      intent: Answer the agent's clarifying questions
      effect: write
      questions:
      - How do I answer the questions the agent asked so it can continue?
      - Will submitting answers to a questions cell resume the agent?
      instructions:
      - text: Submit answers {answers} to the questions in cell {cell} and resume the agent.
        slots:
          answers: requestBody.answers
          cell: requestBody.cellId
      - text: Reply to the agent's clarifying questions in cell {cell} with {answers}.
        slots:
          cell: requestBody.cellId
          answers: requestBody.answers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/UnbookmarkChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a chat bookmark
      effect: write
      questions:
      - How do I unbookmark a chat?
      - Can I take a conversation off my starred list?
      instructions:
      - text: Unbookmark chat {chat}.
        slots:
          chat: requestBody.chatId
      - text: Remove chat {chat} from my bookmarks.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.chat.ChatService/UpdateChat'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a chat's settings or summary
      effect: write
      questions:
      - Can I rename or re-summarize an existing chat?
      - How do I switch a chat into research or dashboard mode after it started?
      instructions:
      - text: Set the summary of chat {chat} to {summary}.
        slots:
          chat: requestBody.chatId
          summary: requestBody.summary
      - text: Turn on research mode for chat {chat}.
        slots:
          chat: requestBody.chatId
      method: generated
      generated: '2026-10-01'