Aller au contenu principal
Version : 20 R10

OpenAI

La classe OpenAI fournit un client permettant d'accéder à diverses ressources de l'API OpenAI. Il inclut des propriétés de gestion des configurations API et des méthodes pour effectuer des requêtes HTTP vers les points de terminaison OpenAI.

Propriétés de configuration

Nom de propriétéTypeDescriptionOptionnel
apiKeyTextVotre clé API OpenAI .Peut être requis par le fournisseur
baseURLTextURL de base pour les requêtes de l'API OpenAI.Oui (si omis = utiliser le fournisseur OpenAI)
organisationTextVotre identifiant d'organisation OpenAI.Oui
projectTextVotre identifiant de projet OpenAI.Oui

Propriétés HTTP supplémentaires

Nom de propriétéTypeDescription
timeoutRealDélai en secondes avant l'expiration du délai.
maxRetriesRealNombre maximum de tentatives en cas d'échec.
httpAgent4D.HTTPAgentAgent HTTP utilisé pour effectuer des requêtes.
customHeadersRealEn-têtes personnalisés à inclure dans les requêtes HTTP.

Class constructor

Créer une instance de la classe client OpenAI.

Nom de l'argumentTypeDescription
apiKey ou configurationText, ObjectapiKey si Texte, ou objet de configuration.

Clé API

// en tant que texte
var $client:=cs.AIKit.OpenAI.new("your api key")
// en tant qu'objet
var $client:=cs.AIKit.OpenAI.new({apiKey: "your api key"})

URL du serveur

Pour une API compatible provider, vous pouvez configurer l'URL du serveur.

var $client:=cs.AIKit.OpenAI.new({apiKey: "your api key"; baseURL: "https://server.ai"})

ou après avoir créé une instance

$client.baseURL:="https://server.ai"

Ressources API

L'API donne accès à de multiples ressources qui permettent une interaction transparente avec les services de l'OpenAI. Chaque ressource est encapsulée dans une classe d'API dédiée, offrant un moyen structuré et intuitif d'interagir avec les différentes fonctionnalités.

Nom de propriétéTypeDescription
modelsOpenAIModelsAPIAccès à l'API des modèles.
chatOpenAIChatAPIAccès à l'API de discussion (Chat).
imagesOpenAIImagesAPIAccès à l'API Images.
moderationsOpenAIModerationsAPIAccès à l'API des modérations.
embeddingsOpenAIEmbeddingsAPIAccès à l'API Embeddings (vectorisation).

Exemple d'utilisation

$client.chat.completions.create(...)
$client.images.generate(...)
$client.model.lists(...)