次の方法で共有

@dragon-speech-sdk/types package

クラス

EhrAuthenticationClient

パートナーが発行したアクセス トークンを、SDK で使用できるアクセス トークンと交換できるようにします。

例

const ehrAuthClient = new dragon.authentication.ehr.EhrAuthenticationClient();

async function acquireToken() {
  const accessToken = await ehrAuthClient.acquireToken({
    accessToken: "partner-issued-access-token",
  });
 return accessToken;
}

dragon.initialize({
  // Other initialization options...
  services: "us",
  authentication: {
    acquireAccessToken: acquireToken,
  },
});
EhrAuthenticationError

このエラーは、EHR トークン交換中にエラーが発生した場合にスローされます。 詳細なエラー コードについては、 <xref:EhrAuthenticationErrorCodes>を参照してください。
IntegrationError

このエラーは、API が不適切に呼び出された場合にスローされます。 詳細なエラー コードについては、 IntegrationErrorCodes を参照してください。
InternalError

このエラーは、SDK の内部の何かが失敗したときにスローされます。
SdkError

すべての SDK エラーの基本エラー クラス。

型エイリアス

ApplicationCommandsEvents

アプリケーション コマンド イベント。
Command

CommandVariantの 1 つをディクテーションすることによってエンド ユーザーがトリガーできるコマンド。 コマンドは CommandSet に属しています。
CommandPlaceholder

読み上げ可能なフォームと値の一覧を含むコマンド プレースホルダー。

例

const placeholder: CommandPlaceholder = {
  id: "patientId",
  label: "name of the patient",
  placeholderValues: [
    { value: "PTN.48389488", spokenForm: "mister Pink" },
    { value: "PTN.48323466", spokenForm: "mister Orange" },
  ]
};
CommandPlaceholderDetail

CommandRecognizedDetail 内の CommandPlaceholder の詳細。
CommandPlaceholderValue

CommandPlaceholder で使用できる特定の値と、spokenForm に関連付けられている値。

例

const placeholderValue: CommandPlaceholderValue = {
  value: "PTN.48389488",
  spokenForm: "mister Pink"
};
CommandRecognizedDetail

commandRecognized イベントのイベントの詳細。 コマンドが認識されたときに発生します。
CommandSet

一緒に有効または無効にできる関連 コマンドのグループ。
CommandType

アプリケーション コマンドの種類。
CommandVariant

Command の spokenForm および関連する displayString。 プレースホルダーを除き、アルファベット文字とスペースのみを含める必要があります。 コマンドには複数のコマンドバリアントを使用して、同じコマンドを異なる方法で言うことができます。
AccessToken

SDK 全体で使用されるパブリック AccessToken 型。
AuthenticationOptions

認証を構成するためのオプション。
AcquireTokenRequest

EHR トークンを取得するための要求パラメーター。
AcquireTokenResult

EHR アクセス トークンを取得した結果。
EhrAuthenticationConfiguration

EHR 認証の構成オプション。
ScopeBehavior

使用可能なスコープの動作を表す共用体の型。
ButtonDetail

サポートされているボタン デバイスの詳細を表します (たとえば、ニュアンス PowerMic、Philips SpeechMike)。
ButtonDeviceEvents

ボタン デバイス イベント。
ButtonDevicePermissionRequiredDetail

ボタン デバイスのアクセス許可が必要かどうかを示すイベントの詳細。
HotkeyPressAction

HotkeyPressAction オブジェクトの型定義。
IntegratorActionRequiredOnButtonPressDetail

ユーザーがボタンを押したときにインテグレーターからアクションが必要になったときに生成されるイベントの詳細。

action プロパティには、次のいずれかの値を指定できます。

  • "transferText": テキスト転送が必要です。
  • "anchorReleaseSpeechFocus": 音声フォーカスはアンカーから解放する必要があります。
  • "toggleMinimizeRestore": 最小化された状態と復元された状態の間で UI を切り替える必要があります。
  • "toggleDictationClipboard": ディクテーション クリップボードを切り替える必要があります。
  • "executeHotKeyPress": ホットキーの押下を実行する必要があります。

arguments プロパティには、アクションに応じて、文字列の配列またはKeyboardKey値を含めることができます。
KeyboardKey

キーボード キーとそれに関連付けられているプロパティについて説明します。 詳細については、「 KeyboardEvent」を参照してください。
MicrophoneButtonAction

