Share via

AIJsonSchemaTransformContext Struct

  • Reference

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v9.5.0
Source:
AIJsonSchemaTransformContext.cs

Defines the context for transforming a schema node withing a larger schema document.

public value class AIJsonSchemaTransformContext
public readonly struct AIJsonSchemaTransformContext
type AIJsonSchemaTransformContext = struct
Public Structure AIJsonSchemaTransformContext
Inheritance
Object
ValueType
AIJsonSchemaTransformContext

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

IsCollectionElementSchema

Gets a value indicating whether the current schema is a collection element.
IsDictionaryValueSchema

Gets a value indicating whether the current schema is a dictionary value.
Path

Gets the path to the schema document currently being generated.
PropertyName

Gets the containing property name if the current schema is a property of an object.

Applies to