Class CfnFlowVersion.FlowDefinitionProperty

The definition of the nodes and connections between nodes in the flow.

Inheritance

object

CfnFlowVersion.FlowDefinitionProperty

Implements

CfnFlowVersion.IFlowDefinitionProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Bedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFlowVersion.FlowDefinitionProperty : CfnFlowVersion.IFlowDefinitionProperty

Syntax (vb)

Public Class CfnFlowVersion.FlowDefinitionProperty Implements CfnFlowVersion.IFlowDefinitionProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdefinition.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 collector;
             FlowDefinitionProperty flowDefinitionProperty_;
             var input;
             var iterator;
             var loopInput;
             var output;

             var flowDefinitionProperty = new FlowDefinitionProperty {
                 Connections = new [] { new FlowConnectionProperty {
                     Name = "name",
                     Source = "source",
                     Target = "target",
                     Type = "type",

                     // the properties below are optional
                     Configuration = new FlowConnectionConfigurationProperty {
                         Conditional = new FlowConditionalConnectionConfigurationProperty {
                             Condition = "condition"
                         },
                         Data = new FlowDataConnectionConfigurationProperty {
                             SourceOutput = "sourceOutput",
                             TargetInput = "targetInput"
                         }
                     }
                 } },
                 Nodes = new [] { new FlowNodeProperty {
                     Name = "name",
                     Type = "type",

                     // the properties below are optional
                     Configuration = new FlowNodeConfigurationProperty {
                         Agent = new AgentFlowNodeConfigurationProperty {
                             AgentAliasArn = "agentAliasArn"
                         },
                         Collector = collector,
                         Condition = new ConditionFlowNodeConfigurationProperty {
                             Conditions = new [] { new FlowConditionProperty {
                                 Name = "name",

                                 // the properties below are optional
                                 Expression = "expression"
                             } }
                         },
                         InlineCode = new InlineCodeFlowNodeConfigurationProperty {
                             Code = "code",
                             Language = "language"
                         },
                         Input = input,
                         Iterator = iterator,
                         KnowledgeBase = new KnowledgeBaseFlowNodeConfigurationProperty {
                             KnowledgeBaseId = "knowledgeBaseId",

                             // the properties below are optional
                             GuardrailConfiguration = new GuardrailConfigurationProperty {
                                 GuardrailIdentifier = "guardrailIdentifier",
                                 GuardrailVersion = "guardrailVersion"
                             },
                             InferenceConfiguration = new PromptInferenceConfigurationProperty {
                                 Text = new PromptModelInferenceConfigurationProperty {
                                     MaxTokens = 123,
                                     StopSequences = new [] { "stopSequences" },
                                     Temperature = 123,
                                     TopP = 123
                                 }
                             },
                             ModelId = "modelId",
                             NumberOfResults = 123,
                             OrchestrationConfiguration = 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"
                                 }
                             },
                             PromptTemplate = new KnowledgeBasePromptTemplateProperty {
                                 TextPromptTemplate = "textPromptTemplate"
                             },
                             RerankingConfiguration = new VectorSearchRerankingConfigurationProperty {
                                 Type = "type",

                                 // the properties below are optional
                                 BedrockRerankingConfiguration = new VectorSearchBedrockRerankingConfigurationProperty {
                                     ModelConfiguration = new VectorSearchBedrockRerankingModelConfigurationProperty {
                                         ModelArn = "modelArn",

                                         // the properties below are optional
                                         AdditionalModelRequestFields = additionalModelRequestFields
                                     },

                                     // the properties below are optional
                                     MetadataConfiguration = new MetadataConfigurationForRerankingProperty {
                                         SelectionMode = "selectionMode",

                                         // the properties below are optional
                                         SelectiveModeConfiguration = new RerankingMetadataSelectiveModeConfigurationProperty {
                                             FieldsToExclude = new [] { new FieldForRerankingProperty {
                                                 FieldName = "fieldName"
                                             } },
                                             FieldsToInclude = new [] { new FieldForRerankingProperty {
                                                 FieldName = "fieldName"
                                             } }
                                         }
                                     },
                                     NumberOfRerankedResults = 123
                                 }
                             }
                         },
                         LambdaFunction = new LambdaFunctionFlowNodeConfigurationProperty {
                             LambdaArn = "lambdaArn"
                         },
                         Lex = new LexFlowNodeConfigurationProperty {
                             BotAliasArn = "botAliasArn",
                             LocaleId = "localeId"
                         },
                         Loop = new LoopFlowNodeConfigurationProperty {
                             Definition = flowDefinitionProperty_
                         },
                         LoopController = new LoopControllerFlowNodeConfigurationProperty {
                             ContinueCondition = new FlowConditionProperty {
                                 Name = "name",

                                 // the properties below are optional
                                 Expression = "expression"
                             },

                             // the properties below are optional
                             MaxIterations = 123
                         },
                         LoopInput = loopInput,
                         Output = output,
                         Prompt = new PromptFlowNodeConfigurationProperty {
                             SourceConfiguration = new PromptFlowNodeSourceConfigurationProperty {
                                 Inline = new PromptFlowNodeInlineConfigurationProperty {
                                     ModelId = "modelId",
                                     TemplateConfiguration = new PromptTemplateConfigurationProperty {
                                         Text = new TextPromptTemplateConfigurationProperty {
                                             Text = "text",

                                             // the properties below are optional
                                             InputVariables = new [] { new PromptInputVariableProperty {
                                                 Name = "name"
                                             } }
                                         }
                                     },
                                     TemplateType = "templateType",

                                     // the properties below are optional
                                     InferenceConfiguration = new PromptInferenceConfigurationProperty {
                                         Text = new PromptModelInferenceConfigurationProperty {
                                             MaxTokens = 123,
                                             StopSequences = new [] { "stopSequences" },
                                             Temperature = 123,
                                             TopP = 123
                                         }
                                     }
                                 },
                                 Resource = new PromptFlowNodeResourceConfigurationProperty {
                                     PromptArn = "promptArn"
                                 }
                             },

                             // the properties below are optional
                             GuardrailConfiguration = new GuardrailConfigurationProperty {
                                 GuardrailIdentifier = "guardrailIdentifier",
                                 GuardrailVersion = "guardrailVersion"
                             }
                         },
                         Retrieval = new RetrievalFlowNodeConfigurationProperty {
                             ServiceConfiguration = new RetrievalFlowNodeServiceConfigurationProperty {
                                 S3 = new RetrievalFlowNodeS3ConfigurationProperty {
                                     BucketName = "bucketName"
                                 }
                             }
                         },
                         Storage = new StorageFlowNodeConfigurationProperty {
                             ServiceConfiguration = new StorageFlowNodeServiceConfigurationProperty {
                                 S3 = new StorageFlowNodeS3ConfigurationProperty {
                                     BucketName = "bucketName"
                                 }
                             }
                         }
                     },
                     Inputs = new [] { new FlowNodeInputProperty {
                         Expression = "expression",
                         Name = "name",
                         Type = "type"
                     } },
                     Outputs = new [] { new FlowNodeOutputProperty {
                         Name = "name",
                         Type = "type"
                     } }
                 } }
             };

