ChatCompletionsResponseFormat Class

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

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

Source:: ChatCompletionsResponseFormat.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON mode. 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..

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

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

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

Inheritance: Object
ChatCompletionsResponseFormat

Attributes: PersistableModelProxyAttribute

Implements: IJsonModel<ChatCompletionsResponseFormat> IPersistableModel<ChatCompletionsResponseFormat> IPersistableModel<T>

Constructors

ChatCompletionsResponseFormat()

Initializes a new instance of ChatCompletionsResponseFormat.

Fields

JsonObject	A response format for Chat Completions that restricts responses to emitting valid JSON objects.
Text	The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response content that adheres to a specific schema.

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.

Applies to