openai kotlin

Kotlin的OpenAI API客戶端

Kotlin客戶端的OpenAI API具有乘數和Coroutines功能。

？設定

1. 通過將以下依賴關係添加到build.gradle文件：

repositories {
    mavenCentral()
}

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

2. 選擇並添加到您的依賴項中，這是KTOR的引擎之一。

bom

另外，您可以通過將以下依賴關係添加到build.gradle文件來使用OpenAi-Client-Bom

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

乘數

在多頁面項目中，將OpenAI客戶端依賴性添加到commonMain ，然後為每個目標選擇一個引擎。

小牛

Gradle是多平台支持所必需的，但是沒有什麼可以阻止您在Maven項目中使用JVM客戶端。您仍然需要添加依賴項之一，這是KTOR的引擎之一。

用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不支持Maven項目。

⚡️開始

筆記

OpenAI鼓勵對API鍵使用環境變量。閱讀更多。

創建一個OpenAI客戶端的實例：

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

或者，您可以使用預先配置的OpenAIConfig創建OpenAI實例：

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

val openAI = OpenAI (config)

使用您的OpenAI實例進行API請求。了解更多。

支持的功能

• 型號
• 聊天
• 圖像
• 嵌入
• 文件
• 微調
• 適中
• 聲音的

beta

• 助手
• 線程
• 消息
• 運行

棄用

• 完成
• 微調
• 編輯

尋找令牌？嘗試KTOKEN，Ktoken，kotlin庫，用於引導文本。

嚮導

開始並了解如何使用這些指南為Kotlin使用OpenAI API客戶端：

• 入門
• 聊天和功能電話
• FileSource指南
• 助手

示例應用程序

示例應用程序可在sample下找到，請檢查讀書我的運行說明。

proguard / r8

特定規則已經捆綁到可以由R8自動解釋的JAR中。

？快照

了解如何導入快照版本

要將快照版本導入項目中，請在Gradle文件中添加以下代碼段：

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

故障排除

有關常見問題及其解決方案，請檢查故障排除指南。

️支持

感謝這個項目？這是您可以提供幫助的方式：

1. 明星：在右上角給它一顆星星。這意味著很多！
2. 貢獻：找到問題或有特徵想法？提交公關。
3. 反饋：有建議嗎？打開問題或開始討論。

？執照

Openai Kotlin API客戶端是根據MIT許可證許可的開源軟件。這是一個非正式的圖書館，它與Openai不屬於或認可。歡迎捐款。