Hindsight TypeScript Client

TypeScript client library for the Hindsight API.

Installation

npm install @vectorize-io/hindsight-client
# or
yarn add @vectorize-io/hindsight-client

Usage

import { HindsightClient } from '@vectorize-io/hindsight-client';

const client = new HindsightClient({ baseUrl: 'http://localhost:8888' });

// Retain information
await client.retain('my-bank', 'Alice works at Google in Mountain View.');

// Recall memories
const results = await client.recall('my-bank', 'Where does Alice work?');

// Reflect and get an opinion
const response = await client.reflect('my-bank', 'What do you think about Alice\'s career?');

API Reference

retain(bankId, content, options?)

Store a single memory.

await client.retain('my-bank', 'User prefers dark mode', {
  timestamp: new Date(),
  context: 'Settings conversation',
  metadata: { source: 'chat' }
});

retainBatch(bankId, items, options?)

Store multiple memories in batch.

await client.retainBatch('my-bank', [
  { content: 'Alice loves hiking' },
  { content: 'Alice visited Paris last summer' }
], { async: true });

recall(bankId, query, options?)

Recall memories matching a query.

const results = await client.recall('my-bank', 'What are Alice\'s hobbies?', {
  budget: 'mid'
});

reflect(bankId, query, options?)

Generate a contextual answer using the bank's identity and memories.

const response = await client.reflect('my-bank', 'What should I do this weekend?', {
  budget: 'low'
});
console.log(response.text);

createBank(bankId, options)

Create or update a memory bank with personality.

await client.createBank('my-bank', {
  name: 'My Assistant',
  background: 'A helpful assistant that remembers everything.'
});

Documentation

For full documentation, visit hindsight.