ChatRole Struct

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v1.0.0-beta.17

Source:

ChatRole.cs

A description of the intended purpose of a message within a chat completions interaction.

public readonly struct ChatRole : IEquatable<Azure.AI.OpenAI.ChatRole>

type ChatRole = struct

Public Structure ChatRole
Implements IEquatable(Of ChatRole)

Inheritance

ValueType

ChatRole

Implements

IEquatable<ChatRole>

Constructors

ChatRole(String)

Initializes a new instance of ChatRole.

Properties

Assistant	The role that provides responses to system-instructed, user-prompted input.
Function	The role that provides function results for chat completions.
System	The role that instructs or sets the behavior of the assistant.
Tool	The role that represents extension tool activity within a chat completions operation.
User	The role that provides input for chat completions.

Methods

Equals(ChatRole)	Indicates whether the current object is equal to another object of the same type.
ToString()	Returns the fully qualified type name of this instance.

Operators

Equality(ChatRole, ChatRole)	Determines if two ChatRole values are the same.
Implicit(String to ChatRole)	Converts a string to a ChatRole.
Inequality(ChatRole, ChatRole)	Determines if two ChatRole values are not the same.