ChatCompletionSchema Class
Definition
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.
Object defining the custom schema the model will use to structure its output.
public class ChatCompletionSchema : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.ChatCompletionSchema>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.ChatCompletionSchema>type ChatCompletionSchema = class
interface IJsonModel<ChatCompletionSchema>
interface IPersistableModel<ChatCompletionSchema>Public Class ChatCompletionSchema
Implements IJsonModel(Of ChatCompletionSchema), IPersistableModel(Of ChatCompletionSchema)- Inheritance
-
ChatCompletionSchema
- Implements
Constructors
| ChatCompletionSchema() |
Initializes a new instance of ChatCompletionSchema. |
Properties
| AdditionalProperties |
Controls whether it is allowable for an object to contain additional keys / values that were not defined in the JSON Schema. Default is false. |
| Properties |
A JSON-formatted string that defines the output schema's properties and constraints for the model. |
| Required |
An array of the property names that are required to be part of the model's response. All properties must be included for structured outputs. |
| Type |
Type of schema representation. Usually 'object'. Default is 'object'. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
| IJsonModel<ChatCompletionSchema>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ChatCompletionSchema>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ChatCompletionSchema>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ChatCompletionSchema>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ChatCompletionSchema>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
