apptype

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 15, 2025 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddObservationsArgs

type AddObservationsArgs struct {
	ProjectArgs  ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	EntityName   string      `json:"entityName" jsonschema:"The name of the entity to add observations to."`
	Observations []string    `json:"observations" jsonschema:"A list of observations to append."`
}

AddObservationsArgs represents arguments for appending observations to an entity

type CreateEntitiesArgs

type CreateEntitiesArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	Entities    []Entity    `json:"entities" jsonschema:"A list of entities to create."`
}

CreateEntitiesArgs represents the arguments for the create_entities tool

type CreateRelationsArgs

type CreateRelationsArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	Relations   []Relation  `json:"relations" jsonschema:"A list of relations to create between entities."`
}

CreateRelationsArgs represents the arguments for the create_relations tool

type DeleteEntitiesArgs

type DeleteEntitiesArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty"`
	Names       []string    `json:"names"`
}

Bulk deletion/update argument types (planned tools)

type DeleteEntityArgs

type DeleteEntityArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	Name        string      `json:"name" jsonschema:"The name of the entity to delete."`
}

DeleteEntityArgs represents the arguments for the delete_entity tool

type DeleteObservationsArgs

type DeleteObservationsArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty"`
	EntityName  string      `json:"entityName"`
	IDs         []int64     `json:"ids,omitempty"`
	Contents    []string    `json:"contents,omitempty"`
}

type DeleteRelationArgs

type DeleteRelationArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	Source      string      `json:"source" jsonschema:"The name of the source entity in the relation."`
	Target      string      `json:"target" jsonschema:"The name of the target entity in the relation."`
	Type        string      `json:"type" jsonschema:"The type of the relation."`
}

DeleteRelationArgs represents the arguments for the delete_relation tool

type DeleteRelationsArgs

type DeleteRelationsArgs struct {
	ProjectArgs ProjectArgs     `json:"projectArgs,omitempty"`
	Relations   []RelationTuple `json:"relations"`
}

type Entity

type Entity struct {
	Name         string    `json:"name"`
	EntityType   string    `json:"entityType"`
	Observations []string  `json:"observations"`
	Embedding    []float32 `json:"embedding,omitempty"`
}

Entity represents a node in the knowledge graph

type GraphResult

type GraphResult struct {
	Entities  []Entity   `json:"entities"`
	Relations []Relation `json:"relations"`
}

GraphResult represents the result for graph-related tools (search_nodes, read_graph)

type HealthArgs

type HealthArgs struct{}

Health

type HealthResult

type HealthResult struct {
	Name          string `json:"name"`
	Version       string `json:"version"`
	Revision      string `json:"revision"`
	BuildDate     string `json:"buildDate"`
	MultiProject  bool   `json:"multiProject"`
	EmbeddingDims int    `json:"embeddingDims"`
}

type NeighborsArgs

type NeighborsArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	Names       []string    `json:"names" jsonschema:"Seed entity names to expand from."`
	Direction   string      `json:"direction,omitempty" jsonschema:"Which direction of edges to follow: out|in|both (default both)."`
	Limit       int         `json:"limit,omitempty" jsonschema:"Maximum number of neighbor entities to return (per seed)."`
}

NeighborsArgs represents arguments for fetching 1-hop neighbors Direction may be "out", "in", or "both" (default "both").

type OpenNodesArgs

type OpenNodesArgs struct {
	ProjectArgs      ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	Names            []string    `json:"names" jsonschema:"Entity names to open."`
	IncludeRelations bool        `json:"includeRelations,omitempty" jsonschema:"Whether to include relations among the returned entities."`
}

OpenNodesArgs represents arguments for fetching entities (and optional relations)

type ProjectArgs

type ProjectArgs struct {
	ProjectName string `json:"projectName,omitempty" jsonschema:"The name of the project to operate on. REQUIRED in multi-project mode."`
	AuthToken   string `` /* 139-byte string literal not displayed */
}

ProjectArgs provides a standard way to pass project context to tools.

type ReadGraphArgs

type ReadGraphArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	Limit       int         `json:"limit,omitempty" jsonschema:"Maximum number of recent entities to return (default 10)."`
}

ReadGraphArgs represents the arguments for the read_graph tool

type Relation

type Relation struct {
	From         string `json:"from"`
	To           string `json:"to"`
	RelationType string `json:"relationType"`
}

Relation represents a directed relationship between two entities

type RelationTuple

type RelationTuple struct {
	From         string `json:"from"`
	To           string `json:"to"`
	RelationType string `json:"relationType"`
}

type SearchNodesArgs

type SearchNodesArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty" jsonschema:"Project context for the operation."`
	Query       interface{} `json:"query" jsonschema:"The search query. Can be a string for text search or a []float32 for vector similarity search."`
	Limit       int         `json:"limit,omitempty" jsonschema:"Maximum number of results to return (default 5)."`
	Offset      int         `json:"offset,omitempty" jsonschema:"Number of results to skip (for pagination)."`
}

SearchNodesArgs represents the arguments for the search_nodes tool

type SearchResult

type SearchResult struct {
	Entity   Entity  `json:"entity"`
	Distance float64 `json:"distance"`
}

SearchResult represents the result of a similarity search

type ShortestPathArgs

type ShortestPathArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty"`
	From        string      `json:"from" jsonschema:"Source entity name."`
	To          string      `json:"to" jsonschema:"Target entity name."`
	Direction   string      `json:"direction,omitempty" jsonschema:"out|in|both (default both)."`
}

ShortestPathArgs represents arguments for computing a shortest path between two nodes.

type UpdateEntitiesArgs

type UpdateEntitiesArgs struct {
	ProjectArgs ProjectArgs        `json:"projectArgs,omitempty"`
	Updates     []UpdateEntitySpec `json:"updates"`
}

UpdateEntitiesArgs represents partial updates to entities

type UpdateEntitySpec

type UpdateEntitySpec struct {
	Name                string    `json:"name"`
	EntityType          string    `json:"entityType,omitempty"`
	Embedding           []float32 `json:"embedding,omitempty"`
	MergeObservations   []string  `json:"mergeObservations,omitempty"`
	ReplaceObservations []string  `json:"replaceObservations,omitempty"`
}

type UpdateRelationChange

type UpdateRelationChange struct {
	From            string `json:"from"`
	To              string `json:"to"`
	RelationType    string `json:"relationType"`
	NewFrom         string `json:"newFrom,omitempty"`
	NewTo           string `json:"newTo,omitempty"`
	NewRelationType string `json:"newRelationType,omitempty"`
}

type UpdateRelationsArgs

type UpdateRelationsArgs struct {
	ProjectArgs ProjectArgs            `json:"projectArgs,omitempty"`
	Updates     []UpdateRelationChange `json:"updates"`
}

UpdateRelationsArgs represents updates to relation tuples

type WalkArgs

type WalkArgs struct {
	ProjectArgs ProjectArgs `json:"projectArgs,omitempty"`
	Names       []string    `json:"names" jsonschema:"Seed entity names to start from."`
	MaxDepth    int         `json:"maxDepth,omitempty" jsonschema:"Maximum hop depth (default 1)."`
	Direction   string      `json:"direction,omitempty" jsonschema:"out|in|both (default both)."`
	Limit       int         `json:"limit,omitempty" jsonschema:"Optional limit on entities returned."`
}

WalkArgs represents arguments for bounded-depth graph expansion from seeds.

Jump to

Keyboard shortcuts

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