async openai

async-openai

OpenaiのAsync Rust Library

_{このリポジトリ自体によって作成されたロゴ}

概要

async-openai Openaiの非公式の錆ライブラリです。

• Openai Openapi仕様に基づいています
• 現在の機能：
  • アシスタント（V2）
  • オーディオ
  • バッチ
  • チャット
  • 完了（レガシー）
  • 埋め込み
  • ファイル
  • 微調整
  • 画像
  • モデル
  • モデレーション
  • 組織|管理
  • リアルタイムAPIタイプ（ベータ）
  • アップロード
• 利用可能なAPIでのSSEストリーミング
• フォームの送信を含むリクエスト（SSEストリーミングを除く）は、レートが制限されたときに指数バックオフで再試行されます。
• すべてのリクエストオブジェクトの人間工学的ビルダーパターン。
• Microsoft Azure Openaiサービス（Openai仕様に一致するAPIのみ）

使用法

ライブラリは、環境変数OPENAI_API_KEYからAPIキーを読み取ります。

 # On macOS/Linux
export OPENAI_API_KEY= ' sk-... ' 

 # On Windows Powershell
$ Env: OPENAI_API_KEY = ' sk-... '

• async-openai使用方法に関する例のディレクトリにアクセスしてください。
• docs.rs/async-openaiにアクセスしてください。

リアルタイムAPI

リアルタイムAPIのタイプのみが実装されており、機能フラグをrealtimeで有効にすることができます。これらのタイプは、Openaiが公式の仕様をリリースした場合に変更される場合があります。

画像生成の例

 use async_openai :: {
    types :: { CreateImageRequestArgs , ImageSize , ImageResponseFormat } ,
    Client ,
} ;
use std :: error :: Error ;

# [ tokio :: main ]
async fn main ( ) -> Result < ( ) , Box < dyn Error > > {
    // create client, reads OPENAI_API_KEY environment variable for API key.
    let client = Client :: new ( ) ;

    let request = CreateImageRequestArgs :: default ( )
        . prompt ( "cats on sofa and carpet in living room" )
        . n ( 2 )
        . response_format ( ImageResponseFormat :: Url )
        . size ( ImageSize :: S256x256 )
        . user ( "async-openai" )
        . build ( ) ? ;

    let response = client . images ( ) . create ( request ) . await ? ;

    // Download and save images to ./data directory.
    // Each url is downloaded and saved in dedicated Tokio task.
    // Directory is created if it doesn't exist.
    let paths = response . save ( "./data" ) . await ? ;

    paths
        . iter ( )
        . for_each ( |path| println ! ( "Image file path: {}" , path.display ( ) ) ) ;

    Ok ( ( ) )
}

_{実際のサイズ256x256のREADMEのスケールアップ}

貢献

プロジェクトに貢献し、改善するために時間を割いていただきありがとうございます。私はあなたを迎えてくれてうれしいです！

新機能のリクエスト、バグの修正、問題、ドキュメント、テスト、コメント、例などのあらゆる形式の貢献は大歓迎です。

良い出発点は、既存のオープンな問題を調べることです。

プロジェクトの品質を維持するには、コード貢献のためには、次の最低値が必須です。

• 名前とドキュメント：すべてのstruct名、フィールド名、およびドキュメントコメントは、Openapi仕様からのものです。名前のない仕様のネストされたオブジェクトは、適切な名前を作成する余地を残します。
• テスト：サポートテストおよび/または例をサポートする変更には必要です。既存の例、ドキュメントテスト、単体テスト、統合テストは、該当する場合は変更と連携するために行う必要があります。
• 範囲：APIリファレンスやOpenapi仕様などの公式ドキュメントで利用可能なAPIに制限されています。他のLLMSまたはAIプロバイダーは、OpenAI互換のAPIを提供しますが、必ずしも完全なパリティを持っているとは限りません。そのような場合、Openai仕様が優先されます。
• 一貫性：ライブラリが公開するすべての「API」にわたってコードスタイルの一貫性を保ちます。素晴らしい開発者エクスペリエンスを作成します。

このプロジェクトは、錆の行動規範に準拠しています

無料の木枠

• Openai-Func-Enumsは、OpenAI APIのツール呼び出し機能でこのライブラリを簡単に使用できるようにする手続き的マクロを提供します。また、コマンドラインツールの自然言語使用のために既存のCLAPアプリケーションサブコマンドに追加できるマクロの派生も提供します。また、OpenAIの並列ツール呼び出しをサポートし、複数のツール呼び出しを同時に実行するか、独自のOSスレッドを所有するかを選択できます。
• Async-Openai-wasmはWASMサポートを提供します。

ライセンス

このプロジェクトは、MITライセンスに基づいてライセンスされています。