Partager via

ChatCompletionsResponseFormatJsonSchemaDefinition interface

  • Référence
Paquet:
@azure-rest/ai-inference

Définit le format de réponse pour les achèvements de conversation en tant que JSON avec un schéma donné. Le modèle IA doit adhérer à ce schéma lors de la génération d’achèvements.

Propriétés

description

Description du format de réponse utilisé par le modèle IA pour déterminer comment générer des réponses dans ce format.
name

Nom qui étiquette ce schéma JSON. Doit être a-z, A-Z, 0-9 ou contenir des traits de soulignement et des tirets, avec une longueur maximale de 64.
schema

Définition du schéma JSON. Voir https://json-schema.org/overview/what-is-jsonschema. Notez que les modèles IA prennent généralement uniquement en charge un sous-ensemble des mots clés définis par le schéma JSON. Consultez la documentation de votre modèle IA pour déterminer ce qui est pris en charge.
strict

Si la valeur est true, le service s’affiche si le schéma JSON fourni contient des mots clés non pris en charge par le modèle IA. Un exemple de ce mot clé peut être maxLength pour le type JSON string. Si la valeur est false et que le schéma JSON fourni contient des mots clés non pris en charge par le modèle IA, le modèle IA ne s’affiche pas. Au lieu de cela, il ignore les mots clés non pris en charge.

Détails de la propriété

description

Description du format de réponse utilisé par le modèle IA pour déterminer comment générer des réponses dans ce format.

description?: string

Valeur de propriété

string

name

Nom qui étiquette ce schéma JSON. Doit être a-z, A-Z, 0-9 ou contenir des traits de soulignement et des tirets, avec une longueur maximale de 64.

name: string

Valeur de propriété

string

schema

Définition du schéma JSON. Voir https://json-schema.org/overview/what-is-jsonschema. Notez que les modèles IA prennent généralement uniquement en charge un sous-ensemble des mots clés définis par le schéma JSON. Consultez la documentation de votre modèle IA pour déterminer ce qui est pris en charge.

schema: Record<string, unknown>

Valeur de propriété

Record<string, unknown>

strict

Si la valeur est true, le service s’affiche si le schéma JSON fourni contient des mots clés non pris en charge par le modèle IA. Un exemple de ce mot clé peut être maxLength pour le type JSON string. Si la valeur est false et que le schéma JSON fourni contient des mots clés non pris en charge par le modèle IA, le modèle IA ne s’affiche pas. Au lieu de cela, il ignore les mots clés non pris en charge.

strict?: boolean

Valeur de propriété

boolean