Skip to content

brain_knowledge_neighborhood

Expand the neighborhood (related entities + relations) around one knowledge entity

Tool

brain_knowledge_neighborhood

Expand the neighborhood (related entities + relations) around one knowledge entity

Expand the neighborhood (related entities + relations) around one knowledge entity

Behavior

HTTP
GET /brain/knowledge/entities/:entity_ref/neighborhood

Arguments

Name
Type
Required
Description
depth
integer
—
Hops to expand (engine clamps to 3)
limit
integer
—
Max neighbors
scope
string
—
Read scope; 'both' (default) unions shared + your private
entity_ref
string
•
Entity id or name to expand around
entity_type
string
—
Only include neighbors of this entity type
relation_type
string
—
Only traverse this relation type

Response

Field
Type
Always
Description
root
object
•
The entity that was expanded around; null when `entity_ref` matched nothing
entities
array
•
The neighbours reached within `depth` hops of the root, the root excluded
relations
array
•
The relations that connect the root and the neighbours above
elapsed_ms
number
•
How long the engine took to answer, milliseconds
request_id
string
•
Engine request id for this call — quote it when reporting a problem

Try it

Expand the neighborhood (related entities + relations) around one knowledge entity.

When to use

Expand the neighborhood (related entities + relations) around one knowledge entity

Example

Ask your agent something like this:

Expand the neighborhood (related entities + relations) around one knowledge entity.

The agent will invoke brain_knowledge_neighborhood with these arguments:

{
  "entity_ref": "<entity_ref>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select