APIリファレンス：検索

検索エンドポイントは、テナント内のコンテンツを対象に、セマンティック検索を含む横断検索を実行します。無料トライアルで、ご自身のワークスペースを使ってお試しいただけます。

テナント内のロール、プロセス、要素、文書化、バージョン、コメントを横断して検索

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

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：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 リクエスト数の上限に達しました。エンドポイントに記載されたレート制限をご確認ください