ChatCompletionsResponseFormat Class

Definition

Namespace:

Azure.AI.Inference

Assembly:

Azure.AI.Inference.dll

Package:

Azure.AI.Inference v1.0.0-beta.2

Source:

ChatCompletionsResponseFormat.cs

Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode. Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON via a system or user message. Please note ChatCompletionsResponseFormat is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ChatCompletionsResponseFormatJSON and ChatCompletionsResponseFormatText.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Inference.UnknownChatCompletionsResponseFormat))]
public abstract class ChatCompletionsResponseFormat : System.ClientModel.Primitives.IJsonModel<Azure.AI.Inference.ChatCompletionsResponseFormat>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Inference.ChatCompletionsResponseFormat>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Inference.UnknownChatCompletionsResponseFormat))>]
type ChatCompletionsResponseFormat = class
    interface IJsonModel<ChatCompletionsResponseFormat>
    interface IPersistableModel<ChatCompletionsResponseFormat>

Public MustInherit Class ChatCompletionsResponseFormat
Implements IJsonModel(Of ChatCompletionsResponseFormat), IPersistableModel(Of ChatCompletionsResponseFormat)

Inheritance

Object

ChatCompletionsResponseFormat

Derived

Azure.AI.Inference.ChatCompletionsResponseFormatJSON

Azure.AI.Inference.ChatCompletionsResponseFormatText

Attributes

PersistableModelProxyAttribute

Implements

IJsonModel<ChatCompletionsResponseFormat> IPersistableModel<ChatCompletionsResponseFormat> IPersistableModel<T>

Constructors

ChatCompletionsResponseFormat()

Initializes a new instance of ChatCompletionsResponseFormat.

Explicit Interface Implementations

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