OpenAI
La clase OpenAI proporciona un cliente para acceder a varios recursos de la API OpenAI. Incluye propiedades de gestión de las configuraciones API y de los métodos para efectuar las peticiones HTTP a los puntos de terminación de OpenAI.
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. | Sí (si se omite = utilizar la plataforma OpenAI) |
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 | Número máximo de reintentos en caso de fallo. |
httpAgent | 4D.HTTPAgent | Agente HTTP utilizado para realizar peticiones. |
customHeaders | Real | Encabezados personalizados que se incluirán en las peticiones HTTP. |
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
// como texto
var $client:=cs.AIKit.OpenAI.new("your api key")
// como objeto
var $client:=cs.AIKit.OpenAI.new({apiKey: "your api key"})
URL del servidor
Para una API proveedor compatible, puede configurar la URL del servidor.
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
La API ofrece acceso a múltiples recursos que permiten una interacción perfecta con los servicios de OpenAI. Cada recurso está encapsulado en una clase API específica, que ofrece una forma estructurada e intuitiva de interactuar con las distintas funcionalidades.
| 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. |
files | OpenAIFilesAPI | Acceso a la API Files. |
Ejemplo de Uso
$client.chat.completions.create(...)
$client.images.generate(...)
$client.files.create(...)
$client.model.lists(...)
Alias de modelos de proveedor
El cliente OpenAI soporta los alias de modelos de proveedores para facilitar el uso de múltiples proveedores. Consulte la documentación completa en Alias de modelos de proveedores.
Puede construir un cliente OpenAI usando un nombre de proveedor preconfigurado. Esto le permite cambiar fácilmente entre diferentes proveedores de IA (OpenAI, Anthropic, etc.) sin especificar la configuración completa cada vez.
var $client:=cs.AIKit.OpenAI.new({provider: "anthropic"})