ベクトル類似度マッチング

クエリ内容やキーワードに基づいて、エージェント/ワークフローのナレッジベースから知識スライスを検索・抽出します。開発者は group_ids や data_ids を使用して検索範囲を指定でき、top_k パラメータを設定し、知識の関連性スコアリングと再ランク付けを通じて、カスタマイズされた検索強化生成（RAG）機能を実現できます。

リクエストメソッド

POST

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/vector/match

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/vector/match' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "embedding_rate": 0.9 , "prompt": "What APIs does GPTBots offer?", "group_ids": ["1234567890","1230987654"], "data_ids": ["1234567890","1230987654"], "top_k": 10 , "rerank_version": "Jina-reranker-v2-base-multilingual", "doc_correlation": 0.70 }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/vector/match' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json'  \
-d '{
        "embedding_rate": 0.9 ,
        "prompt": "What APIs does GPTBots offer?",
        "group_ids": ["1234567890","1230987654"],
        "data_ids":  ["1234567890","1230987654"],
        "top_k": 10 ,
        "rerank_version": "Jina-reranker-v2-base-multilingual",
        "doc_correlation": 0.70
}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${API Key}	認証には `Authorization: Bearer ${API Key}` を使用してください。トークンはAPIキーページから取得できます。
Content-Type	application/json	データの形式は `application/json` を設定してください。

リクエストボディ

フィールド	タイプ	必須	説明
embedding_rate	float	いいえ	キーワードベースと意味ベースの検索の重み付け比率を指定します。値の範囲：[0,1]、デフォルトは1。例：0 = キーワードのみ、1 = 意味のみ、0.4 = キーワード40%、意味60%。
prompt	string	はい	エージェント/ワークフロー内のドキュメントとベクトル類似度マッチングを行うためのキーワードまたはクエリ内容。
group_ids	array	いいえ	指定したナレッジベース内でベクトル検索を行うためのナレッジベースID。1つ以上のナレッジベースIDが提供された場合、それらの和集合内で検索が実行されます。nullまたは未指定の場合、すべてのナレッジベースがデフォルトとなります。空配列([])の場合、ナレッジベースは検索されません。
data_ids	array	いいえ	指定したナレッジドキュメント内でベクトル検索を行うためのドキュメントID。1つ以上のドキュメントIDが提供された場合、それらの和集合内で検索が実行されます。nullまたは未指定の場合、すべてのナレッジドキュメントがデフォルトとなります。空配列([])の場合、ナレッジドキュメントは検索されません。
top_k	int	はい	キーワードとドキュメントIDのベクトル類似度マッチング後、上位K件の結果を返します。有効範囲：[1,50]。
rerank_version	string	いいえ	より精密な検索のためのナレッジ再ランク付けモデルの名称。選択肢：BGE-Rerank、Jina-reranker-v2-base-multilingual、Jina-colbert-v2、BCE-Rerank。
doc_correlation	float	いいえ	ユーザーの質問とナレッジチャンクの類似度を表すナレッジ関連性スコア。スコアが高いほど関連性が高くなりますが、過度に高い値を設定すると利用可能なナレッジチャンクが見つからない場合があります。範囲：[0.1,0.95]。

group_idsとdata_idsの両方が提供された場合、それぞれのナレッジ範囲の和集合内で検索が実行されます。両方がnullまたは未指定の場合、デフォルトですべてのナレッジベースが検索されます。両方が空配列([])の場合、ナレッジは検索されません。

レスポンス

レスポンス例

{ "total": 2, "list": [ { "content": "Test data", "data_id": "aS1CNvPK4XCckDKQNj7azC9a", "document_name": "demo.md", "score": 0.75 }, { "content": "Test data", "data_id": "aS1CNvPK4XCckDKQNj7azC9a", "document_name": "demo.md", "score": 0.75 } ] }

                      
                      {
  "total": 2,
  "list": [
    {
      "content": "Test data",
      "data_id": "aS1CNvPK4XCckDKQNj7azC9a",
      "document_name": "demo.md",
      "score": 0.75

    },
    {
      "content": "Test data",
      "data_id": "aS1CNvPK4XCckDKQNj7azC9a",
      "document_name": "demo.md",
      "score": 0.75 
    }
  ]
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
total	int	返された知識チャンクの総数です。
list	JSON Array	知識チャンクのリストです。
content	string	チャンクの内容です。
data_id	string	ソースドキュメントのIDです。
score	float	類似度スコアです。

エラー時のレスポンス

フィールド	タイプ	説明
code	Int	エラーコードです。
message	String	エラー詳細内容です。

エラーコード

コード	メッセージ
40000	不正なパラメータです
40127	開発者認証に失敗しました
20059	エージェントが削除されました
40332	クエリで指定できるドキュメントは最大10件までです