Skip to main content

Module types

Module types 

Source
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
capabilities result.
CreateEntityInput
create_entity input. aliases is omitted when empty.
CreateEntityResult
create_entity result.
EncodeInput
encode input.
EncodeResult
encode result.
Endpoint
A plan/reason endpoint: text or memory_id.
EntityDetail
One entity, as the edge projects it.
ForgetInput
forget input.
ForgetResult
forget result.
GetRelationQuery
get_relation query. follow_supersession defaults to true on the edge: leave it None to follow the chain, or send Some(false) for this exact row.
GetStatementQuery
get_statement query. Same defaulting as GetRelationQuery: absent means the edge’s true.
GraphEdge
One edge of the typed graph.
GraphFetchQuery
graph_fetch query — one page of the space’s typed graph.
GraphNode
One node of the typed graph.
GraphPage
graph_fetch result. next_cursor is absent on the last page.
InferenceStep
One inference step.
LinkInput
link input.
LinkResult
link result.
ListEntitiesQuery
list_entities query. Each field is a filter; omitting it applies none.
ListEntitiesResult
list_entities result.
ListRelationsQuery
list_relations query — the relations incident to one entity.
ListRelationsResult
list_relations result.
ListStatementsQuery
list_statements query. only_current defaults to true on the edge — send Some(false) to see superseded rows.
ListStatementsResult
list_statements result.
MemoryHit
One recalled memory.
MemoryInspect
memory_inspect result. found == false leaves the rest empty.
MemoryListItem
One memory in a memory_list page.
MemoryListPage
memory_list result. next_cursor is absent on the last page.
MemoryListQuery
memory_list query — a page of the space’s memories.
Permissions
Resolved permission flags.
PlanInput
plan input.
PlanResult
plan result.
PlanStep
One planned step.
ReasonInput
reason input.
ReasonResult
reason result.
RecallInput
recall input.
RecallResult
recall result.
RelationDetail
One relation, as the edge projects it.
ResolveEntityInput
resolve_entity input: a name to match against the typed graph.
ResolveEntityResult
resolve_entity result. entity_id is set when outcome resolved to one entity; candidate_ids is the ranked list when it was ambiguous.
Schema
get_schema result.
SchemaError
One schema validation diagnostic, positioned in the document.
SchemaGetQuery
get_schema query. Absent namespace means the caller’s own; absent version means the active one.
SchemaReplaceInput
replace_schema input.
SchemaReplaceResult
replace_schema result. dropped_count is how many declared rows the swap removed.
SchemaUploadInput
upload_schema input.
SchemaUploadResult
upload_schema result. A non-empty validation_errors means nothing landed.
SchemaValidateInput
validate_schema input.
SchemaValidateResult
validate_schema result. would_be_version is what an upload would produce.
StageArtifact
Everything the encode pipeline produced for one memory.
StageGraph
The knowledge graph an encode produced.
StageGraphEdge
An edge in the knowledge graph an encode produced.
StageGraphNode
A node in the knowledge graph an encode produced.
StageKeywordField
One text-index field and the analyzed terms the write produced for it.
StageRecord
The durable metadata row an encode wrote.
StatementDetail
One statement, as the edge projects it.
TraversalPath
One path the traversal found, as an ordered list of steps.
TraversalStep
One hop of a traversal.
TraverseInput
traverse_relations input: a multi-hop walk from one entity.
TraverseResult
traverse_relations result. truncated means a bound cut the walk short.
UnlinkInput
unlink input.
UnlinkResult
unlink result.
Whoami
whoami result.

Enums§

StatementObject
What a statement points at. Internally tagged by kind, with snake_case tag values: {"kind": "entity", "id": "…"}, {"kind": "value", "value": {…}}.
StatementValue
A literal on the object side of a statement. Internally tagged by type, with snake_case tag values: {"type": "text", "value": "…"}.