MicrophoneButtonPressAction、HotkeyPressAction、または StepByStepAction のいずれかを指定できる MicrophoneButtonAction の型定義。
MicrophoneButtonPreferences

UserPreferences 型の一部である MicrophoneButtonPreferences オブジェクトの型定義。
Correction

選択したテキストに対して修正が可能です。修正メニューでユーザーに表示できます。
CorrectionEvents

修正イベント。
ShowCorrectionMenuDetail

showCorrectionMenu イベントのイベントの詳細。
CustomControlOptions

カスタム コントロールと Dragon 音声機能の統合の構成オプション。 SDK によってカスタム コントロールを検出して処理する方法の設定を定義します。
ExternalCustomControl

Dragon の音声機能と統合できる外部カスタム コントロールを表します。 この型は、外部テキスト コントロールを音声で有効にするために必要な初期構造とプロパティを定義します。
NoDictateDirection

使用可能なディクテーション ブロックの方向を表す和集合型。
ProtectedRange

ディクテーション動作が制御されるテキスト内の保護された範囲を表します。 ディクテーションをブロックする必要がある特定の領域 (SSN、電話番号など) をマークするために使用されます。
ProtectedSection

複数の保護された範囲を含む保護されたセクションを表します。 セクションは、関連する保護された範囲をグループ化します。
ProtectedTextLayout

完全な保護されたテキスト レイアウトメタデータ構造を表します。 これは、保護された領域を定義するために SDK に渡される最上位の構造です。
ProcessingStatus

カスタム コントロールの処理状態を表します。 特定のコントロールに対して音声が処理されているかどうかを示します。
ErrorEvents

エラー イベント。
ErrorOccurredDetail

SDK 内で発生したエラーのイベントの詳細。
NonSupportedBrowserDetectedDetail

サポートされていないブラウザーが検出された場合のイベントの詳細。 BrowserCompatibilityStatus を再利用しますが、isSupported フィールドは省略します。
ChangeType
  • preferredMicConnectedNotRecording - 録音していない間、優先マイクが接続されています。 優先マイクは、録音の開始時に使用されます。
  • preferredMicConnectedWhileRecording - 録音中は、優先マイクが接続されています。 切り替えを選択すると、記録は停止します。
  • preferredMicChangedWhileRecording - 録音中に、優先マイクが変更されます。 記録が停止します。 新しい優先マイクは、録音の開始時に使用されます。
  • currentMicDisconnectedNotRecording - 録音していない間、現在のマイクは取り外されています。 優先マイクまたは既定のマイクは、録音の開始時に使用されます。
  • currentMicDisconnectedWhileRecording - 録音中に、現在のマイクが取り外されています。 記録が停止します。 優先マイクまたは既定のマイクは、録音の開始時に使用されます。
Microphone

使用可能なマイクに関する情報。
MicrophoneEvents

マイク イベント。
MicrophoneListChangedDetail

現在接続されているマイクに関する情報。
MobileMicEvents

モバイル マイク イベント。
PairingStatusChangedDetail

ペアリングの状態が変更されたイベント。
RemoteButtonKeyName

リモート ボタン アクションの有効なキー名を表します。 アクションをトリガーするためにモバイル マイク アプリによって送信されるキー。
RemoteClientEventOccurredDetail

リモート クライアント イベント。 コンテンツは、リモート クライアントから受信された内容です。
SeparatedClientPairingEventMap

クライアント マイク ペアリング イベント マップ。
SeparatedClientPairingEventType

クライアント マイクのペアリング イベントの種類
PreferredMicrophone

ユーザーの優先マイクに関する情報。
FieldDelimiterPreferences

UserPreferences 型の一部である FieldDelimiterPreferences オブジェクトの型定義。
NavigationOptions

ナビゲーション オプション。
AmbientEvents

アンビエント記録イベント。
AmbientRecording

1 つのアンビエント記録を表します。
AmbientRecordingUploadStatus

停止したアンビエント記録に対して可能なアップロード状態を定義します。

  • "uploading": オーディオ データは現在サーバーにアップロードされています。
  • "uploadCompleted": すべてのオーディオ データが正常にアップロードされ、サーバーによって確認されました。
  • "uploadFailed": オーディオのアップロードに失敗し、サーバーに到達できませんでした。

この状態を含むイベントの詳細については、 AmbientRecordingUploadStatusChangedDetail を参照してください。
AmbientRecordingUploadStatusChangedDetail

