openai_ex

readme

OpenaiEx 、コミュニティに維持されたOpenAI APIクライアントを提供するElixirライブラリです。

このプロジェクトの一部は、ChatGPT 3.5および4の支援と、Claude 3 OpusおよびClaude 3.5 Sonnetの支援を受けて開発されました。ただし、コードのすべての行は人間がキュレーションされています（私によって？）。

すべてのAPIエンドポイントと機能（2024年5月1日現在）がサポートされています。これには、実行ランストリーミング、Dall-E-3、テキストツースピーチ、チャット完了時のツールサポート、およびチャット完了エンドポイントのストリーミングバージョンなど、すべてのAPIベータ2がサポートされています。ストリーミングリクエストのキャンセルもサポートされています。

FinchプールとAPIベースURLの構成がサポートされています。

他のElixir Openaiラッパーと比較して、いくつかの違いがあります。

• 公式のPython APIの命名/構造を忠実に反映しようとしました。たとえば、すでにメモリにあるコンテンツは、リクエストの一部としてアップロードできます。ローカルパスのファイルから読み取る必要はありません。
• 私はライブブックのユースケースのために開発していたので、構成はなく、環境変数のみがあります。
• 要求キャンセルを伴うストリーミングAPIバージョンがサポートされています。
• 基礎となる輸送は、httpoisonではなくフィンチです
• Azure Openai APIと同様に、Openaiプロキシを備えたサードパーティ（ローカルを含む）LLMは、正当なユースケースと見なされます。

ディスカッションと発表は、Elixirフォーラムのこのスレッドにあります

インストールと使用

インストールの手順と詳細な使用例については、HexDocsのユーザーガイドをご覧ください。このガイドはライブブックであり、新しいプロジェクトを作成せずにすべてのコードを実行できます。実際には、すべてのAPIコールには、ユーザーガイドに実行されている例があります。

ライブブックの例もあります

• Streaming OrderBotチャットボットでChatCompletionストリーミングを使用する方法の例。これは、このリストの次のライブブックのストリーミングバージョンです。
• deeplearning.ai Orderbot。このノートブックは、Deeplearning.AIのコースチャットの迅速なエンジニアリングのレッスン8のPythonノートブックのElixir / Kino翻訳です。
• ライブブックアプリとして展開できる完了チャットボット。展開されたアプリには2つのフォームが表示されます。1つは通常の完成用で、もう1つはストリーミング完了です。
• 画像生成UI

これらはHexdocsでホストされており、独自のプロジェクトのインスピレーション /スターターとして使用できます。

発達

次のセクションは、このリポジトリに貢献したい開発者向けです。

このライブラリは、VSコードDevContainer内で実行されるLiveBook Docker画像を使用して開発されました。 .devcontainerフォルダーには、関連するすべてのファイルが含まれています。

開始するには、リポジトリをローカルマシンにクローンし、VSコードで開きます。プロンプトに従ってコンテナで開く。

コンテナがVSコードで稼働している後、http：// localhost：8080でLivebookにアクセスできます。ただし、環境変数LIVEBOOK_PASSWORDに保存されているパスワードを入力する必要があります。この変数は、以下で説明する.devcontainer/.envファイルで定義する必要があります。

環境変数と秘密

DevContainer開発の環境変数を設定するには、 .devcontainerフォルダーに.envファイルを作成できます。 OPENAI_API_KEYやLIVEBOOK_PASSWORDなどの秘密は、このファイルで環境変数として定義できます。この.envファイルはバージョンコントロールに含めるべきではなく、このために.gitignoreファイルに既に含まれていることに注意してください。

同じフォルダーにサンプルenvファイルを見つけることができます。これは、独自の.envファイルのテンプレートとして使用できます。これらの変数はdocker-compose.ymlを介してライブブックに渡されます。