Field Value
The FieldValue resource provides sample values associated with a Field Type.
For example, if the Field Type is city some sample values could be San Francisco, London, Tallinn or Bogota. You do not need to enter every possible value. Twilio's Autopilot is smart enough to detect cities even you haven't explicitly entered every option as a value. That said, the more Field Values you provide the training model, the better.
All Autopilot REST API resources use the following base URL.
https://autopilot.twilio.com/v1
FieldValues do not support special characters or emoji. FieldValues are also case-insensitive.
FieldValue properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created the FieldValue resource. |
date_created
|
The date and time in GMT when the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in RFC 2822 format. |
field_type_sid
|
The SID of the Field Type associated with the Field Value. |
language
|
The ISO language-country tag that specifies the language of the value. Currently supported tags: |
assistant_sid
|
The SID of the Assistant that is the parent of the FieldType associated with the resource. |
sid
|
The unique string that we created to identify the FieldValue resource. |
value
|
The Field Value data. |
url
|
The absolute URL of the FieldValue resource. |
synonym_of
|
The word for which the field value is a synonym of. |
Create a FieldValue resource
https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues
Creates a new Field Value for the Field Type specified by the {FieldTypeSid}.
Parameters
| Parameters in REST API format | |
|---|---|
assistant_sid
Path
|
The SID of the Assistant that is the parent of the FieldType associated with the new resource. |
field_type_sid
Path
|
The SID of the Field Type associated with the Field Value. |
language
Required
|
The ISO language-country tag that specifies the language of the value. Currently supported tags: |
value
Required
|
The Field Value data. |
synonym_of
Optional
|
The string value that indicates which word the field value is a synonym of. |
Example 1
Fetch a FieldValue resource
https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}
Returns the Field Value instance identified by {FieldValueSid} or {Value}.
Parameters
| Parameters in REST API format | |
|---|---|
assistant_sid
Path
|
The SID of the Assistant that is the parent of the FieldType associated with the resource to fetch. |
field_type_sid
Path
|
The SID of the Field Type associated with the Field Value to fetch. |
sid
Path
|
The Twilio-provided string that uniquely identifies the FieldValue resource to fetch. |
Example 1
Read multiple FieldValue resources
https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues
Returns the list of Field Values for this Field Type. The list includes paging information.
Parameters
| Parameters in REST API format | |
|---|---|
assistant_sid
Path
|
The SID of the Assistant that is the parent of the FieldType associated with the resources to read. |
field_type_sid
Path
|
The SID of the Field Type associated with the Field Value to read. |
language
Optional
|
The ISO language-country tag that specifies the language of the value. Currently supported tags: |
Example 1
Delete a FieldValue resource
https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}
Deletes a Field Value.
Parameters
| Parameters in REST API format | |
|---|---|
assistant_sid
Path
|
The SID of the Assistant that is the parent of the FieldType associated with the resources to delete. |
field_type_sid
Path
|
The SID of the Field Type associated with the Field Value to delete. |
sid
Path
|
The Twilio-provided string that uniquely identifies the FieldValue resource to delete. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
