Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchUpdateCustomVocabularyItem

Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Request Syntax


PUT /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary/DEFAULT/batchupdate HTTP/1.1
Content-type: application/json

{
   "customVocabularyItemList": [ 
      { 
         "displayAs": "string",
         "itemId": "string",
         "phrase": "string",
         "weight": number
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

botId

The identifier of the bot associated with this custom vocabulary

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The identifier of the version of the bot associated with this custom vocabulary.

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^(DRAFT|[0-9]+)$

Required: Yes

localeId

The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

Required: Yes

Request Body

The request accepts the following data in JSON format.

customVocabularyItemList

A list of custom vocabulary items with updated fields. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.

Type: Array of CustomVocabularyItem objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botId": "string",
   "botVersion": "string",
   "errors": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "itemId": "string"
      }
   ],
   "localeId": "string",
   "resources": [ 
      { 
         "displayAs": "string",
         "itemId": "string",
         "phrase": "string",
         "weight": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

botId

The identifier of the bot associated with this custom vocabulary.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botVersion

The identifier of the version of the bot associated with this custom vocabulary.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^(DRAFT|[0-9]+)$

errors

A list of custom vocabulary items that failed to update during the operation. The reason for the error is contained within each error object.

Type: Array of FailedCustomVocabularyItem objects

localeId

The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

Type: String

resources

A list of custom vocabulary items that were successfully updated during the operation.

Type: Array of CustomVocabularyItem objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ResourceNotFoundException

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

HTTP Status Code: 404

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

retryAfterSeconds: The number of seconds after which the user can invoke the API again.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400