Skip to content

GetRecommendationsRequest

Source code in docs_src/capo_wisdom/types/get_recommendations_request.py 
13
14
15
16
17
18
19
20
21
class GetRecommendationsRequest(TypedDict, closed=True):
    assistant_id: "capo_wisdom.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    session_id: "capo_wisdom.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    max_results: NotRequired["capo_wisdom.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per page.</p>"""
    wait_time_seconds: "capo_wisdom.types.wait_time_seconds.WaitTimeSeconds"
    """<p>The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the call returns successfully with an empty list.</p>"""

assistant_id instance-attribute 

assistant_id: UuidOrArn

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

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return per page.

session_id instance-attribute 

session_id: UuidOrArn

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

wait_time_seconds instance-attribute 

wait_time_seconds: WaitTimeSeconds

The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.