Skip to main content

Module types

Module types 

Source

Structs§

AgentStats
Agent memory statistics
AgentSummary
Lightweight agent summary for batch listing (uses count() not get_all)
AggregateFunctionInput
Wrapper for parsing aggregate function from JSON array
AggregationGroup
Single group in aggregation results
AggregationRequest
Request for aggregation query (Turbopuffer-inspired)
AggregationResponse
Response for aggregation query
BatchQueryItem
A single query within a batch request
BatchQueryRequest
Batch query request - execute multiple queries in parallel
BatchQueryResponse
Batch query response
BatchQueryResult
Results for a single query within a batch
BatchTextQueryRequest
Batch text query request
BatchTextQueryResponse
Response from batch text query
ColumnUpsertRequest
Column-based upsert request (Turbopuffer-inspired) All arrays must have equal length. Use null for missing values.
ConsolidateRequest
Request to consolidate related memories
ConsolidateResponse
Response from consolidation
DecayConfig
Configuration for importance decay
DeduplicateRequest
Request to deduplicate memories
DeduplicateResponse
Response from deduplication
DefaultQuotaResponse
Response for default quota query
DeleteDocumentsRequest
Request to delete documents from full-text index
DeleteDocumentsResponse
Response from deleting documents
DeleteRequest
Delete request
DeleteResponse
Delete response
DuplicateGroup
A group of duplicate memories
ExportRequest
Request to export vectors from a namespace with pagination
ExportResponse
Response from export operation
ExportedVector
A single exported vector record
FeedbackRequest
Request to provide feedback on a recalled memory (active learning)
FeedbackResponse
Response from feedback
ForgetRequest
Request to forget (delete) memories
ForgetResponse
Response from forget
FullGraphEdge
An edge in the full knowledge graph
FullGraphNode
A node in the full knowledge graph
FullKnowledgeGraphRequest
Request for full knowledge graph (all memories, pairwise similarity)
FullKnowledgeGraphResponse
Response from full knowledge graph query
FullTextIndexStats
Full-text index statistics
FullTextSearchRequest
Request to search for documents
FullTextSearchResponse
Full-text search response
FullTextSearchResult
Single full-text search result
GraphCluster
A cluster of related memories
GraphStats
Statistics about the full knowledge graph
HybridSearchRequest
Hybrid search request combining vector similarity and full-text search
HybridSearchResponse
Hybrid search response
HybridSearchResult
Single hybrid search result
IndexDocumentRequest
Request to index a document for full-text search
IndexDocumentsRequest
Request to index multiple documents
IndexDocumentsResponse
Response from indexing operation
KnowledgeGraphEdge
Knowledge graph edge
KnowledgeGraphNode
Knowledge graph node
KnowledgeGraphRequest
Request for knowledge graph traversal
KnowledgeGraphResponse
Response from knowledge graph query
ListSessionsResponse
Response listing sessions
Memory
A memory stored by an AI agent
MultiVectorSearchRequest
Request for multi-vector search with positive and negative vectors
MultiVectorSearchResponse
Response from multi-vector search
MultiVectorSearchResult
Single result from multi-vector search
PaginationCursor
Internal cursor state for pagination
QueryRequest
Query request for vector search
QueryResponse
Query response
QuotaCheckRequest
Request to check if an operation would exceed quota
QuotaCheckResult
Quota check result
QuotaConfig
Quota configuration for a namespace
QuotaListResponse
Response listing all namespace quotas
QuotaStatus
Combined quota status showing config and current usage
QuotaUsage
Current quota usage for a namespace
RankByInput
Input format for rank_by that handles JSON array syntax Examples:
RecallRequest
Request to recall memories by semantic query
RecallResponse
Response from recall
RecallResult
Single recall result
SearchMemoriesRequest
Request for advanced memory search
SearchMemoriesResponse
Response from memory search
SearchResult
Single search result
Session
An agent session
SessionEndRequest
Request to end a session
SessionEndResponse
Response from ending a session
SessionMemoriesResponse
Response for session memories
SessionStartRequest
Request to start a session
SessionStartResponse
Response from starting a session
SetDefaultQuotaRequest
Request to set default quota configuration
SetQuotaRequest
Request to set quota for a namespace
SetQuotaResponse
Response from setting quota
StalenessConfig
Configuration for bounded staleness reads
StoreMemoryRequest
Request to store a memory
StoreMemoryResponse
Response from storing a memory
SummarizeRequest
Request to summarize memories
SummarizeResponse
Response from summarization
TextDocument
A text document with metadata for text-based upsert
TextQueryRequest
Request for text-based query (auto-embedded)
TextQueryResponse
Response from text-based query
TextSearchResult
Single result from text search
TextUpsertRequest
Request to upsert text documents (auto-embedded)
TextUpsertResponse
Response from text upsert operation
UnifiedQueryRequest
Unified query request with rank_by parameter (Turbopuffer-inspired)
UnifiedQueryResponse
Unified query response with $dist scoring
UnifiedSearchResult
Single result from unified query
UpdateImportanceRequest
Request to update importance of a memory
UpdateMemoryRequest
Request to update a memory
UpsertRequest
Request to upsert vectors
UpsertResponse
Response from upsert operation
Vector
A vector with associated metadata

Enums§

AggregateFunction
Aggregate function for computing values across documents
DecayStrategy
Strategy for importance decay
DistanceMetric
Distance metric for vector comparison
EmbeddingModelType
Available embedding models
FeedbackSignal
Feedback signal for active learning
FilterCondition
Comparison operators for filter conditions
FilterExpression
A filter expression that can be a single field condition or a logical combinator
FilterValue
A filter value that can be compared against metadata fields
MemorySortField
Fields to sort memories by
MemoryType
Type of memory stored by an agent
QuotaEnforcement
Quota enforcement mode
RankBy
Ranking function for unified query API Supports vector search (ANN/kNN), full-text BM25, and attribute ordering
ReadConsistency
Read consistency level for queries (Turbopuffer-inspired)
SortDirection
Sort direction for attribute ordering
VectorSearchMethod
Vector search method

Type Aliases§

NamespaceId
Namespace identifier
VectorId
Unique identifier for a vector