Interface CfnFlowVersion.IKnowledgeBaseOrchestrationConfigurationProperty

Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.

Namespace: Amazon.CDK.AWS.Bedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnFlowVersion.IKnowledgeBaseOrchestrationConfigurationProperty

Syntax (vb)

Public Interface CfnFlowVersion.IKnowledgeBaseOrchestrationConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseorchestrationconfiguration.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 additionalModelRequestFields;

             var knowledgeBaseOrchestrationConfigurationProperty = new KnowledgeBaseOrchestrationConfigurationProperty {
                 AdditionalModelRequestFields = additionalModelRequestFields,
                 InferenceConfig = new PromptInferenceConfigurationProperty {
                     Text = new PromptModelInferenceConfigurationProperty {
                         MaxTokens = 123,
                         StopSequences = new [] { "stopSequences" },
                         Temperature = 123,
                         TopP = 123
                     }
                 },
                 PerformanceConfig = new PerformanceConfigurationProperty {
                     Latency = "latency"
                 },
                 PromptTemplate = new KnowledgeBasePromptTemplateProperty {
                     TextPromptTemplate = "textPromptTemplate"
                 }
             };

Synopsis

Properties

AdditionalModelRequestFields	The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
InferenceConfig	Contains inference configurations for the prompt.
PerformanceConfig	The performance configuration options for the knowledge base retrieval and generation process.
PromptTemplate	A custom prompt template for orchestrating the retrieval and generation process.

Properties

AdditionalModelRequestFields

The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.

object? AdditionalModelRequestFields { get; }

Property Value

object

Remarks

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

InferenceConfig

Contains inference configurations for the prompt.

object? InferenceConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnFlowVersion.IPromptInferenceConfigurationProperty

PerformanceConfig

The performance configuration options for the knowledge base retrieval and generation process.

object? PerformanceConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnFlowVersion.IPerformanceConfigurationProperty

PromptTemplate

A custom prompt template for orchestrating the retrieval and generation process.

object? PromptTemplate { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnFlowVersion.IKnowledgeBasePromptTemplateProperty