Synopsis

Constructors

FlowDefinitionProperty()

The definition of the nodes and connections between nodes in the flow.

Properties

Connections	An array of connection definitions in the flow.
Nodes	An array of node definitions in the flow.

Constructors

FlowDefinitionProperty()

The definition of the nodes and connections between nodes in the flow.

public FlowDefinitionProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdefinition.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 collector;
             FlowDefinitionProperty flowDefinitionProperty_;
             var input;
             var iterator;
             var loopInput;
             var output;

             var flowDefinitionProperty = new FlowDefinitionProperty {
                 Connections = new [] { new FlowConnectionProperty {
                     Name = "name",
                     Source = "source",
                     Target = "target",
                     Type = "type",

                     // the properties below are optional
                     Configuration = new FlowConnectionConfigurationProperty {
                         Conditional = new FlowConditionalConnectionConfigurationProperty {
                             Condition = "condition"
                         },
                         Data = new FlowDataConnectionConfigurationProperty {
                             SourceOutput = "sourceOutput",
                             TargetInput = "targetInput"
                         }
                     }
                 } },
                 Nodes = new [] { new FlowNodeProperty {
                     Name = "name",
                     Type = "type",

                     // the properties below are optional
                     Configuration = new FlowNodeConfigurationProperty {
                         Agent = new AgentFlowNodeConfigurationProperty {
                             AgentAliasArn = "agentAliasArn"
                         },
                         Collector = collector,
                         Condition = new ConditionFlowNodeConfigurationProperty {
                             Conditions = new [] { new FlowConditionProperty {
                                 Name = "name",

                                 // the properties below are optional
                                 Expression = "expression"
                             } }
                         },
                         InlineCode = new InlineCodeFlowNodeConfigurationProperty {
                             Code = "code",
                             Language = "language"
                         },
                         Input = input,
                         Iterator = iterator,
                         KnowledgeBase = new KnowledgeBaseFlowNodeConfigurationProperty {
                             KnowledgeBaseId = "knowledgeBaseId",

                             // the properties below are optional
                             GuardrailConfiguration = new GuardrailConfigurationProperty {
                                 GuardrailIdentifier = "guardrailIdentifier",
                                 GuardrailVersion = "guardrailVersion"
                             },
                             InferenceConfiguration = new PromptInferenceConfigurationProperty {
                                 Text = new PromptModelInferenceConfigurationProperty {
                                     MaxTokens = 123,
                                     StopSequences = new [] { "stopSequences" },
                                     Temperature = 123,
                                     TopP = 123
                                 }
                             },
                             ModelId = "modelId",
                             NumberOfResults = 123,
                             OrchestrationConfiguration = 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"
                                 }
                             },
                             PromptTemplate = new KnowledgeBasePromptTemplateProperty {
                                 TextPromptTemplate = "textPromptTemplate"
                             },
                             RerankingConfiguration = new VectorSearchRerankingConfigurationProperty {
                                 Type = "type",

                                 // the properties below are optional
                                 BedrockRerankingConfiguration = new VectorSearchBedrockRerankingConfigurationProperty {
                                     ModelConfiguration = new VectorSearchBedrockRerankingModelConfigurationProperty {
                                         ModelArn = "modelArn",

                                         // the properties below are optional
                                         AdditionalModelRequestFields = additionalModelRequestFields
                                     },

                                     // the properties below are optional
                                     MetadataConfiguration = new MetadataConfigurationForRerankingProperty {
                                         SelectionMode = "selectionMode",

                                         // the properties below are optional
                                         SelectiveModeConfiguration = new RerankingMetadataSelectiveModeConfigurationProperty {
                                             FieldsToExclude = new [] { new FieldForRerankingProperty {
                                                 FieldName = "fieldName"
                                             } },
                                             FieldsToInclude = new [] { new FieldForRerankingProperty {
                                                 FieldName = "fieldName"
                                             } }
                                         }
                                     },
                                     NumberOfRerankedResults = 123
                                 }
                             }
                         },
                         LambdaFunction = new LambdaFunctionFlowNodeConfigurationProperty {
                             LambdaArn = "lambdaArn"
                         },
                         Lex = new LexFlowNodeConfigurationProperty {
                             BotAliasArn = "botAliasArn",
                             LocaleId = "localeId"
                         },
                         Loop = new LoopFlowNodeConfigurationProperty {
                             Definition = flowDefinitionProperty_
                         },
                         LoopController = new LoopControllerFlowNodeConfigurationProperty {
                             ContinueCondition = new FlowConditionProperty {
                                 Name = "name",

                                 // the properties below are optional
                                 Expression = "expression"
                             },

                             // the properties below are optional
                             MaxIterations = 123
                         },
                         LoopInput = loopInput,
                         Output = output,
                         Prompt = new PromptFlowNodeConfigurationProperty {
                             SourceConfiguration = new PromptFlowNodeSourceConfigurationProperty {
                                 Inline = new PromptFlowNodeInlineConfigurationProperty {
                                     ModelId = "modelId",
                                     TemplateConfiguration = new PromptTemplateConfigurationProperty {
                                         Text = new TextPromptTemplateConfigurationProperty {
                                             Text = "text",

                                             // the properties below are optional
                                             InputVariables = new [] { new PromptInputVariableProperty {
                                                 Name = "name"
                                             } }
                                         }
                                     },
                                     TemplateType = "templateType",

                                     // the properties below are optional
                                     InferenceConfiguration = new PromptInferenceConfigurationProperty {
                                         Text = new PromptModelInferenceConfigurationProperty {
                                             MaxTokens = 123,
                                             StopSequences = new [] { "stopSequences" },
                                             Temperature = 123,
                                             TopP = 123
                                         }
                                     }
                                 },
                                 Resource = new PromptFlowNodeResourceConfigurationProperty {
                                     PromptArn = "promptArn"
                                 }
                             },

                             // the properties below are optional
                             GuardrailConfiguration = new GuardrailConfigurationProperty {
                                 GuardrailIdentifier = "guardrailIdentifier",
                                 GuardrailVersion = "guardrailVersion"
                             }
                         },
                         Retrieval = new RetrievalFlowNodeConfigurationProperty {
                             ServiceConfiguration = new RetrievalFlowNodeServiceConfigurationProperty {
                                 S3 = new RetrievalFlowNodeS3ConfigurationProperty {
                                     BucketName = "bucketName"
                                 }
                             }
                         },
                         Storage = new StorageFlowNodeConfigurationProperty {
                             ServiceConfiguration = new StorageFlowNodeServiceConfigurationProperty {
                                 S3 = new StorageFlowNodeS3ConfigurationProperty {
                                     BucketName = "bucketName"
                                 }
                             }
                         }
                     },
                     Inputs = new [] { new FlowNodeInputProperty {
                         Expression = "expression",
                         Name = "name",
                         Type = "type"
                     } },
                     Outputs = new [] { new FlowNodeOutputProperty {
                         Name = "name",
                         Type = "type"
                     } }
                 } }
             };

Properties

Connections

An array of connection definitions in the flow.

public object? Connections { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnFlowVersion.IFlowConnectionProperty)[]

Nodes

An array of node definitions in the flow.

public object? Nodes { get; set; }