openai kotlin

Client de l'API OpenAI pour Kotlin

Client Kotlin pour l'API d'OpenAI avec les capacités multiplateform et coroutines.

? Installation

1. Installez le client Openai API Kotlin en ajoutant la dépendance suivante à votre fichier build.gradle :

repositories {
    mavenCentral()
}

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

2. Choisissez et ajoutez à vos dépendances l'un des moteurs de Ktor.

Nager

Alternativement, vous pouvez utiliser Openai-Client-bom en ajoutant la dépendance suivante à votre fichier 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 '
}

Multiplatifier

Dans les projets multiplateformes, ajoutez la dépendance du client OpenAI à commonMain et choisissez un moteur pour chaque cible.

Maven

Gradle est requis pour le support multiplateforme, mais rien ne vous empêche d'utiliser le client JVM dans un projet Maven. Vous devez toujours ajouter à vos dépendances l'un des moteurs de Ktor.

Configurer le client avec 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 >

La nomenclature n'est pas soutenue pour les projets Maven.

⚡️ En démarrage

Note

OpenAI encourage l'utilisation des variables d'environnement pour la clé API. En savoir plus.

Créer une instance de client OpenAI :

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

Ou vous pouvez créer une instance d' OpenAI à l'aide d'un OpenAIConfig préconfiguré:

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

val openAI = OpenAI (config)

Utilisez votre instance OpenAI pour faire des demandes d'API. Apprendre encore plus.

Fonctionnalités prises en charge

• Modèles
• Chat
• Images
• Incorporer
• Fichiers
• Réglage fin
• Modérations
• Audio

Bêta

• Assistants
• Threads
• Messages
• Courses

Déprécié

• Achèvement
• Tas fins
• Modification

Vous cherchez un jetons? Essayez Ktoken, une bibliothèque Kotlin pour le texte tokenisant.

Guides

Commencez et comprenez-vous davantage sur la façon d'utiliser le client API OpenAI pour Kotlin avec ces guides:

• Commencer
• Chat et fonction
• Guide de Filesource
• Assistants

Exemples d'applications

Les exemples d'applications sont disponibles sous sample , veuillez vérifier les instructions en cours d'exécution de la lecture.

Proguard / R8

Les règles spécifiques sont déjà regroupées dans le pot qui peuvent être interprétées automatiquement par R8.

? Instantanés

Apprenez à importer la version instantanée

Pour importer des versions instantanées dans votre projet, ajoutez l'extrait de code suivant à votre fichier gradle:

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

Dépannage

Pour les problèmes communs et leurs solutions, consultez le guide de dépannage.

️ Support

Apprécier le projet? Voici comment vous pouvez aider:

1. Star : Donnez-lui une étoile en haut à droite. Cela signifie beaucoup!
2. Contribuer : Vous avez trouvé un problème ou avez une idée de fonctionnalité? Soumettre un pr.
3. Commentaires : avez-vous des suggestions? Ouvrez un problème ou commencez une discussion.

? Licence

Le client de l'API Openai Kotlin est un logiciel open d'open licencié sous la licence MIT. Il s'agit d'une bibliothèque non officielle, elle n'est pas affiliée à ni approuvé par Openai . Les contributions sont les bienvenues.