相対タイムスタンプを追加するには:

• タイムスタンプの有効化 – enableTimestamp: true
• 相対タイムスタンプの有効化 – timestampType: 'relative'

タイムスタンプ(timestampType: 'relative')を構成すると、一日の最初のメッセージの前にヘッダーとして絶対タイムスタンプが表示されます。このヘッダーは、会話がクリアされておらず、履歴で古いメッセージをまだ確認できる場合に表示されます。

このタイムスタンプは、新しいメッセージが受信されるまで、次の一定間隔(秒数、分数など)で更新されます。

• 最初の10秒間
• 10秒-60秒
• 1分-60分の毎分
• 1時間-24時間の毎時
• 1日-30日の毎日
• 1月-12月の毎月
• 1年目の後の毎年

新しいメッセージがチャットにロードされると、前のメッセージの相対タイムスタンプが削除され、新しいメッセージの新しいタイムスタンプ(前のメッセージに対する相対的な時間を示す)が表示されます。その時点から、次のメッセージが届くまで、この相対タイムスタンプが更新されます。

Bots.shareMenuItems(customItems); APIをコールして、共有メニュー・アイテム・ポップアップを動的に更新できます(customItemsはObjectsのArrayListです)。各オブジェクトの型は、ShareMenuItem列挙値またはShareMenuCustomItemのオブジェクトです。

ArrayList<Object> customItems = new ArrayList<>();
        ShareMenuCustomItem shareMenuCustomItem1  = new ShareMenuCustomItem("pdf bin", "Label1", 1024, R.drawable.odaas_menuitem_share_file);
        ShareMenuCustomItem shareMenuCustomItem2  = new ShareMenuCustomItem("doc", "Label2", R.drawable.odaas_menuitem_share_file);
        ShareMenuCustomItem shareMenuCustomItem3  = new ShareMenuCustomItem("csv");
        customItems.add(shareMenuCustomItem1);
        customItems.add(ShareMenuItem.CAMERA);
        customItems.add(ShareMenuItem.FILE);
        customItems.add(shareMenuCustomItem2);
        customItems.add(shareMenuCustomItem3);
        Bots.shareMenuItems(customItems);

Bots.shareMenuItems(); APIをコールして、共有メニュー・アイテム・リストを取得できます。

Bots.shareMenuItems()

会話は、Bots.endChat() APIをコールして動的に終了することもできます。

Bots.endChat()

テキスト・メッセージをスキルに送信します。textパラメータは、テキスト・メッセージです。

Bots.sendMessage("I want to order a Pizza");

Webビューのリンクの動作を構成するには、linkHandler関数にWebviewLinkHandlerType.WEBVIEWを設定します。webViewConfigクラス・オブジェクトを使用して、Webビュー自体のサイズと表示を設定できます:

BotsConfiguration botsConfiguration = new BotsConfiguration.BotsConfigurationBuilder(<SERVER_URI>, false, getApplicationContext()) // Configuration to initialize the SDK
    .channelId(<CHANNEL_ID>)
    .userId(<USER_ID>)
    .linkHandler(WebviewLinkHandlerType.WEBVIEW)
    .webViewConfig(new WebViewConfig()
                                .webViewSize(WebviewSizeWindow.FULL)
                                .webViewTitleColor(<COLOR_VALUE>)
                                .webviewHeaderColor(<COLOR_VALUE>)
                                .clearButtonLabel(<BUTTON_TEXT>)
                                .clearButtonLabelColor(<COLOR_VALUE>)
                                .clearButtonIcon(<IMAGE_ID>))
    .build();

このコード・スニペットに示すように、Webビューに次の属性を設定できます:

言語タグ(lang)とオプションの表示ラベル(label)で構成されるsupportedLanguage ArrayListを含むオブジェクトでmultiLangChatプロパティを定義することで、ユーザーがドロップダウン・メニューから優先言語を選択できるようにするメニューを有効にできます。この配列の外部で、primaryプロパティを使用してオプションでデフォルト言語を設定できます(次のスニペットではprimary("en"))。

ArrayList<SupportedLanguage> supportedLanguages = new ArrayList<>();
supportedLanguages.add(new SupportedLanguage("en"));
supportedLanguages.add(new SupportedLanguage("fr", "French"));
supportedLanguages.add(new SupportedLanguage("de", "German"));
MultiLangChat multiLangChat = new MultiLangChat().supportedLanguage(supportedLanguages).primary("en");
BotsConfiguration botsConfiguration = new BotsConfiguration.BotsConfigurationBuilder(<SERVER_URI>, false, getApplicationContext()) // Configuration to initialize the SDK
    .channelId(<CHANNEL_ID>)
    .userId(<USER_ID>)
    .multiLangChat(multiLangChat)
    .build();

渡されたサポート対象言語が、チャット・ウィジェットによって、ヘッダーにあるドロップダウン・メニューに表示されます。使用可能な言語に加えて、メニューには「言語の検出」オプションも含まれています。ユーザーがこのメニューから言語を選択すると、現在の会話がリセットされ、選択した言語で新しい会話が開始されます。ユーザーが選択した言語は、同じブラウザではセッションにまたがって継続されるため、チャット・ウィジェットを含むページからユーザーがスキルに再アクセスすると、以前の言語が自動的に選択されます。

複数言語サポートを構成する際には、次の点に注意してください:

• ドロップダウン・メニューを表示するには、少なくとも2つの言語を定義する必要があります。
• primaryキーを省略すると、ウィジェットがユーザー・プロファイルの言語を自動的に検出し、メニューの「言語の検出」オプションを選択します。

渡された言語の他に、チャット・ウィジェットでは、ドロップダウンに「言語の検出」オプションが表示されます。このオプションを選択すると、ユーザーのメッセージから会話の言語を自動的に検出し、可能な場合は同じ言語で応答することがスキルに指示されます。

Bots.shareMenuItems(); APIをコールして、共有メニュー・アイテム・リストを取得できます。

Bots.shareMenuItems()

Bots.shareMenuItems(customItems); APIをコールして、共有メニュー・アイテムのポップアップを動的に更新できます(customItemsはオブジェクトのArrayListです)。各オブジェクトとして使用できるのは、ShareMenuItem列挙値型またはShareMenuCustomItemオブジェクトのいずれかです。

ArrayList<Object> customItems = new ArrayList<>();
ShareMenuCustomItem shareMenuCustomItem1  = new ShareMenuCustomItem("pdf bin", "Label1", 1024, R.drawable.odaas_menuitem_share_file);
ShareMenuCustomItem shareMenuCustomItem2  = new ShareMenuCustomItem("doc", "Label2", R.drawable.odaas_menuitem_share_file);
ShareMenuCustomItem shareMenuCustomItem3  = new ShareMenuCustomItem("csv");
customItems.add(shareMenuCustomItem1);
customItems.add(ShareMenuItem.CAMERA);
customItems.add(ShareMenuItem.FILE);
customItems.add(shareMenuCustomItem2);
customItems.add(shareMenuCustomItem3);
Bots.shareMenuItems(customItems);

クラスは、インタフェースIBotsSpeechListenerを実装し、それに次のメソッドの機能を実装する必要があります:

• void onError(String error)
• void onSuccess(文字列発話)
• void onPartialResult(String utterance)
• void onClose(int code、 Stringメッセージ)
• void onOpen()

パラメータ:

• code – ステータス・コード
• message – 接続をクローズする理由

このメソッドは、ユーザーの音声メッセージに更新がある場合にコールされ、音声ビジュアライザの更新に使用できます。パラメータは、記録されたユーザーの音声のバイト配列であるspeechDataです。

public class BotsSpeechListener implements IBotsSpeechListener {
    @Override
    public void onError(String error) {
            // Handle errors
    }
 
    @Override
    public void onSuccess(String utterance) {
        // This method was deprecated in release 20.8.1.
        // Handle final result
    }
 
 
    @Override
    public void onSuccess(BotsSpeechResult botsSpeechResult) {
        // Handle final result
    }  
 
    @Override
    public void onPartialResult(String utterance) {
        // Handle partial result
    }
 
    @Override
    public void onClose(int code, String message) {
        // Handle the close event of connection to server
    }
 
    @Override
    public void onOpen() {
        // Handle the open event of connection to server
    }
 
 
    @Override
    public void onActiveSpeechUpdate(byte[] speechData) {
        // Handle the speech update event
    }
}
 
 
Bots.startRecording(new BotsSpeechListener()); // Start voice recording
 
if (Bots.isRecording()) {
    Bots.stopRecording(); // Stop voice recording
}

音声合成サービスを初期化します。このメソッドは、アクティビティのonCreate()メソッドでコールして、音声合成サービスを初期化する必要があります。音声合成サービスの初期化は、enableSpeechSynthesis機能フラグがtrueに設定されている場合にのみ、SDKライブラリの初期化時に実行されます。

public class ConversationActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        Bots.initSpeechSynthesisService();
    }
}

スキルのレスポンスの読上げを開始します。textパラメータは、読み上げられるスキルのメッセージのテキストです。

Bots.startBotAudioResponse("What kind of crust do you want?");

スキルのレスポンスの読上げを停止します。

Bots.stopBotAudioResponse()

スキルのレスポンスが現在読み上げられている場合、trueを返します。そうでない場合はfalseを返します。

if (Bots.isSpeaking()) {
    Bots.stopBotAudioResponse();
}

このメソッドは、ConversationActivityのonDestroy()メソッドでコールされます。

public class ConversationActivity extends AppCompatActivity {
    @Override
    protected void onDestroy() {
        super.onDestroy();
        Bots.shutdownBotAudioResponse();
    }
}

SpeechSynthesisServiceインタフェースの実装であるクラスのインスタンスを作成します。次のメソッドを実装します。

• initTextToSpeechService(@NonNull Application application, @NonNull BotsConfiguration botsConfiguration): 新しいTTSサービスを初期化します。

  パラメータ	説明
  application	アプリケーション。これはnullにできません。
  botsConfiguration	ライブラリの機能の制御に使用されるBotsConfigurationオブジェクト。これはnullにできません。

• speak(String phrase): 発話キューに発話されるフレーズを追加します。 phraseパラメータは、話すテキストです。
• isSpeaking(): オーディオ・レスポンスが話されているかどうかを確認します。進行中のオーディオ・レスポンスがない場合、falseを返します。
  ノート
  
  このメソッドは、リリース21.08で非推奨になりました。
• stopTextToSpeech(): 進行中の音声合成を停止します。
  ノート
  
  このメソッドは、リリース21.08で非推奨になりました。
• shutdownTextToSpeech(): TextToSpeechエンジンによって使用されるリソースを解放します。
• getSpeechSynthesisVoicePreferences(): 音声合成に使用される使用可能な音声の最適な一致の選択に使用される音声プリファレンス配列を返します。
• setSpeechSynthesisVoicePreferences(ArrayList<SpeechSynthesisSetting> speechSynthesisVoicePreferences): 音声合成に最適な音声一致を選択するために使用する音声プリファレンス配列を設定します。speechSynthesisVoicePreferencesパラメータは、音声合成の音声プリファレンス配列です。
• onSpeechSynthesisVoicePreferencesChange(ArrayList<SpeechSynthesisSetting> speechSynthesisVoicePreferences): 音声合成音声を最適な音声一致に設定します。
  ノート
  
  このメソッドは、リリース21.08で非推奨になりました。
  このメソッドは、音声プリファレンスArrayListを設定した後、setSpeechSynthesisVoicePreferencesメソッド内でコールすることをお薦めします。speechSynthesisVoicePreferencesパラメータは、音声合成の音声プリファレンス配列です。
• onSpeechRecognitionLocaleChange(Locale speechLocale: このメソッドは、音声認識言語が変更されたときに起動されます。このメソッドをオーバーライドすることで、音声合成言語を音声認識言語と同じ言語に設定できます。speechLocaleパラメータは、音声認識に設定されたロケールです。

   private class TextToSpeechServiceInjection implements SpeechSynthesisService {

        @Override
        public void initTextToSpeechService(@NonNull Application application, @NonNull BotsConfiguration botsConfiguration) {
            // Initialisation of Text to Speech Service.
        }

        @Override
        public void speak(String phrase) {
            // Adds a phrase to the utterance queue to be spoken
        }

        @Override
        public boolean isSpeaking() {
            // Checks whether the bot audio response is being spoken or not.
            return false;
        }

        @Override
        public void stopTextToSpeech() {
            // Stops any ongoing speech synthesis
        }

        @Override
        public void shutdownTextToSpeech() {
            // Releases the resources used by the TextToSpeech engine.
        }

        @Override
        public ArrayList<SpeechSynthesisSetting> getSpeechSynthesisVoicePreferences() {
            // The voice preferences array which is used to choose the best match available voice for speech synthesis.
            return null;
        }

        @Override
        public void setSpeechSynthesisVoicePreferences(ArrayList<SpeechSynthesisSetting> speechSynthesisVoicePreferences) {
            // Sets the voice preferences array which can be used to choose the best match available voice for speech synthesis.
        }

        @Override
        public SpeechSynthesisSetting onSpeechSynthesisVoicePreferencesChange(ArrayList<SpeechSynthesisSetting> speechSynthesisVoicePreferences) {
            // Sets the speech synthesis voice to the best voice match available.
            return null;
        }

        @Override
        public void onSpeechRecognitionLocaleChange(Locale speechLocale) {
            // If the speech recognition language is changed, the speech synthesis language can also be changed to the same language.
        }
    }

すべてのメッセージ(前のメッセージを含む)のユーザー・アバターを設定します。

ConversationActivity.setUserPerson(Object);

エージェントの詳細を含むオブジェクトを返します。

Bots.getAgentDetails(AgentDetails);

AgentDetailsクラスの詳細は、Javadocを参照してください。

サーバーから受信したエージェントの詳細をオーバーライドします。

Bots.setAgentDetails(AgentDetails);

エージェントの詳細を含むオブジェクトを返します。

Bots.getAgentDetails(AgentDetails);

AgentDetailsクラスの詳細は、Javadocを参照してください。