rust-kgdb 0.3.8 → 0.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +36 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -581,6 +581,42 @@ HyperMind is a **production-grade neuro-symbolic agentic framework** built on ru
581
581
  - **Neural Planning**: LLM-based planning (Claude, GPT-4o)
582
582
  - **Symbolic Execution**: rust-kgdb knowledge graph operations
583
583
 
584
+ ### Quick Start: Create an Agent in 3 Lines
585
+
586
+ ```typescript
587
+ const { HyperMindAgent } = require('rust-kgdb')
588
+
589
+ // 1. Spawn an agent
590
+ const agent = await HyperMindAgent.spawn({
591
+ name: 'university-explorer',
592
+ model: 'mock', // 'mock' | 'claude-sonnet-4' | 'gpt-4o'
593
+ tools: ['kg.sparql.query'], // Available tools
594
+ endpoint: 'http://localhost:30080' // rust-kgdb cluster endpoint
595
+ })
596
+
597
+ // 2. Ask natural language questions
598
+ const result = await agent.call('Find all professors in the database')
599
+
600
+ // 3. Get results
601
+ console.log(result.sparql) // "PREFIX ub: <...> SELECT ?x WHERE { ?x a ub:Professor }"
602
+ console.log(result.results) // [{ bindings: { x: 'http://...' } }, ...]
603
+ console.log(result.success) // true
604
+ ```
605
+
606
+ ### Run the Benchmark Suite
607
+
608
+ ```typescript
609
+ const { runHyperMindBenchmark } = require('rust-kgdb')
610
+
611
+ // Run 12 LUBM benchmark tests
612
+ const stats = await runHyperMindBenchmark('http://localhost:30080', 'mock', {
613
+ saveResults: true // Saves to hypermind_benchmark_*.json
614
+ })
615
+
616
+ console.log(`Success Rate: ${stats.hypermindSyntaxRate}%`) // 100%
617
+ console.log(`Avg Latency: ${stats.avgLatencyMs}ms`) // ~6.58ms
618
+ ```
619
+
584
620
  ### Architecture Overview
585
621
 
586
622
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rust-kgdb",
3
- "version": "0.3.8",
3
+ "version": "0.3.9",
4
4
  "description": "High-performance RDF/SPARQL database with GraphFrames analytics, vector embeddings, Datalog reasoning, Pregel BSP processing, and HyperMind neuro-symbolic agentic framework",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",