AIJsonUtilities.CreateFunctionJsonSchema Method

Definition

Determines a JSON schema for the provided method.

C#
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);

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

A JSON schema document encoded as a JsonElement.

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard 2.0 (package-provided)