AIJsonUtilities.CreateJsonSchema メソッド

定義

指定した型の JSON スキーマを作成します。

public static System.Text.Json.JsonElement CreateJsonSchema(Type? type, string? description = default, bool hasDefaultValue = false, object? defaultValue = default, System.Text.Json.JsonSerializerOptions? serializerOptions = default, Microsoft.Extensions.AI.AIJsonSchemaCreateOptions? inferenceOptions = default);
static member CreateJsonSchema : Type * string * bool * obj * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.AIJsonSchemaCreateOptions -> System.Text.Json.JsonElement
Public Function CreateJsonSchema (type As Type, Optional description As String = Nothing, Optional hasDefaultValue As Boolean = false, Optional defaultValue As Object = Nothing, Optional serializerOptions As JsonSerializerOptions = Nothing, Optional inferenceOptions As AIJsonSchemaCreateOptions = Nothing) As JsonElement

パラメーター

type
Type

スキーマを生成する型。

description
String

パラメーターの説明。

hasDefaultValue
Boolean

true パラメーターが省略可能な場合は 〗。それ以外の場合は false

defaultValue
Object

省略可能なパラメーターの既定値 (該当する場合)。

serializerOptions
JsonSerializerOptions

指定した型からスキーマを抽出するために使用するオプション。

inferenceOptions
AIJsonSchemaCreateOptions

スキーマの作成を制御するオプション。

返品

スキーマを表す JsonElement

注釈

TransformSchemaNode デリゲートが指定されていない限り、serializerOptionsでキー付けされたキャッシュを使用してスキーマの結果を格納します。

適用対象