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 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 software.amazon.awscdk.services.bedrock.*;
 Object additionalModelRequestFields;
 KnowledgeBaseFlowNodeConfigurationProperty knowledgeBaseFlowNodeConfigurationProperty = KnowledgeBaseFlowNodeConfigurationProperty.builder()
         .knowledgeBaseId("knowledgeBaseId")
         // the properties below are optional
         .guardrailConfiguration(GuardrailConfigurationProperty.builder()
                 .guardrailIdentifier("guardrailIdentifier")
                 .guardrailVersion("guardrailVersion")
                 .build())
         .inferenceConfiguration(PromptInferenceConfigurationProperty.builder()
                 .text(PromptModelInferenceConfigurationProperty.builder()
                         .maxTokens(123)
                         .stopSequences(List.of("stopSequences"))
                         .temperature(123)
                         .topP(123)
                         .build())
                 .build())
         .modelId("modelId")
         .numberOfResults(123)
         .orchestrationConfiguration(KnowledgeBaseOrchestrationConfigurationProperty.builder()
                 .additionalModelRequestFields(additionalModelRequestFields)
                 .inferenceConfig(PromptInferenceConfigurationProperty.builder()
                         .text(PromptModelInferenceConfigurationProperty.builder()
                                 .maxTokens(123)
                                 .stopSequences(List.of("stopSequences"))
                                 .temperature(123)
                                 .topP(123)
                                 .build())
                         .build())
                 .performanceConfig(PerformanceConfigurationProperty.builder()
                         .latency("latency")
                         .build())
                 .promptTemplate(KnowledgeBasePromptTemplateProperty.builder()
                         .textPromptTemplate("textPromptTemplate")
                         .build())
                 .build())
         .promptTemplate(KnowledgeBasePromptTemplateProperty.builder()
                 .textPromptTemplate("textPromptTemplate")
                 .build())
         .rerankingConfiguration(VectorSearchRerankingConfigurationProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .bedrockRerankingConfiguration(VectorSearchBedrockRerankingConfigurationProperty.builder()
                         .modelConfiguration(VectorSearchBedrockRerankingModelConfigurationProperty.builder()
                                 .modelArn("modelArn")
                                 // the properties below are optional
                                 .additionalModelRequestFields(additionalModelRequestFields)
                                 .build())
                         // the properties below are optional
                         .metadataConfiguration(MetadataConfigurationForRerankingProperty.builder()
                                 .selectionMode("selectionMode")
                                 // the properties below are optional
                                 .selectiveModeConfiguration(RerankingMetadataSelectiveModeConfigurationProperty.builder()
                                         .fieldsToExclude(List.of(FieldForRerankingProperty.builder()
                                                 .fieldName("fieldName")
                                                 .build()))
                                         .fieldsToInclude(List.of(FieldForRerankingProperty.builder()
                                                 .fieldName("fieldName")
                                                 .build()))
                                         .build())
                                 .build())
                         .numberOfRerankedResults(123)
                         .build())
                 .build())
         .build();

See Also: