Constructor

Uneeqクラスは、以下のコンストラクタでインスタンス化されます。

constructor(options);

パラメータ

options (Object): Uneeqインスタンスを初期化するための設定オプション。

Options

Uneeqクラスを初期化する際に渡すことができる設定オプション。

autoStart

（オプション）セッションを自動的に開始するかどうかを示すブール値。このオプションを設定すると、ページの読み込み時にstartSession()を呼び出すことなくセッションが自動的に開始されます。デフォルト値はfalseです。

autoStart: false

cameraAnchorHorizontal

（オプション）セッション開始時のカメラアンカーの初期水平位置を定義する文字列。

値:

left

right

center

cameraAnchorPosition: "right"

cameraAnchorDistance

(任意) セッション開始時のカメラアンカーの初期距離（ズーム）を定義する文字列。

値:

close_up

loose_close_up

tight_medium_shot

medium_shot

medium_full_shot

full_shot

cameraAnchorPosition: "close_up"

captionsPosition

（オプション）クローズドキャプションの位置を定義する文字列。デフォルト値はbottom-leftです。

値:

bottom-left

bottom-right

bottom

top-left

top-right

top

connectionUrl

（必須）接続エンドポイントの文字列URL。

connectionUrl: "https://api.uneeq.io"

ctaThumbnailUrl

（オプション）コールトゥアクションのサムネイル画像を上書きするためのURL文字列。提供される画像は140pxの正方形の.jpg、.png、または.gif形式である必要があります。

ctaThumbnailUrl: "https://cdn.your-domain.com/image1"

customMetadata

（オプション）すべてのチャットプロンプトまたは音声プロンプトに渡されるJSONデータ。この値は、実行時にsetCustomPromptMetadata()を使用して上書きすることができます。customMetadataを介して設定されたデータは対話プラットフォームに送信され、応答を生成する際に使用されることがあります。

customMetadata: {"name": "John"}

customStyles

（オプション）ホステッドエクスペリエンスフレームに適用されるカスタムCSSを定義する文字列。例えば、ホステッドエクスペリエンスフレーム内のボタンの色を変更する際に使用できます。

customStyles: `h1 { font-size: 150%; }`

displayCallToAction

（オプション）コールトゥアクションを表示するかどうかを示す真偽値。デフォルト値はtrueです。

displayCallToAction: false

enableMicrophone

（オプション）セッション開始時にマイクの許可を要求するかどうかを示す真偽値。デフォルト値はfalseです。

enableMicrophone: true

enableVad

（オプション）音声アクティビティ検出（VAD）を有効にするかどうかを示す真偽値。VADを使用すると、ユーザーは録音の開始/停止ボタンを押すことなく話すことができます。この値をfalseに設定すると、ユーザーは押して話す必要があります。デフォルト値はtrueです。

enableVad: false

initLoadHandler

（オプション）デジタルヒューマンフレームをページ読み込み時に初期化するかどうかを示す真偽値。この値がtrueの場合、ページ読み込み時に（ページロードイベントハンドラーを通じて）デジタルヒューマンフレームが初期化されます。この値がfalseの場合、デジタルヒューマンフレームはページ読み込み時に追加されません。

この値をfalseに設定した場合、デジタルヒューマンフレームをロードしたいときにuneeq.init()を自分で呼び出す必要があります。これは、特定のデータの取得やアクションの実行を待つため、デジタルヒューマンスクリプトの読み込みを遅延または防止したい場合に望ましい設定です。

デフォルト値はtrueです。

initLoadHandler: false

languageStrings

（オプション）languageStringsプロパティを定義することで、ホステッドエクスペリエンスインターフェース内で表示されるテキストを更新できます。languageStringsオブジェクトには、ISO-639-1言語コード（例：en、es、jaなど）に対応する値を含める必要があります。各言語コード値には、更新したい値のキーを含むオブジェクトを提供します。また、より正確な言語ターゲット設定のために、en-US、en-GB、de-DE、pt-BRなどの特定のロケール/地域を指定することもできます。

ユーザーがデジタルヒューマンエクスペリエンスをロードする際、ブラウザはユーザーの好みの言語リスト（優先順の配列）を提供します。ホステッドエクスペリエンスは、ユーザーのブラウザで設定された言語の優先順位に基づいて、提供されたlanguageStringsリストを順に検索し、キーに一致する言語を探します。ブラウザが好みの言語を検出する方法についての詳細はこちらで確認できます。

言語コードが提供されていない場合は、default値が使用されます。default設定が指定されていない場合は、ホステッドエクスペリエンスの基本値が使用されます。

languageStringsキーの完全なリストは、こちらで確認できます: 表示文字列（多言語対応）

languageStrings: {
	es: {
		callToActionText: "¡Hola! Haga clic aquí para iniciar una conversación.e",
		textInputPlaceholder: "Escriba aquí...",
	},
	ja: {
		callToActionText: "やあ！会話を始めるにはここをクリックしてください。",
		textInputPlaceholder: "ここに入力...",
	},
	"de-DE": {
		callToActionText: "Hi! Klicken Sie hier, um ein Gespräch zu beginnen.",
		textInputPlaceholder: "Geben Sie hier ein ...",
	},
	default: {
		callToActionText: "Hi! Click here to start a conversation.",
		textInputPlaceholder: "Type here...",
	},
}

layoutMode

（オプション）レイアウトモードを定義する文字列。

オーバーレイ:

値: overlay

デジタルヒューマンをユーザーの画面の右下に小さくオーバーレイ表示します。このビューは、ユーザーが閲覧中のウェブサイトを引き続き見る必要がある場合に最適です。

フルスクリーン:

値: fullScreen

デジタルヒューマンをユーザーの画面全体を覆うビューで表示します。ユーザーはホスティングウェブサイトを閲覧または操作することができません。このビューは、没入型のデジタルヒューマン体験に最適です。

コンテインド:

デジタルヒューマンを、クライアントがページに追加し制御するHTMLのdivコンテナ要素内に表示します。このレイアウトモードを使用するには、ページ上にidがuneeqContainedLayoutのdiv要素が必要です。デジタルヒューマンはこのコンテナ内でレンダリングされ、クライアントはコンテナを再スタイルすることができます。たとえば、クライアントはコンテナの移動、サイズ変更、表示非表示をコンテキストに応じて行えます。

注意: コンテナ要素はセッションを終了せずにDOMから削除することはできません。

layoutMode: "overlay"

logLevel

（オプション）目的のログレベルを定義する文字列。低いログレベルを選択すると、それより上のすべてのログレベルが含まれます。たとえば、infoを使用すると、それより上のwarn、error、fatalなどのログレベルも含まれます。ホステッドエクスペリエンスからのログを最小限にするには、errorを使用してください。

値:

error: エラーが発生し、処理が中断される可能性がある重大な問題を示します。

warn: 警告を示し、潜在的な問題があるが、処理は続行できる状況を指します。

info: システムやアプリケーションの一般的な動作状況を示す情報を記録します。

debug: デバッグ目的で使用され、詳細な診断情報を提供します。

trace: トレース情報を記録し、システムの詳細な内部動作を追跡するのに用いられます。

logLevel: "warn"

personaId

（必須）開始するデジタルヒューマンのID。この値は、アドミンポータルのデジタルヒューマンページからコピーできます。

personaId: "323d5c36-e01c-4c0d-9ef5-2c00de4aa166"

renderContent

（オプション）デジタルヒューマンフレーム内にHTMLコンテンツをレンダリングするかどうかを示すブール値。このオプションをfalseに設定した場合、クライアント実装でHTMLコンテンツメッセージを受け取り、独自のビュー内でコンテンツをレンダリングすることができます。

renderContent: false

showClosedCaptions

（オプション）ビュー内にクローズドキャプションを表示するかどうかを示すブール値。この設定が無効の場合、クライアントはイベントをキャッチして、独自にクローズドキャプションをレンダリングすることができます。デフォルト値はtrueです。

showClosedCaptions: false

