QueryAssistant - Amazon Connect Wisdom

QueryAssistant

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

Request Syntax

POST /assistants/assistantId/query HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string", "queryText": "string" }

URI Request Parameters

The request uses the following URI parameters.

assistantId

The identifier of the Wisdom 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})?$

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults

The maximum number of results to return per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

queryText

The text to search for.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "results": [ { "document": { "contentReference": { "contentArn": "string", "contentId": "string", "knowledgeBaseArn": "string", "knowledgeBaseId": "string" }, "excerpt": { "highlights": [ { "beginOffsetInclusive": number, "endOffsetExclusive": number } ], "text": "string" }, "title": { "highlights": [ { "beginOffsetInclusive": number, "endOffsetExclusive": number } ], "text": "string" } }, "relevanceScore": number, "resultId": "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.

nextToken

If there are additional results, this is the token for the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

results

The results of the query.

Type: Array of ResultData 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.

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: