8ecb5d3a0c
* Add documentation code validation system - Create runnable example scripts in examples/api/ (19 files) - Add CodeSnippet component for extracting marked sections - Add raw-loader dependency for importing source files - Create sample retain-new.mdx showing new approach - Add README documenting coverage and gaps * Fix wheel glob expansion in test-doc-examples CI job * Fix CI issue * Fix wheel path - uv build outputs to repo root dist/ * Fix: use explicit shell expansion for wheel install * Fix: run cd in subshell so install runs from repo root * Add documentation code validation CI job - Use uv sync + uv run pattern (matches existing CI) - Add requests to test dependencies for cleanup scripts * Fix async API client usage in documents.py example * Fix main-methods.py: RecallResult and ReflectFact don't have weight attribute * Fix opinions.py: use actual API attributes instead of non-existent ones * Fix example scripts: remove non-existent API attributes - recall.py: remove .weight, fix entities iteration (dict not list) - retain.mjs: remove result.async check
61 lines
2.1 KiB
JavaScript
61 lines
2.1 KiB
JavaScript
#!/usr/bin/env node
|
|
/**
|
|
* Recall API examples for Hindsight (Node.js)
|
|
* Run: node examples/api/recall.mjs
|
|
*/
|
|
import { HindsightClient } from '@vectorize-io/hindsight-client';
|
|
|
|
const HINDSIGHT_URL = process.env.HINDSIGHT_API_URL || 'http://localhost:8888';
|
|
|
|
// =============================================================================
|
|
// Setup (not shown in docs)
|
|
// =============================================================================
|
|
const client = new HindsightClient({ baseUrl: HINDSIGHT_URL });
|
|
|
|
// Seed some data for recall examples
|
|
await client.retain('my-bank', 'Alice works at Google as a software engineer');
|
|
await client.retain('my-bank', 'Alice loves hiking on weekends');
|
|
await client.retain('my-bank', 'Bob is a data scientist who works with Alice');
|
|
|
|
// =============================================================================
|
|
// Doc Examples
|
|
// =============================================================================
|
|
|
|
// [docs:recall-basic]
|
|
const response = await client.recall('my-bank', 'What does Alice do?');
|
|
for (const r of response.results) {
|
|
console.log(`${r.text} (score: ${r.weight})`);
|
|
}
|
|
// [/docs:recall-basic]
|
|
|
|
|
|
// [docs:recall-with-options]
|
|
const detailedResponse = await client.recall('my-bank', 'What does Alice do?', {
|
|
types: ['world', 'experience'],
|
|
budget: 'high',
|
|
maxTokens: 8000,
|
|
trace: true
|
|
});
|
|
|
|
// Access results
|
|
for (const r of detailedResponse.results) {
|
|
console.log(`${r.text} (score: ${r.weight})`);
|
|
}
|
|
// [/docs:recall-with-options]
|
|
|
|
|
|
// [docs:recall-budget-levels]
|
|
// Quick lookup
|
|
const quickResults = await client.recall('my-bank', "Alice's email", { budget: 'low' });
|
|
|
|
// Deep exploration
|
|
const deepResults = await client.recall('my-bank', 'How are Alice and Bob connected?', { budget: 'high' });
|
|
// [/docs:recall-budget-levels]
|
|
|
|
|
|
// =============================================================================
|
|
// Cleanup (not shown in docs)
|
|
// =============================================================================
|
|
await fetch(`${HINDSIGHT_URL}/v1/default/banks/my-bank`, { method: 'DELETE' });
|
|
|
|
console.log('recall.mjs: All examples passed');
|