ChatCompletionSchema interface

Package:

@azure/search-documents

Object defining the custom schema the model will use to structure its output.

Properties

additionalProperties	Controls whether it is allowable for an object to contain additional keys / values that were not defined in the JSON Schema. Default is false.
properties	A JSON-formatted string that defines the output schema's properties and constraints for the model.
required	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.
type	Type of schema representation. Usually 'object'. Default is 'object'.

Property Details

additionalProperties

Controls whether it is allowable for an object to contain additional keys / values that were not defined in the JSON Schema. Default is false.

additionalProperties?: boolean

Property Value

boolean

properties

A JSON-formatted string that defines the output schema's properties and constraints for the model.

properties?: string

Property Value

string

required

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.

required?: string[]

Property Value

string[]

type

Type of schema representation. Usually 'object'. Default is 'object'.

type?: string

Property Value

string