components: schemas: CreateUnderstandModelBuildRequest: type: object properties: StatusCallback: type: string format: uri description: '' UniqueName: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1 UpdateUnderstandQueryRequest: type: object properties: SampleSid: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ description: An optional reference to the Sample created from this query. Status: type: string description: >- A string that described the query status. The values can be: pending_review, reviewed, discarded CreateUnderstandQueryRequest: type: object required: - Language - Query properties: Language: type: string description: An ISO language-country string of the sample. Query: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long. Tasks: type: string description: >- Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2* ModelBuild: type: string description: The Model Build Sid or unique name of the Model Build to be queried. Field: type: string description: >- Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name* UpdateUnderstandSampleRequest: type: object properties: Language: type: string description: An ISO language-country string of the sample. TaggedText: type: string description: >- The text example of how end-users may express this task. The sample may contain Field tag blocks. SourceChannel: type: string description: >- The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null CreateUnderstandSampleRequest: type: object required: - Language - TaggedText properties: Language: type: string description: An ISO language-country string of the sample. TaggedText: type: string description: >- The text example of how end-users may express this task. The sample may contain Field tag blocks. SourceChannel: type: string description: >- The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null UpdateUnderstandStyleSheetRequest: type: object properties: StyleSheet: description: The JSON Style sheet string UpdateUnderstandTaskRequest: type: object properties: FriendlyName: type: string description: >- A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. UniqueName: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. Actions: description: >- A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique. ActionsUrl: type: string format: uri description: User-provided HTTP endpoint where from the assistant fetches actions CreateUnderstandTaskRequest: type: object required: - UniqueName properties: UniqueName: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. FriendlyName: type: string description: >- A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. Actions: description: >- A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique. ActionsUrl: type: string format: uri description: User-provided HTTP endpoint where from the assistant fetches actions UpdateUnderstandTaskActionsRequest: type: object properties: Actions: description: >- The JSON actions that instruct the Assistant how to perform this task. UpdateUnderstandModelBuildRequest: type: object properties: UniqueName: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1 CreateUnderstandFieldValueRequest: type: object required: - Language - Value properties: Language: type: string description: An ISO language-country string of the value. Value: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. SynonymOf: type: string description: >- A value that indicates this field value is a synonym of. Empty if the value is not a synonym. CreateUnderstandFieldTypeRequest: type: object required: - UniqueName properties: UniqueName: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. FriendlyName: type: string description: >- A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. UpdateUnderstandFieldTypeRequest: type: object properties: FriendlyName: type: string description: >- A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. UniqueName: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. CreateUnderstandFieldRequest: type: object required: - FieldType - UniqueName properties: FieldType: type: string description: >- The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type. UniqueName: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. UpdateUnderstandAssistantInitiationActionsRequest: type: object properties: InitiationActions: description: '' UpdateUnderstandAssistantFallbackActionsRequest: type: object properties: FallbackActions: description: '' UpdateUnderstandAssistantRequest: type: object properties: FriendlyName: type: string description: >- A text description for the Assistant. It is non-unique and can up to 255 characters long. LogQueries: type: boolean description: >- A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided. UniqueName: type: string description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. CallbackUrl: type: string format: uri description: A user-provided URL to send event callbacks to. CallbackEvents: type: string description: Space-separated list of callback events that will trigger callbacks. FallbackActions: description: >- The JSON actions to be executed when the user's input is not recognized as matching any Task. InitiationActions: description: >- The JSON actions to be executed on inbound phone calls when the Assistant has to say something first. StyleSheet: description: The JSON object that holds the style sheet for the assistant model_build_enum_status: type: string enum: - enqueued - building - completed - failed - canceled preview.understand.assistant: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Assistant. date_created: type: string format: date-time nullable: true description: The date that this resource was created date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated friendly_name: type: string nullable: true description: >- A text description for the Assistant. It is non-unique and can up to 255 characters long. latest_model_build_sid: type: string minLength: 34 maxLength: 34 pattern: ^UG[0-9a-fA-F]{32}$ nullable: true description: >- The unique ID (Sid) of the latest model build. Null if no model has been built. links: type: object format: uri-map nullable: true log_queries: type: boolean nullable: true description: >- A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. unique_name: type: string nullable: true description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path. Unique up to 64 characters long. url: type: string format: uri nullable: true callback_url: type: string format: uri nullable: true description: A user-provided URL to send event callbacks to. callback_events: type: string nullable: true description: Space-separated list of callback events that will trigger callbacks. preview.understand.assistant.assistant_fallback_actions: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true url: type: string format: uri nullable: true data: nullable: true preview.understand.assistant.assistant_initiation_actions: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true url: type: string format: uri nullable: true data: nullable: true preview.understand.assistant.dialogue: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Field. assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the parent Assistant. sid: type: string minLength: 34 maxLength: 34 pattern: ^UK[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Dialogue data: nullable: true description: The dialogue memory object as json url: type: string format: uri nullable: true preview.understand.assistant.task.field: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Field. date_created: type: string format: date-time nullable: true description: The date that this resource was created date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated field_type: type: string nullable: true description: >- The Field Type of this field. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or sid of a custom Field Type. task_sid: type: string minLength: 34 maxLength: 34 pattern: ^UD[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Task associated with this Field. assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the parent Assistant. sid: type: string minLength: 34 maxLength: 34 pattern: ^UE[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. unique_name: type: string nullable: true description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. url: type: string format: uri nullable: true ListUnderstandFieldResponse: type: object properties: fields: type: array items: $ref: '#/components/schemas/preview.understand.assistant.task.field' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string preview.understand.assistant.field_type: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Field Type. date_created: type: string format: date-time nullable: true description: The date that this resource was created date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated friendly_name: type: string nullable: true description: >- A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. links: type: object format: uri-map nullable: true assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Assistant. sid: type: string minLength: 34 maxLength: 34 pattern: ^UB[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. unique_name: type: string nullable: true description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. url: type: string format: uri nullable: true ListUnderstandFieldTypeResponse: type: object properties: field_types: type: array items: $ref: '#/components/schemas/preview.understand.assistant.field_type' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string preview.understand.assistant.field_type.field_value: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Field Value. date_created: type: string format: date-time nullable: true description: The date that this resource was created date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated field_type_sid: type: string minLength: 34 maxLength: 34 pattern: ^UB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Field Type associated with this Field Value. language: type: string nullable: true description: An ISO language-country string of the value. assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Assistant. sid: type: string minLength: 34 maxLength: 34 pattern: ^UC[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. value: type: string nullable: true description: The Field Value itself. url: type: string format: uri nullable: true synonym_of: type: string minLength: 34 maxLength: 34 pattern: ^UC[0-9a-fA-F]{32}$ nullable: true description: >- A value that indicates this field value is a synonym of. Empty if the value is not a synonym. ListUnderstandFieldValueResponse: type: object properties: field_values: type: array items: $ref: >- #/components/schemas/preview.understand.assistant.field_type.field_value meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string preview.understand.assistant.model_build: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Model Build. date_created: type: string format: date-time nullable: true description: The date that this resource was created date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the parent Assistant. sid: type: string minLength: 34 maxLength: 34 pattern: ^UG[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. status: type: string $ref: '#/components/schemas/model_build_enum_status' nullable: true description: >- A string that described the model build status. The values can be: enqueued, building, completed, failed unique_name: type: string nullable: true description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. url: type: string format: uri nullable: true build_duration: type: integer nullable: true description: The time in seconds it took to build the model. error_code: type: integer nullable: true ListUnderstandModelBuildResponse: type: object properties: model_builds: type: array items: $ref: '#/components/schemas/preview.understand.assistant.model_build' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string preview.understand.assistant.query: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Query. date_created: type: string format: date-time nullable: true description: The date that this resource was created date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated results: nullable: true description: >- The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields. language: type: string nullable: true description: An ISO language-country string of the sample. model_build_sid: type: string minLength: 34 maxLength: 34 pattern: ^UG[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Model Build queried. query: type: string nullable: true description: The end-user's natural language input. x-twilio: pii: handling: standard deleteSla: 30 sample_sid: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ nullable: true description: An optional reference to the Sample created from this query. assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the parent Assistant. sid: type: string minLength: 34 maxLength: 34 pattern: ^UH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. status: type: string nullable: true description: >- A string that described the query status. The values can be: pending_review, reviewed, discarded url: type: string format: uri nullable: true source_channel: type: string nullable: true description: The communication channel where this end-user input came from ListUnderstandQueryResponse: type: object properties: queries: type: array items: $ref: '#/components/schemas/preview.understand.assistant.query' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string preview.understand.assistant.task.sample: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Sample. date_created: type: string format: date-time nullable: true description: The date that this resource was created date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated task_sid: type: string minLength: 34 maxLength: 34 pattern: ^UD[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Task associated with this Sample. language: type: string nullable: true description: An ISO language-country string of the sample. assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Assistant. sid: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. tagged_text: type: string nullable: true description: >- The text example of how end-users may express this task. The sample may contain Field tag blocks. url: type: string format: uri nullable: true source_channel: type: string nullable: true description: >- The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null ListUnderstandSampleResponse: type: object properties: samples: type: array items: $ref: '#/components/schemas/preview.understand.assistant.task.sample' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string preview.understand.assistant.style_sheet: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Assistant assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Assistant url: type: string format: uri nullable: true data: nullable: true description: The JSON style sheet object preview.understand.assistant.task: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Task. date_created: type: string format: date-time nullable: true description: The date that this resource was created date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated friendly_name: type: string nullable: true description: >- A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. links: type: object format: uri-map nullable: true assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Assistant. sid: type: string minLength: 34 maxLength: 34 pattern: ^UD[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. unique_name: type: string nullable: true description: >- A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. actions_url: type: string format: uri nullable: true description: User-provided HTTP endpoint where from the assistant fetches actions url: type: string format: uri nullable: true ListUnderstandTaskResponse: type: object properties: tasks: type: array items: $ref: '#/components/schemas/preview.understand.assistant.task' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string preview.understand.assistant.task.task_actions: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Field. assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the parent Assistant. task_sid: type: string minLength: 34 maxLength: 34 pattern: ^UD[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Task. url: type: string format: uri nullable: true data: nullable: true preview.understand.assistant.task.task_statistics: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Account that created this Field. assistant_sid: type: string minLength: 34 maxLength: 34 pattern: ^UA[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the parent Assistant. task_sid: type: string minLength: 34 maxLength: 34 pattern: ^UD[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Task associated with this Field. samples_count: type: integer nullable: true description: The total number of Samples associated with this Task. fields_count: type: integer nullable: true description: The total number of Fields associated with this Task. url: type: string format: uri nullable: true securitySchemes: accountSid_authToken: type: http scheme: basic info: title: Twilio Assistants description: Needs description. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.52.0 openapi: 3.0.1 paths: /understand/Assistants/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance dependentProperties: field_types: mapping: assistant_sid: sid resource_url: /understand/Assistants/{assistant_sid}/FieldTypes tasks: mapping: assistant_sid: sid resource_url: /understand/Assistants/{assistant_sid}/Tasks model_builds: mapping: assistant_sid: sid resource_url: /understand/Assistants/{assistant_sid}/ModelBuilds queries: mapping: assistant_sid: sid resource_url: /understand/Assistants/{assistant_sid}/Queries assistant_fallback_actions: mapping: assistant_sid: sid resource_url: /understandNone assistant_initiation_actions: mapping: assistant_sid: sid resource_url: /understandNone dialogues: mapping: assistant_sid: sid resource_url: /understand/Assistants/{assistant_sid}/Dialogues style_sheet: mapping: assistant_sid: sid resource_url: /understandNone get: description: '' tags: - Understand parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandAssistant x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant' description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandAssistant x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUnderstandAssistantRequest' delete: description: '' tags: - Understand parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUnderstandAssistant x-maturity: - Preview /understand/Assistants/{AssistantSid}/FallbackActions: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{Sid} mountName: assistant_fallback_actions className: assistant_fallback_actions get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.assistant_fallback_actions description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandAssistantFallbackActions x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.assistant_fallback_actions description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandAssistantFallbackActions x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/UpdateUnderstandAssistantFallbackActionsRequest /understand/Assistants/{AssistantSid}/InitiationActions: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{Sid} mountName: assistant_initiation_actions className: assistant_initiation_actions get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.assistant_initiation_actions description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandAssistantInitiationActions x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.assistant_initiation_actions description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandAssistantInitiationActions x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/UpdateUnderstandAssistantInitiationActionsRequest /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.dialogue' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandDialogue x-maturity: - Preview /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Field. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.task.field' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandField x-maturity: - Preview delete: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Field. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUnderstandField x-maturity: - Preview /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Field. schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUnderstandFieldResponse' description: OK security: - accountSid_authToken: [] operationId: ListUnderstandField x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the parent Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Field. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.task.field' description: Created security: - accountSid_authToken: [] operationId: CreateUnderstandField x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUnderstandFieldRequest' /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance dependentProperties: field_values: mapping: assistant_sid: assistant_sid field_type_sid: sid resource_url: >- /understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.field_type' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandFieldType x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.field_type' description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandFieldType x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUnderstandFieldTypeRequest' delete: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUnderstandFieldType x-maturity: - Preview /understand/Assistants/{AssistantSid}/FieldTypes: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list dependentProperties: field_values: mapping: assistant_sid: assistant_sid field_type_sid: sid resource_url: >- /understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUnderstandFieldTypeResponse' description: OK security: - accountSid_authToken: [] operationId: ListUnderstandFieldType x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.field_type' description: Created security: - accountSid_authToken: [] operationId: CreateUnderstandFieldType x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUnderstandFieldTypeRequest' /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: FieldTypeSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.field_type.field_value description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandFieldValue x-maturity: - Preview delete: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: FieldTypeSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUnderstandFieldValue x-maturity: - Preview /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: FieldTypeSid in: path description: '' schema: type: string required: true - name: Language in: query description: 'An ISO language-country string of the value. For example: *en-US*' schema: type: string - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUnderstandFieldValueResponse' description: OK security: - accountSid_authToken: [] operationId: ListUnderstandFieldValue x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: FieldTypeSid in: path description: '' schema: type: string required: true responses: '201': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.field_type.field_value description: Created security: - accountSid_authToken: [] operationId: CreateUnderstandFieldValue x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUnderstandFieldValueRequest' /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.model_build' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandModelBuild x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.model_build' description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandModelBuild x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUnderstandModelBuildRequest' delete: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUnderstandModelBuild x-maturity: - Preview /understand/Assistants/{AssistantSid}/ModelBuilds: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUnderstandModelBuildResponse' description: OK security: - accountSid_authToken: [] operationId: ListUnderstandModelBuild x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: '' schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.model_build' description: Created security: - accountSid_authToken: [] operationId: CreateUnderstandModelBuild x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUnderstandModelBuildRequest' /understand/Assistants/{AssistantSid}/Queries/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.query' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandQuery x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the parent Assistant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.query' description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandQuery x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUnderstandQueryRequest' delete: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUnderstandQuery x-maturity: - Preview /understand/Assistants/{AssistantSid}/Queries: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the parent Assistant. schema: type: string required: true - name: Language in: query description: An ISO language-country string of the sample. schema: type: string - name: ModelBuild in: query description: The Model Build Sid or unique name of the Model Build to be queried. schema: type: string - name: Status in: query description: >- A string that described the query status. The values can be: pending_review, reviewed, discarded schema: type: string - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUnderstandQueryResponse' description: OK security: - accountSid_authToken: [] operationId: ListUnderstandQuery x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the parent Assistant. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.query' description: Created security: - accountSid_authToken: [] operationId: CreateUnderstandQuery x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUnderstandQueryRequest' /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Sample. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.task.sample' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandSample x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Sample. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.task.sample' description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandSample x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUnderstandSampleRequest' delete: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Sample. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUnderstandSample x-maturity: - Preview /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Sample. schema: type: string required: true - name: Language in: query description: An ISO language-country string of the sample. schema: type: string - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUnderstandSampleResponse' description: OK security: - accountSid_authToken: [] operationId: ListUnderstandSample x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Sample. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.task.sample' description: Created security: - accountSid_authToken: [] operationId: CreateUnderstandSample x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUnderstandSampleRequest' /understand/Assistants/{AssistantSid}/StyleSheet: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{Sid} get: description: Returns Style sheet JSON object for this Assistant tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.style_sheet' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandStyleSheet x-maturity: - Preview post: description: >- Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}. tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.style_sheet' description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandStyleSheet x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUnderstandStyleSheetRequest' /understand/Assistants/{AssistantSid}/Tasks/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance dependentProperties: fields: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields samples: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples task_actions: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /understandNone statistics: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /understandNone parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.task' description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandTask x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.task' description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandTask x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUnderstandTaskRequest' delete: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUnderstandTask x-maturity: - Preview /understand/Assistants/{AssistantSid}/Tasks: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list dependentProperties: fields: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields samples: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples task_actions: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /understandNone statistics: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /understandNone parent: /Assistants/{Sid} get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUnderstandTaskResponse' description: OK security: - accountSid_authToken: [] operationId: ListUnderstandTask x-maturity: - Preview post: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the Assistant. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/preview.understand.assistant.task' description: Created security: - accountSid_authToken: [] operationId: CreateUnderstandTask x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUnderstandTaskRequest' /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} mountName: task_actions className: task_actions get: description: Returns JSON actions for this Task. tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the parent Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task. schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.task.task_actions description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandTaskActions x-maturity: - Preview post: description: >- Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the parent Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task. schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.task.task_actions description: OK security: - accountSid_authToken: [] operationId: UpdateUnderstandTaskActions x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUnderstandTaskActionsRequest' /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} className: task_statistics get: description: '' tags: - Understand parameters: - name: AssistantSid in: path description: The unique ID of the parent Assistant. schema: type: string required: true - name: TaskSid in: path description: The unique ID of the Task associated with this Field. schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/preview.understand.assistant.task.task_statistics description: OK security: - accountSid_authToken: [] operationId: FetchUnderstandTaskStatistics x-maturity: - Preview servers: - url: https://preview.twilio.com tags: - name: Understand x-maturity: - name: Preview description: >- PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact.