ChatCompletionSchema interface
モデルが出力を構造化するために使用するカスタムスキーマを定義するオブジェクト。
プロパティ
| additional |
JSON スキーマで定義されていない追加のキー/値を含むことをオブジェクトに含めるかどうかを制御します。 既定値は false です。 |
| properties | モデルの出力スキーマのプロパティと制約を定義する JSON 形式の文字列。 |
| required | モデルの応答の一部となる必要があるプロパティ名の配列。 構造化出力には、すべてのプロパティを含める必要があります。 |
| type | スキーマ表現のタイプ。 通常は「オブジェクト」。 デフォルトは「オブジェクト」です。 |
プロパティの詳細
additionalProperties
JSON スキーマで定義されていない追加のキー/値を含むことをオブジェクトに含めるかどうかを制御します。 既定値は false です。
additionalProperties?: boolean
プロパティ値
boolean
properties
モデルの出力スキーマのプロパティと制約を定義する JSON 形式の文字列。
properties?: string
プロパティ値
string
required
モデルの応答の一部となる必要があるプロパティ名の配列。 構造化出力には、すべてのプロパティを含める必要があります。
required?: string[]
プロパティ値
string[]
type
スキーマ表現のタイプ。 通常は「オブジェクト」。 デフォルトは「オブジェクト」です。
type?: string
プロパティ値
string