openai kotlin

OpenAI -API -Client für Kotlin

Kotlin -Kunde für die Openai -API mit Multiplattform- und Coroutines -Funktionen.

? Aufstellen

1. Installieren Sie den OpenAI -API Kotlin -Client, indem Sie die folgende Abhängigkeit zu Ihrer build.gradle -Datei hinzufügen: Gradle -Datei:

repositories {
    mavenCentral()
}

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

2. Wählen Sie Ihre Abhängigkeiten aus und fügen Sie eine der Motoren von KTOR hinzu.

Bom

Alternativ können Sie OpenAi-Client-Bom verwenden, indem Sie die folgende Abhängigkeit zu Ihrem build.gradle Datei hinzufügen

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 '
}

Multiplattform

Fügen Sie in Multiplatform -Projekten OpenAI -Client -Abhängigkeit zu commonMain hinzu und wählen Sie für jedes Ziel eine Engine.

Maven

Gradle ist für die Unterstützung von Multiplatform erforderlich, aber es hindert Sie nichts daran, den JVM -Client in einem Maven -Projekt zu verwenden. Sie müssen Ihre Abhängigkeiten noch zu einem der Motoren von Ktor hinzufügen.

Richten Sie den Kunden mit Maven ein

< 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 >

Die BOM wird nicht für Maven -Projekte unterstützt.

⚡️ Erste Schritte

Notiz

OpenAI fördert die Verwendung von Umgebungsvariablen für den API -Schlüssel. Mehr lesen.

Erstellen Sie eine Instanz des OpenAI -Kunden:

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

Oder Sie können eine Instanz von OpenAI mit einem vorkonfigurierten OpenAIConfig erstellen:

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

val openAI = OpenAI (config)

Verwenden Sie Ihre OpenAI -Instanz, um API -Anfragen zu stellen. Erfahren Sie mehr.

Unterstützte Funktionen

• Modelle
• Chat
• Bilder
• Einbettungen
• Dateien
• Feinabstimmung
• Moderationen
• Audio

Beta

• Assistenten
• Themen
• Nachrichten
• Läuft

Veraltet

• Fertigstellungen
• Feinhöhe
• Änderungen

Auf der Suche nach einem Tokenizer? Versuchen Sie es mit Ktoken, einer Kotlin -Bibliothek zum Tokenisierungstext.

Führer

Erstaunen Sie an und verstehen Sie mehr darüber, wie Sie mit den OpenAI -API -Client für Kotlin mit diesen Leitfäden verwendet werden:

• Erste Schritte
• Chat- und Funktionsaufruf
• Filesource -Handbuch
• Assistenten

Beispiel -Apps

Beispiel -Apps sind unter sample erhältlich. Bitte überprüfen Sie die Readme, um Anweisungen zu erhalten.

Proguard / R8

Die spezifischen Regeln sind bereits in das Glas gebündelt, das von R8 automatisch interpretiert werden kann.

? Schnappschüsse

Erfahren Sie, wie Sie Snapshot -Version importieren

Um Snapshot -Versionen in Ihr Projekt zu importieren, fügen Sie Ihrer Gradle -Datei den folgenden Code -Snippet hinzu:

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

Fehlerbehebung

Unter allgemeinen Themen und deren Lösungen finden Sie den Leitfaden zur Fehlerbehebung.

️ Unterstützung

Das Projekt schätzen? So können Sie helfen:

1. Star : Geben Sie ihm oben rechts einen Stern. Es bedeutet viel!
2. Beitrag : Ein Problem gefunden oder eine Feature -Idee haben? Ein PR einreichen.
3. Feedback : Haben Sie Vorschläge? Eröffnen Sie ein Problem oder beginnen Sie eine Diskussion.

? Lizenz

OpenAI Kotlin API-Client ist eine Open-Sourcing-Software, die unter der MIT-Lizenz lizenziert wurde. Dies ist eine inoffizielle Bibliothek, die weder von OpenAI verbunden noch unterstützt wird . Beiträge sind willkommen.