@cariva/asr-sdk v1.5.0

Cariva ASR SDK for JavaScript

Effortlessly integrate Cariva’s Automatic Speech Recognition (ASR) API into your JavaScript applications to transcribe audio with minimal setup.

📋 Table of Contents

• ✨ Features
• 🎬 Demo
• ⚙️ Requirements

• 🚀 Installation

  • npm
  • CDN

• 💡 Quick Start

• 🔧 Configuration

  • ASRConfigs
  • Process Options

• ⚠️ Error Handling

• 🗂️ Specialty Key Mapping
• 📜 License

✨ Features

• Minimal Setup: Get up and running in minutes.
• Flexible Environments: Supports Node.js (v18+) and modern browsers.
• Promise‑based API: Intuitive task creation and processing.
• Cancellation Support: Abort long‑running tasks.
• Customizable: Override language and medical specialty for model tuning.

🎬 Demo

Try a live integration guide and playground demo here.

⚙️ Requirements

• Node.js v18 or higher (for npm install)
• Modern browsers (for CDN usage)

🚀 Installation

npm

npm install @cariva/asr-sdk
# or
yarn add @cariva/asr-sdk

CDN

Include via <script> tag:

<script src="https://cdn.jsdelivr.net/npm/@cariva/asr-sdk/dist/global/1.4.0/index.min.js"></script>

💡 Quick Start

import { ASR, ASRConfigs, cancelASRTask } from '@cariva/asr-sdk';

(async () => {
  const config = new ASRConfigs({
    key: 'YOUR_API_KEY',           // required
    secret: 'YOUR_API_SECRET',     // required
    mode: 'doc-ipd-soap',          // required
    lang: 'en',                    // optional, default: 'en'
    specialty: 'other',            // optional, default: 'other'
    newLineString: '\n',          // optional
  });

  const asr = new ASR(config);

  try {
    const task = await asr.create();

    // Cancel if it takes longer than 5 minutes
    const timeoutId = setTimeout(async () => {
      console.warn('Cancelling ASR task due to timeout');
      await cancelASRTask(task.id);
    }, 300000);

    const audioBlob = /* your File or Blob */;
    const result = await task.process(audioBlob);
    clearTimeout(timeoutId);

    console.log('Transcription:', result);
  } catch (error) {
    console.error('ASR error:', error);
  }
})();

🔧 Configuration

ASRConfigs

Process Options

When calling task.process(), you can override configuration per request:

⚠️ Error Handling

All failures are thrown as JavaScript Error. Wrap your calls in try/catch:

try {
  // ASR logic...
} catch (err) {
  console.error("ASR processing failed:", err);
}

🗂️ Specialty Key Mapping

📜 License

This project is licensed under the Apache License 2.0.