Aller au contenu principal
Version: 20 R9 BETA

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 .Non pour OpenAI
baseURLTextURL de base pour les requêtes de l'API OpenAI.Oui
organisationTextVotre identifiant d'organisation OpenAI.Oui
projectTextVotre identifiant de projet OpenAI.Oui

Propriétés HTTP supplémentaires

Nom de propriétéTypeDescription
timeoutRealTime in seconds before timeout occurs.
maxRetriesRealMaximum number of retry attempts in case of failure.
httpAgent4D.HTTPAgentHTTP agent used for making requests.
customHeadersRealCustom headers to be included in the HTTP requests.

Class constructor

Créer une instance de la classe client OpenAI.

Nom de l'argumentTypeDescription
apiKeyText, ObjectapiKey if Text as first argument and the second can be an Object of parameters.

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. Each resource is encapsulated within a dedicated API class, offering a structured and intuitive way to interact with different functionalities.

Nom de propriétéTypeDescription
modelsOpenAIModelsAPIAccès à l'API des modèles.
chatOpenAIChatAPIAccès à l'API de Chat.
imagesOpenAIImagesAPIAccès à l'API Images.
moderationsOpenAIModerationsAPIAccès à l'API des modérations.

Exemple d'utilisation

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