TextResponseFormatJsonSchema interface

JSON-Schemaantwortformat. Wird verwendet, um strukturierte JSON-Antworten zu generieren. Erfahren Sie mehr über Structured Outputs.

Eigenschaften

description	Eine Beschreibung des Zwecks des Antwortformats, die vom Modell verwendet wird, um zu bestimmen, wie in dem Format geantwortet werden soll.
name	Der Name des Antwortformats. Muss aus a–z, A–Z, 0–9 bestehen oder Unterstriche und Bindestriche enthalten, maximale Länge: 64.
schema	Das JSON-Schema, das die erforderliche Struktur der Modellausgabe definiert.
strict	Ob die vom Modell erzeugte Ausgabe strikt dem bereitgestellten JSON-Schema entsprechen muss.
type	Der Typ des zu definierenden Antwortformats. Immer `json_schema`.

Eine Beschreibung des Zwecks des Antwortformats, die vom Modell verwendet wird, um zu bestimmen, wie in dem Format geantwortet werden soll.

description?: string

string

Der Name des Antwortformats. Muss aus a–z, A–Z, 0–9 bestehen oder Unterstriche und Bindestriche enthalten, maximale Länge: 64.

name: string

string

Das JSON-Schema, das die erforderliche Struktur der Modellausgabe definiert.

schema: Record<string, unknown>

Record<string, unknown>

Ob die vom Modell erzeugte Ausgabe strikt dem bereitgestellten JSON-Schema entsprechen muss.

strict?: boolean

boolean

Der Typ des zu definierenden Antwortformats. Immer json_schema.

type: "json_schema"

"json_schema"