AIJsonSchemaCreateContext Struct

Reference

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.Abstractions.dll

Package:: Microsoft.Extensions.AI.Abstractions v9.0.1-preview.1.24570.5

Source:: AIJsonSchemaCreateContext.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the context in which a JSON schema within a type graph is being generated.

public value class AIJsonSchemaCreateContext

public readonly struct AIJsonSchemaCreateContext

type AIJsonSchemaCreateContext = struct

Public Structure AIJsonSchemaCreateContext

Inheritance: Object

ValueType
AIJsonSchemaCreateContext

Remarks

This struct is being passed to the user-provided TransformSchemaNode callback by the CreateJsonSchema(Type, String, Boolean, Object, JsonSerializerOptions, AIJsonSchemaCreateOptions) method and cannot be instantiated directly.

Properties

BaseTypeInfo	Gets the type info for the polymorphic base type if generated as a derived type.
DeclaringType	Gets the declaring type of the property or parameter being processed.
ParameterAttributeProvider	Gets the ICustomAttributeProvider of the constructor parameter associated with the accompanying PropertyInfo.
Path	Gets the path to the schema document currently being generated.
PropertyAttributeProvider	Gets the ICustomAttributeProvider corresponding to the property or field being processed.
PropertyInfo	Gets the JsonPropertyInfo if the schema is being generated for a property.
TypeInfo	Gets the JsonTypeInfo for the type being processed.

Methods

GetCustomAttribute<TAttribute>(Boolean)

Retrieves a custom attribute of a specified type that is applied to the specified schema node context.

Applies to

Share via