recall
保存したファクトを検索します。RESTの POST /v1/recall とMCPの recall ツールで利用できます。
POST/v1/recall
query、predicate、related_to のうち、少なくとも1つを指定してください。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
query | string | いいえ | エンティティ(type:id)または自然言語のトピック。最大2,000文字。 |
predicate | string | いいえ | 1種類の関係に絞り込みます。 |
predicates | string[] | いいえ | 指定した関係のいずれかに絞り込みます。最大20種類。 |
entity_type | string | いいえ | エンティティの種類(例:user)で絞り込みます。 |
related_to | string | いいえ | 指定したエンティティにつながるファクトを探します。 |
depth | integer | いいえ | 隣接ノードへの展開深度。省略時は2。 |
fuzzy_match | boolean | いいえ | 似た名前のエンティティにも一致させます。 |
limit | integer | いいえ | 返すファクトの最大件数。デフォルト20、最大200。 |
offset | integer | いいえ | 指定件数を飛ばします。各ページで同じsort_byとsort_orderを使ってください。 |
sort_by | string | いいえ | 一覧の並び順。created_at、predicate、subject、object、confidence、idから選びます。objectは関連エンティティ名、エンティティでない場合はリテラルのvalueです。省略すると従来の順序(意味検索では関連度順)を維持します。指定すると並び替えたページが返り、埋め込みによる順位付けや深度によるページ補完は行われません。 |
sort_order | string | いいえ | ascまたはdesc。デフォルトはasc。同順位は同じ方向のidで判定します。 |
collection | string | いいえ | コレクションコード。省略するか "" を渡すとデフォルト領域を使います。 |
応答
{
"facts": [
{ "subject": "user:maya", "predicate": "has_skill", "object": "TypeScript" }
],
"count": 1
}
各ファクトには、リテラルの value、context、source、意味検索時のみの score、created_at が含まれる場合があります。
recall_connections
1つのエンティティから近くのノードをたどります。RESTの POST /v1/recall_connections とMCPの recall_connections ツールで利用できます。
POST/v1/recall_connections
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
entity | string | はい | 起点となるエンティティ(type:id)。 |
depth | integer | いいえ | たどる段数。デフォルト2。 |
limit | integer | いいえ | 接続の最大件数。デフォルト20、最大500。 |
offset | integer | いいえ | 指定件数の接続を飛ばします。 |
collection | string | いいえ | コレクションコード。省略するとデフォルト領域を使います。 |
{
"entity": "user:maya",
"depth": 2
}