This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::Bedrock::Flow KnowledgeBaseFlowNodeConfiguration
Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "GuardrailConfiguration" :GuardrailConfiguration, "InferenceConfiguration" :PromptInferenceConfiguration, "KnowledgeBaseId" :String, "ModelId" :String, "NumberOfResults" :Number, "OrchestrationConfiguration" :KnowledgeBaseOrchestrationConfiguration, "PromptTemplate" :KnowledgeBasePromptTemplate, "RerankingConfiguration" :VectorSearchRerankingConfiguration}
YAML
GuardrailConfiguration:GuardrailConfigurationInferenceConfiguration:PromptInferenceConfigurationKnowledgeBaseId:StringModelId:StringNumberOfResults:NumberOrchestrationConfiguration:KnowledgeBaseOrchestrationConfigurationPromptTemplate:KnowledgeBasePromptTemplateRerankingConfiguration:VectorSearchRerankingConfiguration
Properties
GuardrailConfiguration-
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
Required: No
Type: GuardrailConfiguration
Update requires: No interruption
InferenceConfiguration-
Contains inference configurations for the prompt.
Required: No
Type: PromptInferenceConfiguration
Update requires: No interruption
KnowledgeBaseId-
The unique identifier of the knowledge base to query.
Required: Yes
Type: String
Pattern:
^[0-9a-zA-Z]+$Maximum:
10Update requires: No interruption
ModelId-
The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
Required: No
Type: String
Pattern:
^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$Minimum:
1Maximum:
2048Update requires: No interruption
NumberOfResults-
The number of results to retrieve from the knowledge base.
Required: No
Type: Number
Minimum:
1Maximum:
100Update requires: No interruption
OrchestrationConfiguration-
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
Required: No
Type: KnowledgeBaseOrchestrationConfiguration
Update requires: No interruption
PromptTemplate-
A custom prompt template to use with the knowledge base for generating responses.
Required: No
Type: KnowledgeBasePromptTemplate
Update requires: No interruption
RerankingConfiguration-
The configuration for reranking the retrieved results from the knowledge base to improve relevance.
Required: No
Type: VectorSearchRerankingConfiguration
Update requires: No interruption