ChatCompletionsOptions.ResponseFormat Property

Definition

Namespace:

Azure.AI.Inference

Assembly:

Azure.AI.Inference.dll

Package:

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

Source:

ChatCompletionsOptions.cs

An object specifying the format that the model must output.

Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema.

Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length. 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 ChatCompletionsResponseFormatJsonObject and ChatCompletionsResponseFormatText.

public Azure.AI.Inference.ChatCompletionsResponseFormat ResponseFormat { get; set; }

member this.ResponseFormat : Azure.AI.Inference.ChatCompletionsResponseFormat with get, set

Public Property ResponseFormat As ChatCompletionsResponseFormat

Property Value

ChatCompletionsResponseFormat