TextResponseFormatJsonSchema interface

Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o danych wyjściowych ze strukturą.

Rozszerzenie

Właściwości

description

Opis celu formatu odpowiedzi, który jest używany przez model do określenia, jak odpowiedzieć w tym formacie.

name

Nazwa formatu odpowiedzi. Musi składać się z a-z, A-Z, 0-9 lub zawierać podkreślniki i kreski, z maksymalną długością 64 znaków.

schema

Schemat JSON, który definiuje wymaganą strukturę wyniku modelu.

strict

Czy generowany wynik modelu musi ściśle odpowiadać dostarczonemu schematowi JSON.

type

Typ zdefiniowanego formatu odpowiedzi. Zawsze json_schema.

Szczegóły właściwości

description

Opis celu formatu odpowiedzi, który jest używany przez model do określenia, jak odpowiedzieć w tym formacie.

description?: string

Wartość właściwości

string

name

Nazwa formatu odpowiedzi. Musi składać się z a-z, A-Z, 0-9 lub zawierać podkreślniki i kreski, z maksymalną długością 64 znaków.

name: string

Wartość właściwości

string

schema

Schemat JSON, który definiuje wymaganą strukturę wyniku modelu.

schema: Record<string, unknown>

Wartość właściwości

Record<string, unknown>

strict

Czy generowany wynik modelu musi ściśle odpowiadać dostarczonemu schematowi JSON.

strict?: boolean

Wartość właściwości

boolean

type

Typ zdefiniowanego formatu odpowiedzi. Zawsze json_schema.

type: "json_schema"

Wartość właściwości

"json_schema"