Expand description
The Brain HTTP contract — request/response types for super::BrainHttpClient.
Field names are the JSON wire names (snake_case, Rust’s default), identical
across the Rust, Python, and TypeScript SDKs. Optional request fields skip
when None.
Structs§
- Capabilities
capabilitiesresult.- Create
Entity Input create_entityinput.aliasesis omitted when empty.- Create
Entity Result create_entityresult.- Encode
Input encodeinput.- Encode
Result encoderesult.- Endpoint
- A plan/reason endpoint:
textormemory_id. - Entity
Detail - One entity, as the edge projects it.
- Forget
Input forgetinput.- Forget
Result forgetresult.- GetRelation
Query get_relationquery.follow_supersessiondefaults totrueon the edge: leave itNoneto follow the chain, or sendSome(false)for this exact row.- GetStatement
Query get_statementquery. Same defaulting asGetRelationQuery: absent means the edge’strue.- Graph
Edge - One edge of the typed graph.
- Graph
Fetch Query graph_fetchquery — one page of the space’s typed graph.- Graph
Node - One node of the typed graph.
- Graph
Page graph_fetchresult.next_cursoris absent on the last page.- Inference
Step - One inference step.
- Link
Input linkinput.- Link
Result linkresult.- List
Entities Query list_entitiesquery. Each field is a filter; omitting it applies none.- List
Entities Result list_entitiesresult.- List
Relations Query list_relationsquery — the relations incident to one entity.- List
Relations Result list_relationsresult.- List
Statements Query list_statementsquery.only_currentdefaults totrueon the edge — sendSome(false)to see superseded rows.- List
Statements Result list_statementsresult.- Memory
Hit - One recalled memory.
- Memory
Inspect memory_inspectresult.found == falseleaves the rest empty.- Memory
List Item - One memory in a
memory_listpage. - Memory
List Page memory_listresult.next_cursoris absent on the last page.- Memory
List Query memory_listquery — a page of the space’s memories.- Permissions
- Resolved permission flags.
- Plan
Input planinput.- Plan
Result planresult.- Plan
Step - One planned step.
- Reason
Input reasoninput.- Reason
Result reasonresult.- Recall
Input recallinput.- Recall
Result recallresult.- Relation
Detail - One relation, as the edge projects it.
- Resolve
Entity Input resolve_entityinput: a name to match against the typed graph.- Resolve
Entity Result resolve_entityresult.entity_idis set whenoutcomeresolved to one entity;candidate_idsis the ranked list when it was ambiguous.- Schema
get_schemaresult.- Schema
Error - One schema validation diagnostic, positioned in the document.
- Schema
GetQuery get_schemaquery. Absentnamespacemeans the caller’s own; absentversionmeans the active one.- Schema
Replace Input replace_schemainput.- Schema
Replace Result replace_schemaresult.dropped_countis how many declared rows the swap removed.- Schema
Upload Input upload_schemainput.- Schema
Upload Result upload_schemaresult. A non-emptyvalidation_errorsmeans nothing landed.- Schema
Validate Input validate_schemainput.- Schema
Validate Result validate_schemaresult.would_be_versionis what an upload would produce.- Stage
Artifact - Everything the encode pipeline produced for one memory.
- Stage
Graph - The knowledge graph an encode produced.
- Stage
Graph Edge - An edge in the knowledge graph an encode produced.
- Stage
Graph Node - A node in the knowledge graph an encode produced.
- Stage
Keyword Field - One text-index field and the analyzed terms the write produced for it.
- Stage
Record - The durable metadata row an encode wrote.
- Statement
Detail - One statement, as the edge projects it.
- Traversal
Path - One path the traversal found, as an ordered list of steps.
- Traversal
Step - One hop of a traversal.
- Traverse
Input traverse_relationsinput: a multi-hop walk from one entity.- Traverse
Result traverse_relationsresult.truncatedmeans a bound cut the walk short.- Unlink
Input unlinkinput.- Unlink
Result unlinkresult.- Whoami
whoamiresult.
Enums§
- Statement
Object - What a statement points at. Internally tagged by
kind, with snake_case tag values:{"kind": "entity", "id": "…"},{"kind": "value", "value": {…}}. - Statement
Value - A literal on the object side of a statement. Internally tagged by
type, with snake_case tag values:{"type": "text", "value": "…"}.