openai kotlin

Openai API Client untuk Kotlin

Klien Kotlin untuk API OpenAI dengan kemampuan multiplatform dan coroutine.

? Pengaturan

1. Instal OpenAI API Kotlin Client dengan menambahkan ketergantungan berikut ke file build.gradle Anda:

repositories {
    mavenCentral()
}

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

2. Pilih dan tambahkan ketergantungan Anda salah satu mesin Ktor.

Bom

Atau, Anda dapat menggunakan openai-client-bom dengan menambahkan ketergantungan berikut ke file build.gradle Anda

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

Multiplatform

Dalam proyek multiplatform, tambahkan ketergantungan klien OpenAI ke commonMain , dan pilih mesin untuk setiap target.

Maven

Gradle diperlukan untuk dukungan multiplatform, tetapi tidak ada yang menghentikan Anda menggunakan klien JVM dalam proyek Maven. Anda masih perlu menambah dependensi Anda salah satu mesin Ktor.

Siapkan Klien dengan 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 >

BOM tidak didukung untuk proyek Maven.

⚡️ Memulai

Catatan

Openai mendorong penggunaan variabel lingkungan untuk kunci API. Baca selengkapnya.

Buat contoh klien OpenAI :

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

Atau Anda dapat membuat instance OpenAI menggunakan OpenAIConfig yang telah dikonfigurasi:

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

val openAI = OpenAI (config)

Gunakan instance OpenAI Anda untuk membuat permintaan API. Pelajari lebih lanjut.

Fitur yang didukung

• Model
• Mengobrol
• Gambar
• Embeddings
• File
• Fine-tuning
• Moderasi
• Audio

Beta

• Asisten
• Utas
• Pesan
• Berjalan

Tercerahkan

• Penyelesaian
• Tune-tunes
• Sunting

Mencari tokenizer? Coba KToken, perpustakaan Kotlin untuk Tokenizing Text.

Pemandu

Mulailah dan pahami lebih lanjut tentang cara menggunakan klien API openai untuk Kotlin dengan panduan ini:

• Memulai
• Panggilan Obrolan & Fungsi
• Panduan FileSource
• Asisten

Contoh aplikasi

Contoh aplikasi tersedia di bawah sample , silakan periksa readme untuk menjalankan instruksi.

Proguard / R8

Aturan spesifik sudah dibundel ke dalam toples yang dapat ditafsirkan oleh R8 secara otomatis.

? Snapshots

Pelajari cara mengimpor versi snapshot

Untuk mengimpor versi snapshot ke proyek Anda, tambahkan cuplikan kode berikut ke file gradle Anda:

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

Pemecahan masalah

Untuk masalah umum dan solusi mereka, periksa panduan pemecahan masalah.

️ Dukungan

Menghargai proyeknya? Begini cara Anda dapat membantu:

1. Bintang : Beri bintang di kanan atas. Itu sangat berarti!
2. Kontribusi : Menemukan masalah atau memiliki ide fitur? Kirim PR.
3. Umpan Balik : Punya saran? Buka masalah atau mulai diskusi.

? Lisensi

Openai Kotlin API Client adalah perangkat lunak bersumber terbuka yang dilisensikan di bawah lisensi MIT. Ini adalah perpustakaan tidak resmi, tidak berafiliasi dengan atau didukung oleh Openai . Kontribusi dipersilakan.