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 and the foundation model used for generation.
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 used to generate a response.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$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:
