Android SDK の API リファレンス - Intelligent Media Services - Alibaba Cloud ドキュメントセンター

このトピックでは、Android ソフトウェア開発キット (SDK) の API 操作について説明します。

API の概要

クラス/プロトコル	API	説明
*ARTCAIChatEngine* 会話エンジンのインターフェイスを定義します。	setEngineCallback	会話エンジンのコールバックを登録します。
	destory	リソースを解放します。
	setTemplateConfig	会話設定のパラメーターを設定します。この操作はオプションです。
	setUserData	カスタムユーザー情報を設定します。この情報は、カスタム拡張フィールドとしてエージェントに渡されます。
	startChat	チャットを開始します。
	endChat	チャットを終了します。
	sendMessage	テキストメッセージを送信します。
	startPushVoiceMessage	プッシュツートークの音声メッセージングを開始します。
	finishPushVoiceMessage	プッシュツートークの音声メッセージングを終了します。
	cancelPushVoiceMessage	プッシュツートークの音声メッセージングをキャンセルします。
	interruptAgentResponse	エージェントの出力を中断します。
	deleteMessage	メッセージを削除します。
	queryMessageList	履歴メッセージのリストをクエリします。
	getAgentInfo	エージェント情報を取得します。
	startPlayMessage	メッセージの音声合成再生を開始します。
	stopPlayMessage	音声合成の再生を停止します。
	isPlayingMessage	音声合成の再生が進行中かどうかを確認します。
	getVoiceList	利用可能な音声合成ボイスのリストを取得します。
	getCurrentVoice	現在の音声合成ボイスを取得します。
	getCurrentAIChatAgentState	エージェントの現在の応答状態を取得します。
	createAttachmentUploader	添付ファイルアップローダーオブジェクトを作成します。添付ファイルには、イメージやファイルなどのアイテムを含めることができます。
	getEngineState	エンジンの現在の状態を取得します。
	parseShareConfig	共有エージェントの情報を解析します。
	generateShareAgentChat	共有エージェントとの会話を開始します。
*IARTCAIChatEngineCallback* 会話エンジンのコールバックイベント。	onRequestAuthToken	認証トークンをリクエストします。これは必須のコールバックです。
	onEngineStateChange	エンジン状態が変化したときにトリガーされます。
	onReceivedMessage	メッセージが受信されたときにトリガーされます。
	onUserMessageUpdated	ユーザーが送信したメッセージのフィールドが更新されたときにトリガーされます。
	onAgentResponseStateChange	エージェントの応答状態が変化したときにトリガーされます。
	onMessagePlayStateChange	音声合成の再生状態が変化したときにトリガーされます。
	onErrorOccurs	エラーが発生しました。
	onReceivedCustomMessage	カスタムメッセージが受信されたときにトリガーされます。
*ARTCAIChatAttachmentUploader* 添付ファイルアップローダークラス。	registerAttachmentUploadCallback	添付ファイルのアップロードコールバックを登録します。
	addAttachment	添付ファイルオブジェクトを追加します。
	removeAttachment	添付ファイルオブジェクトを削除します。
	getAttachmentList	添付ファイルのリストを取得します。
	allUploadSussess	すべての添付ファイルが正常にアップロードされたかどうかを確認します。
*IARTCAIChatAttachmentUploadCallback* 添付ファイルのアップロード進行状況コールバッククラス。	onSuccess	アップロードが成功したときにトリガーされます。
	onFailure	アップロードが失敗したときにトリガーされます。
	onProgress	アップロードの進行状況を報告します。

API の詳細

ARTCAIChatEngine の詳細

setEngineCallback

コールバックを登録します。

/**
* コールバックを登録します。
* @param engineCallback
*/
public abstract void setEngineCallback(ARTCAIChatEngine.IARTCAIChatEngineCallback engineCallback);

パラメーター:

パラメーター	型	説明
engineCallback	IARTCAIChatEngineCallback	エンジンコールバック。

destory

リソースを解放します。

 /**
* リソースを解放します。
*/
public abstract void destory();

setTemplateConfig

会話設定のパラメーターを設定します。ビジネスパラメーターを設定する必要がない場合は、この操作をスキップできます。

public abstract void setTemplateConfig(ARTCAIChatTemplateConfig templateConfig);

パラメーター:

パラメーター	タイプ	説明
templateConfig	ARTCAIChatTemplateConfig	会話の TemplateConfig パラメーター。

setUserData

カスタムユーザー情報を設定します。この情報は、カスタム拡張フィールドとしてエージェントに渡されます。

public abstract void setUserData(String userData); // ユーザー定義データを設定します。

パラメーター:

パラメーター	タイプ	説明
userData	String	カスタムユーザー情報。

startChat

チャットを開始します。

