AIJsonSchemaCreateOptions Class
Definition
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.
Provides options for configuring the behavior of AIJsonUtilities JSON schema creation functionality.
public ref class AIJsonSchemaCreateOptions sealed : IEquatable<Microsoft::Extensions::AI::AIJsonSchemaCreateOptions ^>public sealed class AIJsonSchemaCreateOptions : IEquatable<Microsoft.Extensions.AI.AIJsonSchemaCreateOptions>type AIJsonSchemaCreateOptions = class
interface IEquatable<AIJsonSchemaCreateOptions>Public NotInheritable Class AIJsonSchemaCreateOptions
Implements IEquatable(Of AIJsonSchemaCreateOptions)- Inheritance
-
AIJsonSchemaCreateOptions
- Implements
Constructors
| AIJsonSchemaCreateOptions() |
Properties
| Default |
Gets the default options instance. |
| DisallowAdditionalProperties |
Gets a value indicating whether to generate schemas with the additionalProperties set to false for .NET objects. |
| IncludeParameter |
Gets a callback that is invoked for every parameter in the MethodBase provided to CreateFunctionJsonSchema(MethodBase, String, String, JsonSerializerOptions, AIJsonSchemaCreateOptions) in order to determine whether it should be included in the generated schema. |
| IncludeSchemaKeyword |
Gets a value indicating whether to include the $schema keyword in inferred schemas. |
| IncludeTypeInEnumSchemas |
Gets a value indicating whether to include the type keyword in inferred schemas for .NET enums. |
| RequireAllProperties |
Gets a value indicating whether to mark all properties as required in the schema. |
| TransformSchemaNode |
Gets a callback that is invoked for every schema that is generated within the type graph. |
Methods
| <Clone>$() | |
| Equals(AIJsonSchemaCreateOptions) |
Indicates whether the current object is equal to another object of the same type. |
| Equals(Object) |
Determines whether the specified object is equal to the current object. |
| GetHashCode() |
Serves as the default hash function. |
| ToString() | |
Operators
| Equality(AIJsonSchemaCreateOptions, AIJsonSchemaCreateOptions) | |
| Inequality(AIJsonSchemaCreateOptions, AIJsonSchemaCreateOptions) |
