Sofia SDK

AI-powered medical assistant web component for healthcare applications.

Documentation & Support:

• Official Documentation
• Examples Repository
• Report Issues

Installation

Option 1: NPM/Yarn (Recommended)

npm install @omniloy/sofia-sdk

yarn add @omniloy/sofia-sdk

Import in your project:

// In your main file (main.js, app.js, index.js, etc.)
import '@omniloy/sofia-sdk';

Once imported, the <sofia-sdk> component becomes available globally.

Option 2: CDN

Latest version:

<script src="https://unpkg.com/@omniloy/sofia-sdk@latest/dist/webcomponents.umd.js"></script>

Specific version:

<script src="https://unpkg.com/@omniloy/[email protected]/dist/webcomponents.umd.js"></script>

Option 3: Manual Build

<script src="/dist/webcomponents.umd.js"></script>

Installation Verification

Browser verification:

console.log(customElements.get('sofia-sdk'));

Should return the component definition rather than undefined.

HTML verification:

<sofia-sdk></sofia-sdk>

Successful installation displays a message about missing required properties.

Environment Requirements

HTTPS Protocol

SofIA SDK requires HTTPS for audio and microphone functionality. Local development uses https://localhost or local-ssl-proxy.

Content Security Policy

connect-src 'self' https://*.omniloy.com wss://*.omniloy.com;
script-src 'self' 'unsafe-inline' https://unpkg.com;

SDK Configuration with Proxy

<sofia-sdk
  baseurl="base-url"
  apikey="your-api-key"
  wssurl="wss://WSS_URL"
  userid="doctor-123"
  patientid="patient-456"
  template='{"$schema": "http://json-schema.org/draft-07/schema#", "title": "Medical Consultation", "type": "object", "properties": {"diagnosis": {"type": "string"}}, "required": ["diagnosis"]}'
  templateid='1234'
></sofia-sdk>

Troubleshooting

Component doesn't load:

• Verify the import is in the main file
• Confirm no errors in browser console
• Check network connectivity for CDN usage

CORS errors:

• Ensure application uses HTTPS
• Verify baseurl and wssurl URLs are correct

Component not defined:

// Wait for component definition
customElements.whenDefined('sofia-sdk').then(() => {
  console.log('SofIA SDK is ready');
});

Next Steps

1. Required Properties: Configure mandatory parameters
2. Optional Properties: Customize behavior
3. Clinical Data Schemas: Define data structure to generate

License

Dual-licensed: AGPL-3.0 for open source, Commercial License for proprietary use.

For commercial licensing: omniloy.com