/**
     * チャットを開始します。
     * @param userInfo
     * @param agentInfo
     * @param sessionId 現在のセッションの一意の ID。このパラメーターを空のままにすると、一意の ID はユーザー ID とエージェント ID の組み合わせになります。
     */
    public abstract void startChat(ARTCAIChatUserInfo userInfo, ARTCAIChatAgentInfo agentInfo, String sessionId);

パラメーター:

パラメータ	型	説明
userInfo	ARTCAIChatUserInfo	ユーザー情報。ユーザー ID は空にできません。ビジネスのユーザー ID を使用できます。
agentInfo	ARTCAIChatAgentInfo	エージェント情報。エージェント ID は空にできません。
sessionId	String	現在のセッションの一意の ID。このパラメーターを空のままにすると、一意の ID はユーザー ID とエージェント ID の組み合わせになります。セッション ID は、ユーザーとエージェント間のすべてのチャットレコードを関連付けるために使用されます。

endChat

チャットを終了します。

    /**
     * チャットを終了します。
     * @param needLogout
     */
    public abstract void endChat(boolean needLogout);

パラメーター:

パラメーター	型	説明
needLogout	boolean	チャットを終了してインスタントメッセージング (IM) サービスからログアウトするかどうかを指定します。

sendMessage

テキストメッセージを送信します。

 /**
 * テキストメッセージを送信します。
 * @param request
 */
public abstract void sendMessage(ARTCAIChatSendMessageRequest request, IARTCAIChatMessageCallback callback);

パラメーター:

パラメーター	型	説明
request	ARTCAIChatSendMessageRequest	メッセージを送信するためのリクエスト。
callback	IARTCAIChatMessageCallback	テキストメッセージを送信するためのコールバック。

startPushVoiceMessage

プッシュツートークの音声メッセージングを開始します。

/**
* プッシュツートークを開始します。
* @param request
*/
public abstract boolean startPushVoiceMessage(ARTCAIChatSendMessageRequest request);

パラメーター:

パラメータ	型	説明
request	ARTCAIChatSendMessageRequest	メッセージを送信するリクエスト。

finishPushVoiceMessage

プッシュツートークの音声メッセージングを終了します。

    /**
     * プッシュツートークを終了します。
     * @param callback
     */
    public abstract void finishPushVoiceMessage( IARTCAIChatMessageCallback callback);

パラメーター:

パラメータ	型	説明
request	IARTCAIChatMessageCallback	プッシュツートーク音声メッセージを送信するためのコールバック。

cancelPushVoiceMessage

プッシュツートークの音声メッセージングをキャンセルします。

    /**
     * プッシュツートークをキャンセルします。
     */
    public abstract void cancelPushVoiceMessage();

interruptAgentResponse

エージェントの出力を中断します。

    /**
     * エージェントの出力を中断します。
     */
    public abstract void interruptAgentResponse();

deleteMessage

メッセージを削除します。

    /**
     * メッセージを削除します。
     * @param message
     */
    public abstract void deleteMessage(ARTCAIChatMessage message, IARTCAIChatMessageCallback callback);

パラメーター:

パラメータ	型	説明
message	ARTCAIChatMessage	削除するメッセージレコード。
callback	IARTCAIChatMessageCallback	メッセージを削除するためのコールバック。

queryMessageList

履歴メッセージのリストをクエリします。

 /**
  * 履歴メッセージのリストをクエリします。
  * @param request リクエストモデル。
  * @param callback
  */
public abstract void queryMessageList(ARTCAIChatMessageListRequest request, IARTCAIChatHistoryMessageCallback callback);

パラメーター:

パラメータ	型	説明
message	ARTCAIChatMessageListRequest	履歴メッセージのリストをクエリするリクエスト。
callback	IARTCAIChatHistoryMessageCallback	履歴メッセージのリストをクエリするためのコールバック。

getAgentInfo

エージェント情報を取得します。

/**
 * エージェント情報を取得します。
 */
public abstract ARTCAIChatAgentInfo  getAgentInfo();

startPlayMessage

メッセージの音声合成再生を開始します。

/**
 * 音声合成の再生を開始します。
 * @param message 再生するメッセージ。
 * @param voiceId 再生するボイス。
 * @param callback コールバックメッセージ。
 */
 public abstract void startPlayMessage(ARTCAIChatMessage message, String voiceId, IARTCAIChatMessageCallback callback);

パラメーター:

パラメーター	型	説明
message	ARTCAIChatMessage	音声合成再生を開始するメッセージ。
voiceId	String	再生用の音声。
callback	IARTCAIChatMessageCallback	音声合成再生のコールバック。

stopPlayMessage

音声合成の再生を停止します。

 /**
  * メッセージ内容の再生を停止します。
  */
public abstract void stopPlayMessage();

