Share via

ChatCompletionsResponseFormatJSON Class

  • Reference

Definition

Namespace:
Azure.AI.Inference
Assembly:
Azure.AI.Inference.dll
Package:
Azure.AI.Inference v1.0.0-beta.2
Source:
ChatCompletionsResponseFormatJSON.cs

A response format for Chat Completions that restricts responses to emitting valid JSON objects. 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.

public class ChatCompletionsResponseFormatJSON : Azure.AI.Inference.ChatCompletionsResponseFormat, System.ClientModel.Primitives.IJsonModel<Azure.AI.Inference.ChatCompletionsResponseFormatJSON>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Inference.ChatCompletionsResponseFormatJSON>
type ChatCompletionsResponseFormatJSON = class
    inherit ChatCompletionsResponseFormat
    interface IJsonModel<ChatCompletionsResponseFormatJSON>
    interface IPersistableModel<ChatCompletionsResponseFormatJSON>
Public Class ChatCompletionsResponseFormatJSON
Inherits ChatCompletionsResponseFormat
Implements IJsonModel(Of ChatCompletionsResponseFormatJSON), IPersistableModel(Of ChatCompletionsResponseFormatJSON)
Inheritance
Object
ChatCompletionsResponseFormat
ChatCompletionsResponseFormatJSON
Implements
IJsonModel<ChatCompletionsResponseFormatJSON> IPersistableModel<ChatCompletionsResponseFormatJSON> IPersistableModel<T>

Constructors

ChatCompletionsResponseFormatJSON()

Initializes a new instance of ChatCompletionsResponseFormatJSON.

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.

(Inherited from ChatCompletionsResponseFormat)
IJsonModel<ChatCompletionsResponseFormat>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ChatCompletionsResponseFormat)
IJsonModel<ChatCompletionsResponseFormatJSON>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ChatCompletionsResponseFormatJSON>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ChatCompletionsResponseFormat>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ChatCompletionsResponseFormat)
IPersistableModel<ChatCompletionsResponseFormat>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ChatCompletionsResponseFormat)
IPersistableModel<ChatCompletionsResponseFormat>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ChatCompletionsResponseFormat)
IPersistableModel<ChatCompletionsResponseFormatJSON>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<ChatCompletionsResponseFormatJSON>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ChatCompletionsResponseFormatJSON>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to