Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Assistants Understand API

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

What the actions change

x-apievangelist-phrasing

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

$.info
$.paths['/understand/Assistants/{Sid}'].get
$.paths['/understand/Assistants/{Sid}'].post
$.paths['/understand/Assistants/{Sid}'].delete
$.paths['/understand/Assistants/{AssistantSid}/FallbackActions'].get
$.paths['/understand/Assistants/{AssistantSid}/FallbackActions'].post
$.paths['/understand/Assistants/{AssistantSid}/InitiationActions'].get
$.paths['/understand/Assistants/{AssistantSid}/InitiationActions'].post
$.paths['/understand/Assistants/{AssistantSid}/Dialogues/{Sid}'].get
$.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}'].get
$.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}'].delete
$.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields'].get
$.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields'].post
$.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}'].get
$.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}'].post
$.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}'].delete

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 Twilio Assistants Understand API
  version: 1.0.0
extends: openapi/twilio-understand-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 46
- target: $.paths['/understand/Assistants/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View an Understand assistant
      effect: read
      questions:
      - What name, callback URL and query logging setting does my Understand assistant have?
      - Can I look up an Understand assistant by its SID?
      instructions:
      - text: Show Understand assistant {assistant}.
        slots:
          assistant: path.Sid
      - text: Get the configuration of natural language assistant {assistant}.
        slots:
          assistant: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an Understand assistant's settings
      effect: write
      questions:
      - Can I turn off query logging on my assistant so user input isn't stored?
      - Where do I set the callback URL and events an assistant reports to?
      instructions:
      - text: Rename Understand assistant {assistant} to {name}.
        slots:
          assistant: path.Sid
          name: requestBody.FriendlyName
      - text: Set query logging on assistant {assistant} to {log_queries}.
        slots:
          assistant: path.Sid
          log_queries: requestBody.LogQueries
      - text: Send assistant {assistant} callbacks for {events} to {callback_url}.
        slots:
          assistant: path.Sid
          events: requestBody.CallbackEvents
          callback_url: requestBody.CallbackUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Understand assistant
      effect: destructive
      questions:
      - How do I get rid of an assistant I no longer use?
      - Can I delete a whole Understand assistant?
      instructions:
      - text: Delete Understand assistant {assistant}.
        slots:
          assistant: path.Sid
      - text: Remove the unused natural language assistant {assistant}.
        slots:
          assistant: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FallbackActions'].get
  update:
    x-apievangelist-phrasing:
      intent: See what an assistant does when it doesn't understand
      effect: read
      questions:
      - What does my assistant say when user input matches no task?
      - Can I read the fallback actions JSON for an assistant?
      instructions:
      - text: Show the fallback actions for assistant {assistant}.
        slots:
          assistant: path.AssistantSid
      - text: Get what assistant {assistant} does when nothing matches.
        slots:
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FallbackActions'].post
  update:
    x-apievangelist-phrasing:
      intent: Set an assistant's fallback actions
      effect: write
      questions:
      - How do I change the reply an assistant gives when it can't match any task?
      - Can I replace just the fallback actions without touching the rest of the assistant?
      instructions:
      - text: Set the fallback actions of assistant {assistant} to {actions}.
        slots:
          assistant: path.AssistantSid
          actions: requestBody.FallbackActions
      - text: Replace what assistant {assistant} does on unrecognized input with {actions}.
        slots:
          assistant: path.AssistantSid
          actions: requestBody.FallbackActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/InitiationActions'].get
  update:
    x-apievangelist-phrasing:
      intent: See an assistant's opening actions on calls
      effect: read
      questions:
      - What does my assistant say first when it answers an inbound phone call?
      - Can I read the initiation actions JSON for an assistant?
      instructions:
      - text: Show the initiation actions for assistant {assistant}.
        slots:
          assistant: path.AssistantSid
      - text: Get the greeting assistant {assistant} uses on inbound calls.
        slots:
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/InitiationActions'].post
  update:
    x-apievangelist-phrasing:
      intent: Set an assistant's opening actions on calls
      effect: write
      questions:
      - Can I change what my assistant says first on an inbound call?
      - What endpoint replaces only the initiation actions of an assistant?
      instructions:
      - text: Set the initiation actions of assistant {assistant} to {actions}.
        slots:
          assistant: path.AssistantSid
          actions: requestBody.InitiationActions
      - text: Make assistant {assistant} open inbound calls with {actions}.
        slots:
          assistant: path.AssistantSid
          actions: requestBody.InitiationActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Dialogues/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a dialogue with an assistant
      effect: read
      questions:
      - What happened in a specific conversation between a user and my assistant?
      - Can I pull up one dialogue by its SID?
      instructions:
      - text: Show dialogue {dialogue} from assistant {assistant}.
        slots:
          dialogue: path.Sid
          assistant: path.AssistantSid
      - text: Get the conversation data for dialogue {dialogue} on {assistant}.
        slots:
          dialogue: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a field on a task
      effect: read
      questions:
      - What field type does one of my task's fields use?
      - Can I look up a single task field by SID?
      instructions:
      - text: Show field {field} on task {task} of assistant {assistant}.
        slots:
          field: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
      - text: Get the type of field {field} in task {task} for {assistant}.
        slots:
          field: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a field from a task
      effect: destructive
      questions:
      - How do I stop a task from collecting a particular field?
      - Can I delete one field without deleting the task?
      instructions:
      - text: Delete field {field} from task {task} on assistant {assistant}.
        slots:
          field: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
      - text: Remove task field {field} under {task} in {assistant}.
        slots:
          field: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List the fields of a task
      effect: read
      questions:
      - Which fields does a task extract from what the user says?
      - What values is a task set up to capture?
      instructions:
      - text: List the fields on task {task} of assistant {assistant}.
        slots:
          task: path.TaskSid
          assistant: path.AssistantSid
      - text: Show every field task {task} collects in {assistant}.
        slots:
          task: path.TaskSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a task
      effect: write
      questions:
      - How do I make a task capture a date or a city from the user's words?
      - Can I add a field that uses one of my custom field types?
      instructions:
      - text: Add field {name} of type {field_type} to task {task} on assistant {assistant}.
        slots:
          name: requestBody.UniqueName
          field_type: requestBody.FieldType
          task: path.TaskSid
          assistant: path.AssistantSid
      - text: Create a {field_type} field called {name} in task {task} for {assistant}.
        slots:
          field_type: requestBody.FieldType
          name: requestBody.UniqueName
          task: path.TaskSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a custom field type
      effect: read
      questions:
      - What are the name and details of one of my custom field types?
      - Can I look up a field type by its SID?
      instructions:
      - text: Show field type {field_type} on assistant {assistant}.
        slots:
          field_type: path.Sid
          assistant: path.AssistantSid
      - text: Get the details of custom field type {field_type} in {assistant}.
        slots:
          field_type: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a custom field type
      effect: write
      questions:
      - Can I change the unique name of a field type I already created?
      - Is it possible to relabel an existing custom field type?
      instructions:
      - text: Rename field type {field_type} on assistant {assistant} to {name}.
        slots:
          field_type: path.Sid
          assistant: path.AssistantSid
          name: requestBody.FriendlyName
      - text: Change the unique name of existing field type {field_type} in {assistant} to {unique_name}.
        slots:
          field_type: path.Sid
          assistant: path.AssistantSid
          unique_name: requestBody.UniqueName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field type
      effect: destructive
      questions:
      - How do I remove a custom field type I no longer need?
      - Can I delete a field type and all its values?
      instructions:
      - text: Delete field type {field_type} from assistant {assistant}.
        slots:
          field_type: path.Sid
          assistant: path.AssistantSid
      - text: Remove the custom field type {field_type} in {assistant}.
        slots:
          field_type: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List an assistant's custom field types
      effect: read
      questions:
      - Which custom field types have I defined for my assistant?
      - What vocabularies like product names or store locations does my assistant know?
      instructions:
      - text: List the custom field types on assistant {assistant}.
        slots:
          assistant: path.AssistantSid
      - text: Show all field types defined in {assistant}.
        slots:
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field type
      effect: write
      questions:
      - How do I teach my assistant a custom list of things, like my product names?
      - Can I define my own field type beyond the built-in ones?
      instructions:
      - text: Create a field type named {name} on assistant {assistant}.
        slots:
          name: requestBody.UniqueName
          assistant: path.AssistantSid
      - text: Add custom field type {name} labeled {label} to {assistant}.
        slots:
          name: requestBody.UniqueName
          label: requestBody.FriendlyName
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one value of a field type
      effect: read
      questions:
      - What language and synonym is set on a particular field value?
      - Can I look up one field value by its SID?
      instructions:
      - text: Show value {value} of field type {field_type} on assistant {assistant}.
        slots:
          value: path.Sid
          field_type: path.FieldTypeSid
          assistant: path.AssistantSid
      - text: Check whether field value {value} in {field_type} for {assistant} is a synonym.
        slots:
          value: path.Sid
          field_type: path.FieldTypeSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a value from a field type
      effect: destructive
      questions:
      - How do I drop one entry or synonym from a custom field type?
      - Can I delete a single field value and keep the rest of the type?
      instructions:
      - text: Delete value {value} from field type {field_type} on assistant {assistant}.
        slots:
          value: path.Sid
          field_type: path.FieldTypeSid
          assistant: path.AssistantSid
      - text: Remove entry {value} under {field_type} in {assistant}.
        slots:
          value: path.Sid
          field_type: path.FieldTypeSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues'].get
  update:
    x-apievangelist-phrasing:
      intent: List the values of a field type
      effect: read
      questions:
      - What entries and synonyms make up one of my custom field types?
      - Can I list only the Spanish values of a field type?
      instructions:
      - text: List the values of field type {field_type} on assistant {assistant}.
        slots:
          field_type: path.FieldTypeSid
          assistant: path.AssistantSid
      - text: Show {language} values for field type {field_type} in {assistant}.
        slots:
          language: query.Language
          field_type: path.FieldTypeSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a value or synonym to a field type
      effect: write
      questions:
      - How do I add a new product name to a custom field type?
      - Can I register a synonym so two words map to the same field value?
      instructions:
      - text: Add {value} in {language} to field type {field_type} on assistant {assistant}.
        slots:
          value: requestBody.Value
          language: requestBody.Language
          field_type: path.FieldTypeSid
          assistant: path.AssistantSid
      - text: Add {value} ({language}) as a synonym of {synonym_of} in field type {field_type} for {assistant}.
        slots:
          value: requestBody.Value
          language: requestBody.Language
          synonym_of: requestBody.SynonymOf
          field_type: path.FieldTypeSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a model build
      effect: read
      questions:
      - Has my assistant's latest model build finished training?
      - Can I see the status of one model build by SID?
      instructions:
      - text: Show model build {build} for assistant {assistant}.
        slots:
          build: path.Sid
          assistant: path.AssistantSid
      - text: Check whether build {build} of {assistant} is completed.
        slots:
          build: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a model build
      effect: write
      questions:
      - Can I give an existing model build a new unique name, like a version tag?
      - Is it possible to relabel a build after it was created?
      instructions:
      - text: Rename model build {build} on assistant {assistant} to {name}.
        slots:
          build: path.Sid
          assistant: path.AssistantSid
          name: requestBody.UniqueName
      - text: Tag existing build {build} of {assistant} as {name}.
        slots:
          build: path.Sid
          assistant: path.AssistantSid
          name: requestBody.UniqueName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a model build
      effect: destructive
      questions:
      - How do I clean up old model builds for my assistant?
      - Can I delete one outdated model build?
      instructions:
      - text: Delete model build {build} from assistant {assistant}.
        slots:
          build: path.Sid
          assistant: path.AssistantSid
      - text: Remove the old build {build} of {assistant}.
        slots:
          build: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/ModelBuilds'].get
  update:
    x-apievangelist-phrasing:
      intent: List an assistant's model builds
      effect: read
      questions:
      - Which model builds have been trained for my assistant?
      - What is the build history of an assistant?
      instructions:
      - text: List the model builds for assistant {assistant}.
        slots:
          assistant: path.AssistantSid
      - text: Show every training build of {assistant}.
        slots:
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/ModelBuilds'].post
  update:
    x-apievangelist-phrasing:
      intent: Train a new model build
      effect: write
      questions:
      - How do I retrain my assistant after adding new samples?
      - Can I get a callback when a model build finishes training?
      instructions:
      - text: Start a new model build for assistant {assistant}.
        slots:
          assistant: path.AssistantSid
      - text: Train {assistant} as build {name} and notify {callback} when done.
        slots:
          assistant: path.AssistantSid
          name: requestBody.UniqueName
          callback: requestBody.StatusCallback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Queries/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one query sent to an assistant
      effect: read
      questions:
      - Which task did my assistant match for a particular query?
      - Can I look up one logged query by its SID?
      instructions:
      - text: Show query {query} on assistant {assistant}.
        slots:
          query: path.Sid
          assistant: path.AssistantSid
      - text: Get the matched task and fields for query {query} in {assistant}.
        slots:
          query: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Queries/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Review or discard a logged query
      effect: write
      questions:
      - Can I mark a logged query as reviewed after checking it?
      - Can a query be linked to the sample I created from it?
      instructions:
      - text: Set the status of query {query} on assistant {assistant} to {status}.
        slots:
          query: path.Sid
          assistant: path.AssistantSid
          status: requestBody.Status
      - text: Link query {query} in {assistant} to sample {sample}.
        slots:
          query: path.Sid
          assistant: path.AssistantSid
          sample: requestBody.SampleSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Queries/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a logged query
      effect: destructive
      questions:
      - How do I delete a stored user query from my assistant's logs?
      - Can I remove one query that contains something sensitive?
      instructions:
      - text: Delete query {query} from assistant {assistant}.
        slots:
          query: path.Sid
          assistant: path.AssistantSid
      - text: Remove logged query {query} in {assistant}.
        slots:
          query: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Queries'].get
  update:
    x-apievangelist-phrasing:
      intent: List queries an assistant received
      effect: read
      questions:
      - Which user queries are still pending review for my assistant?
      - Can I see the queries answered by one specific model build?
      instructions:
      - text: List queries on assistant {assistant} with status {status}.
        slots:
          assistant: path.AssistantSid
          status: query.Status
      - text: Show {language} queries handled by build {build} in {assistant}.
        slots:
          language: query.Language
          build: query.ModelBuild
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Queries'].post
  update:
    x-apievangelist-phrasing:
      intent: Test what an assistant understands from a phrase
      effect: write
      questions:
      - What task would my assistant pick for a sentence a user might say?
      - Can I test a phrase against only a few tasks or a single field?
      - How do I try a phrase against an older model build?
      instructions:
      - text: Ask assistant {assistant} to interpret {text} in {language}.
        slots:
          assistant: path.AssistantSid
          text: requestBody.Query
          language: requestBody.Language
      - text: Test {text} ({language}) on {assistant} limited to tasks {tasks}.
        slots:
          text: requestBody.Query
          language: requestBody.Language
          assistant: path.AssistantSid
          tasks: requestBody.Tasks
      - text: Run {text} in {language} against build {build} of {assistant}.
        slots:
          text: requestBody.Query
          language: requestBody.Language
          build: requestBody.ModelBuild
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a training sample
      effect: read
      questions:
      - What tagged text and channel does one training sample have?
      - Can I look up a single sample by its SID?
      instructions:
      - text: Show sample {sample} on task {task} of assistant {assistant}.
        slots:
          sample: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
      - text: Get the tagged text of sample {sample} in {task} for {assistant}.
        slots:
          sample: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit a training sample
      effect: write
      questions:
      - Can I fix the wording or field tags of a sample I already added?
      - Is it possible to change the channel an existing sample came from?
      instructions:
      - text: Change the text of sample {sample} on task {task} in {assistant} to {tagged_text}.
        slots:
          sample: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
          tagged_text: requestBody.TaggedText
      - text: Set the source channel of existing sample {sample} in {task} for {assistant} to {channel}.
        slots:
          sample: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
          channel: requestBody.SourceChannel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a training sample
      effect: destructive
      questions:
      - How do I remove a bad training sample that confuses my assistant?
      - Can I delete one sample from a task?
      instructions:
      - text: Delete sample {sample} from task {task} on assistant {assistant}.
        slots:
          sample: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
      - text: Remove training sample {sample} in {task} for {assistant}.
        slots:
          sample: path.Sid
          task: path.TaskSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples'].get
  update:
    x-apievangelist-phrasing:
      intent: List a task's training samples
      effect: read
      questions:
      - What example phrases is a task trained on?
      - Can I list only the French samples for a task?
      instructions:
      - text: List the samples for task {task} on assistant {assistant}.
        slots:
          task: path.TaskSid
          assistant: path.AssistantSid
      - text: Show {language} training samples of task {task} in {assistant}.
        slots:
          language: query.Language
          task: path.TaskSid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a training sample to a task
      effect: write
      questions:
      - How do I teach a task a new way users might phrase a request?
      - Can I tag field values inside a sample's text?
      instructions:
      - text: Add sample {tagged_text} in {language} to task {task} on assistant {assistant}.
        slots:
          tagged_text: requestBody.TaggedText
          language: requestBody.Language
          task: path.TaskSid
          assistant: path.AssistantSid
      - text: Train task {task} in {assistant} with the {channel} phrase {tagged_text} ({language}).
        slots:
          task: path.TaskSid
          assistant: path.AssistantSid
          channel: requestBody.SourceChannel
          tagged_text: requestBody.TaggedText
          language: requestBody.Language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/StyleSheet'].get
  update:
    x-apievangelist-phrasing:
      intent: View an assistant's style sheet
      effect: read
      questions:
      - What voice and style settings does my assistant's style sheet define?
      - Can I read the style sheet JSON for an assistant?
      instructions:
      - text: Show the style sheet for assistant {assistant}.
        slots:
          assistant: path.AssistantSid
      - text: Get the style sheet JSON of {assistant}.
        slots:
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/StyleSheet'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace an assistant's style sheet
      effect: write
      questions:
      - How do I change the voice my assistant uses through its style sheet?
      - Can I update only the style sheet without editing other assistant settings?
      instructions:
      - text: Set the style sheet of assistant {assistant} to {style_sheet}.
        slots:
          assistant: path.AssistantSid
          style_sheet: requestBody.StyleSheet
      - text: Replace the style sheet on {assistant} with {style_sheet}.
        slots:
          assistant: path.AssistantSid
          style_sheet: requestBody.StyleSheet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a task
      effect: read
      questions:
      - What is a task's unique name and where do its actions come from?
      - Can I look up one assistant task by SID?
      instructions:
      - text: Show task {task} on assistant {assistant}.
        slots:
          task: path.Sid
          assistant: path.AssistantSid
      - text: Get the name and actions URL of task {task} in {assistant}.
        slots:
          task: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a task or change its actions URL
      effect: write
      questions:
      - Can I point an existing task at a different URL that serves its actions?
      - Is renaming a task possible after it's been trained?
      instructions:
      - text: Rename task {task} on assistant {assistant} to {name}.
        slots:
          task: path.Sid
          assistant: path.AssistantSid
          name: requestBody.FriendlyName
      - text: Point task {task} in {assistant} at actions URL {actions_url}.
        slots:
          task: path.Sid
          assistant: path.AssistantSid
          actions_url: requestBody.ActionsUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/understand/Assistants/{AssistantSid}/Tasks/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task
      effect: destructive
      questions:
      - How do I remove a task my assistant no longer handles?
      - Can I delete a task along with its samples and fields?
      instructions:
      - text: Delete task {task} from assistant {assistant}.
        slots:
          task: path.Sid
          assistant: path.AssistantSid
      - text: Remove the unused task {task} in {assistant}.
        slots:
          task: path.Sid
          assistant: path.AssistantSid
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/overlays/twilio-understand-api-phrasing-overlay.yaml