GetRecommendations
Important
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Retrieves recommendations for the specified session. To avoid retrieving the same
recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the
waitTimeSeconds parameter. Short poll is the default behavior and only returns
recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
Request Syntax
GET /assistants/assistantId/sessions/sessionId/recommendations?maxResults=maxResults&nextChunkToken=nextChunkToken&waitTimeSeconds=waitTimeSeconds HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- assistantId
-
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}Required: Yes
- maxResults
-
The maximum number of results to return per page.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextChunkToken
-
The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.
Length Constraints: Minimum length of 1. Maximum length of 2048.
- sessionId
-
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}Required: Yes
- 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.Valid Range: Minimum value of 0. Maximum value of 20.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"recommendations": [
{
"data": {
"details": { ... },
"reference": { ... }
},
"document": {
"contentReference": {
"contentArn": "string",
"contentId": "string",
"knowledgeBaseArn": "string",
"knowledgeBaseId": "string",
"referenceType": "string",
"sourceURL": "string"
},
"excerpt": {
"highlights": [
{
"beginOffsetInclusive": number,
"endOffsetExclusive": number
}
],
"text": "string"
},
"title": {
"highlights": [
{
"beginOffsetInclusive": number,
"endOffsetExclusive": number
}
],
"text": "string"
}
},
"recommendationId": "string",
"relevanceLevel": "string",
"relevanceScore": number,
"type": "string"
}
],
"triggers": [
{
"data": { ... },
"id": "string",
"recommendationIds": [ "string" ],
"source": "string",
"type": "string"
}
]
}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.
- recommendations
-
The recommendations.
Type: Array of RecommendationData objects
- triggers
-
The triggers corresponding to recommendations.
Type: Array of RecommendationTrigger objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ResourceNotFoundException
-
The specified resource does not exist.
- resourceName
-
The specified resource name.
HTTP Status Code: 404
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
