メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Field Type

The FieldType resource is a custom, user-built Field "type" to be extracted from the end user's input.

Just as a web form has field types like numbers, dates, or amounts, Autopilot has field types so that the natural language understanding model knows what values to extract as fields.

With the FieldType Resource, you can define custom field types that are relevant to your application. FieldTypes are identified by their UniqueName.

All Autopilot REST API resources use the following base URL:

https://autopilot.twilio.com/v1/

FieldType properties

Names in PHP format
accountSid
sid<AC> Not PII

The unique ID of the Account that created this Field Type.

dateCreated
date_time<iso8601> Not PII

The date that this resource was created

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated

friendlyName
文字列 Not PII

A user-provided string that identifies this resource. It is non-unique and can be up to 255 characters long.

links
uri_map Not PII

assistantSid
sid<UA> Not PII

The unique ID of the Assistant.

sid
sid<UB> Not PII

A 34-character string that uniquely identifies this resource.

uniqueName
文字列 Not PII

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 when addressing this resource. Unique up to 64 characters long.

url
url Not PII

Create a FieldType resource

post
https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes

Creates a new FieldType

パラメーター
Names in None format
assistant_sid
必須
post sid_like<UA> Not PII

The unique ID of the Assistant.

unique_name
必須
post 文字列 Not PII

A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

friendly_name
オプション
post 文字列 Not PII

A user-provided string that identifies this resource. It is non-unique and can be up to 255 characters long.

例 1
        
        
        
        

        Fetch a FieldType resource

        GET
        https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}

        Returns the Field Type instance identified by {FieldTypeSid} or {FieldTypeUniqueName}.

        パラメーター
        Names in None format
        assistant_sid
        必須
        GET sid_like<UA> Not PII

        The unique ID of the Assistant.

        sid
        必須
        GET sid_like<UB> Not PII

        A 34-character string that uniquely identifies this resource.

        例 1
              
              
              
              

              Read multiple FieldType resources

              GET
              https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes

              Returns the complete list of Field Types for this Assistant. The list includes paging information.

              パラメーター
              Names in None format
              assistant_sid
              必須
              GET sid_like<UA> Not PII

              The unique ID of the Assistant.

              例 1
                    
                    
                    
                    

                    Update a FieldType resource

                    post
                    https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}

                    Updates the Field Type instance identified by {FieldTypeSid} or {FieldTypeUniqueName}.

                    パラメーター
                    Names in None format
                    assistant_sid
                    必須
                    post sid_like<UA> Not PII

                    The unique ID of the Assistant.

                    sid
                    必須
                    post sid_like<UB> Not PII

                    A 34-character string that uniquely identifies this resource.

                    friendly_name
                    オプション
                    post 文字列 Not PII

                    A user-provided string that identifies this resource. It is non-unique and can be up to 255 characters long.

                    unique_name
                    オプション
                    post 文字列 Not PII

                    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

                    例 1
                          
                          
                          
                          

                          Delete a FieldType resource

                          削除する
                          https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}

                          Deletes a Field Type.

                          Before you can delete a FieldType, you must first delete all values and any of your FieldType's associations with any task.

                          パラメーター
                          Names in None format
                          assistant_sid
                          必須
                          削除する sid_like<UA> Not PII

                          The unique ID of the Assistant.

                          sid
                          必須
                          削除する sid_like<UB> Not PII

                          A 34-character string that uniquely identifies this resource.

                          例 1
                                
                                
                                
                                
                                Rate this page:

                                ヘルプが必要ですか?

                                We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.