Partilhar via

ChatCompletionsResponseFormatJsonSchemaDefinition interface

  • Referência
Pacote:
@azure-rest/ai-inference

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

Propriedades

description

Uma descrição do formato de resposta, usado 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. Ver https://json-schema.org/overview/what-is-jsonschema. Observe que os modelos de IA geralmente suportam apenas um subconjunto das palavras-chave definidas pelo esquema JSON. Consulte a documentação do seu modelo de IA para determinar o que é suportado.
strict

Se definido como true, o serviço errará se o esquema JSON fornecido contiver palavras-chave não suportadas pelo modelo de IA. Um exemplo dessa palavra-chave pode ser maxLength para o tipo JSON string. Se false, e o esquema JSON fornecido contiver palavras-chave não suportadas pelo modelo de IA, o modelo de IA não cometerá erros. Em vez disso, ignorará as palavras-chave não suportadas.

Detalhes de Propriedade

description

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

description?: string

Valor de 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 de Propriedade

string

schema

A definição do esquema JSON. Ver https://json-schema.org/overview/what-is-jsonschema. Observe que os modelos de IA geralmente suportam apenas um subconjunto das palavras-chave definidas pelo esquema JSON. Consulte a documentação do seu modelo de IA para determinar o que é suportado.

schema: Record<string, unknown>

Valor de Propriedade

Record<string, unknown>

strict

Se definido como true, o serviço errará se o esquema JSON fornecido contiver palavras-chave não suportadas pelo modelo de IA. Um exemplo dessa palavra-chave pode ser maxLength para o tipo JSON string. Se false, e o esquema JSON fornecido contiver palavras-chave não suportadas pelo modelo de IA, o modelo de IA não cometerá erros. Em vez disso, ignorará as palavras-chave não suportadas.

strict?: boolean

Valor de Propriedade

boolean