Intelligent Media Services:API 操作の詳細

状態

エンジン接続ステータスを取得します。ARTCAIChatEngineState の詳細については、「ARTCAIChatEngineState」をご参照ください。

var state: ARTCAIChatEngineState { get } // 状態を取得します

userInfo

現在のセッションに参加しているユーザーの情報を取得します。ARTCAIChatUserInfo の詳細については、「ARTCAIChatUserInfo」をご参照ください。

var userInfo: ARTCAIChatUserInfo? { get } // 現在のセッションに参加しているユーザーの情報を取得します。

sessionId

現在のセッションの一意の識別子を取得します。

var sessionId: String? { get } // 現在のセッションの一意の識別子を取得します。

agentInfo

現在のセッションに参加しているエージェントの情報を取得します。ARTCAIChatAgentInfo の詳細については、「ARTCAIChatAgentInfo」をご参照ください。

var agentInfo: ARTCAIChatAgentInfo? { get } // 現在のセッションに参加しているAIエージェントの情報を取得します。

agentResponeState

現在のエージェントの応答ステータスを取得します。ARTCAIChatAgentResponseState の詳細については、「ARTCAIChatAgentResponseState」をご参照ください。

var agentResponeState: ARTCAIChatAgentResponseState { get }

voiceIdList

現在の音声リストを取得します。

var voiceIdList: [String] { get } // voiceIdList を取得します。

デリゲート

コールバックイベントを設定およびクエリします。ARTCAIChatEngineDelegate の詳細については、「ARTCAIChatEngineDelegate」をご参照ください。

weak var delegate: ARTCAIChatEngineDelegate? { get set } // デリゲート。

templateConfig

TemplateConfig を設定および取得します。ARTCAIChatTemplateConfig の詳細については、「ARTCAIChatTemplateConfig」をご参照ください。

var templateConfig: ARTCAIChatTemplateConfig? { get set } // templateConfig: ARTCAIChatTemplateConfig？ を取得および設定します

userData

エージェントに渡されるカスタムユーザー情報。

var userData: [String: Any]? { get set } // ユーザーデータ

startChat

チャットセッションを開始します。

func startChat(userInfo: ARTCAIChatUserInfo, agentInfo: ARTCAIChatAgentInfo, sessionId: String?)

パラメーター:

endChat

チャットセッションを終了します。

func endChat(needLogout: Bool)

パラメーター:

sendMessage

メッセージを送信し、現在の返信を中断します (エージェントが思考中または返信中の場合)。

func sendMessage(request: ARTCAIChatSendMessageRequest, completed:((_ msg: ARTCAIChatMessage?, _ error: NSError?) -> Void)?) // メッセージを送信する関数

パラメーター:

state

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

func deleteMessage(message: ARTCAIChatMessage, completed:((_ error: NSError?) -> Void)?)

パラメーター:

メッセージリストのクエリ

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

func queryMessageList(request: ARTCAIChatMessageListRequest, completed:((_ msgList: [ARTCAIChatMessage]?, _ error: NSError?) -> Void)?) // メッセージリストをクエリする

パラメーター:

interruptAgentResponse

現在のメッセージの返信を中断します。

func interruptAgentResponse()

agentInfo

現在のセッションに参加している AI エージェントに関する情報を取得します。

func deleteMessage(dialogueId: String, completed:((_ error: NSError?) -> Void)?) // メッセージを削除する

パラメーター:

startPlayMessage

メッセージ内容の再生を開始します。

func startPlayMessage(message: ARTCAIChatMessage, voiceId: String?, completed: ((NSError?) -> Void)?) // メッセージの再生を開始

パラメーター:

voiceIdList

メッセージの再生を停止します。

func stopPlayMessage()

delegate

メッセージが再生中かどうかを確認します。func isPlayingMessage(dialogueId: String) -> Bool

func isPlayingMessage(dialogueId: String) -> Bool