isPlayingMessage

音声合成の再生が進行中かどうかを確認します。

 /**
  * 音声合成の再生が進行中かどうかを確認します。
  */
  public abstract boolean isPlayingMessage(String messageId);

パラメーター:

パラメーター	型	説明
messageId	String	現在のメッセージが音声合成再生中かどうかを指定します。

getVoiceList

ボイスリスト

 
/**
 * 利用可能なボイスのリスト。
 */
public abstract List<String> getVoiceList();

getCurrentVoice

現在のボイス

 
/**
 * 現在のボイス。
 */
public abstract String getCurrentVoice();

getCurrentAIChatAgentState

エージェントの現在の応答状態を取得します。

 

/**
 * エージェントの現在の応答状態を取得します。
 */
public abstract ARTCAIChatAgentState getCurrentAIChatAgentState();

createAttachmentUploader

添付ファイルアップローダーオブジェクトを作成します。添付ファイルには、イメージやファイルなどのアイテムを含めることができます。

/**
  * 添付ファイルアップローダーオブジェクトを作成します。オブジェクトは 1 つだけ作成できます。
  * @return
*/
public abstract ARTCAIChatAttachmentUploader createAttachmentUploader()

getEngineState

エンジンの現在の状態を取得します。


 /**
  * エンジンの現在の状態を取得します。
  */
public abstract ARTCAIChatEngineState getEngineState();

parseShareConfig

共有エージェントの情報を解析します。


/**
 * 共有エージェントの情報を解析します。
 * @param shareInfo
 * @return
 */
public abstract ARTCAIChatAgentShareConfig parseShareConfig(String shareInfo);

パラメーター:

パラメーター	型	説明
shareInfo	String	共有エージェントの文字列。

generateShareAgentChat

チャットを開始します。

/**
 * 共有エージェントとの会話を開始します。
 * @param shareConfig
 * @param userId
 * @param callback
 */
 public abstract void generateShareAgentChat(ARTCAIChatAgentShareConfig shareConfig, String userId, IARTCAIChatGenerateShareAgentCallback callback);

パラメーター:

パラメータ	タイプ	説明
shareConfig	ARTCAIChatAgentShareConfig	共有エージェントの設定情報。
userId	String	ユーザー ID。
callback	IARTCAIChatGenerateShareAgentCallback	共有エージェントのコールバック。

IARTCAIChatEngineCallback の詳細

onRequestAuthToken

認証トークンをリクエストします。これは必須のコールバックです。アプリサーバーまたはビジネスサーバーで generateMessageChatToken OpenAPI 操作を呼び出して、トークンを取得します。AICall SDK はこのトークンを認証に使用します。

/**
 * 認証トークンをリクエストします。
 * @param userId
 * @param callback
*/
public void onRequestAuthToken(String userId, IARTCAIChatAuthTokenCallback callback);

パラメーター:

パラメーター	型	説明
userId	String	ユーザー ID です。
callback	IARTCAIChatAuthTokenCallback	トークンを取得するためのコールバック。

onEngineStateChange

エンジン状態が変化したときにトリガーされます。

/**
 * エンジン状態が変化したときにトリガーされます。
 *
 * @param oldState 変更前のエンジンの状態。
 * @param newState エンジンの新しい状態。
 */
public void onEngineStateChange(ARTCAIChatEngineState oldState, ARTCAIChatEngineState newState);

パラメーター:

パラメーター	型	説明
oldState	ARTCAIChatEngineState	変更前のエンジンの状態。
newState	ARTCAIChatEngineState	エンジンの新しい状態。

onReceivedMessage

メッセージが受信されたときにトリガーされます。

/**
 * メッセージが受信されたときにトリガーされます。
 * このメソッドは、受信した ARTCAIChatMessage オブジェクトを処理します。ここでメッセージロジックを実装できます。
 * たとえば、インターフェイスにメッセージを表示したり、他の処理を実行したりできます。
 *
 * @param message 受信したメッセージオブジェクト。メッセージの内容やその他の関連情報が含まれます。
 */
 public void onReceivedMessage(ARTCAIChatMessage message);

パラメーター:

パラメーター	型	説明
message	ARTCAIChatMessage	受信したメッセージオブジェクト。メッセージの内容やその他の関連情報が含まれます。

onUserMessageUpdated

ユーザーが送信したメッセージのフィールドが更新されたときにトリガーされます。

/**
 * ユーザーが送信したメッセージのフィールドが更新されたときにトリガーされます。
 *
 * @param message ユーザーが送信したメッセージ。
 */
public void onUserMessageUpdated(ARTCAIChatMessage message);

パラメーター:

パラメーター	型	説明
message	ARTCAIChatMessage	ユーザーが送信したメッセージ。

