Class ChatTemplateConfigurationProps

(experimental) Properties for creating a chat template configuration.

Inheritance

object

ChatTemplateConfigurationProps

Implements

IChatTemplateConfigurationProps

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.Alpha

Assembly: Amazon.CDK.AWS.Bedrock.Alpha.dll

Syntax (csharp)

public class ChatTemplateConfigurationProps : IChatTemplateConfigurationProps

Syntax (vb)

Public Class ChatTemplateConfigurationProps Implements IChatTemplateConfigurationProps

Remarks

Stability: Experimental

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.Alpha;

             ChatMessage chatMessage;
             Tool tool;
             ToolChoice toolChoice;

             var chatTemplateConfigurationProps = new ChatTemplateConfigurationProps {
                 Messages = new [] { chatMessage },

                 // the properties below are optional
                 InputVariables = new [] { "inputVariables" },
                 System = "system",
                 ToolConfiguration = new ToolConfiguration {
                     ToolChoice = toolChoice,
                     Tools = new [] { tool }
                 }
             };

Synopsis

Constructors

ChatTemplateConfigurationProps()

(experimental) Properties for creating a chat template configuration.

Properties

InputVariables	(experimental) The input variables for the template.
Messages	(experimental) The messages in the chat template.
System	(experimental) The system message for the chat template.
ToolConfiguration	(experimental) The tool configuration for the chat template.

Constructors

ChatTemplateConfigurationProps()

(experimental) Properties for creating a chat template configuration.

public ChatTemplateConfigurationProps()

Remarks

Stability: Experimental

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.Alpha;

             ChatMessage chatMessage;
             Tool tool;
             ToolChoice toolChoice;

             var chatTemplateConfigurationProps = new ChatTemplateConfigurationProps {
                 Messages = new [] { chatMessage },

                 // the properties below are optional
                 InputVariables = new [] { "inputVariables" },
                 System = "system",
                 ToolConfiguration = new ToolConfiguration {
                     ToolChoice = toolChoice,
                     Tools = new [] { tool }
                 }
             };

Properties

InputVariables

(experimental) The input variables for the template.

public string[]? InputVariables { get; set; }

Property Value

string[]

Remarks

Default: - No input variables

Stability: Experimental

Messages

(experimental) The messages in the chat template.

public ChatMessage[] Messages { get; set; }

Property Value

ChatMessage[]

Remarks

Stability: Experimental

System

(experimental) The system message for the chat template.

public string? System { get; set; }

Property Value

string

Remarks

Default: - No system message

Stability: Experimental

ToolConfiguration

(experimental) The tool configuration for the chat template.

public IToolConfiguration? ToolConfiguration { get; set; }

Property Value

IToolConfiguration

Remarks

Default: - No tool configuration

Stability: Experimental

Implements

IChatTemplateConfigurationProps