showUserInputInterface

（オプション）テキストメッセージを入力するためのテキスト入力要素とマイクのミュートボタンを含むユーザー入力インターフェースを表示するかどうかを示すブール値。この設定が無効な場合、UneeQフレーム外で独自の入力インターフェースを実装することを選択できます。

showUserInputInterface: true

speechRecognitionHintPhrases

（オプション）スピーチ認識システムに予想される単語についてのヒントを与えるためのフレーズをカンマで区切った文字列。このヒントフレーズを提供することで、スピーチ認識システムでそれらがより検出されやすくなります。

speechRecognitionHintPhrases: "uneeq,digital humans"

speechRecognitionHintPhrasesBoost

（オプション）音声内でヒントフレーズの単語が検出される可能性を高めるために使用できる0から20までの整数。

speechRecognitionHintPhrasesBoost: 10

speechRecognitionLocales

（オプション）このオプションは、デジタルヒューマンが人の話す言語を理解するために最大4つのロケールを指定します（音声認識）。ロケールはBCP-47形式で指定し、例としては"en-US"などがあります。最初のロケールが主要なロケールと見なされます。ロケールはコロンで区切って指定してください。

speechRecognitionLocales: ja-JP:en-US:en-GB:en-AU

音声認識のロケールコードの変更を行う場合は、会話AIやRAG、音声合成のロケールの統一対応など調整を行ってください。

認識させたい言語	ロケールコード/BCP-47
日本語	`ja-JP`
英語（オーストラリア）	`en-AU`
英語（カナダ）	`en-CA`
英語（インド）	`en-IN`
英語（ニュージーランド）	`en-NZ`
英語（英国）	`en-GB`
英語（米国）	`en-US`
中国語（簡体字、中国本土）	`cmn-Hans-CN`
中国語（繁体字、台湾）	`cmn-Hant-TW`
韓国語（韓国）	`ko-KR`
タイ語（タイ）	`th-TH`
ベトナム語（ベトナム）	`vi-VN`
その他	対応言語

welcomePrompt

（オプション）セッション開始時に会話（LLM）システムに送信されるプロンプト。デフォルト値は"Hello"です。

注: この値は、セッション開始時にユーザーに話されるものではなく、ユーザーから言語モデルに送信されるプロンプト（質問）です。

welcomePrompt: "Hi, can you welcome me and see if I need any help."

コードスニペットサンプル

let uneeqOptions = {
    connectionUrl: "https://api.uneeq.io",
    personaId: "323d5c36-e01c-4c0d-9ef5-2c00de4aa166",
    displayCallToAction: true,
    renderContent: true,
    ctaThumbnailUrl: "https://your-cta-image.com",
    customStyles: "/* Define your own styles */",
    mobileViewWidthBreakpoint: 900,
    layoutMode: "fullScreen",
    cameraAnchorPosition: "loose_close_up",
    logLevel: "info",
    enableMicrophone: false,
    showUserInputInterface: true,
    enableVad: true,
    enableInterruptBySpeech: false,
    autoStart: false,
    containedAutoLayout: true,
    showClosedCaptions: true,
    languageStrings: {
        es: {
            callToActionText: "¡Hola! Haga clic aquí para iniciar una conversación.e",
            textInputPlaceholder: "Escriba aquí...",
        },
        ja: {
            callToActionText: "やあ！会話を始めるにはここをクリックしてください。",
            textInputPlaceholder: "ここに入力...",
        },
        "de-DE": {
            callToActionText: "Hi! Klicken Sie hier, um ein Gespräch zu beginnen.",
            textInputPlaceholder: "Geben Sie hier ein ...",
        },
        default: {
            callToActionText: "Hi! Click here to start a conversation.",
            textInputPlaceholder: "Type here...",
        },
    },
    speechRecognitionLocales: "ja-JP:en-US:en-GB:en-AU",
    speechRecognitionHintPhrases: "uneeq, digital human",
    speechRecognitionHintPhrasesBoost: 20,
};
const uneeq = new Uneeq(uneeqOptions);