openai kotlin

Cliente de API de OpenAI para Kotlin

Cliente Kotlin para la API de OpenAI con capacidades multiplataforma y coroutinas.

? Configuración

1. Instale el cliente API de OpenAI Kotlin agregando la siguiente dependencia a su archivo build.gradle :

repositories {
    mavenCentral()
}

dependencies {
    implementation " com.aallam.openai:openai-client:3.8.2 "
}

2. Elija y agregue a sus dependencias uno de los motores de KTOR.

Proseperar

Alternativamente, puede usar OpenAI-Client-Bom agregando la siguiente dependencia a su archivo build.gradle

dependencies {
    // import Kotlin API client BOM
    implementation platform( ' com.aallam.openai:openai-client-bom:3.8.2 ' )

    // define dependencies without versions
    implementation ' com.aallam.openai:openai-client '
    runtimeOnly ' io.ktor:ktor-client-okhttp '
}

Multiplataforma

En proyectos multiplataforma, agregue la dependencia del cliente OpenAI a commonMain y elija un motor para cada objetivo.

Aturdir

Se requiere Gradle para el soporte multiplataforma, pero no hay nada que le impida usar el cliente JVM en un proyecto Maven. Todavía necesita agregar a sus dependencias uno de los motores de KTOR.

Configurar el cliente con Maven

< dependencies >
    < dependency >
        < groupId >com.aallam.openai</ groupId >
        < artifactId >openai-client-jvm</ artifactId >
        < version >3.8.0</ version >
    </ dependency >
            
    < dependency >
        < groupId >io.ktor</ groupId >
        < artifactId >ktor-client-okhttp-jvm</ artifactId >
        < version >2.3.2</ version >
        < scope >runtime</ scope >
    </ dependency >
</ dependencies >

El nacimiento no es compatible con los proyectos Maven.

⚡️ al comenzar

Nota

OpenAI fomenta el uso de variables de entorno para la clave API. Leer más.

Cree una instancia de Cliente OpenAI :

 val openai = OpenAI (
    token = " your-api-key " ,
    timeout = Timeout (socket = 60 .seconds),
    // additional configurations...
)

O puede crear una instancia de OpenAI utilizando un OpenAIConfig preconfigurado:

 val config = OpenAIConfig (
    token = apiKey,
    timeout = Timeout (socket = 60 .seconds),
    // additional configurations...
)

val openAI = OpenAI (config)

Use su instancia OpenAI para realizar solicitudes de API. Aprende más.

Características compatibles

• Modelos
• Charlar
• Imágenes
• Incrustaciones
• Archivos
• Sintonia FINA
• Moderaciones
• Audio

Beta

• Asistentes
• Trapos
• Mensajes
• Carreras

Desapercibido

• Finalización
• Ajuste
• Ediciones

¿Buscas un tokenizador? Prueba Ktoken, una biblioteca Kotlin para el texto de tokenización.

Guías

Comience y comprenda más sobre cómo usar el cliente API Operai para Kotlin con estas guías:

• Empezando
• Llamada de chat y función
• Guía de FileSource
• Asistentes

Aplicaciones de muestra

Las aplicaciones de muestra están disponibles en sample , consulte el ReadMe para ejecutar instrucciones.

Proguard / R8

Las reglas específicas ya están incluidas en el frasco que puede ser interpretado por R8 automáticamente.

? Instantáneas

Aprenda a importar la versión de instantánea

Para importar versiones de instantáneas a su proyecto, agregue el siguiente fragmento de código a su archivo de Gradle:

repositories {
   // ...
   maven { url ' https://oss.sonatype.org/content/repositories/snapshots/ ' }
}

Solución de problemas

Para problemas comunes y sus soluciones, verifique la guía de solución de problemas.

Encar de apoyo

Apreciar el proyecto? Así es como puedes ayudar:

1. Estrella : Dale una estrella en la parte superior derecha. ¡Significa mucho!
2. Contribuir : ¿encontró un problema o tiene una idea de característica? Envíe un PR.
3. Comentarios : ¿Tiene sugerencias? Abra un problema o comience una discusión.

? Licencia

El cliente API de Operai Kotlin es un software de código abierto con licencia bajo la licencia MIT. Esta es una biblioteca no oficial, no está afiliada ni respaldada por OpenAI . Las contribuciones son bienvenidas.