RetrieveAndGenerateStream
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
Note
The AWS CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
Request Syntax
POST /retrieveAndGenerateStream HTTP/1.1
Content-type: application/json
{
"input": {
"text": "string"
},
"retrieveAndGenerateConfiguration": {
"externalSourcesConfiguration": {
"generationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
}
},
"modelArn": "string",
"sources": [
{
"byteContent": {
"contentType": "string",
"data": blob,
"identifier": "string"
},
"s3Location": {
"uri": "string"
},
"sourceType": "string"
}
]
},
"knowledgeBaseConfiguration": {
"generationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
}
},
"knowledgeBaseId": "string",
"modelArn": "string",
"orchestrationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
},
"queryTransformationConfiguration": {
"type": "string"
}
},
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"filter": { ... },
"implicitFilterConfiguration": {
"metadataAttributes": [
{
"description": "string",
"key": "string",
"type": "string"
}
],
"modelArn": "string"
},
"numberOfResults": number,
"overrideSearchType": "string",
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"metadataConfiguration": {
"selectionMode": "string",
"selectiveModeConfiguration": { ... }
},
"modelConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"modelArn": "string"
},
"numberOfRerankedResults": number
},
"type": "string"
}
}
}
},
"type": "string"
},
"sessionConfiguration": {
"kmsKeyArn": "string"
},
"sessionId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- input
-
Contains the query to be made to the knowledge base.
Type: RetrieveAndGenerateInput object
Required: Yes
- retrieveAndGenerateConfiguration
-
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
Type: RetrieveAndGenerateConfiguration object
Required: No
- sessionConfiguration
-
Contains details about the session with the knowledge base.
Type: RetrieveAndGenerateSessionConfiguration object
Required: No
- sessionId
-
The unique identifier of the session. When you first make a
RetrieveAndGeneraterequest, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set thesessionIdyourself.Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern:
^[0-9a-zA-Z._:-]+$Required: No
Response Syntax
HTTP/1.1 200
x-amzn-bedrock-knowledge-base-session-id: sessionId
Content-type: application/json
{
"accessDeniedException": {
},
"badGatewayException": {
},
"citation": {
"citation": {
"generatedResponsePart": {
"textResponsePart": {
"span": {
"end": number,
"start": number
},
"text": "string"
}
},
"retrievedReferences": [
{
"content": {
"byteContent": "string",
"row": [
{
"columnName": "string",
"columnValue": "string",
"type": "string"
}
],
"text": "string",
"type": "string"
},
"location": {
"confluenceLocation": {
"url": "string"
},
"customDocumentLocation": {
"id": "string"
},
"kendraDocumentLocation": {
"uri": "string"
},
"s3Location": {
"uri": "string"
},
"salesforceLocation": {
"url": "string"
},
"sharePointLocation": {
"url": "string"
},
"sqlLocation": {
"query": "string"
},
"type": "string",
"webLocation": {
"url": "string"
}
},
"metadata": {
"string" : JSON value
}
}
]
}
},
"conflictException": {
},
"dependencyFailedException": {
},
"guardrail": {
"action": "string"
},
"internalServerException": {
},
"output": {
"text": "string"
},
"resourceNotFoundException": {
},
"serviceQuotaExceededException": {
},
"throttlingException": {
},
"validationException": {
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- sessionId
-
The session ID.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern:
^[0-9a-zA-Z._:-]+$
The following data is returned in JSON format by the service.
- accessDeniedException
-
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 403 - badGatewayException
-
The request failed due to a bad gateway error.
Type: Exception
HTTP Status Code: 502 - citation
-
A citation event.
Type: CitationEvent object
- conflictException
-
Error occurred because of a conflict while performing an operation.
Type: Exception
HTTP Status Code: 409 - dependencyFailedException
-
The request failed due to a dependency error.
Type: Exception
HTTP Status Code: 424 - guardrail
-
A guardrail event.
Type: GuardrailEvent object
- internalServerException
-
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500 - output
-
An output event.
Type: RetrieveAndGenerateOutputEvent object
- resourceNotFoundException
-
The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 404 - serviceQuotaExceededException
-
Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.
Type: Exception
HTTP Status Code: 400 - throttlingException
-
Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 429 - validationException
-
The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 400
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions. Check your permissions and retry your request.
HTTP Status Code: 403
- BadGatewayException
-
There was an issue with a dependency due to a server issue. Retry your request.
HTTP Status Code: 502
- ConflictException
-
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
- DependencyFailedException
-
There was an issue with a dependency. Check the resource configurations and retry the request.
HTTP Status Code: 424
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 400
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
