API Reference
Start typing to search…

ナレッジ検索(β版)

📘

本APIはベータ版です。

本APIはmiiboのプレミアムプランおよびエンタープライズプランのユーザー向けに先行提供しています。

本APIには下記のリクエスト制限があります。(今後制限や提供範囲が変更される可能性があります。)

  • 1000 req / day
  • 10000 req / month

基本情報

この API は、miibo の RAG（Retrieval-Augmented Generation）システム用のベクトルデータベースにアクセスするためのインターフェースを提供します。

ベースURL

https://api-mebo.dev/knowledge/search

認証

APIリクエストには、HTTPヘッダーに有効なAPIキーが必要です。
miiboのAPI設定画面でAPIキーを取得してください。(ナレッジデータストア用のAPIキーを利用します。)

X-API-Key: YOUR_API_KEY

エンドポイント

発話の検索

指定されたベクトルに最も類似したベクトルを検索します。

  • URL: /search

  • メソッド: POST

    • リクエストボディ:

      {
  "agent_id": "string",
  "utterance": "検索する発話",
  "metadata_filter": {
    "key1": "value1"
  }
}

      パラメータ:

      パラメータ名

      値

      required

      補足

      agent_id

      String

      ✅ 

      ナレッジデータストアが紐づくエージェントのID。

      utterance

      String

      ✅

      url

      String

      metadata_filter

      String配列

      CustomFieldと組み合わせてフィルタリングができます。

      limit

      Int

      取得する件数 (最大10000)

      use_lexical_search_only

      Boolean

      セマンティック検索ではなく、字句検索のみを行います。特定のキーワードにマッチするデータを取得したいときなどに有効です。(default: False)

      include_all_text

      Boolean

      レスポンス結果にチャンクだけでなく「全文」を含めるかどうか
      (default: False)

      search_query_model

      String

      ※今後、公開予定
      (default: gpt-4o)

      gpt-4o-mini指定可能です


  • レスポンス:

    [
    {
      "label": "string",
      "score": float,
      "text": "string",
      "url": "string",
      "all_text": "string"
    }
]
    • 成功時 (200 OK)
    • エラー時 (400 Bad Request) 
      {
  "error": "Invalid search parameters"
}

サンプル

下記が本APIの利用サンプルです。

curl -X POST "https://api-mebo.dev/knowledge/search" \
  -H "X-API-Key: <ナレッジデータストア用のAPI>" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "<ナレッジデータストアが紐づくエージェントのID>",
    "utterance": "<検索したい文字列>",
    "limit": 10
  }'

エラーハンドリング

全てのエンドポイントは、以下の共通エラーレスポンスを返す可能性があります：

  • 400 Bad Request: リクエストの内容に不備がある場合
  • 401 Unauthorized: APIキーが無効または不足している場合
  • 429 Too Many Requests: レート制限を超えた場合
  • 500 Internal Server Error: サーバー側のエラーが発生した場合