ChatCompletionsResponseFormatJsonSchemaDefinition interface

Paket:

@azure-rest/ai-inference

Definiert das Antwortformat für Chatabschlusse als JSON mit einem bestimmten Schema. Das KI-Modell muss beim Generieren von Fertigstellungen dieses Schemas einhalten.

Eigenschaften

description	Eine Beschreibung des Antwortformats, das vom KI-Modell verwendet wird, um zu bestimmen, wie Antworten in diesem Format generiert werden.
name	Ein Name, der dieses JSON-Schema beschriftt. Muss a-z, A-Z, 0-9 sein oder Unterstriche und Gedankenstriche enthalten, mit einer maximalen Länge von 64.
schema	Die Definition des JSON-Schemas. Siehe https://json-schema.org/overview/what-is-jsonschema. Beachten Sie, dass KI-Modelle in der Regel nur eine Teilmenge der durch das JSON-Schema definierten Schlüsselwörter unterstützen. Lesen Sie Ihre KI-Modelldokumentation, um zu ermitteln, was unterstützt wird.
strict	Wenn dieser Wert auf "true" festgelegt ist, tritt ein Fehler auf, wenn das bereitgestellte JSON-Schema Schlüsselwörter enthält, die vom KI-Modell nicht unterstützt werden. Ein Beispiel für ein solches Schlüsselwort kann für DEN JSON-Typ stringmaxLength sein. Wenn "false" und das bereitgestellte JSON-Schema Stichwörter enthält, die vom KI-Modell nicht unterstützt werden, wird das KI-Modell nicht fehlerhaft. Stattdessen werden die nicht unterstützten Schlüsselwörter ignoriert.

Details zur Eigenschaft

description

Eine Beschreibung des Antwortformats, das vom KI-Modell verwendet wird, um zu bestimmen, wie Antworten in diesem Format generiert werden.

description?: string

Eigenschaftswert

string

name

Ein Name, der dieses JSON-Schema beschriftt. Muss a-z, A-Z, 0-9 sein oder Unterstriche und Gedankenstriche enthalten, mit einer maximalen Länge von 64.

name: string

Eigenschaftswert

string

schema

Die Definition des JSON-Schemas. Siehe https://json-schema.org/overview/what-is-jsonschema. Beachten Sie, dass KI-Modelle in der Regel nur eine Teilmenge der durch das JSON-Schema definierten Schlüsselwörter unterstützen. Lesen Sie Ihre KI-Modelldokumentation, um zu ermitteln, was unterstützt wird.

schema: Record<string, unknown>

Eigenschaftswert

Record<string, unknown>

strict

Wenn dieser Wert auf "true" festgelegt ist, tritt ein Fehler auf, wenn das bereitgestellte JSON-Schema Schlüsselwörter enthält, die vom KI-Modell nicht unterstützt werden. Ein Beispiel für ein solches Schlüsselwort kann für DEN JSON-Typ stringmaxLength sein. Wenn "false" und das bereitgestellte JSON-Schema Stichwörter enthält, die vom KI-Modell nicht unterstützt werden, wird das KI-Modell nicht fehlerhaft. Stattdessen werden die nicht unterstützten Schlüsselwörter ignoriert.

strict?: boolean

Eigenschaftswert

boolean