Class CfnFlowVersion.KnowledgeBaseFlowNodeConfigurationProperty

Contains configurations for a knowledge base node in a flow.

Inheritance
System.Object
CfnFlowVersion.KnowledgeBaseFlowNodeConfigurationProperty
Namespace: Amazon.CDK.AwsBedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class KnowledgeBaseFlowNodeConfigurationProperty : Object, CfnFlowVersion.IKnowledgeBaseFlowNodeConfigurationProperty
Syntax (vb)
Public Class KnowledgeBaseFlowNodeConfigurationProperty
    Inherits Object
    Implements CfnFlowVersion.IKnowledgeBaseFlowNodeConfigurationProperty
Remarks

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 Amazon Bedrock works in the Amazon Bedrock User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_bedrock;

var knowledgeBaseFlowNodeConfigurationProperty = new KnowledgeBaseFlowNodeConfigurationProperty {
    KnowledgeBaseId = "knowledgeBaseId",

    // the properties below are optional
    GuardrailConfiguration = new GuardrailConfigurationProperty {
        GuardrailIdentifier = "guardrailIdentifier",
        GuardrailVersion = "guardrailVersion"
    },
    ModelId = "modelId"
};

Synopsis

Constructors

KnowledgeBaseFlowNodeConfigurationProperty()

Properties

GuardrailConfiguration

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

The unique identifier of the knowledge base to query.
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.

Constructors

KnowledgeBaseFlowNodeConfigurationProperty()

public KnowledgeBaseFlowNodeConfigurationProperty()

Properties

GuardrailConfiguration

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

public object GuardrailConfiguration { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-guardrailconfiguration

KnowledgeBaseId

The unique identifier of the knowledge base to query.

public string KnowledgeBaseId { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-knowledgebaseid

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.

public string ModelId { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-modelid

Implements