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.
Contents
- knowledgeBaseId
-
The unique identifier of the knowledge base to query.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern:
$|^[0-9a-zA-Z]+Required: Yes
- guardrailConfiguration
-
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
Type: GuardrailConfiguration object
Required: No
- inferenceConfiguration
-
Contains inference configurations for the prompt.
Type: PromptInferenceConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
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})?Required: No
- numberOfResults
-
The number of results to retrieve from the knowledge base.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- orchestrationConfiguration
-
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
Type: KnowledgeBaseOrchestrationConfiguration object
Required: No
- promptTemplate
-
A custom prompt template to use with the knowledge base for generating responses.
Type: KnowledgeBasePromptTemplate object
Required: No
- rerankingConfiguration
-
The configuration for reranking the retrieved results from the knowledge base to improve relevance.
Type: VectorSearchRerankingConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: