api

package

Go to main page

Versions in this module

v1

v1.12.0

Nov 7, 2026

v1.11.1

Nov 7, 2026

v1.11.0

Nov 6, 2026

v1.10.0

Oct 22, 2026

Changes in this version

type Server

+ func (s *Server) SetHost(host string)

v1.9.0

Oct 21, 2026

Changes in this version

+ type BatchNodeUpsertResponse struct

+ Created int

+ Errors []BatchItemError

+ Failed int

+ Matched int

+ Nodes []*NodeUpsertResponse

+ Time string

+ type NodeUpsertNotDurableResponse struct

+ Created bool

+ type NodeUpsertResponse struct

+ Created bool

+ type UniqueConflictResponse struct

+ ConflictingNodeID uint64

+ type UpsertAmbiguousResponse struct

+ ConflictingNodeIDs []uint64

+ type UpsertLabelsDifferResponse struct

+ ConflictingNodeID uint64

+ MissingLabels []string

v1.8.0

Oct 21, 2026

v1.7.0

Oct 8, 2026

Changes in this version

+ const CypherDeprecationHeader

v1.6.0

Oct 8, 2026

v1.5.0

Oct 7, 2026

Changes in this version

+ type EdgeNotDurableResponse struct

+ type NodeNotDurableResponse struct

+ type WriteNotDurableResponse struct

+ ID uint64

v1.4.0

Sep 8, 2026

Changes in this version

+ const IncompleteEnumerationHeader

+ const TraversalTruncatedHeader

type BatchEdgeResponse

+ Errors []BatchItemError

+ Failed int

+ type BatchItemError struct

+ Error string

+ Index int

type BatchNodeResponse

+ Errors []BatchItemError

+ Failed int

+ type UniquenessRulesListResponse struct

+ Rules []storage.UniquenessRule

v1.0.0

Jun 23, 2026

v0

v0.8.0

Jun 22, 2026

Changes in this version

+ var BuildVersion = "unknown"

type Server

+ func (s *Server) Shutdown(ctx context.Context) error

v0.6.0

Jun 17, 2026

v0.5.0

Jun 16, 2026

Changes in this version

+ var MaxTraversalNodes = 10000

type TraversalResponse

+ Truncated bool

v0.4.1

Jun 4, 2026

Changes in this version

+ const CursorHeader

+ const DefaultAlgorithmTimeout

+ const DefaultDampingFactor

+ const DefaultPageLimit

+ const DefaultPageRankIterations

+ const DefaultTraversalDepth

+ const HeaderHybridDegraded

+ const HeaderRetrieveDegraded

+ const MaxAlgorithmTimeout

+ const MaxCycleLength

+ const MaxDampingFactor

+ const MaxPageLimit

+ const MaxPageRankIterations

+ const MaxTraversalDepth

+ const MinCycleLength

+ const MinDampingFactor

+ const MinPageRankIterations

+ const MinTraversalDepth

+ const TenantIDHeader

+ var DefaultCORSConfig = middleware.DefaultCORSConfig

+ var DefaultRateLimitConfig = middleware.DefaultRateLimitConfig

+ var GetClientIP = middleware.GetClientIP

+ var GetRequestID = middleware.GetRequestID

+ var IsTrustedProxy = middleware.IsTrustedProxy

+ var NewRateLimiter = middleware.NewRateLimiter

+ type APIKeyResponse struct

+ Created time.Time

+ Expires *time.Time

+ ID string

+ LastUsed *time.Time

+ Name string

+ Permissions []string

+ Prefix string

+ Revoked bool

+ type AlgorithmRequest struct

+ Algorithm string

+ Parameters map[string]any

+ type AlgorithmResponse struct

+ Algorithm string

+ Results map[string]any

+ Time string

+ type BatchEdgeRequest struct

+ Edges []EdgeRequest

+ type BatchEdgeResponse struct

+ Created int

+ Edges []*EdgeResponse

+ Time string

+ type BatchNodeRequest struct

+ Nodes []NodeRequest

+ type BatchNodeResponse struct

+ Created int

+ Nodes []*NodeResponse

+ Time string

+ type CORSConfig = middleware.CORSConfig

+ type CreateAPIKeyRequest struct

+ Environment string

+ ExpiresIn int64

+ Name string

+ Permissions []string

+ type CreateAPIKeyResponse struct

+ Created time.Time

+ Expires *time.Time

+ ID string

+ Key string

+ Name string

+ Prefix string

+ type EdgeRequest struct

+ FromNodeID uint64

+ Properties map[string]any

+ ToNodeID uint64

+ Type string

+ Weight float64

+ type EdgeResponse struct

+ FromNodeID uint64

+ ID uint64

+ Properties map[string]any

+ ToNodeID uint64

+ Type string

+ Weight float64

+ type EdgeUpdateRequest struct

+ Properties map[string]any

+ Weight *float64

+ type EmbeddingData struct

+ Embedding []float32

+ Index int

+ Object string

+ type EmbeddingsRequest struct

+ Dimensions int

+ EncodingFormat string

+ Input embeddingsInput

+ Model string

+ User string

+ type EmbeddingsResponse struct

+ Data []EmbeddingData

+ Model string

+ Object string

+ Usage EmbeddingsUsage

+ type EmbeddingsUsage struct

+ PromptTokens int

+ TotalTokens int

+ type ErrorResponse struct

+ Code int

+ Error string

+ Message string

+ type HealthResponse struct

+ Checks map[string]any

+ Edition string

+ Features []string

+ Status string

+ Timestamp time.Time

+ Uptime string

+ Version string

+ type HybridSearchRequest struct

+ Alpha *float64

+ IncludeContent bool

+ IncludeNodes bool

+ Labels []string

+ Limit int

+ Offset int

+ Query string

+ type HybridSearchResponse struct

+ Count int

+ Degraded string

+ Results []HybridSearchResultItem

+ TookMs int64

+ type HybridSearchResultItem struct

+ FTSRank int

+ LSARank int

+ Node *NodeResponse

+ NodeID uint64

+ Score float64

+ Snippet string

+ type LSAIndexRequest struct

+ BodyProperties []string

+ Dims int

+ Labels []string

+ MaxVocab int

+ MinDocFreq int

+ Seed int64

+ TitleBoost int

+ TitleProperty string

+ type LSAIndexResponse struct

+ Dimensions int

+ IndexedDocs int

+ TookMs int64

+ type MetricsResponse struct

+ AvgQueryTime float64

+ EdgeCount uint64

+ MemoryTotalMB uint64

+ MemoryUsedMB uint64

+ NodeCount uint64

+ NumCPU int

+ NumGoroutines int

+ TotalQueries uint64

+ Uptime string

+ UptimeSeconds int64

+ type NodeRequest struct

+ Labels []string

+ Properties map[string]any

+ type NodeResponse struct

+ ID uint64

+ Labels []string

+ Properties map[string]any

+ type QueryRequest struct

+ Parameters map[string]any

+ Query string

+ TimeoutSeconds *int

+ type QueryResponse struct

+ Columns []string

+ Count int

+ Rows []map[string]any

+ Time string

+ type RateLimitConfig = middleware.RateLimitConfig

+ type RateLimiter = middleware.RateLimiter

+ type RetrieveDocument struct

+ Metadata RetrieveDocumentMetadata

+ PageContent string

+ type RetrieveDocumentMetadata struct

+ Node *NodeResponse

+ NodeID uint64

+ Score float64

+ Source RetrieveSource

+ type RetrieveRequest struct

+ Alpha *float64

+ Beta *float64

+ IncludeNode bool

+ K int

+ Labels []string

+ MaxHops int

+ MaxTokens int

+ Query string

+ Tau *float64

+ type RetrieveResponse struct

+ Degraded string

+ Documents []RetrieveDocument

+ TookMs int64

+ type RetrieveSource struct

+ Label string

+ NodeID uint64

+ Path []uint64

+ type SearchIndexRequest struct

+ Labels []string

+ Properties []string

+ type SearchIndexResponse struct

+ IndexedNodes int

+ TookMs int64

+ type SearchRequest struct

+ IncludeContent bool

+ IncludeNodes bool

+ Labels []string

+ Limit int

+ Offset int

+ Query string

+ type SearchResponse struct

+ Count int

+ Results []SearchResultItem

+ TookMs int64

+ type SearchResultItem struct

+ Node *NodeResponse

+ NodeID uint64

+ Score float64

+ Snippet string

+ type Server struct

+ func NewServer(graph *storage.GraphStorage, port int) (*Server, error)

+ func NewServerWithDataDir(graph *storage.GraphStorage, port int, dataDir string) (*Server, error)

+ func (s *Server) GetDataDir() string

+ func (s *Server) InitCORSFromEnv()

+ func (s *Server) InitRateLimiterFromEnv()

+ func (s *Server) NewMethodRouter(w http.ResponseWriter, r *http.Request) *methodRouter

+ func (s *Server) NewPathExtractor(w http.ResponseWriter, r *http.Request) *pathIDExtractor

+ func (s *Server) NewRequestDecoder(w http.ResponseWriter, r *http.Request) *requestDecoder

+ func (s *Server) SaveAuthData() error

+ func (s *Server) SetCORSConfig(cfg *CORSConfig)

+ func (s *Server) SetEncryption(engine encryption.EncryptDecrypter, keyManager encryption.KeyProvider)

+ func (s *Server) SetTLSConfig(cfg *tlspkg.Config)

+ func (s *Server) Start() error

+ func (s *Server) StopMetrics()

+ type ShortestPathRequest struct

+ EndNodeID uint64

+ MaxDepth int

+ StartNodeID uint64

+ type ShortestPathResponse struct

+ Found bool

+ Length int

+ Path []uint64

+ Time string

+ type TenantCreateRequest struct

+ Description string

+ ID string

+ Metadata map[string]string

+ Name string

+ Quota *tenant.TenantQuota

+ type TenantListResponse struct

+ Count int

+ Tenants []TenantResponse

+ type TenantResponse struct

+ CreatedAt int64

+ Description string

+ ID string

+ Metadata map[string]string

+ Name string

+ Quota *tenant.TenantQuota

+ Status tenant.TenantStatus

+ UpdatedAt int64

+ type TenantUpdateRequest struct

+ Description string

+ Metadata map[string]string

+ Name string

+ Quota *tenant.TenantQuota

+ type TenantUsageResponse struct

+ EdgeCount int64

+ LastUpdated int64

+ NodeCount int64

+ QuotaUsage *tenant.QuotaUsage

+ StorageBytes int64

+ TenantID string

+ type TraversalRequest struct

+ Direction string

+ EdgeTypes []string

+ MaxDepth int

+ StartNodeID uint64

+ type TraversalResponse struct

+ Count int

+ Nodes []*NodeResponse

+ Time string

+ type UpdateApplyResponse struct

+ JobID string

+ Message string

+ TargetVersion string

+ type UpdateCheckResponse struct

+ CurrentVersion string

+ LatestRelease *updater.Release

+ LatestVersion string

+ UpdateAvailable bool

+ type UpdateJob struct

+ CompletedAt *time.Time

+ Error string

+ ID string

+ StartedAt time.Time

+ Status UpdateJobStatus

+ TargetVersion string

+ type UpdateJobStatus string

+ const UpdateJobFailed

+ const UpdateJobRunning

+ const UpdateJobSucceeded

+ type VectorIndexListResponse struct

+ Count int

+ Indexes []VectorIndexResponse

+ type VectorIndexRequest struct

+ Dimensions int

+ EfConstruction int

+ M int

+ Metric string

+ PropertyName string

+ type VectorIndexResponse struct

+ Dimensions int

+ Metric string

+ PropertyName string

+ type VectorSearchRequest struct

+ Ef int

+ FilterLabels []string

+ IncludeNodes bool

+ K int

+ PropertyFilter map[string]any

+ PropertyName string

+ QueryVector []float32

+ type VectorSearchResponse struct

+ Count int

+ Results []VectorSearchResult

+ TookMs int64

+ type VectorSearchResult struct

+ Distance float32

+ Node *NodeResponse

+ NodeID uint64

+ Score float32

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL