LexModelsV2 / Client / list_recommended_intents

list_recommended_intents#

LexModelsV2.Client.list_recommended_intents(**kwargs)#

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

Request Syntax

response = client.list_recommended_intents(
    botId='string',
    botVersion='string',
    localeId='string',
    botRecommendationId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

botId (string) –
[REQUIRED]

The unique identifier of the bot associated with the recommended intents.
botVersion (string) –
[REQUIRED]

The version of the bot that contains the recommended intents.
localeId (string) –
[REQUIRED]

The identifier of the language and locale of the recommended intents.
botRecommendationId (string) –
[REQUIRED]

The identifier of the bot recommendation that contains the recommended intents.
nextToken (string) – If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
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.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'botRecommendationId': 'string',
    'summaryList': [
        {
            'intentId': 'string',
            'intentName': 'string',
            'sampleUtterancesCount': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- botId (string) –
  
  The unique identifier of the bot associated with the recommended intent.
- botVersion (string) –
  
  The version of the bot that contains the intent.
- localeId (string) –
  
  The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
- botRecommendationId (string) –
  
  The identifier of the bot recommendation that contains the recommended intent.
- summaryList (list) –
  
  Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
  - (dict) –
    
    An object that contains a summary of a recommended intent.
    - intentId (string) –
      
      The unique identifier of a recommended intent associated with the bot recommendation.
    - intentName (string) –
      
      The name of a recommended intent associated with the bot recommendation.
    - sampleUtterancesCount (integer) –
      
      The count of sample utterances of a recommended intent that is associated with a bot recommendation.
- nextToken (string) –
  
  A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.

list_recommended_intents#

Request Syntax

Response Syntax

Response Structure

Exceptions