你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ChatCompletionsResponseFormatJsonSchemaDefinition interface

参考

包:: @azure-rest/ai-inference

使用给定架构将聊天完成的响应格式定义为 JSON。生成完成时，AI 模型需要遵循此架构。

属性

description	AI 模型用来确定如何以此格式生成响应的响应格式的说明。
name	标记此 JSON 架构的名称。必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。
schema	JSON 架构的定义。请参阅 https://json-schema.org/overview/what-is-jsonschema。请注意，AI 模型通常仅支持 JSON 架构定义的关键字的子集。请参阅 AI 模型文档以确定支持的内容。
strict	如果设置为 true，则如果提供的 JSON 架构包含 AI 模型不支持的关键字，则服务将出错。对于 JSON 类型 `maxLength`，可能 `string` 此类关键字的示例。如果为 false，并且提供的 JSON 架构包含 AI 模型不支持的关键字，则 AI 模型不会出错。而是会忽略不受支持的关键字。

属性详细信息

description

AI 模型用来确定如何以此格式生成响应的响应格式的说明。

description?: string

属性值

string

name

标记此 JSON 架构的名称。必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。

name: string

属性值

string

schema

JSON 架构的定义。请参阅 https://json-schema.org/overview/what-is-jsonschema。请注意，AI 模型通常仅支持 JSON 架构定义的关键字的子集。请参阅 AI 模型文档以确定支持的内容。

schema: Record<string, unknown>

属性值

Record<string, unknown>

strict

如果设置为 true，则如果提供的 JSON 架构包含 AI 模型不支持的关键字，则服务将出错。对于 JSON 类型 maxLength，可能 string 此类关键字的示例。如果为 false，并且提供的 JSON 架构包含 AI 模型不支持的关键字，则 AI 模型不会出错。而是会忽略不受支持的关键字。

strict?: boolean

属性值

boolean

通过