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.	Puede ser requerido por el proveedor
baseURL	Text	URL base para las peticiones de la API OpenAI.	Yes (if omitted = use OpenAI provider)
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	Tiempo en segundos antes de que se agote el tiempo de espera.
maxRetries	Real	Maximum number of retry attempts in case of failure.
httpAgent	4D.HTTPAgent	Agente HTTP utilizado para realizar peticiones.
customHeaders	Real	Custom headers to be included in the HTTP requests.

Class constructor

Crear una instancia de la clase cliente OpenAI.

Nombre del argumento	Tipo	Descripción
apiKey or configuration	Texto u objeto	apiKey si Text u objeto de configuración.

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"

Recursos API

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.
embeddings	OpenAIEmbeddingsAPI	Acceso a la API Embeddings.

Ejemplo de Uso

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