QConnect / Client / notify_recommendations_received

notify_recommendations_received#

QConnect.Client.notify_recommendations_received(**kwargs)#

Removes the specified recommendations from the specified assistant’s queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

See also: AWS API Documentation

Request Syntax

response = client.notify_recommendations_received(
    assistantId='string',
    recommendationIds=[
        'string',
    ],
    sessionId='string'
)
Parameters:

  • assistantId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • recommendationIds (list) –

    [REQUIRED]

    The identifiers of the recommendations.

    • (string) –

  • sessionId (string) –

    [REQUIRED]

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type:

dict

Returns:

Response Syntax

{
    'errors': [
        {
            'message': 'string',
            'recommendationId': 'string'
        },
    ],
    'recommendationIds': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • errors (list) –

      The identifiers of recommendations that are causing errors.

      • (dict) –

        An error occurred when creating a recommendation.

        • message (string) –

          A recommendation is causing an error.

        • recommendationId (string) –

          The identifier of the recommendation that is in error.

    • recommendationIds (list) –

      The identifiers of the recommendations.

      • (string) –

Exceptions