onAgentResponseStateChange

エージェントの応答状態が変化したときにトリガーされます。

 /**
  * エージェントの応答状態が変化したときにトリガーされます。
  *
  * @param agentState エージェントの新しい状態。
  * @param requestId 応答状態の変更に関連する文 ID。
  */
public void onAgentResponseStateChange(ARTCAIChatAgentState agentState, String requestId);

パラメーター:

パラメーター	型	説明
agentState	ARTCAIChatAgentState	エージェントの状態。
requestId	String	対応するリクエスト。これは空にすることができます。

onMessagePlayStateChange

音声合成の再生状態が変化したときにトリガーされます。

 /**
  * 音声合成の再生状態が変化したときにトリガーされます。
  *
  * @param message メッセージオブジェクト。
  * @param state メッセージの再生状態。
*/
public void onMessagePlayStateChange(ARTCAIChatMessage message, ARTCAIChatMessagePlayState state);

パラメーター:

パラメーター	型	説明
message	ARTCAIChatMessage	音声合成再生用のメッセージオブジェクト。
state	ARTCAIChatMessagePlayState	メッセージの再生状態。

onErrorOccurs

エラーが発生しました。

 /**
  * エラーが発生しました。
  * @param error
  * @param requestId
 */
public void onErrorOccurs(ARTCAIChatError error, String requestId)

パラメーター:

パラメーター	型	説明
error	ARTCAIChatError	エラー情報。
requestId	String	対応するリクエスト。これは空にすることができます。

onReceivedCustomMessage

カスタムメッセージが受信されたときにトリガーされます。

/**
 * カスタムメッセージが受信されます。
 * このコールバックは、OpenAPI 操作を呼び出してカスタムメッセージを送信するときにトリガーされます。AICall SDK はこのメッセージを受信します。
 * @param text カスタムメッセージ。
 */
public void onReceivedCustomMessage(String  text)

パラメーター:

パラメーター	タイプ	説明
text	String	受信したカスタムメッセージ。

ARTCAIChatAttachmentUploader

registerAttachmentUploadCallback

添付ファイルのアップロードコールバックを登録します。

 /**
   * 添付ファイルのアップロードコールバックを登録します。
   * @param callback
   */
public abstract void registerAttachmentUploadCallback(ARTCAIChatAttachmentUploader.IARTCAIChatAttachmentUploadCallback callback);

パラメーター:

パラメーター	型	説明
callback	IARTCAIChatAttachmentUploadCallback	添付ファイルのアップロード結果のコールバック。

addAttachment

添付ファイルオブジェクトを追加します。

 /**
   * 添付ファイルを追加します。
   * @param attachment
   */
public  abstract void addAttachment(ARTCAIChatAttachmentUploader.ARTCAIChatAttachment attachment);

パラメーター:

パラメーター	型	説明
attachment	ARTCAIChatAttachment	添付ファイルオブジェクト。

removeAttachment

添付ファイルオブジェクトを削除します。

 /**
   * 添付ファイルを削除します。
   * @param attachment
   */
public  abstract void removeAttachment(ARTCAIChatAttachmentUploader.ARTCAIChatAttachment attachment);

パラメーター:

パラメーター	型	説明
attachment	ARTCAIChatAttachment	添付ファイルオブジェクト。

getAttachmentList

添付ファイルのリストを取得します。

 /**
   * 添付ファイルのリストを取得します。
   */
public abstract List<ARTCAIChatAttachment> getAttachmentList()

allUploadSussess

すべての添付ファイルが正常にアップロードされたかどうかを確認します。

 /**
   * すべての添付ファイルがアップロードされたかどうかを確認します。
   */
 public abstract boolean allUploadSussess();

IARTCAIChatAttachmentUploadCallback

onSuccess

アップロードが成功したときにトリガーされます。

/**
  * アップロードは成功です。
 */
public void onSuccess(ARTCAIChatAttachment attachment) {}

onFailure

アップロードに失敗したときにトリガーされます。

 /**
   * アップロードが失敗しました。
   * @param error 返されるエラー情報。
   */
public void onFailure(ARTCAIChatAttachment attachment, ARTCAIChatEngine.ARTCAIChatError error) {}

パラメーター：

パラメーター	型	説明
attachment	ARTCAIChatAttachment	添付ファイルオブジェクト。
error	ARTCAIChatError	アップロードが失敗した理由。

onProgress

アップロードの進行状況を報告します。

 /**
   * アップロードの進行状況。
   * @param progress
   */
public void onProgress(ARTCAIChatAttachment attachment, int progress) {}

パラメーター:

パラメーター	型	説明
attachment	ARTCAIChatAttachment	添付ファイルオブジェクト。
progress	int	アップロードの進行状況。有効な値: 0 ～ 100。