open assistant apiダウンロード - open assistant apiソースコードダウンロード

open assistant api

その他のソースコード

1.0.0

ダウンロード

オープンアシスタントAPI

すぐに使用できるAIインテリジェントアシスタントAPI

英語| 简体中文| 日本語

導入

Open Assistant APIは、オープンソースの自己ホストのAIインテリジェントアシスタントAPIであり、公式のOpenAIインターフェイスと互換性があります。公式のOpenAIクライアントと直接使用して、LLMアプリケーションを構築できます。

より多くの商用モデルおよびプライベートモデルと統合するための1つのAPIをサポートします。

R2Rラグエンジンをサポートします。

使用法

以下は、公式のOpenai Python openaiライブラリを使用する例です。

 import openai

client = openai . OpenAI (
    base_url = "http://127.0.0.1:8086/api/v1" ,
    api_key = "xxx"
)

assistant = client . beta . assistants . create (
    name = "demo" ,
    instructions = "You are a helpful assistant." ,
    model = "gpt-4-1106-preview"
)

オープンアシスタントAPIを選択する理由

特徴	オープンアシスタントAPI	OpenaiアシスタントAPI
生態系戦略	オープンソース	クローズドソース
ラグエンジン	サポートR2R	サポート
インターネット検索	サポート	サポートされていません
カスタム関数	サポート	サポート
ビルトインツール	拡張可能	拡張できません
コードインタープリター	開発中	サポート
マルチモーダル	サポート	サポート
LLMサポート	より多くのLLMをサポートします	GPTのみ
メッセージストリーミング出力	サポート	サポート
ローカル展開	サポート	サポートされていません

LLMサポート：公式バージョンと比較して、1つのAPIと統合することで、より多くのモデルをサポートできます。
ツール：現在、オンライン検索をサポートしています。より多くのツールを簡単に拡張できます。
RAGエンジン：現在サポートされているファイルタイプは、TXT、HTML、MarkDown、PDF、DOCX、PPTX、XLSX、PNG、MP3、MP4などです。予備実装を提供します。
メッセージストリーミング出力：スムーズなユーザーエクスペリエンスのためのメッセージストリーミング出力をサポートします。
エコシステム戦略：オープンソース、サービスをローカルに展開し、既存の機能を拡張できます。

クイックスタート

オープンアシスタントAPIを開始する最も簡単な方法は、docker-compose.ymlファイルを実行することです。実行する前に、DockerとDocker Composeがマシンにインストールされていることを確認してください。

構成

Project Root Directoryに移動し、 docker-compose.ymlを開き、Openai API_KEYとBing Searchキー（オプション）に入力します。

 # openai api_key (supports OneAPI api_key)
OPENAI_API_KEY= < openai_api_key >

# bing search key (optional)
BING_SUBSCRIPTION_KEY= < bing_subscription_key >

R2R RAGエンジンを構成して、デフォルトのRAG実装を置き換えて、より良いRAG機能を提供することをお勧めします。 R2R Githubリポジトリを介してR2Rについて学び、使用できます。

 # RAG config
# FILE_SERVICE_MODULE=app.services.file.impl.oss_file.OSSFileService
FILE_SERVICE_MODULE=app.services.file.impl.r2r_file.R2RFileService
R2R_BASE_URL=http:// < r2r_api_address >
R2R_USERNAME= < r2r_username >
R2R_PASSWORD= < r2r_password >

走る

Docker Composeで実行します：

docker compose up -d

APIにアクセスします

APIベースURL：http：//127.0.0.1:8086/api/v1

インターフェイスドキュメントアドレス：http：//127.0.0.1:8086/docs

完全な使用例

この例では、公式のOpenaiクライアントライブラリを使用してAIアシスタントが作成および実行されます。ストリーミング出力、ツール（web_search、取得、関数）などの他の使用方法を調査する必要がある場合は、Examplesディレクトリの下に対応するコードを見つけることができます。実行する前に、Python openaiライブラリをインストールするためにpip install openai実行する必要があります。

 # !pip install openai
export PYTHONPATH= $( pwd )
python examples/run_assistant.py

権限

SaaSの展開要件を満たすために、トークンに基づいて単純なユーザー分離が提供されます。 APP_AUTH_ENABLEを構成することで有効にできます。

認証方法はBearer Tokenです。認証のヘッダーにAuthorization: Bearer ***を含めることができます。
トークン管理は、APIドキュメントのトークンセクションで説明されています。関連するAPIは、 APP_AUTH_ADMIN_TOKENとして構成され、デフォルトで「admin」に設定されている管理トークンで認証する必要があります。
トークンを作成するときは、大きなモデルのベースURLとAPIキーを提供する必要があります。作成されたアシスタントは、対応する構成を使用して大きなモデルにアクセスします。

ツール

Openapi/Swagger仕様によると、さまざまなツールをアシスタントに統合し、外部世界とつながる能力を強化し、強化することができます。

アプリケーションを他のシステムまたはサービスと接続し、コードの実行や独自の情報源へのアクセスなど、外部環境との相互作用を可能にします。
使用中に、最初にツールを作成する必要があり、次にそれらをアシスタントと統合できます。詳細については、テストケースを参照してください。
認証情報を使用してツールを使用する必要がある場合は、実行時に認証情報を追加するだけです。特定のパラメーター形式は、APIドキュメントに記載されています。詳細については、テストケースを参照してください。 AUTHアクションで実行します