ChatRequestSystemMessage Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

ChatRequestSystemMessage.cs

A request chat message containing system instructions that influence how the model will generate a chat completions response.

public class ChatRequestSystemMessage : Azure.AI.OpenAI.ChatRequestMessage, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ChatRequestSystemMessage>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ChatRequestSystemMessage>

type ChatRequestSystemMessage = class
    inherit ChatRequestMessage
    interface IJsonModel<ChatRequestSystemMessage>
    interface IPersistableModel<ChatRequestSystemMessage>

Public Class ChatRequestSystemMessage
Inherits ChatRequestMessage
Implements IJsonModel(Of ChatRequestSystemMessage), IPersistableModel(Of ChatRequestSystemMessage)

Inheritance

Object

ChatRequestMessage

ChatRequestSystemMessage

Implements

IJsonModel<ChatRequestSystemMessage> IPersistableModel<ChatRequestSystemMessage> IPersistableModel<T>

Constructors

ChatRequestSystemMessage(String)

Initializes a new instance of ChatRequestSystemMessage.

Properties

Content	The contents of the system message.
Name	An optional name for the participant.
Role	The chat role associated with this message. (Inherited from ChatRequestMessage)

Explicit Interface Implementations

IJsonModel<ChatRequestMessage>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from ChatRequestMessage)
IJsonModel<ChatRequestMessage>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from ChatRequestMessage)
IJsonModel<ChatRequestSystemMessage>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ChatRequestSystemMessage>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ChatRequestMessage>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from ChatRequestMessage)
IPersistableModel<ChatRequestMessage>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from ChatRequestMessage)
IPersistableModel<ChatRequestMessage>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from ChatRequestMessage)
IPersistableModel<ChatRequestSystemMessage>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ChatRequestSystemMessage>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ChatRequestSystemMessage>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.