Documentation
¶
Index ¶
- func Provider()
- type CreateNodeEndpoint
- type CreateRunEndpoint
- type CreateRunReq
- type CreateRunResp
- type EdgeProvenanceResp
- type EdgeResponse
- type GetEdgeEndpoint
- type GetEdgeProvenanceEndpoint
- type GetEdgeProvenanceReq
- type GetEdgeReq
- type GetEntityEndpoint
- type GetEntityReq
- type GetEntityResp
- type GetEntityTimelineEndpoint
- type GetEntityTimelineReq
- type GetEntityTimelineResp
- type GetNodeContentEndpoint
- type GetNodeEdgesEndpoint
- type GetNodeEdgesReq
- type GetNodeEdgesResp
- type GetNodeEndpoint
- type GetNodeProvenanceEndpoint
- type GetNodeProvenanceReq
- type GetNodeReq
- type GetQueueEndpoint
- type GetQueueReq
- type GetQueueResp
- type ListNodesEndpoint
- type ListNodesReq
- type ListNodesResp
- type ListRelationsEndpoint
- type ListRelationsReq
- type ListRelationsResp
- type NodeResponse
- type PaginationParams
- type ProvenanceSubgraph
- type RelationResponse
- type SearchEntitiesEndpoint
- type SearchEntitiesReq
- type SearchEntitiesResp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CreateNodeEndpoint ¶
type CreateNodeEndpoint struct{}
CreateNodeEndpoint creates a graph node. L0 sources use multipart form upload; L1/L2 use JSON. L0 root creation is idempotent via content_sha256.
func (CreateNodeEndpoint) Auth ¶
func (e CreateNodeEndpoint) Auth() bool
func (CreateNodeEndpoint) HandleRaw ¶
func (e CreateNodeEndpoint) HandleRaw(w http.ResponseWriter, r *http.Request) error
func (CreateNodeEndpoint) Method ¶
func (e CreateNodeEndpoint) Method() string
func (CreateNodeEndpoint) Path ¶
func (e CreateNodeEndpoint) Path() string
type CreateRunEndpoint ¶
type CreateRunEndpoint struct{}
CreateRunEndpoint registers a new worker run and returns a run_id.
func (CreateRunEndpoint) Auth ¶
func (e CreateRunEndpoint) Auth() bool
func (CreateRunEndpoint) Handle ¶
func (e CreateRunEndpoint) Handle(ctx context.Context, req CreateRunReq) (CreateRunResp, error)
func (CreateRunEndpoint) Method ¶
func (e CreateRunEndpoint) Method() string
func (CreateRunEndpoint) Path ¶
func (e CreateRunEndpoint) Path() string
type CreateRunReq ¶
type CreateRunReq struct {
WorkerConfigID string `json:"worker_config_id"`
}
type CreateRunResp ¶
type CreateRunResp struct {
RunID string `json:"run_id"`
}
type EdgeProvenanceResp ¶
type EdgeProvenanceResp struct {
Edge EdgeResponse `json:"edge"`
RunID string `json:"run_id,omitempty"`
WorkerConfigNode *NodeResponse `json:"worker_config_node,omitempty"`
}
type EdgeResponse ¶
type EdgeResponse struct {
ID string `json:"id"`
SourceNodeID string `json:"source_node_id"`
TargetNodeID string `json:"target_node_id"`
Type string `json:"type"`
Confidence *float64 `json:"confidence,omitempty"`
RunID *string `json:"run_id,omitempty"`
CreatedAt string `json:"created_at"`
}
EdgeResponse is the unified API representation of any edge.
type GetEdgeEndpoint ¶
type GetEdgeEndpoint struct{}
GetEdgeEndpoint returns an edge by ID with its metadata.
func (GetEdgeEndpoint) Auth ¶
func (e GetEdgeEndpoint) Auth() bool
func (GetEdgeEndpoint) Handle ¶
func (e GetEdgeEndpoint) Handle(ctx context.Context, req GetEdgeReq) (EdgeResponse, error)
func (GetEdgeEndpoint) Method ¶
func (e GetEdgeEndpoint) Method() string
func (GetEdgeEndpoint) Path ¶
func (e GetEdgeEndpoint) Path() string
type GetEdgeProvenanceEndpoint ¶
type GetEdgeProvenanceEndpoint struct{}
GetEdgeProvenanceEndpoint returns the provenance context of an edge: run, worker config node.
func (GetEdgeProvenanceEndpoint) Auth ¶
func (e GetEdgeProvenanceEndpoint) Auth() bool
func (GetEdgeProvenanceEndpoint) Handle ¶
func (e GetEdgeProvenanceEndpoint) Handle(ctx context.Context, req GetEdgeProvenanceReq) (EdgeProvenanceResp, error)
func (GetEdgeProvenanceEndpoint) Method ¶
func (e GetEdgeProvenanceEndpoint) Method() string
func (GetEdgeProvenanceEndpoint) Path ¶
func (e GetEdgeProvenanceEndpoint) Path() string
type GetEdgeProvenanceReq ¶
type GetEdgeProvenanceReq struct {
ID string `path:"id"`
}
type GetEdgeReq ¶
type GetEdgeReq struct {
ID string `path:"id"`
}
type GetEntityEndpoint ¶
type GetEntityEndpoint struct{}
GetEntityEndpoint returns an entity with all its relations, sorted by temporal validity.
func (GetEntityEndpoint) Auth ¶
func (e GetEntityEndpoint) Auth() bool
func (GetEntityEndpoint) Handle ¶
func (e GetEntityEndpoint) Handle(ctx context.Context, req GetEntityReq) (GetEntityResp, error)
func (GetEntityEndpoint) Method ¶
func (e GetEntityEndpoint) Method() string
func (GetEntityEndpoint) Path ¶
func (e GetEntityEndpoint) Path() string
type GetEntityReq ¶
type GetEntityResp ¶
type GetEntityResp struct {
Entity NodeResponse `json:"entity"`
Relations []RelationResponse `json:"relations"`
}
type GetEntityTimelineEndpoint ¶
type GetEntityTimelineEndpoint struct{}
GetEntityTimelineEndpoint returns all relations of an entity sorted chronologically by valid_from.
func (GetEntityTimelineEndpoint) Auth ¶
func (e GetEntityTimelineEndpoint) Auth() bool
func (GetEntityTimelineEndpoint) Handle ¶
func (e GetEntityTimelineEndpoint) Handle(ctx context.Context, req GetEntityTimelineReq) (GetEntityTimelineResp, error)
func (GetEntityTimelineEndpoint) Method ¶
func (e GetEntityTimelineEndpoint) Method() string
func (GetEntityTimelineEndpoint) Path ¶
func (e GetEntityTimelineEndpoint) Path() string
type GetEntityTimelineReq ¶
type GetEntityTimelineReq struct {
ID string `path:"id"`
}
type GetEntityTimelineResp ¶
type GetEntityTimelineResp struct {
Relations []RelationResponse `json:"relations"`
}
type GetNodeContentEndpoint ¶
type GetNodeContentEndpoint struct{}
GetNodeContentEndpoint returns the raw content bytes of a node. Serves from Postgres cache if available, otherwise proxies from S3.
func (GetNodeContentEndpoint) Auth ¶
func (e GetNodeContentEndpoint) Auth() bool
func (GetNodeContentEndpoint) HandleRaw ¶
func (e GetNodeContentEndpoint) HandleRaw(w http.ResponseWriter, r *http.Request) error
func (GetNodeContentEndpoint) Method ¶
func (e GetNodeContentEndpoint) Method() string
func (GetNodeContentEndpoint) Path ¶
func (e GetNodeContentEndpoint) Path() string
type GetNodeEdgesEndpoint ¶
type GetNodeEdgesEndpoint struct{}
GetNodeEdgesEndpoint returns edges connected to a node, filterable by direction and type.
func (GetNodeEdgesEndpoint) Auth ¶
func (e GetNodeEdgesEndpoint) Auth() bool
func (GetNodeEdgesEndpoint) Handle ¶
func (e GetNodeEdgesEndpoint) Handle(ctx context.Context, req GetNodeEdgesReq) (GetNodeEdgesResp, error)
func (GetNodeEdgesEndpoint) Method ¶
func (e GetNodeEdgesEndpoint) Method() string
func (GetNodeEdgesEndpoint) Path ¶
func (e GetNodeEdgesEndpoint) Path() string
type GetNodeEdgesReq ¶
type GetNodeEdgesResp ¶
type GetNodeEdgesResp struct {
Edges []EdgeResponse `json:"edges"`
}
type GetNodeEndpoint ¶
type GetNodeEndpoint struct{}
GetNodeEndpoint returns a node by ID with full metadata and inline content.
func (GetNodeEndpoint) Auth ¶
func (e GetNodeEndpoint) Auth() bool
func (GetNodeEndpoint) Handle ¶
func (e GetNodeEndpoint) Handle(ctx context.Context, req GetNodeReq) (NodeResponse, error)
func (GetNodeEndpoint) Method ¶
func (e GetNodeEndpoint) Method() string
func (GetNodeEndpoint) Path ¶
func (e GetNodeEndpoint) Path() string
type GetNodeProvenanceEndpoint ¶
type GetNodeProvenanceEndpoint struct{}
GetNodeProvenanceEndpoint returns the upstream provenance chain from a node back to L0 roots.
func (GetNodeProvenanceEndpoint) Auth ¶
func (e GetNodeProvenanceEndpoint) Auth() bool
func (GetNodeProvenanceEndpoint) Handle ¶
func (e GetNodeProvenanceEndpoint) Handle(ctx context.Context, req GetNodeProvenanceReq) (ProvenanceSubgraph, error)
func (GetNodeProvenanceEndpoint) Method ¶
func (e GetNodeProvenanceEndpoint) Method() string
func (GetNodeProvenanceEndpoint) Path ¶
func (e GetNodeProvenanceEndpoint) Path() string
type GetNodeProvenanceReq ¶
type GetNodeProvenanceReq struct {
ID string `path:"id"`
}
type GetNodeReq ¶
type GetNodeReq struct {
ID string `path:"id"`
}
type GetQueueEndpoint ¶
type GetQueueEndpoint struct{}
GetQueueEndpoint returns unprocessed nodes for a given worker type.
func (GetQueueEndpoint) Auth ¶
func (e GetQueueEndpoint) Auth() bool
func (GetQueueEndpoint) Handle ¶
func (e GetQueueEndpoint) Handle(ctx context.Context, req GetQueueReq) (GetQueueResp, error)
func (GetQueueEndpoint) Method ¶
func (e GetQueueEndpoint) Method() string
func (GetQueueEndpoint) Path ¶
func (e GetQueueEndpoint) Path() string
type GetQueueReq ¶
type GetQueueResp ¶
type GetQueueResp struct {
Nodes []NodeResponse `json:"nodes"`
}
type ListNodesEndpoint ¶
type ListNodesEndpoint struct{}
ListNodesEndpoint returns a filtered, paginated list of nodes.
func (ListNodesEndpoint) Auth ¶
func (e ListNodesEndpoint) Auth() bool
func (ListNodesEndpoint) Handle ¶
func (e ListNodesEndpoint) Handle(ctx context.Context, req ListNodesReq) (ListNodesResp, error)
func (ListNodesEndpoint) Method ¶
func (e ListNodesEndpoint) Method() string
func (ListNodesEndpoint) Path ¶
func (e ListNodesEndpoint) Path() string
type ListNodesReq ¶
type ListNodesResp ¶
type ListNodesResp struct {
Nodes []NodeResponse `json:"nodes"`
}
type ListRelationsEndpoint ¶
type ListRelationsEndpoint struct{}
ListRelationsEndpoint returns filtered relation nodes.
func (ListRelationsEndpoint) Auth ¶
func (e ListRelationsEndpoint) Auth() bool
func (ListRelationsEndpoint) Handle ¶
func (e ListRelationsEndpoint) Handle(ctx context.Context, req ListRelationsReq) (ListRelationsResp, error)
func (ListRelationsEndpoint) Method ¶
func (e ListRelationsEndpoint) Method() string
func (ListRelationsEndpoint) Path ¶
func (e ListRelationsEndpoint) Path() string
type ListRelationsReq ¶
type ListRelationsResp ¶
type ListRelationsResp struct {
Relations []RelationResponse `json:"relations"`
}
type NodeResponse ¶
type NodeResponse struct {
ID string `json:"id"`
Level int `json:"level"`
ContentClass string `json:"content_class"`
ContentType string `json:"content_type"`
EncodingClass string `json:"encoding_class"`
EncodingFormat string `json:"encoding_format"`
ContentSha256 string `json:"content_sha256"`
ContentLen int64 `json:"content_len"`
Content *string `json:"content,omitempty"`
CreatedAt string `json:"created_at"`
ArtifactCreatedAt *string `json:"artifact_created_at,omitempty"`
ArtifactCreatedAtBlur *string `json:"artifact_created_at_blur,omitempty"`
Origin *string `json:"origin,omitempty"`
OriginalName *string `json:"original_name,omitempty"`
ValidFrom *string `json:"valid_from,omitempty"`
ValidFromBlur *string `json:"valid_from_blur,omitempty"`
ValidUntil *string `json:"valid_until,omitempty"`
ValidUntilBlur *string `json:"valid_until_blur,omitempty"`
Confidence *float64 `json:"confidence,omitempty"`
}
NodeResponse is the API representation of a graph node.
type PaginationParams ¶
Pagination helpers
type ProvenanceSubgraph ¶
type ProvenanceSubgraph struct {
Nodes []NodeResponse `json:"nodes"`
Edges []EdgeResponse `json:"edges"`
}
ProvenanceSubgraph is a set of nodes and edges forming a provenance chain.
type RelationResponse ¶
type RelationResponse struct {
Node NodeResponse `json:"node"`
HeadEdges []EdgeResponse `json:"head_edges"`
TailEdges []EdgeResponse `json:"tail_edges"`
}
RelationResponse is a relation node with its head and tail edges.
type SearchEntitiesEndpoint ¶
type SearchEntitiesEndpoint struct{}
SearchEntitiesEndpoint searches entities by full-text query over names and aliases.
func (SearchEntitiesEndpoint) Auth ¶
func (e SearchEntitiesEndpoint) Auth() bool
func (SearchEntitiesEndpoint) Handle ¶
func (e SearchEntitiesEndpoint) Handle(ctx context.Context, req SearchEntitiesReq) (SearchEntitiesResp, error)
func (SearchEntitiesEndpoint) Method ¶
func (e SearchEntitiesEndpoint) Method() string
func (SearchEntitiesEndpoint) Path ¶
func (e SearchEntitiesEndpoint) Path() string
type SearchEntitiesReq ¶
type SearchEntitiesResp ¶
type SearchEntitiesResp struct {
Entities []NodeResponse `json:"entities"`
}