ChatCompletionsResponseFormatJsonSchemaDefinition interface

Paquete:

@azure-rest/ai-inference

Define el formato de respuesta para las finalizaciones de chat como JSON con un esquema determinado. El modelo de IA deberá cumplir este esquema al generar finalizaciones.

Propiedades

description	Descripción del formato de respuesta, utilizado por el modelo de IA para determinar cómo generar respuestas en este formato.
name	Nombre que etiqueta este esquema JSON. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64.
schema	Definición del esquema JSON. Consulte https://json-schema.org/overview/what-is-jsonschema. Tenga en cuenta que los modelos de IA normalmente solo admiten un subconjunto de las palabras clave definidas por el esquema JSON. Consulte la documentación del modelo de IA para determinar qué se admite.
strict	Si se establece en true, el servicio producirá un error si el esquema JSON proporcionado contiene palabras clave no compatibles con el modelo de IA. Un ejemplo de dicha palabra clave puede ser maxLength para el tipo JSON string. Si es false y el esquema JSON proporcionado contiene palabras clave no compatibles con el modelo de IA, el modelo de IA no generará errores. En su lugar, omitirá las palabras clave no admitidas.

Detalles de las propiedades

description

Descripción del formato de respuesta, utilizado por el modelo de IA para determinar cómo generar respuestas en este formato.

description?: string

Valor de propiedad

string

name

Nombre que etiqueta este esquema JSON. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64.

name: string

Valor de propiedad

string

schema

Definición del esquema JSON. Consulte https://json-schema.org/overview/what-is-jsonschema. Tenga en cuenta que los modelos de IA normalmente solo admiten un subconjunto de las palabras clave definidas por el esquema JSON. Consulte la documentación del modelo de IA para determinar qué se admite.

schema: Record<string, unknown>

Valor de propiedad

Record<string, unknown>

strict

Si se establece en true, el servicio producirá un error si el esquema JSON proporcionado contiene palabras clave no compatibles con el modelo de IA. Un ejemplo de dicha palabra clave puede ser maxLength para el tipo JSON string. Si es false y el esquema JSON proporcionado contiene palabras clave no compatibles con el modelo de IA, el modelo de IA no generará errores. En su lugar, omitirá las palabras clave no admitidas.

strict?: boolean

Valor de propiedad

boolean