SearchModelFactory.ChatCompletionSchema Method
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.
Object defining the custom schema the model will use to structure its output.
public static Azure.Search.Documents.Indexes.Models.ChatCompletionSchema ChatCompletionSchema(string type = default, string properties = default, System.Collections.Generic.IEnumerable<string> required = default, bool? additionalProperties = default);static member ChatCompletionSchema : string * string * seq<string> * Nullable<bool> -> Azure.Search.Documents.Indexes.Models.ChatCompletionSchemaPublic Shared Function ChatCompletionSchema (Optional type As String = Nothing, Optional properties As String = Nothing, Optional required As IEnumerable(Of String) = Nothing, Optional additionalProperties As Nullable(Of Boolean) = Nothing) As ChatCompletionSchemaParameters
- type
- String
Type of schema representation. Usually 'object'. Default is 'object'.
- properties
- String
A JSON-formatted string that defines the output schema's properties and constraints for the model.
- required
- IEnumerable<String>
An array of the property names that are required to be part of the model's response. All properties must be included for structured outputs.
Controls whether it is allowable for an object to contain additional keys / values that were not defined in the JSON Schema. Default is false.
Returns
A new ChatCompletionSchema instance for mocking.