アンビエント記録が完了したタイミングのイベントの詳細。
AmbientSessionData

アンビエント記録セッションに使用するデータ。
AmbientSessionIdChangedDetail

ambientSessionIdChanged イベントのイベントの詳細。
DataOrigin

患者データと EHR データのデータの原点値。
EhrData

EHR 固有の識別子。
Gender

患者情報の性別値。
LocaleInfo

出会いの言語情報を定義します。
Patient

患者識別子。
PronounPreference

患者の代名詞の好み。
CommonRecordingOptions

記録関連機能の一般的なオプション。
DictationEvents

ディクテーション イベント。
DictationProcessingFinishedForElementDetail

特定の要素の処理が停止したときのイベントの詳細。
DictationProcessingStartedForElementDetail

特定の要素の処理が開始されたときのイベントの詳細。
DisableRecordingOptions

記録を無効にするオプション。
EnableRecordingOptions

記録を有効にするオプション。
RecordingEvents

イベントの記録。
RecordingMode

記録モード。
RecordingStartedDetail

記録の開始時のイベントの詳細。
RecordingStoppedDetail

記録が停止したときのイベントの詳細。
RecordingVolumeChangedDetail

ボリュームを記録するためのイベントの詳細。
StartRecordingOptions

記録を開始するためのオプション。
StopRecordingOptions

記録を停止するためのオプション。
ToggleRecordingOptions

記録を切り替えるオプション。
SettingViewNavigationRequestedDetail

settingViewsNavigated イベントのイベントの詳細。
SettingViewsEvents

ビュー イベントの設定。
SettingViewsUrls

ビューの URL の設定。
SpeechOptions

音声認識の設定。
SpeechTopic

音声認識のトピック (専門)。 定義済みのトピックまたは任意のカスタム文字列のいずれかを指定できます。

定義済みの医療ドメインのトピックについては、 <xref:Topics> を参照してください。
AdditionalSystemCommandSpokenForms

組み込みの SystemCommand 名から、追加の音声形式の配列へのマッピング。 元の組み込みの読み上げフォームを保持しながら、同じシステム コマンドをトリガーするカスタム 音声フォームを追加できます。

例

const additionalForms: AdditionalSystemCommandSpokenForms = {
  scratchThat: ["erase that", "remove that"],
  goToNextField: ["next section", "next element"]
};
BrowserCompatibilityStatus

ブラウザーのサポート状態、バージョンの詳細、および互換性の問題に関する情報が含まれています。
ClientType

モバイル マイク アプリケーションで使用できるモードを定義します。

  • "VuiForm": アプリケーションは音声フォームを使用し、モバイル マイク入力が必要です。
  • "Audio": アプリケーションはマイク機能のみを提供します。
ConsoleLoggerOptions

SDK のコンソール ロガーの構成オプション。
DragonEventTarget

イベント リスナーの追加と削除のみを許可する EventTarget。 イベントをディスパッチする方法は提供されません。
ElementDetail

要素または外部コントロールを識別するために使用される情報が含まれます。
Events

SDK の最上位レベルのイベント。
InitializationOptions

SDK を初期化するためのオプション。
LogLevel

使用可能なログ レベルを表す共用体の種類。
ServiceConfig

SDK で使用されるバックエンド サービスの構成。 各サービスには、認証用の URL と OAuth スコープが必要です。
SystemCommand

システム コマンド

関数

destroy()

Dragon Copilot SDK によって使用されるリソースを非同期的にクリーンアップします。

この関数は、リソースを解放し、必要なクリーンアップを実行します。 正常に破棄された場合はデバッグ メッセージをログに記録し、例外が発生した場合はエラーをログに記録します。
initialize(InitializationOptions)

指定されたオプションを使用して、Dragon Copilot SDK for JavaScript を初期化します。
isBrowserSupported()

ブラウザーの種類とバージョンがサポートされているかどうかを確認します。
removeInjectedMarkup(null | Document | Element | Element[])

Dragon Copilot SDK によってコンテナーに追加された挿入された要素または属性を削除します。
setControlFocusContext(FocusContext, number)

SDK の現在の音声フォーカス コンテキストを更新します。

この関数は、音声フォーカス コンテキストの変更について SDK に通知し、フォーカスが Web コントロールにあるか外部コントロールにあるかに基づいて音声入力とコマンドを適切に処理できるようにします。

変数

ClientTypes

