APIリファレンス：検索

検索エンドポイントでは、テナントのコンテンツ全体を対象にグローバル（セマンティック）検索を実行します。

テナントのロール、プロセス、要素、ドキュメント、バージョン、コメントを横断して検索

テナント単位でレート制限されます。429レスポンスには共通のメッセージ本文（{“message”: “検索リクエストが多すぎます。速度を落として再試行してください。”}）が含まれます。

エンドポイント： POST /v1/tenant/{tenantId}/search

認証： テナント単位のAPIキー · read スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid

リクエストボディ：

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}

フィールド	型	必須	説明
query	string	はい	検索クエリ 最大長：1000
mode	semantic | exact | hybrid	いいえ	semantic = 埋め込み、exact = リテラル、hybrid = 両方 指定可能な値：semantic、exact、hybrid デフォルト：hybrid
categories	role | process | element | documentation | version | comment[]	いいえ	結果をこれらのカテゴリーに限定
processId	string	いいえ	結果を1つのプロセスに限定 形式：uuid
k	integer	いいえ	返す結果数 デフォルト：20 最小値：1 最大値：50

レスポンス（200）：

検索結果（ヒット、件数、合計、候補）

{
	"hits": [
		{
			"category": "role",
			"entityType": "role",
			"entityId": "string",
			"subKey": "string",
			"title": "string",
			"snippet": "string",
			"score": 0,
			"processId": "00000000-0000-0000-0000-000000000000",
			"processDisplayName": "string",
			"elementType": "string",
			"docSection": "string",
			"url": "string"
		}
	],
	"counts": {},
	"total": 0,
	"suggestions": [
		"string"
	]
}

フィールド	型	必須	説明
hits	object[]	はい
counts	object	はい
total	number	はい
suggestions	string[]	はい

エラー：

• 401 APIキーがない、無効、無効化済み、または期限切れ
• 429 レート制限に達しました。エンドポイントに記載されたレート制限を確認してください