api doc gpt

API ドキュメント GPT

これは、API ドキュメントの検索に役立つ AI ツールです。これは、OpenAI の GPT-3.5 言語モデルに基づいています。これは、FastApi アプリに直接接続するか、 openapi.jsonファイルを渡すことで使用できます。

設定

依存関係をインストールする

pip install -r requirements.txt

FastApiでの使い方

1. バックエンド アプリを実行する

uvicorn main:app --reload

2. スクリプトを実行する

python api_master.py --openai-key < your-openai-key > --target < your-fastapi-app > --base-url < your-base-url > 

openapi.jsonでの使用方法

python api_master.py --openai-key < your-openai-key > --openapi-json < openapi-json > --base-url < your-base-url > 

走行例

python api_master.py --openai-key= < your-openai-key > --openapi-json=./example/openapi.json --base-url= " https://petstore3.swagger.io/api/v3 "

API ドキュメントの操作を楽しむ

GPT-4を搭載

これは GPT-4 でも機能します。スクリプトの実行中にパラメーター--model-name=gpt-4を渡す必要があるだけです。

仕組み

これは、fastapi アプリからオープン API ドキュメントを作成し、GPT-3.5 言語モデルを使用して API のドキュメントを分析することで機能します。

シーケンス図
    ユーザー-->>+プロセッサ: アイテムのリストを教えてください。 5つだけ必要です
    プロセッサ-->>+AI: プロンプト: アイテムのリストを教えてください。 5つだけ必要です
    AI-->>+プロセッサ: CMD: GET /items?filter=5
    プロセッサ-->>+AI: CMD_RESP: [{"名前": "キュウリ"}、{"名前": "セロリ"}...]
    AI-->>+プロセッサ: OUT: アイテムはキュウリ、セロリ...
    プロセッサー-->>+ユーザー: アイテムはキュウリ、セロリです...

これは反応もサポートします。詳細については、https://arxiv.org/abs/2210.03629 をご覧ください。

制約

• トークンサイズ