API 拡張

• moderation センシティブコンテンツ審査
• external_data_tool 外部データツール

​

API 仕様

POST {Your-API-Endpoint}

​

Header

​

Request Body

{
    "point":  string, //  拡張ポイント、異なるモジュールには複数の拡張ポイントが含まれる場合があります
    "params": {
        ...  // 各モジュール拡張ポイントに渡されるパラメータ
    }
}

​

API レスポンス

{
    ...  // API が返すコンテンツ、異なる拡張ポイントのレスポンスについては各モジュールの仕様設計を参照してください
}

​

検証

​

Header

Content-Type: application/json
Authorization: Bearer {api_key}

​

Request Body

{
    "point": "ping"
}

​

API 期待レスポンス

{
    "result": "pong"
}

​

サンプル

​

API サンプル

POST https://fake-domain.com/api/dify/receive

Content-Type: application/json
Authorization: Bearer 123456

{
    "point": "app.external_data_tool.query",
    "params": {
        "app_id": "61248ab4-1125-45be-ae32-0ce91334d021",
        "tool_variable": "weather_retrieve",
        "inputs": {
            "location": "London"
        },
        "query": "How's the weather today?"
    }
}

{
    "result": "City: London\nTemperature: 10°C\nRealFeel®: 8°C\nAir Quality: Poor\nWind Direction: ENE\nWind Speed: 8 km/h\nWind Gusts: 14 km/h\nPrecipitation: Light rain"
}

​

コードサンプル

1. 依存関係をインストール
   pip install fastapi[all] uvicorn
   
2. インターフェース仕様に従ってコードを記述
   from fastapi import FastAPI, Body, HTTPException, Header
   from pydantic import BaseModel
   
   app = FastAPI()
   
   
   class InputData(BaseModel):
       point: str
       params: dict = {}
   
   
   @app.post("/api/dify/receive")
   async def dify_receive(data: InputData = Body(...), authorization: str = Header(None)):
       """
       Receive API query data from Dify.
       """
       expected_api_key = "123456"  # TODO Your API key of this API
       auth_scheme, _, api_key = authorization.partition(' ')
   
       if auth_scheme.lower() != "bearer" or api_key != expected_api_key:
           raise HTTPException(status_code=401, detail="Unauthorized")
   
       point = data.point
   
       # for debug
       print(f"point: {point}")
   
       if point == "ping":
           return {
               "result": "pong"
           }
       if point == "app.external_data_tool.query":
           return handle_app_external_data_tool_query(params=data.params)
       # elif point == "{point name}":
           # TODO other point implementation here
   
       raise HTTPException(status_code=400, detail="Not implemented")
   
   
   def handle_app_external_data_tool_query(params: dict):
       app_id = params.get("app_id")
       tool_variable = params.get("tool_variable")
       inputs = params.get("inputs")
       query = params.get("query")
   
       # for debug
       print(f"app_id: {app_id}")
       print(f"tool_variable: {tool_variable}")
       print(f"inputs: {inputs}")
       print(f"query: {query}")
   
       # TODO your external data tool query implementation here, 
       #  return must be a dict with key "result", and the value is the query result
       if inputs.get("location") == "London":
           return {
               "result": "City: London\nTemperature: 10°C\nRealFeel®: 8°C\nAir Quality: Poor\nWind Direction: ENE\nWind "
                         "Speed: 8 km/h\nWind Gusts: 14 km/h\nPrecipitation: Light rain"
           }
       else:
           return {"result": "Unknown city"}
   
3. API サービスを起動します。デフォルトポートは 8000 で、完全な API アドレスは http://127.0.0.1:8000/api/dify/receive、設定された API Key は 123456 です。
   uvicorn main:app --reload --host 0.0.0.0
   
4. Dify でこの API を設定します。
5. App でこの API 拡張を選択します。

{
    "point": "app.external_data_tool.query",
    "params": {
        "app_id": "61248ab4-1125-45be-ae32-0ce91334d021",
        "tool_variable": "weather_retrieve",
        "inputs": {
            "location": "London"
        },
        "query": "How's the weather today?"
    }
}

{
    "result": "City: London\nTemperature: 10°C\nRealFeel®: 8°C\nAir Quality: Poor\nWind Direction: ENE\nWind Speed: 8 km/h\nWind Gusts: 14 km/h\nPrecipitation: Light rain"
}

​

ローカルデバッグ

1. https://ngrok.com の公式サイトにアクセスし、登録して Ngrok ファイルをダウンロードします。
2. ダウンロード完了後、ダウンロードディレクトリに移動し、以下の説明に従って圧縮ファイルを解凍し、説明の初期化スクリプトを実行します。
   unzip /path/to/ngrok.zip
   ./ngrok config add-authtoken あなたのToken
   
3. ローカル API サービスのポートを確認します: そして、以下のコマンドを実行して起動します:
   ./ngrok http ポート番号
   
   起動成功のサンプルは以下の通りです:
4. Forwarding の中から、上図のように https://177e-159-223-41-52.ngrok-free.app（これはサンプルドメインです、自分のものに置き換えてください）が公開ネットワークドメインです。

​

Cloudflare Workers を使用した API 拡張のデプロイ