TypeScript SDK

npm install @hyphaedb/client

import { HyphaeClient, CellType } from "@hyphaedb/client";

import { HyphaeClient, CellType } from "@hyphaedb/client";

async function main() {
  // auth is the whole hyk_... key; it rides every RPC as x-hyphae-key and is never parsed.
  const client = await HyphaeClient.connect("localhost:50051", "hyk_your_key_here");
  await client.startSession("my-agent"); // opens the live inbox stream

  const nodeId = await client.store({
    cellType: CellType.DECISION,
    content: "We ship on Friday",
    salience: 0.9,
  });
  console.log("stored", nodeId);

  const hits = await client.recall({ text: "ship", k: 5 }); // cache-first, server on miss
  for (const hit of hits) {
    console.log(hit.score, hit.fromCache, hit.content);
  }

  for await (const item of client.inbox()) {
    // deduped gossip deliveries, live
    console.log("delivered", item.delivery?.diffId);
    break;
  }

  await client.close();
}

main();

HyphaeClient.connect(
  endpoint: string,
  auth: string,
  config?: Partial<ClientConfig>,
): Promise<HyphaeClient>

client.store(cell: CellInput): Promise<string>

client.recall(query: RecallQuery): Promise<RecallHit[]>

client.startSession(agentId: string): Promise<Session>

client.placeBeacon(interest: string): Promise<string>

client.inbox(): AsyncIterableIterator<InboxItem>

client.close(): Promise<void>

interface CellInput {
  cellType: CellType;
  content: string;
  sceneId?: string;
  salience?: number; // defaults to 0.5
}

interface RecallQuery {
  text: string;
  k?: number; // 0 ⇒ use ClientConfig.recallDefaultK
  cellTypes?: CellType[];
  sceneId?: string;
  includeInbox?: boolean; // defaults to true
}

interface RecallHit {
  nodeId: string;
  content: string;
  cellType: CellType;
  score: number;
  fromCache: boolean;
}