Intelligent Media Services：API介面詳情

state

擷取引擎串連狀態。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 }

agentResponeState

擷取當前智能體響應狀態。ARTCAIChatAgentResponseState詳情，請參見ARTCAIChatAgentResponseState。

var agentResponeState: ARTCAIChatAgentResponseState { get }

voiceIdList

擷取當前音色列表

var voiceIdList: [String] { get }

delegate

設定和擷取回調事件。ARTCAIChatEngineDelegate詳情，請參見ARTCAIChatEngineDelegate。

weak var delegate: ARTCAIChatEngineDelegate? { get set }

templateConfig

設定和擷取TemplateConfig。ARTCAIChatTemplateConfig詳情，請參見ARTCAIChatTemplateConfig。

var templateConfig: ARTCAIChatTemplateConfig? { get set }

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)?)

參數詳情：

deleteMessage

刪除訊息

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

參數詳情：

queryMessageList

請求歷史訊息列表

func queryMessageList(request: ARTCAIChatMessageListRequest, completed:((_ msgList: [ARTCAIChatMessage]?, _ error: NSError?) -> Void)?)  

參數詳情：

interruptAgentResponse

打斷當前的訊息回複

func interruptAgentResponse()

deleteMessage

刪除訊息

func deleteMessage(dialogueId: String, completed:((_ error: NSError?) -> Void)?)

參數詳情：

startPlayMessage

開始播放訊息內容

func startPlayMessage(message: ARTCAIChatMessage, voiceId: String?, completed: ((NSError?) -> Void)?)

參數詳情：

stopPlayMessage

結束訊息的播放

func stopPlayMessage()

isPlayingMessage

是否播放中

func isPlayingMessage(dialogueId: String) -> Bool

createAttachmentUploader

建立附件上傳器對象，發送訊息時可以通過關聯AttachmentUploader實現發訊息帶上圖片/視頻/檔案

func createAttachmentUploader() -> ARTCAIChatAttachmentUploader?

startPushVoiceMessage

開始按鍵語音，按下去時開始錄音並即時發送，需確保已經開啟錄音許可權

返回true表示成功， 返回false表示失敗（一般原因是：目前狀態不對、錄音許可權未開啟等）

func startPushVoiceMessage(request: ARTCAIChatSendMessageRequest) -> Bool

參數詳情：

finishPushVoiceMessage

結束按鍵語音，鬆開後時調用，表示當前語音訊息發送完畢，等待智能體返回結果

func finishPushVoiceMessage(completed:((_ msg: ARTCAIChatMessage) -> Void)?)

參數詳情：

cancelPushVoiceMessage

取消按鍵語音，鬆開後時調用，表示取消當前語音訊息的發送

func cancelPushVoiceMessage()

destroy

釋放資源

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

建立預設的Chat智能體引擎

public static func createChatEngine() -> ARTCAIChatEngineInterface