Skip to content

Brain

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

NameTypeRequiredDescription
depthintegerHops to expand (engine clamps to 3)
limitintegerMax neighbors
scopestringRead scope; 'both' (default) unions shared + your private
entity_refstringEntity id or name to expand around
entity_typestringOnly include neighbors of this entity type
relation_typestringOnly traverse this relation type

Response

FieldTypeAlwaysDescription
rootobject
entitiesarray
relationsarray
elapsed_msnumber
request_idstring

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.

navigateselect