ChatCompletionsResponseFormatJsonSchemaDefinition interface

Balíček:
@azure-rest/ai-inference

Definuje formát odpovědi pro dokončování chatu jako JSON s daným schématem. Model AI bude muset při generování dokončení dodržovat toto schéma.

Vlastnosti

description

Popis formátu odpovědi, který model AI používá k určení způsobu generování odpovědí v tomto formátu.
name

Název, který označuje toto schéma JSON. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.
schema

Definice schématu JSON. Viz https://json-schema.org/overview/what-is-jsonschema. Všimněte si, že modely AI obvykle podporují pouze podmnožinu klíčových slov definovaných schématem JSON. Pokud chcete zjistit, co se podporuje, projděte si dokumentaci k modelu AI.
strict

Pokud je nastavená hodnota true, služba se zobrazí chyba, pokud zadané schéma JSON obsahuje klíčová slova, která model AI nepodporuje. Příkladem takového klíčového slova může být maxLength pro typ JSON string. Pokud je false a zadané schéma JSON obsahuje klíčová slova nepodporovaná modelem AI, model AI se nezobrazí chybu. Místo toho bude ignorovat nepodporovaná klíčová slova.

Podrobnosti vlastnosti

description

Popis formátu odpovědi, který model AI používá k určení způsobu generování odpovědí v tomto formátu.

description?: string

Hodnota vlastnosti

string

name

Název, který označuje toto schéma JSON. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.

name: string

Hodnota vlastnosti

string

schema

Definice schématu JSON. Viz https://json-schema.org/overview/what-is-jsonschema. Všimněte si, že modely AI obvykle podporují pouze podmnožinu klíčových slov definovaných schématem JSON. Pokud chcete zjistit, co se podporuje, projděte si dokumentaci k modelu AI.

schema: Record<string, unknown>

Hodnota vlastnosti

Record<string, unknown>

strict

Pokud je nastavená hodnota true, služba se zobrazí chyba, pokud zadané schéma JSON obsahuje klíčová slova, která model AI nepodporuje. Příkladem takového klíčového slova může být maxLength pro typ JSON string. Pokud je false a zadané schéma JSON obsahuje klíčová slova nepodporovaná modelem AI, model AI se nezobrazí chybu. Místo toho bude ignorovat nepodporovaná klíčová slova.

strict?: boolean

Hodnota vlastnosti

boolean