OpenAI

The OpenAI class provides a client for accessing various OpenAI API resources. It includes properties for managing API configurations and methods for performing HTTP requests to the OpenAI endpoints.

Propiedades de configuración

Nombre de la propiedad	Tipo	Descripción	Opcional
apiKey	Text	Su llave OpenAI API.	No para OpenAI
baseURL	Text	Base URL for OpenAI API requests.	Sí
organization	Text	Su ID de organización OpenAI.	Sí
project	Text	Su ID de proyecto OpenAI.	Sí

Propiedades HTTP adicionales

Nombre de la propiedad	Tipo	Descripción
timeout	Real	Time in seconds before timeout occurs.
maxRetries	Real	Maximum number of retry attempts in case of failure.
httpAgent	4D.HTTPAgent	HTTP agent used for making requests.
customHeaders	Real	Custom headers to be included in the HTTP requests.

Class constructor

Create an instance of the OpenAI client class.

Argument Name	Tipo	Descripción
apiKey	Texto u objeto	apiKey if Text as first argument and the second can be an Object of parameters.

Llave API

// as text
var $client:=cs.AIKit.OpenAI.new("your api key")
// as object
var $client:=cs.AIKit.OpenAI.new({apiKey: "your api key"})

URL del servidor

For a compatible provider API, you can configure the server URL.

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

o después de crear una instancia

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

API resources

The API provides access to multiple resources that allow seamless interaction with OpenAI's services. Each resource is encapsulated within a dedicated API class, offering a structured and intuitive way to interact with different functionalities.

Nombre de la propiedad	Tipo	Descripción
models	OpenAIModelsAPI	Acceso a la API Models.
chat	OpenAIChatAPI	Acceso a la API Chat.
images	OpenAIImagesAPI	Acceso a la API Images.
moderations	OpenAIModerationsAPI	Acceso a la API de moderaciones.

Ejemplo de Uso

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