メニュー

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?

フィールド

A Field is an attribute that you expect will give specific details about the intent expressed by the end-user, such as a time, date, or number.

Each Task may have a distinct set of Fields associated with it.

Every Field has a Field Type associated with it. For example: for the task orderStatus, a relevant Field for might be orderStatus_orderNumber with a Field Type of orderNumber.

Fields are then used in Samples to train the Assistant model on where to look for the given attributes. For example, I want to know if my order {orderStatus_orderNumber} shipped.

All Autopilot REST API resources use the following base URL.

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

Field properties

Names in PHP format
accountSid
sid<AC> Not PII

The unique ID of the Account that created this Field.

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

fieldType
文字列 Not PII

The Field Type of this field. It can be either a Built-in Field Type or the unique_name or sid of a custom Field Type.

taskSid
sid<UD> Not PII

The unique ID of the Task associated with this Field.

assistantSid
sid<UA> Not PII

The unique ID of the Assistant.

sid
sid<UE> 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. Unique up to 64 characters long.

url
url Not PII

Create a Field resource

post
https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields

Creates a new Field subresource for the Task. Make sure to use Built-in Field Types when possible.

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

The unique ID of the Assistant.

task_sid
必須
post sid_like<UD> Not PII

The unique ID of the Task associated with this Field.

field_type
必須
post 文字列 Not PII

The Field Type of this field. It can be either a Built-in Field Type or the unique_name or sid of a custom Field Type.

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
        
        
        
        

        Fetch a Field resource

        GET
        https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}

        Returns the Task Field instance identified by {FieldSid}.

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

        The unique ID of the Assistant.

        task_sid
        必須
        GET sid_like<UD> Not PII

        The unique ID of the Task associated with this Field.

        sid
        必須
        GET sid_like<UE> Not PII

        A 34-character string that uniquely identifies this resource.

        例 1
              
              
              
              

              Read multiple Field resources

              GET
              https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields

              Returns a list of Fields for the specified Task. The list includes paging information.

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

              The unique ID of the Assistant.

              task_sid
              必須
              GET sid_like<UD> Not PII

              The unique ID of the Task associated with this Field.

              例 1
                    
                    
                    
                    

                    Delete a Field resource

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

                    Deletes a Field.

                    Fields cannot be associated with any Samples if they are to be successfully deleted.

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

                    The unique ID of the Assistant.

                    task_sid
                    必須
                    削除する sid_like<UD> Not PII

                    The unique ID of the Task associated with this Field.

                    sid
                    必須
                    削除する sid_like<UE> 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.