openai kotlin

KotlinのOpenai APIクライアント

MultiplatformおよびCoroutines機能を備えたOpenaiのAPI用のKotlinクライアント。

？設定

1. build.gradleファイルに次の依存関係を追加して、OpenAI API Kotlinクライアントをインストールします。

repositories {
    mavenCentral()
}

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

2. KTORのエンジンの1つを依存関係に選択して追加します。

ボム

または、次の依存関係を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 '
}

マルチプラットフォーム

マルチプラットフォームプロジェクトでは、 commonMainにOpenAIクライアントの依存関係を追加し、各ターゲットのエンジンを選択します。

メイベン

Gradleはマルチプラットフォームサポートに必要ですが、MavenプロジェクトでJVMクライアントを使用することを妨げるものはありません。依存関係にKTORのエンジンの1つを追加する必要があります。

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リクエストを行います。もっと詳しく知る。

サポートされている機能

• モデル
• チャット
• 画像
• 埋め込み
• ファイル
• 微調整
• モデレーション
• オーディオ

ベータ

• アシスタント
• スレッド
• メッセージ
• 実行

非推奨

• 完了
• 微調整
• 編集

トークンザーをお探しですか？テキストをトークン化するためのKotlinライブラリであるKtokenをお試しください。

ガイド

これらのガイドを使用して、KotlinにOpenai APIクライアントを使用する方法について、始めて、以下を理解してください。

• はじめる
• チャット＆ファンクションコール
• filesourceガイド
• アシスタント

サンプルアプリ

サンプルアプリはsampleの下で利用できます。実行中の指示については、readmeを確認してください。

Proguard / R8

特定のルールは、R8で自動的に解釈できる瓶にすでにバンドルされています。

？スナップショット

スナップショットバージョンをインポートする方法を学びます

スナップショットバージョンをプロジェクトにインポートするには、次のコードスニペットをGradleファイルに追加します。

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

トラブルシューティング

一般的な問題とそのソリューションについては、トラブルシューティングガイドを確認してください。

§サポート

プロジェクトに感謝​​しますか？これがあなたが助けることができる方法です：

1. 星：右上に星を挙げてください。それはたくさんのことを意味します！
2. 貢献：問題を見つけましたか、それとも機能のアイデアがありますか？ PRを提出します。
3. フィードバック：提案がありますか？問題を開くか、ディスカッションを開始します。

？ライセンス

Openai Kotlin APIクライアントは、MITライセンスに基づいてライセンスされているオープンソースのソフトウェアです。これは非公式のライブラリであり、Openaiと提携したり、承認されたりしていません。貢献は大歓迎です。