Create query

POST /v1/Assistants/{AssistantSid}/Queries

TODO: Resource-level docs

Path parameters

Body

  • Language string Required

    The ISO language-country string that specifies the language used for the new query. For example: en-US.

  • ModelBuild string

    The SID or unique name of the Model Build to be queried.

  • Query string Required

    The end-user's natural language input. It can be up to 2048 characters long.

  • Tasks string

    The list of tasks to limit the new query to. Tasks are expressed as a comma-separated list of task unique_name values. For example, task-unique_name-1, task-unique_name-2. Listing specific tasks is useful to constrain the paths that a user can take.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • assistant_sid string | null

      The SID of the Assistant that is the parent of the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UA[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was last updated

    • dialogue_sid string | null

      The SID of the Dialogue.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UK[0-9a-fA-F]{32}$.

    • language string | null

      The ISO language-country string that specifies the language used by the Query

    • model_build_sid string | null

      The SID of the Model Build queried

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UG[0-9a-fA-F]{32}$.

    • query string | null

      The end-user's natural language input

    • results

      The natural language analysis results that include the Task recognized and a list of identified Fields

    • sample_sid string | null

      The SID of an optional reference to the Sample created from the query

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UF[0-9a-fA-F]{32}$.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UH[0-9a-fA-F]{32}$.

    • source_channel string | null

      The communication channel from where the end-user input came

    • status string | null

      The status of the Query

    • url string(uri) | null

      The absolute URL of the Query resource
POST /v1/Assistants/{AssistantSid}/Queries 
curl \
 -X POST https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Queries \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Language=string&ModelBuild=string&Query=string&Tasks=string'
Request example 
{
  "Language": "string",
  "ModelBuild": "string",
  "Query": "string",
  "Tasks": "string"
}
Request examples 
{
  "Language": "string",
  "ModelBuild": "string",
  "Query": "string",
  "Tasks": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "assistant_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "dialogue_sid": "string",
  "language": "string",
  "model_build_sid": "string",
  "query": "string",
  "sample_sid": "string",
  "sid": "string",
  "source_channel": "string",
  "status": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "assistant_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "dialogue_sid": "string",
  "language": "string",
  "model_build_sid": "string",
  "query": "string",
  "sample_sid": "string",
  "sid": "string",
  "source_channel": "string",
  "status": "string",
  "url": "https://example.com"
}