AIJsonUtilities.CreateFunctionJsonSchema Method

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Abstractions.dll

Package:

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

Determines a JSON schema for the provided method.

public static System.Text.Json.JsonElement CreateFunctionJsonSchema(System.Reflection.MethodBase method, string? title = default, string? description = default, System.Text.Json.JsonSerializerOptions? serializerOptions = default, Microsoft.Extensions.AI.AIJsonSchemaCreateOptions? inferenceOptions = default);

static member CreateFunctionJsonSchema : System.Reflection.MethodBase * string * string * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.AIJsonSchemaCreateOptions -> System.Text.Json.JsonElement

Public Function CreateFunctionJsonSchema (method As MethodBase, Optional title As String = Nothing, Optional description As String = Nothing, Optional serializerOptions As JsonSerializerOptions = Nothing, Optional inferenceOptions As AIJsonSchemaCreateOptions = Nothing) As JsonElement

Parameters

method

MethodBase

The method from which to extract schema information.

title

String

The title keyword used by the method schema.

description

String

The description keyword used by the method schema.

serializerOptions

JsonSerializerOptions

The options used to extract the schema from the specified type.

inferenceOptions

AIJsonSchemaCreateOptions

The options controlling schema inference.

Returns

JsonElement

A JSON schema document encoded as a JsonElement.