Share via


ChatCompletionResponseFormatJsonSchemaProperties Class

Definition

An open dictionary for extended properties. Required if 'type' == 'json_schema'.

public class ChatCompletionResponseFormatJsonSchemaProperties : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Models.ChatCompletionResponseFormatJsonSchemaProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Models.ChatCompletionResponseFormatJsonSchemaProperties>
type ChatCompletionResponseFormatJsonSchemaProperties = class
    interface IJsonModel<ChatCompletionResponseFormatJsonSchemaProperties>
    interface IPersistableModel<ChatCompletionResponseFormatJsonSchemaProperties>
Public Class ChatCompletionResponseFormatJsonSchemaProperties
Implements IJsonModel(Of ChatCompletionResponseFormatJsonSchemaProperties), IPersistableModel(Of ChatCompletionResponseFormatJsonSchemaProperties)
Inheritance
ChatCompletionResponseFormatJsonSchemaProperties
Implements

Constructors

ChatCompletionResponseFormatJsonSchemaProperties()

Initializes a new instance of ChatCompletionResponseFormatJsonSchemaProperties.

Properties

Description

Description of the json schema the model will adhere to.

Name

Name of the json schema the model will adhere to.

Schema

Object defining the custom schema the model will use to structure its output.

Strict

Whether or not the model's response should use structured outputs. Default is true.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ChatCompletionResponseFormatJsonSchemaProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ChatCompletionResponseFormatJsonSchemaProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ChatCompletionResponseFormatJsonSchemaProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ChatCompletionResponseFormatJsonSchemaProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ChatCompletionResponseFormatJsonSchemaProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to