LexModelsV2 / Client / search_associated_transcripts

search_associated_transcripts

LexModelsV2.Client.search_associated_transcripts(**kwargs)

Search for associated transcripts that meet the specified criteria.

See also: AWS API Documentation

Request Syntax

response = client.search_associated_transcripts(
    botId='string',
    botVersion='string',
    localeId='string',
    botRecommendationId='string',
    searchOrder='Ascending'|'Descending',
    filters=[
        {
            'name': 'IntentId'|'SlotTypeId',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextIndex=123
)

Parameters:

• botId (string) –

  [REQUIRED]

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

• botVersion (string) –

  [REQUIRED]

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

• localeId (string) –

  [REQUIRED]

  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

• botRecommendationId (string) –

  [REQUIRED]

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

• searchOrder (string) – How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

• filters (list) –

  [REQUIRED]

  A list of filter objects.

  • (dict) –

    Filters to search for the associated transcript.

    • name (string) – [REQUIRED]

      The name of the field to use for filtering. The allowed names are IntentId and SlotTypeId.

    • values (list) – [REQUIRED]

      The values to use to filter the transcript.

      • (string) –

• maxResults (integer) – 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.

• nextIndex (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'botRecommendationId': 'string',
    'nextIndex': 123,
    'associatedTranscripts': [
        {
            'transcript': 'string'
        },
    ],
    'totalResults': 123
}

Response Structure

• (dict) –

  • botId (string) –

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

  • botVersion (string) –

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

  • localeId (string) –

    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

  • botRecommendationId (string) –

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

  • nextIndex (integer) –

    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.

  • associatedTranscripts (list) –

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

    • (dict) –

      The object containing information that associates the recommended intent/slot type with a conversation.

      • transcript (string) –

        The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see Output transcript format.

  • totalResults (integer) –

    The total number of transcripts returned by the search.

Exceptions

• LexModelsV2.Client.exceptions.ThrottlingException

• LexModelsV2.Client.exceptions.ServiceQuotaExceededException

• LexModelsV2.Client.exceptions.ValidationException

• LexModelsV2.Client.exceptions.InternalServerException

• LexModelsV2.Client.exceptions.ResourceNotFoundException