templateConfig

画像、動画、またはファイル付きのメッセージを送信するための添付ファイルアップローダーオブジェクトを作成します。

func createAttachmentUploader() -> ARTCAIChatAttachmentUploader?

userData

プッシュツートーク音声メッセージングを開始します。ボタンを押すと録音が開始され、音声がリアルタイムで送信されます。録音権限が有効になっていることを確認してください。

戻り値 true は操作が成功したことを示します。戻り値 false は操作が失敗したことを示します。一般的な原因には、不正なステータスや録音権限が無効になっていることが含まれます。

func startPushVoiceMessage(request: ARTCAIChatSendMessageRequest) -> Bool // 音声メッセージのプッシュを開始する

パラメーター:

finishPushVoiceMessage

プッシュツートーク音声メッセージングを終了します。この操作はボタンを離したときに呼び出され、現在の音声メッセージが送信され、システムがエージェントの応答を待機していることを示します。

func finishPushVoiceMessage(completed:((_ msg: ARTCAIChatMessage) -> Void)?) // プッシュボイスメッセージの完了

パラメーター:

cancelPushVoiceMessage

プッシュツートーク音声メッセージングをキャンセルします。この操作はボタンを離したときに呼び出され、現在の音声メッセージがキャンセルされたことを示します。

func cancelPushVoiceMessage()

破棄する

リソースを解放します。

func destroy() // 破棄する

parseShareAgentChat

共有インテリジェントエージェントに関する情報を解析します。

func parseShareAgentChat(shareInfo: String) -> ARTCAIChatAgentShareConfig?

パラメーター:

generateShareAgentChat

共有インテリジェントエージェントとの通話を開始します。

func generateShareAgentChat(shareConfig: ARTCAIChatAgentShareConfig, userId: String, completed: ((_ agentInfo: ARTCAIChatAgentInfo?, _ authToken: ARTCAIChatAuthToken?, _ error: NSError?, _ reqId: String) -> Void)?)    

パラメーター:

onErrorOccurs

エラーが発生しました。

@objc optional func onErrorOccurs(error: NSError, requestId: String?)

パラメーター:

onRequestAuthToken

AuthToken をリクエストします。このコールバックは、ChatEngine が IM にログインする必要がある場合、または IM ログイン用の AuthToken の有効期限が切れた場合にトリガーされます。

@objc optional func onRequestAuthToken(userId: String, responseBlock: @escaping (_ authToken: ARTCAIChatAuthToken?, _ error: NSError?)->Void)

パラメーター:

onEngineStateChange

エージェントの接続ステータスが変更されます。

@objc optional func onEngineStateChange(state: ARTCAIChatEngineState)

パラメーター:

onReceivedMessage

エージェントから返信メッセージが受信されます。このコールバックは、エージェントが新しい返信を送信したとき、または現在の返信プロセス中にメッセージのステータスが変更されたときにトリガーされます。

@objc optional func onReceivedMessage(message: ARTCAIChatMessage)

パラメーター:

onReceivedCustomMessage

カスタムメッセージが受信されます。

@objc optional func onReceivedCustomMessage(text: String)

パラメーター:

onUserMessageUpdated

ユーザーが送信したメッセージを更新する必要があります。

@objc optional func onUserMessageUpdated(message: ARTCAIChatMessage)

パラメーター:

onAgentResponeStateChange

エージェントの応答ステータスが変更されます。

@objc optional func onAgentResponeStateChange(state: ARTCAIChatAgentResponseState, requestId: String?)

パラメーター:

onMessagePlayStateChange

チャットエージェントのメッセージ再生ステータスが変更されます。

@objc optional func onMessagePlayStateChange(message: ARTCAIChatMessage, state: ARTCAIChatMessagePlayState)

パラメーター:

createChatEngine

デフォルトのチャットエージェントエンジンを作成します。

public static func createChatEngine() -> ARTCAIChatEngineInterface