Freigeben über

ChatResponseFormat.ForJsonSchema(String, String, String) Method

  • Reference

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v9.0.0-preview.9.24556.5

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

public static Microsoft.Extensions.AI.ChatResponseFormatJson ForJsonSchema (string schema, string? schemaName = default, string? schemaDescription = default);
static member ForJsonSchema : string * string * string -> Microsoft.Extensions.AI.ChatResponseFormatJson
Public Shared Function ForJsonSchema (schema As String, Optional schemaName As String = Nothing, Optional schemaDescription As String = Nothing) As ChatResponseFormatJson

Parameters

schema
String

The JSON schema.

schemaName
String

An optional name of the schema, e.g. if the schema represents a particular class, this could be the name of the class.

schemaDescription
String

An optional description of the schema.

Returns

ChatResponseFormatJson

The ChatResponseFormatJson instance.

Applies to