TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Observability Service API

31 actions 31 updates phrasing extends openapi/textql-observabilityservice-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 31 · first 16 shown; the file carries all of them

$.info
$.paths['/textql.rpc.public.observe.ObservabilityService/ActivateCustomTopic'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/BackfillCustomTopic'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/BackfillThreadWarnings'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/CreateCustomTopic'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/DeactivateCustomTopic'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/DeleteCustomTopic'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/ExportObservabilityCsv'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/FixCheckRecord'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/FixWarning'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/GetAccessMethodStats'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/GetActivePeopleStats'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/GetActivePeopleTrend'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/GetBackfillPreview'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/GetBackfillStatus'].post
$.paths['/textql.rpc.public.observe.ObservabilityService/GetBillingStats'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL Observability Service API
  version: 1.0.0
extends: openapi/textql-observabilityservice-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: 30
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/ActivateCustomTopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a custom topic
      effect: write
      questions:
      - How do I turn a custom topic on so new chats get tagged with it?
      - Can I re-enable a custom topic I paused earlier?
      instructions:
      - text: Activate custom topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      - text: Start tagging chats with custom topic {topic_id} again.
        slots:
          topic_id: requestBody.topicId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/BackfillCustomTopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Backfill a custom topic over past chats
      effect: write
      questions:
      - Can a new custom topic be applied to chats from before it existed?
      - Which date range does a topic backfill cover?
      instructions:
      - text: Backfill custom topic {topic_id} from {start_date} to {end_date}.
        slots:
          topic_id: requestBody.topicId
          start_date: requestBody.startDate
          end_date: requestBody.endDate
      - text: Tag historical chats with custom topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/BackfillThreadWarnings'].post
  update:
    x-apievangelist-phrasing:
      intent: Backfill warnings on past chat threads
      effect: write
      questions:
      - Can I generate thread warnings for older chats retroactively?
      - How many days back and with what concurrency can a warnings backfill run?
      instructions:
      - text: Backfill thread warnings for the last {days} days.
        slots:
          days: requestBody.days
      - text: Redo warnings on all threads in org {org_id} with concurrency {concurrency}.
        slots:
          org_id: requestBody.orgId
          concurrency: requestBody.concurrency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/CreateCustomTopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom topic for tagging chats
      effect: write
      questions:
      - How do I define a custom topic to track what people ask about?
      - Can a custom topic list what it covers and what it excludes?
      instructions:
      - text: Create a custom topic named {name} described by {user_prompt}.
        slots:
          name: requestBody.name
          user_prompt: requestBody.userPrompt
      - text: Add topic {name} covering {covers} but excluding {excludes}.
        slots:
          name: requestBody.name
          covers: requestBody.covers
          excludes: requestBody.excludes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/DeactivateCustomTopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a custom topic
      effect: write
      questions:
      - Can I pause a custom topic without deleting it?
      - What stops new chats being tagged with a topic?
      instructions:
      - text: Deactivate custom topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      - text: Pause tagging for custom topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/DeleteCustomTopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom topic
      effect: destructive
      questions:
      - How do I permanently remove a custom topic?
      - Is deleting a custom topic different from deactivating it?
      instructions:
      - text: Delete custom topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      - text: Permanently remove the topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/ExportObservabilityCsv'].post
  update:
    x-apievangelist-phrasing:
      intent: Export observability data as CSV
      effect: read
      questions:
      - Can I download observability data as a CSV?
      - Which tab and time window does a CSV export cover?
      instructions:
      - text: Export the {tab} observability tab as CSV for the last {days} days.
        slots:
          tab: requestBody.tab
          days: requestBody.days
      - text: Download observability data for {days} days as a spreadsheet.
        slots:
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/FixCheckRecord'].post
  update:
    x-apievangelist-phrasing:
      intent: Fix a failed check record
      effect: write
      questions:
      - Can a flagged check record be fixed automatically?
      - What happens when I apply a fix to a check record?
      instructions:
      - text: Fix check record {record_id}.
        slots:
          record_id: requestBody.recordId
      - text: Apply the fix for flagged check {record_id}.
        slots:
          record_id: requestBody.recordId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/FixWarning'].post
  update:
    x-apievangelist-phrasing:
      intent: Fix a thread warning
      effect: write
      questions:
      - Can I resolve a warning raised on a chat thread?
      - How are thread warnings fixed?
      instructions:
      - text: Fix warning {warning_id}.
        slots:
          warning_id: requestBody.warningId
      - text: Resolve the thread warning {warning_id}.
        slots:
          warning_id: requestBody.warningId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetAccessMethodStats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get usage by access method
      effect: read
      questions:
      - Are people using TextQL more through the web app, chat integrations or the API?
      - Can I break down usage by access method for a date range?
      instructions:
      - text: Show access method stats for the last {days} days.
        slots:
          days: requestBody.days
      - text: Break down usage by access channel from {start_date} to {end_date}.
        slots:
          start_date: requestBody.startDate
          end_date: requestBody.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetActivePeopleStats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get active user counts
      effect: read
      questions:
      - How many people were active in the last month?
      - What's the active people count for a given window?
      instructions:
      - text: Get active people stats for the past {days} days.
        slots:
          days: requestBody.days
      - text: Count how many members were active over {days} days.
        slots:
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetActivePeopleTrend'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the trend of active users over time
      effect: read
      questions:
      - Is the number of active people going up or down over time?
      - Can I chart daily active people between two dates?
      instructions:
      - text: Show the active people trend over {days} days.
        slots:
          days: requestBody.days
      - text: Plot active users between {start_date} and {end_date}.
        slots:
          start_date: requestBody.startDate
          end_date: requestBody.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetBackfillPreview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a thread-warning backfill
      effect: read
      questions:
      - How many threads would a warnings backfill touch before I run it?
      - Can I estimate a backfill's scope first?
      instructions:
      - text: Preview a warnings backfill over {days} days.
        slots:
          days: requestBody.days
      - text: Estimate what a full redo backfill would cover for org {org_id}.
        slots:
          org_id: requestBody.orgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetBackfillStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a thread-warning backfill's progress
      effect: read
      questions:
      - Is my warnings backfill still running?
      - How far along is the backfill for an org?
      instructions:
      - text: Get the backfill status for org {org_id}.
        slots:
          org_id: requestBody.orgId
      - text: Check progress on the current warnings backfill with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetBillingStats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get billing and usage cost stats
      effect: read
      questions:
      - How much usage have we been billed for recently?
      - What do the billing stats look like for the past quarter?
      instructions:
      - text: Get billing stats for the last {days} days.
        slots:
          days: requestBody.days
      - text: Summarize our spend over {days} days.
        slots:
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetChatSourceStats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get chat counts by source
      effect: read
      questions:
      - Where are chats coming from, and in what numbers?
      - Can I see chat sources for one member over a date range?
      instructions:
      - text: Show chat source stats for the last {days} days.
        slots:
          days: requestBody.days
      - text: Break down member {member_id}'s chats by source from {start_date} to {end_date}.
        slots:
          member_id: requestBody.memberId
          start_date: requestBody.startDate
          end_date: requestBody.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetChatTopics'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the topics tagged on chats
      effect: read
      questions:
      - Which topics were these chats tagged with?
      - Can I look up topics for several chats at once?
      instructions:
      - text: Get the topics for chats {chat_ids}.
        slots:
          chat_ids: requestBody.chatIds
      - text: Show which topics apply to chat IDs {chat_ids}.
        slots:
          chat_ids: requestBody.chatIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetCheckRecordFix'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the proposed fix for a check record
      effect: read
      questions:
      - What fix is suggested for a failed check before I apply it?
      - Can I review the remedy for a check record?
      instructions:
      - text: Show the proposed fix for check record {record_id}.
        slots:
          record_id: requestBody.recordId
      - text: Get the suggested remedy for check {record_id} without applying it.
        slots:
          record_id: requestBody.recordId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetCustomTopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a custom topic and its trend
      effect: read
      questions:
      - How is a custom topic configured and trending?
      - Can I see a custom topic's trend within a window?
      instructions:
      - text: Get custom topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      - text: Show topic {topic_id} trending from {trend_start} to {trend_end}.
        slots:
          topic_id: requestBody.topicId
          trend_start: requestBody.trendStart
          trend_end: requestBody.trendEnd
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetCustomTopicPeople'].post
  update:
    x-apievangelist-phrasing:
      intent: List people who discuss a custom topic
      effect: read
      questions:
      - Who in my organization is asking about a given topic?
      - Which members have chats tagged with this custom topic?
      instructions:
      - text: List the people behind custom topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      - text: Show who talks most about topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetCustomTopicThreads'].post
  update:
    x-apievangelist-phrasing:
      intent: List chat threads tagged with a custom topic
      effect: read
      questions:
      - Which chat threads were tagged with a custom topic?
      - Can I filter a topic's threads by verdict or by member?
      instructions:
      - text: List threads tagged with topic {topic_id}.
        slots:
          topic_id: requestBody.topicId
      - text: Show topic {topic_id} threads from member {member_id} with verdict {verdict}.
        slots:
          topic_id: requestBody.topicId
          member_id: requestBody.memberId
          verdict: requestBody.verdict
      - text: Get the next {page_size} topic threads after page token {page_token}.
        slots:
          page_size: requestBody.pageSize
          page_token: requestBody.pageToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetEngagementSpectrum'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the engagement spectrum of members
      effect: read
      questions:
      - How is engagement distributed across our users, from power users to inactive?
      - What does the engagement spectrum look like this month?
      instructions:
      - text: Show the engagement spectrum for the last {days} days.
        slots:
          days: requestBody.days
      - text: Bucket members by engagement level over {days} days.
        slots:
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetMemberActivity'].post
  update:
    x-apievangelist-phrasing:
      intent: Get per-member activity
      effect: read
      questions:
      - What has each member been doing lately?
      - Can I see activity broken out by person?
      instructions:
      - text: Get member activity for the past {days} days.
        slots:
          days: requestBody.days
      - text: List activity per teammate over {days} days.
        slots:
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetMemberSignalTrend'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the member signal trend
      effect: read
      questions:
      - How are member signals trending over time?
      - Is there a trend line for member signals across a window?
      instructions:
      - text: Show the member signal trend over {days} days.
        slots:
          days: requestBody.days
      - text: Chart member signals for the last {days} days.
        slots:
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetObservabilityStats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get overall observability stats
      effect: read
      questions:
      - What are the headline usage stats for my org?
      - Which time windows and timezones can the overview stats use?
      instructions:
      - text: Get observability stats for the last {days} days.
        slots:
          days: requestBody.days
      - text: Show the overview stats for {days} days bucketed in timezone {timezone}.
        slots:
          days: requestBody.days
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/GetThreadWarnings'].post
  update:
    x-apievangelist-phrasing:
      intent: Get warnings raised on chat threads
      effect: read
      questions:
      - Were any warnings flagged on these chats?
      - Can I fetch thread warnings for several chats at once?
      instructions:
      - text: Get thread warnings for chats {chat_ids}.
        slots:
          chat_ids: requestBody.chatIds
      - text: List the warnings flagged on chat IDs {chat_ids}.
        slots:
          chat_ids: requestBody.chatIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/ListCustomTopics'].post
  update:
    x-apievangelist-phrasing:
      intent: List custom topics
      effect: read
      questions:
      - Which custom topics have we defined?
      - Can the topic list include trends for a given window?
      instructions:
      - text: List all custom topics.
      - text: List custom topics with trends from {trend_start} to {trend_end}.
        slots:
          trend_start: requestBody.trendStart
          trend_end: requestBody.trendEnd
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/RefineTopicDraft'].post
  update:
    x-apievangelist-phrasing:
      intent: Refine a draft custom topic definition
      effect: read
      questions:
      - Can the system help me tighten a topic definition before I save it?
      - Will examples and exclusions improve a topic draft?
      instructions:
      - text: Refine the topic draft {prompt}.
        slots:
          prompt: requestBody.prompt
      - text: Improve topic draft {prompt} using examples {examples} and exclusions {exclusions}.
        slots:
          prompt: requestBody.prompt
          examples: requestBody.examples
          exclusions: requestBody.exclusions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/SetTopicTagFeedback'].post
  update:
    x-apievangelist-phrasing:
      intent: Give feedback on a chat's topic tag
      effect: write
      questions:
      - What if a chat was tagged with the wrong topic?
      - Can I exclude a chat from a topic and say why?
      instructions:
      - text: Exclude chat {chat_id} from topic {topic_id} because {reason}.
        slots:
          chat_id: requestBody.chatId
          topic_id: requestBody.topicId
          reason: requestBody.reason
      - text: Record tag feedback on chat {chat_id} for topic {topic_id}.
        slots:
          chat_id: requestBody.chatId
          topic_id: requestBody.topicId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.observe.ObservabilityService/UpdateCustomTopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a custom topic
      effect: write
      questions:
      - Can I rename a custom topic or change what it covers?
      - How do I edit the exclusions on an existing topic?
      instructions:
      - text: Rename custom topic {topic_id} to {name}.
        slots:
          topic_id: requestBody.topicId
          name: requestBody.name
      - text: Change topic {topic_id} to cover {covers} and exclude {excludes}.
        slots:
          topic_id: requestBody.topicId
          covers: requestBody.covers
          excludes: requestBody.excludes
      method: generated
      generated: '2026-10-01'