メニュー

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?

Model Build

A Model Build is a trained natural language understanding model that performs intent recognition and field extraction.

Models are created asynchronously and their status can be monitored as they are built, either via the API or Status Callbacks. Once a model is built, you can query the model using the Query Resource.

All Autopilot REST API resources use the following base URL:

https://autopilot.twilio.com/v1

ModelBuild properties

Names in PHP format
accountSid
sid<AC> Not PII

The unique ID of the Account that created this Model Build.

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

assistantSid
sid<UA> Not PII

The unique ID of the parent Assistant.

sid
sid<UG> Not PII

A 34-character string that uniquely identifies this resource.

status
enum:status Not PII

A string that described the model build status. The values can be: enqueued, building, completed, failed

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

buildDuration
integer? Not PII

The time in seconds it took to build the model.

errorCode
integer? Not PII

Create a ModelBuild resource

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

POST'ing to the Model Build list resource starts a training process that creates a new model based on the Tasks, Samples, Field Types, and Field Values for an Assistant.

When you define new Tasks, Field Types, and Fields, you should create a new Model Build so that Twilio Autopilot can train a new model using the new data.

Similarly, whenever you have a new set of Samples you should train a new model. There is no need to create a Model Build on every new Sample. We recommend creating a new Model Build once you have finished uploading all of your samples.

Model Building is an asynchronous process that returns an HTTP 201 Created response when the Model Build is successfully enqueued for training.

Training times vary depending on the size of your dataset. You can expect longer times for larger datasets.

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

The unique ID of the parent 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. For example: v0.1

例 1
        
        
        
        
        例 2
              
              
              
              
              Specifying a unique name for your Model Builds will help you track your Assistant's machine learning models over time.

              Create a Model Build and specify a unique name

              Specifying a unique name for your Model Builds will help you track your Assistant's machine learning models over time.

              Fetch a ModelBuild resource

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

              Returns the Model Build instance identified by {ModelBuildSid} or {ModelBuildUniqueName}.

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

              The unique ID of the parent Assistant.

              sid
              必須
              GET sid_like<UG> Not PII

              A 34-character string that uniquely identifies this resource.

              例 1
                    
                    
                    
                    

                    Read multiple ModelBuild resources

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

                    Returns a list of Model Builds for a given Assistant.

                    The list returned includes paging information.

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

                    The unique ID of the parent Assistant.

                    例 1
                          
                          
                          
                          

                          Update a ModelBuild resource

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

                          Updates the ModelBuild instance identified by {ModelBuildSid} or {ModelBuildUniqueName}.

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

                          The unique ID of the parent Assistant.

                          sid
                          必須
                          post sid_like<UG> Not PII

                          A 34-character string that uniquely identifies this resource.

                          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. For example: v0.1

                          例 1
                                
                                
                                
                                

                                Delete a ModelBuild resource

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

                                Deletes a Model Build identified by {ModelBuildSid} or {ModelBuildUniqueName}.

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

                                The unique ID of the parent Assistant.

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