ChatResponseFormat Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Abstractions.dll

Package:

Microsoft.Extensions.AI.Abstractions v9.3.0-preview.1.25114.11

Source:

ChatResponseFormat.cs

Represents the response format that is desired by the caller.

public ref class ChatResponseFormat

[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.ChatResponseFormatText), "text")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.ChatResponseFormatJson), "json")]
[System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")]
public class ChatResponseFormat

[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.ChatResponseFormatText), "text")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.ChatResponseFormatJson), "json")>]
[<System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")>]
type ChatResponseFormat = class

Public Class ChatResponseFormat

Inheritance

Object

ChatResponseFormat

Derived

Microsoft.Extensions.AI.ChatResponseFormatJson

Microsoft.Extensions.AI.ChatResponseFormatText

Attributes

JsonDerivedTypeAttribute JsonPolymorphicAttribute

Properties

Json	Gets a singleton instance representing structured JSON data but without any particular schema.
Text	Gets a singleton instance representing unstructured textual data.

Methods

ForJsonSchema(JsonElement, String, String)

Creates a ChatResponseFormatJson representing structured JSON data with the specified schema.