TextResponseFormatJsonSchema interface

JSON 結構的回應格式。 用來產生結構化 JSON 回應。 進一步了解 結構化輸出。

Extends

屬性

description

回應格式用途的描述,模型用來決定如何以該格式進行回應。

name

回應格式的名稱。 必須是 a-z、A-Z、0-9,或包含底線或虛線,長度上限為 64。

schema

定義模型輸出所需結構的 JSON 架構。

strict

模型產生的輸出是否必須嚴格符合所提供的 JSON 架構。

type

正在定義的回應格式類型。 一律為 json_schema。

屬性詳細資料

description

回應格式用途的描述,模型用來決定如何以該格式進行回應。

description?: string

屬性值

string

name

回應格式的名稱。 必須是 a-z、A-Z、0-9,或包含底線或虛線,長度上限為 64。

name: string

屬性值

string

schema

定義模型輸出所需結構的 JSON 架構。

schema: Record<string, unknown>

屬性值

Record<string, unknown>

strict

模型產生的輸出是否必須嚴格符合所提供的 JSON 架構。

strict?: boolean

屬性值

boolean

type

正在定義的回應格式類型。 一律為 json_schema。

type: "json_schema"

屬性值

"json_schema"