Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

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.

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

post/assistants/{assistantId}/query

Path parameters

assistantIdstring required

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

Request body

queryTextstring password

The text to search for.

nextTokenstring

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.

maxResultsinteger

The maximum number of results to return per page.

sessionIdstring

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

overrideKnowledgeBaseSearchType'HYBRID' | 'SEMANTIC'

The search type to be used against the Knowledge Base for this request. The values can be <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector embeddings and raw text.

Response

Success

nextTokenstring

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