KnowledgeBaseRetrieveAndGenerateConfiguration
Contains details about the resource being queried.
This data type is used in the following API operations:
-
Retrieve request – in the
knowledgeBaseConfigurationfield -
RetrieveAndGenerate request – in the
knowledgeBaseConfigurationfield
Contents
- knowledgeBaseId
-
The unique identifier of the knowledge base that is queried.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern:
[0-9a-zA-Z]+Required: Yes
- modelArn
-
The ARN of the foundation model or inference profile used to generate a response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?Required: Yes
- generationConfiguration
-
Contains configurations for response generation based on the knowledge base query results.
Type: GenerationConfiguration object
Required: No
- orchestrationConfiguration
-
Settings for how the model processes the prompt prior to retrieval and generation.
Type: OrchestrationConfiguration object
Required: No
- retrievalConfiguration
-
Contains configurations for how to retrieve and return the knowledge base query.
Type: KnowledgeBaseRetrievalConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: