Package software.amazon.awscdk.services.bedrock

Interface CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 Amazon Bedrock works 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 software.amazon.awscdk.services.bedrock.*;
 KnowledgeBaseFlowNodeConfigurationProperty knowledgeBaseFlowNodeConfigurationProperty = KnowledgeBaseFlowNodeConfigurationProperty.builder()
         .knowledgeBaseId("knowledgeBaseId")
         // the properties below are optional
         .guardrailConfiguration(GuardrailConfigurationProperty.builder()
                 .guardrailIdentifier("guardrailIdentifier")
                 .guardrailVersion("guardrailVersion")
                 .build())
         .modelId("modelId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty.Builder	A builder for CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty
static final class	CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty.Jsii$Proxy	An implementation for CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty.Builder	builder()
default Object	getGuardrailConfiguration()	Configuration for a guardrail.
String	getKnowledgeBaseId()	The unique identifier of the knowledge base to query.
default String	getModelId()	The unique identifier of the model or inference profile to use to generate a response from the query results.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKnowledgeBaseId

@Stability(Stable)
@NotNull
String getKnowledgeBaseId()

The unique identifier of the knowledge base to query.

See Also:

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

getGuardrailConfiguration

@Stability(Stable)
@Nullable
default Object getGuardrailConfiguration()

Configuration for a guardrail.

See Also:

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

getModelId

@Stability(Stable)
@Nullable
default String getModelId()

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.

See Also:

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

builder

@Stability(Stable)
static CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty.Builder builder()

Returns:

a CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty.Builder of CfnFlow.KnowledgeBaseFlowNodeConfigurationProperty