Share via


ChatRole Struct

Definition

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

public readonly struct ChatRole : IEquatable<Azure.AI.Inference.ChatRole>
type ChatRole = struct
Public Structure ChatRole
Implements IEquatable(Of ChatRole)
Inheritance
ChatRole
Implements

Constructors

ChatRole(String)

Initializes a new instance of ChatRole.

Properties

Assistant

The role that provides responses to system-instructed, user-prompted input.

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.

Applies to