你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ResponseFormatJsonSchema Class

Definition

A description of what the response format is for, used by the model to determine how to respond in the format.

public class ResponseFormatJsonSchema : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.ResponseFormatJsonSchema>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.ResponseFormatJsonSchema>
type ResponseFormatJsonSchema = class
    interface IJsonModel<ResponseFormatJsonSchema>
    interface IPersistableModel<ResponseFormatJsonSchema>
Public Class ResponseFormatJsonSchema
Implements IJsonModel(Of ResponseFormatJsonSchema), IPersistableModel(Of ResponseFormatJsonSchema)
Inheritance
ResponseFormatJsonSchema
Implements

Constructors

ResponseFormatJsonSchema(String, BinaryData)

Initializes a new instance of ResponseFormatJsonSchema.

Properties

Description

A description of what the response format is for, used by the model to determine how to respond in the format.

Name

The name of a schema.

Schema

The JSON schema object, describing the response format.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ResponseFormatJsonSchema>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ResponseFormatJsonSchema>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ResponseFormatJsonSchema>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ResponseFormatJsonSchema>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ResponseFormatJsonSchema>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to