nlquery

Documentation

Index

• type Engine
  • func New(g *graph.Graph, s *schema.Schema) *Engine
  • func (e *Engine) Query(ctx context.Context, question string) (*Response, error)
• type Response

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine translates natural language questions to Cypher and executes them.

func New

func New(g *graph.Graph, s *schema.Schema) *Engine

New creates a new NL query engine. Requires ANTHROPIC_API_KEY env var.

func (*Engine) Query

func (e *Engine) Query(ctx context.Context, question string) (*Response, error)

Query translates a natural language question to Cypher and executes it.

type Response

type Response struct {
	Question       string         `json:"question"`
	GeneratedQuery string         `json:"generated_query"`
	Result         *cypher.Result `json:"result"`
}

Response contains the generated Cypher and query results.