OpenAIChatCompletionParameters

La classe OpenAIChatCompletionParameters permet de gérer les paramètres requis pour les générations de réponses conversationnelles en utilisant l'API OpenAI.

Hérite de

• OpenAIParameters

Propriétés

Propriété	Type	Valeur par défaut	Description
model	Text	"gpt-4o-mini"	ID du modèle à utiliser.
stream	Boolean	False	Indique si la progression partielle doit être retransmise en continu. Si cette option est activée, les tokens seront envoyés sous forme de données uniquement. Une formule de rappel est requise.
stream_options	Object	Null	Propriété pour stream=True. Par exemple : {include_usage: True}
max_completion_tokens	Integer	0	Le nombre maximum de tokens qui peuvent être générés dans la réponse.
n	Integer	1	Nombre de réponses à générer pour chaque invite (prompt).
temperature	Real	-1	Température d'échantillonnage à utiliser, entre 0 et 2. Les valeurs élevées rendent la sortie plus aléatoire, tandis que des valeurs faibles la rendent plus ciblée et déterministe.
store	Boolean	False	Stocker ou non le résultat de cette requête de génération de réponse conversationnelle.
reasoning_effort	Text	Null	Contraintes sur l'effort de raisonnement pour les modèles de raisonnement. Les valeurs actuellement prises en charge sont "low", "medium" et "high".
response_format	Object	Null	Un objet spécifiant le format que le modèle doit produire. Compatible avec les sorties structurées.
tools	Collection	Null	Une liste d'outils (OpenAITool) que le modèle peut appeler. Seul le type "function" est pris en charge.
tool_choice	Variant	Null	Contrôle l'outil (le cas échéant) qui est appelé par le modèle. Peut être "none", "auto", "required", ou spécifier un outil particulier.
prediction	Object	Null	Contenu de sortie statique, tel que le contenu d'un fichier texte en cours de régénération.

Propriétés du callback asynchrone

Propriété	Type	Description
onData (ou formula)	4D.Function	Une fonction à appeler de manière asynchrone lors de la réception d'un bloc de données. Assurez-vous que le process courant ne se termine pas.

onData recevra comme argument un OpenAIChatCompletionsStreamResult.

Voir OpenAIParameters pour les autres propriétés de callback (rappel).

Format de réponse

Le paramètre response_format vous permet de spécifier le format que le modèle doit produire. Ceci est particulièrement utile lorsque vous avez besoin de données structurées ou que vous voulez vous assurer que la réponse suit un format spécifique.

Types de formats de réponse pris en charge

1. Format texte (par défaut)

Le format de réponse par défaut renvoie du texte brut :

var $params := cs.OpenAIChatCompletionsParameters.new({ \
    model: "gpt-4o-mini"; \
    response_format: {type: "text"} \
})

2. Format d'objet JSON

Force le modèle à répondre avec du JSON valide :

var $params := cs.OpenAIChatCompletionsParameters.new({ \
    model: "gpt-4o-mini"; \
    response_format: {type: "json_object"} \
})

var $messages := [ \
    cs.OpenAIMessage.new({ \
        role: "system"; \
        content: "You are a helpful assistant that always responds in JSON format." \
    }) \
]
$messages.push({ \
    role: "user"; \
    content: "Give me information about the number 42 in JSON format with keys 'significance' and 'facts'." \
})

$result := $client.chat.completions.create($messages; $params)

3. Format de Schéma JSON (Sorties Structurées)

Pour un contrôle précis de la structure JSON, vous pouvez définir un schéma :

var $jsonSchema := { \
    type: "object"; \
    properties: { \
        name: {type: "string"}; \
        age: {type: "integer"}; \
        occupation: {type: "string"}; \
        city: {type: "string"} \
    }; \
    required: ["name"; "age"; "occupation"; "city"]; \
    additionalProperties: False \
}

var $params := cs.OpenAIChatCompletionsParameters.new({ \
    model: "gpt-4o-mini"; \
    response_format: { \
        type: "json_schema"; \
        json_schema: { \
            name: "person_info"; \
            description: "Information about a person"; \
            schema: $jsonSchema; \
            strict: True \
        } \
    } \
})

var $messages := [{role: "system"; content: "You are a helpful assistant."}]
$messages.push({ role: "user"; content: "Generate information about a person named John Smith."})

$result := $client.chat.completions.create($messages; $params)

Propriétés du schéma JSON

Lorsque vous utilisez le type json_schema, vous pouvez spécifier :

• name: Un nom pour le schéma
• description: Une description de ce que le schéma représente
• schema: La définition du schéma JSON
• strict: Si le schéma doit être respecté de manière stricte

Notes importantes

• Tous les modèles ne prennent pas en charge les sorties structurées (json_object ou json_schema) ; il convient donc de vérifier les capacités du modèle avant de l'utiliser.
• Lorsque vous utilisez le format json_object, vous devez inclure des instructions dans votre message système pour répondre au format JSON
• Le format json_schema offre le plus de contrôle et garantit que la réponse correspond exactement à la structure que vous avez spécifiée
• Les réponses JSON non valides entraîneront une erreur lors de l'utilisation des formats JSON
• La validation du schéma JSON garantit la sécurité des types et la présence des champs requis

Voir également

• OpenAIChatCompletionsAPI