Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

Retrieve

Retrieves content from knowledge sources based on a query.

Request Syntax


POST /assistants/assistantId/retrieve HTTP/1.1
Content-type: application/json

{
   "retrievalConfiguration": { 
      "filter": { ... },
      "knowledgeSource": { ... },
      "numberOfResults": number,
      "overrideKnowledgeBaseSearchType": "string"
   },
   "retrievalQuery": "string"
}

URI Request Parameters

The request uses the following URI parameters.

assistantId

The identifier of the Amazon Q in Connect assistant for content retrieval.

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

Request Body

The request accepts the following data in JSON format.

retrievalConfiguration

The configuration for the content retrieval operation.

Type: RetrievalConfiguration object

Required: Yes

retrievalQuery

The query for content retrieval.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "results": [ 
      { 
         "associationId": "string",
         "contentText": "string",
         "referenceType": "string",
         "sourceId": "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.

results

The results of the content retrieval operation.

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

ConflictException

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

HTTP Status Code: 409

DependencyFailedException

The request failed because it depends on another request that failed.

HTTP Status Code: 424

RequestTimeoutException

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

HTTP Status Code: 408

ResourceNotFoundException

The specified resource does not exist.

resourceName: The specified resource name.

HTTP Status Code: 404

ServiceQuotaExceededException

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by a service.

HTTP Status Code: 400