@vital-ai/vital-kg-model-ts

TypeScript models and utilities for VitalSigns Knowledge Graph.

Installation

npm install @vital-ai/vital-kg-model-ts

What's Included

1. VitalSigns Domain Models

Auto-generated TypeScript classes from the VitalSigns ontology:

• vital-core - Core VitalSigns classes
• vital - Base ontology
• haley-ai-kg - Knowledge Graph schema
• haley-ai-question - Question/Answer schema
• haley - Haley AI base classes
• haley-taxonomy - Taxonomy classes
• vital-nlp - NLP ontology
• vital-social - Social media ontology
• vital-aimp - AI Multi-Party ontology

2. KG Lookup Utilities

Essential functions for traversing Knowledge Graph data:

import { 
  lookup_entity, 
  lookup_frame, 
  lookup_slot,
  lookup_value 
} from '@vital-ai/vital-kg-model-ts';

// Get objects from backend
const objects = await fetch('/api/lead?uri=urn:lead123').then(r => r.json());

// Find entity and frame
const entity = lookup_entity(objects, 'urn:LeadEntityType');
const frame = lookup_frame(objects, entity, 'urn:PersonalInformationFrameType');

// Get slot value
const firstName = lookup_slot(objects, entity, frame, 'urn:FirstName');

// Or use shortcut
const email = lookup_value(objects, entity, 'urn:Email');

Usage

Importing Models

// Import specific classes
import { KGEntity, KGFrame, KGSlot } from '@vital-ai/vital-kg-model-ts';

// Import utilities
import { 
  lookup_entity,
  lookup_entities,
  lookup_frame,
  lookup_frames,
  lookup_slot,
  lookup_slots,
  lookup_value
} from '@vital-ai/vital-kg-model-ts';

Using VitalSigns Converter

import { VitalSignsConverter } from '@vital-ai/vital-kg-model-ts';

// Convert object to JSON
const json = VitalSignsConverter.fromInstance(entity);

// Convert JSON to object
const entity = VitalSignsConverter.toInstance(json);

Working with Edges

import { Edge_hasKGFrame, KGEntity, KGFrame } from '@vital-ai/vital-kg-model-ts';

const entity = new KGEntity();
entity.URI = 'http://example.com/entity1';

const frame = new KGFrame();
frame.URI = 'http://example.com/frame1';

const edge = new Edge_hasKGFrame();
edge.URI = 'http://example.com/edge1';
edge.edgeSource = entity.URI;
edge.edgeDestination = frame.URI;

Converting Raw JSON to Typed Objects

import { convertGraphObjects, lookup_entity, lookup_path_value } from '@vital-ai/vital-kg-model-ts';

const graphObjects = convertGraphObjects(apiResponse.graph_objects);
const entity = lookup_entity(graphObjects, 'urn:LeadEntityType');

Development

Build

npm run build

Watch Mode

npm run dev

Test

npm test

Clean

npm run clean

Publishing

This package is published to the public npm registry:

npm run release 0.1.1

Or via GitHub Actions on release creation.

License

MIT