Entities API

const client = new NdxClient({
  apiKey: process.env.NEURADEX_API_KEY,
  projectId: 'your-project-id',
});

// Access Entities API
const entities = await client.entities.list();
const entity = await client.entities.create({
  canonicalName: 'John Smith',
  type: 'person',
});

// Get all entities
const result = await client.entities.list();
console.log(`Entity count: ${result.total}`);

// People only
const people = await client.entities.list({ type: 'person' });

// Search
const results = await client.entities.list({ search: 'John' });

const entity = await client.entities.get('entity-id');

console.log(`Name: ${entity.canonicalName}`);
console.log(`Type: ${entity.type}`);
console.log(`Aliases: ${entity.aliases.map(a => a.alias).join(', ')}`);

const entity = await client.entities.create({
  canonicalName: 'John Smith',
  type: 'person',
  aliases: ['John', 'J. Smith'],
});

console.log(`Created: ${entity.id}`);

const updated = await client.entities.update('entity-id', {
  canonicalName: 'John Smith (Manager)',
});

await client.entities.delete('entity-id');

const alias = await client.entities.addAlias('entity-id', 'Johnny');

await client.entities.removeAlias('entity-id', 'alias-id');

const relations = await client.entities.getRelations('entity-id');

// Outgoing (from this entity to others)
for (const rel of relations.outgoing) {
  console.log(`${rel.relationType} → ${rel.targetEntity.canonicalName}`);
}

// Incoming (from others to this entity)
for (const rel of relations.incoming) {
  console.log(`${rel.sourceEntity.canonicalName} → ${rel.relationType}`);
}

const relation = await client.entities.addRelation(
  'person-entity-id',
  'company-entity-id',
  'works_for'
);

const result = await client.entities.getKnowledges('entity-id');

for (const k of result.knowledges) {
  console.log(`${k.knowledgeTitle}: "${k.mentionText}"`);
}

const result = await client.entities.getTopics('entity-id');

for (const t of result.topics) {
  console.log(`${t.topicTitle}: "${t.mentionText}"`);
}

const result = await client.entities.getEpisodes('entity-id');

for (const e of result.episodes) {
  console.log(`"${e.mentionText}" in episode`);
}

const pairs = await client.entities.findSimilar();

for (const pair of pairs) {
  console.log(`Similar: ${pair.entity1.canonicalName} ↔ ${pair.entity2.canonicalName}`);
  console.log(`Score: ${pair.similarity}`);
}

const result = await client.entities.merge({
  keepEntityId: 'entity-1',
  mergeEntityId: 'entity-2',
});

console.log(`Merge complete:`);
console.log(`- Aliases: ${result.mergedAliases}`);
console.log(`- Knowledge: ${result.migratedKnowledges}`);
console.log(`- Episodes: ${result.migratedEpisodes}`);

const graph = await client.entities.getGraph();

console.log(`Nodes: ${graph.nodes.length}`);
console.log(`Edges: ${graph.edges.length}`);

// Nodes
for (const node of graph.nodes) {
  console.log(`${node.canonicalName} (${node.type})`);
}

// Edges
for (const edge of graph.edges) {
  console.log(`${edge.source} --${edge.relationType}--> ${edge.target}`);
}