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

SearchAssociatedTranscripts

Search for associated transcripts that meet the specified criteria.

Request Syntax


POST /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/botRecommendationId/associatedtranscripts HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextIndex": number,
   "searchOrder": "string"
}

URI Request Parameters

The request uses the following URI parameters.

botId

The unique identifier of the bot associated with the transcripts that you are searching.

Length Constraints: Fixed length of 10.

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

Required: Yes

botRecommendationId

The unique identifier of the bot recommendation associated with the transcripts to search.

Length Constraints: Fixed length of 10.

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

Required: Yes

botVersion

The version of the bot containing the transcripts that you are searching.

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

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

Required: Yes

localeId

The identifier of the language and locale of the transcripts to search. 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.

filters

A list of filter objects.

Type: Array of AssociatedTranscriptFilter objects

Array Members: Fixed number of 1 item.

Required: Yes

maxResults

The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextIndex

If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000000.

Required: No

searchOrder

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "associatedTranscripts": [ 
      { 
         "transcript": "string"
      }
   ],
   "botId": "string",
   "botRecommendationId": "string",
   "botVersion": "string",
   "localeId": "string",
   "nextIndex": number,
   "totalResults": 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.

associatedTranscripts

The object that contains the associated transcript that meet the criteria you specified.

Type: Array of AssociatedTranscript objects

botId

The unique identifier of the bot associated with the transcripts that you are searching.

Type: String

Length Constraints: Fixed length of 10.

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

botRecommendationId

The unique identifier of the bot recommendation associated with the transcripts to search.

Type: String

Length Constraints: Fixed length of 10.

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

botVersion

The version of the bot containing the transcripts that you are searching.

Type: String

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

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

localeId

The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages

Type: String

nextIndex

A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000000.

totalResults

The total number of transcripts returned by the search.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

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.

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