interface KnowledgeBaseFlowNodeConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.aws_bedrock.CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnFlow_KnowledgeBaseFlowNodeConfigurationProperty`
Java	`software.amazon.awscdk.services.bedrock.CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty`
Python	`aws_cdk.aws_bedrock.CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_bedrock` » `CfnFlow` » `KnowledgeBaseFlowNodeConfigurationProperty`

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const knowledgeBaseFlowNodeConfigurationProperty: bedrock.CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty = {
  knowledgeBaseId: 'knowledgeBaseId',

  // the properties below are optional
  guardrailConfiguration: {
    guardrailIdentifier: 'guardrailIdentifier',
    guardrailVersion: 'guardrailVersion',
  },
  modelId: 'modelId',
};

Properties

Name	Type	Description
knowledgeBaseId	`string`	The unique identifier of the knowledge base to query.
guardrailConfiguration?	`IResolvable` `\|` `GuardrailConfigurationProperty`	Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
modelId?	`string`	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.

knowledgeBaseId

Type: string

The unique identifier of the knowledge base to query.

guardrailConfiguration?

Type: IResolvable | GuardrailConfigurationProperty (optional)

Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

modelId?

Type: string (optional)

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.