Intelligent Media Services:API reference

state

Gets the engine connection state. For detailed states, see ARTCAIChatEngineState.

var state: ARTCAIChatEngineState { get }

userInfo

Gets the current session user information. For details, see ARTCAIChatUserInfo.

var userInfo: ARTCAIChatUserInfo? { get }

sessionId

Gets the current session ID.

var sessionId: String? { get }

agentInfo

Gets the AI agent information for the current session. For details, see ARTCAIChatAgentInfo.

var agentInfo: ARTCAIChatAgentInfo? { get }

agentResponeState

Gets the agent response status. For details, see ARTCAIChatAgentResponseState.

var agentResponeState: ARTCAIChatAgentResponseState { get }

voiceIdList

Retrieves available voices.

var voiceIdList: [String] { get }

delegate

Configures and queries callback events. For details, see ARTCAIChatEngineDelegate.

weak var delegate: ARTCAIChatEngineDelegate? { get set }

templateConfig

Configures and obtains TemplateConfig. For details, see ARTCAIChatTemplateConfig.

var templateConfig: ARTCAIChatTemplateConfig? { get set }

userData

Custom user information passed to the AI agent.

var userData: [String: Any]? { get set }

startChat

Starts a chat session.

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

endChat

Ends a chat session.

func endChat(needLogout: Bool)

sendMessage

Sends a message. Any ongoing agent reply (thinking or replying) is interrupted before sending.

func sendMessage(request: ARTCAIChatSendMessageRequest, completed:((_ msg: ARTCAIChatMessage?, _ error: NSError?) -> Void)?)

deleteMessage

Deletes a message.

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

queryMessageList

Requests historical messages.

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

interruptAgentResponse

Interrupts the current reply.

func interruptAgentResponse()

deleteMessage

Deletes a message.

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

startPlayMessage

Starts reading out a message.

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

stopPlayMessage

Stops reading out a message.

func stopPlayMessage()

isPlayingMessage

Checks whether a message is being read out.

func isPlayingMessage(dialogueId: String) -> Bool

createAttachmentUploader

Creates an attachment uploader for sending messages with images, videos, or other files.

func createAttachmentUploader() -> ARTCAIChatAttachmentUploader?

startPushVoiceMessage

Starts push-to-talk voice recording. Recording begins on tap and voice input is sent in real time. Requires recording permission.

Returns true on success. Returns false on failure, which may be caused by an incorrect status or disabled recording permission.

func startPushVoiceMessage(request: ARTCAIChatSendMessageRequest) -> Bool

finishPushVoiceMessage

Ends push-to-talk voice recording. Called when the button is released, indicating the voice message has been sent.

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

cancelPushVoiceMessage

Cancels push-to-talk voice recording. Called when the button is released, indicating the voice message sending is canceled.

func cancelPushVoiceMessage()

destroy

Releases resources.

func destroy()

parseShareAgentChat

Parses shared agent information.

func parseShareAgentChat(shareInfo: String) -> ARTCAIChatAgentShareConfig?

generateShareAgentChat

Starts a conversation with a shared agent.

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

onErrorOccurs

Called when an error occurs.

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

onRequestAuthToken

Requests an authentication token. Triggered when ChatEngine needs to log on to interactive messaging or when the logon token expires.

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

onEngineStateChange

Called when the connection state of the engine changes.

@objc optional func onEngineStateChange(state: ARTCAIChatEngineState)

onReceivedMessage

Triggered when the agent sends a new reply or when a message status changes during the reply process.

@objc optional func onReceivedMessage(message: ARTCAIChatMessage)

onReceivedCustomMessage

Called when a custom message is received.

@objc optional func onReceivedCustomMessage(text: String)

onUserMessageUpdated

Called when a user-sent message is updated.

@objc optional func onUserMessageUpdated(message: ARTCAIChatMessage)

onAgentResponeStateChange

Called when the response status of the agent changes.

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

onMessagePlayStateChange

Called when the readout status of an AI agent message changes.

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

CreateChatEngine

Creates a default agent engine.

public static func createChatEngine() -> ARTCAIChatEngineInterface