ChatCompletionsResponseFormatJsonSchemaDefinition interface

Pacote:

@azure-rest/ai-inference

Define o formato de resposta para conclusões de chat como JSON com um determinado esquema. O modelo de IA precisará aderir a esse esquema ao gerar conclusões.

Propriedades

description	Uma descrição do formato de resposta, usada pelo modelo de IA para determinar como gerar respostas nesse formato.
name	Um nome que rotula esse esquema JSON. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.
schema	A definição do esquema JSON. Consulte https://json-schema.org/overview/what-is-jsonschema. Observe que os modelos de IA geralmente só dão suporte a um subconjunto das palavras-chave definidas pelo esquema JSON. Consulte a documentação do modelo de IA para determinar o que tem suporte.
strict	Se definido como true, o serviço ocorrerá um erro se o esquema JSON fornecido contiver palavras-chave não compatíveis com o modelo de IA. Um exemplo dessa palavra-chave pode ser maxLength para o tipo JSON string. Se for false e o esquema JSON fornecido contiver palavras-chave sem suporte no modelo de IA, o modelo de IA não errorá. Em vez disso, ignorará as palavras-chave sem suporte.

Detalhes da propriedade

description

Uma descrição do formato de resposta, usada pelo modelo de IA para determinar como gerar respostas nesse formato.

description?: string

Valor da propriedade

string

name

Um nome que rotula esse esquema JSON. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.

name: string

Valor da propriedade

string

schema

A definição do esquema JSON. Consulte https://json-schema.org/overview/what-is-jsonschema. Observe que os modelos de IA geralmente só dão suporte a um subconjunto das palavras-chave definidas pelo esquema JSON. Consulte a documentação do modelo de IA para determinar o que tem suporte.

schema: Record<string, unknown>

Valor da propriedade

Record<string, unknown>

strict

Se definido como true, o serviço ocorrerá um erro se o esquema JSON fornecido contiver palavras-chave não compatíveis com o modelo de IA. Um exemplo dessa palavra-chave pode ser maxLength para o tipo JSON string. Se for false e o esquema JSON fornecido contiver palavras-chave sem suporte no modelo de IA, o modelo de IA não errorá. Em vez disso, ignorará as palavras-chave sem suporte.

strict?: boolean

Valor da propriedade

boolean