ClientTypes の型定義。
FocusContexts

音声フォーカス コンテキスト値。 音声フォーカスが Web コンテキスト内にあるか、外部コントロール コンテキスト内にあるかを示します。
LogLevels

コンソール ログに使用できるログ レベル。 SDK のログ記録の詳細度を制御するために使用されます。
SystemCommands

使用可能なシステム コマンド。
events

最上位レベルのイベントのリスナーのみ EventTarget。

関数の詳細

destroy()

Dragon Copilot SDK によって使用されるリソースを非同期的にクリーンアップします。

この関数は、リソースを解放し、必要なクリーンアップを実行します。 正常に破棄された場合はデバッグ メッセージをログに記録し、例外が発生した場合はエラーをログに記録します。

function destroy(): Promise<void>

戻り値

Promise<void>

initialize(InitializationOptions)

指定されたオプションを使用して、Dragon Copilot SDK for JavaScript を初期化します。

function initialize(options: InitializationOptions): Promise<void>

パラメーター

options
InitializationOptions

初期化オプション。

戻り値

Promise<void>

isBrowserSupported()

ブラウザーの種類とバージョンがサポートされているかどうかを確認します。

function isBrowserSupported(): boolean

戻り値

boolean

現在のブラウザーの種類とバージョンがサポートされている場合は True。

removeInjectedMarkup(null | Document | Element | Element[])

Dragon Copilot SDK によってコンテナーに追加された挿入された要素または属性を削除します。

function removeInjectedMarkup(container: null | Document | Element | Element[]): Document | Element | Element[] | null

パラメーター

container

null | Document | Element | Element[]

複製されたドキュメント、disconnected(cloned) html 要素の配列、または disconnected(cloned) html 要素のいずれか。

戻り値

Document | Element | Element[] | null

SDK によって追加されたすべての要素と属性が削除されたコンテナー。クリーンアップが失敗した場合は null。

setControlFocusContext(FocusContext, number)

SDK の現在の音声フォーカス コンテキストを更新します。

この関数は、音声フォーカス コンテキストの変更について SDK に通知し、フォーカスが Web コントロールにあるか外部コントロールにあるかに基づいて音声入力とコマンドを適切に処理できるようにします。

function setControlFocusContext(focusContext: FocusContext, timestamp: number)

パラメーター

focusContext

FocusContext

現在のフォーカス コンテキスト (Web または外部)

timestamp

number

フォーカス コンテキストが変更されたときのタイムスタンプ (ミリ秒単位)

Variable Details

ClientTypes

ClientTypes の型定義。

ClientTypes: Readonly<{ Audio: "Audio", VuiForm: "VuiForm" }>

型

Readonly<{ Audio: "Audio", VuiForm: "VuiForm" }>

FocusContexts

音声フォーカス コンテキスト値。 音声フォーカスが Web コンテキスト内にあるか、外部コントロール コンテキスト内にあるかを示します。

FocusContexts: Readonly<{ External: "external", Web: "web" }>

型

Readonly<{ External: "external", Web: "web" }>

LogLevels

コンソール ログに使用できるログ レベル。 SDK のログ記録の詳細度を制御するために使用されます。

LogLevels: Readonly<{ Debug: "debug", Error: "error", Exclusive: "exclusive", Info: "info", Trace: "trace", Warning: "warning" }>

型

Readonly<{ Debug: "debug", Error: "error", Exclusive: "exclusive", Info: "info", Trace: "trace", Warning: "warning" }>

SystemCommands

使用可能なシステム コマンド。

SystemCommands: Readonly<{ BeginningOfField: "beginningOfField", CompoundThat: "compoundThat", EndOfField: "endOfField", GoToFirstField: "goToFirstField", GoToLastField: "goToLastField", GoToNextField: "goToNextField", GoToPreviousField: "goToPreviousField", Redo: "redo", ScratchThat: "scratchThat", Undo: "undo" }>

型

Readonly<{ BeginningOfField: "beginningOfField", CompoundThat: "compoundThat", EndOfField: "endOfField", GoToFirstField: "goToFirstField", GoToLastField: "goToLastField", GoToNextField: "goToNextField", GoToPreviousField: "goToPreviousField", Redo: "redo", ScratchThat: "scratchThat", Undo: "undo" }>

events

最上位レベルのイベントのリスナーのみ EventTarget。

events: DragonEventTarget<Events>

型

DragonEventTarget<Events>