Ephia SDK

Official JavaScript/TypeScript SDK for Ephia medical dictation.

Install

npm install @ephia/dova-sdk
# or
pnpm add @ephia/dova-sdk

React quickstart

import { EphiaProvider, useEphiaNativeTarget } from "@ephia/dova-sdk/react";
import { EphiaFloatingButton } from "@ephia/dova-sdk/ui";
import { useRef } from "react";

function ReportTextarea() {
  const ref = useRef<HTMLTextAreaElement>(null);
  useEphiaNativeTarget(ref, { id: "report", label: "Compte rendu" });
  return <textarea ref={ref} placeholder="Dictez votre compte rendu..." />;
}

export function App() {
  return (
    <EphiaProvider bearerToken={token}>
      <ReportTextarea />
      <EphiaFloatingButton />
    </EphiaProvider>
  );
}

TipTap rich editor

import {
  useEphiaRichEditor,
  createTiptapEphiaAdapter,
} from "@ephia/dova-sdk/rich-editor";

useEphiaRichEditor(
  editor ? createTiptapEphiaAdapter(editor) : null,
  { id: "report", label: "Compte rendu" }
);

Entry points

| Import | Description | |---|---| | @ephia/dova-sdk/react | Provider, hooks, React components | | @ephia/dova-sdk/rich-editor | TipTap adapter and useEphiaRichEditor | | @ephia/dova-sdk/headless | createEphiaClient for non-React apps | | @ephia/dova-sdk/bindings | Low-level bindings (NativeBinding, TiptapBinding) | | @ephia/dova-sdk/ui | Standalone UI components | | @ephia/dova-sdk/testing | Test helpers | | @ephia/dova-sdk/speechmike | Philips SpeechMike support | | @ephia/dova-sdk/style.css | Default styles |

Production endpoint

Default API endpoint:

https://api.ephia.app

Documentation

See the public documentation in apps/ephia-docs.

Architecture

The SDK V2 follows a backend-first architecture:

Backend Ephia
→ segment.preview / segment.operation
→ SDK
→ TargetManager
→ NativeBinding / TiptapBinding
→ client editor

The backend decides the final text, corrections, voice commands, layout and segment revisions.
The SDK applies the received operations into the right editable target.