Intelligent Media Services:API reference

state

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

var state: ARTCAIChatEngineState { get }

userInfo

Gets the information about the user who participates in the current session. For details, see ARTCAIChatUserInfo.

var userInfo: ARTCAIChatUserInfo? { get }

sessionId

Gets the unique identifier of the current session.

var sessionId: String? { get }

agentInfo

Gets the information about the AI agent that participates in the current session. For details, see ARTCAIChatAgentInfo.

var agentInfo: ARTCAIChatAgentInfo? { get }

agentResponeState

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

var agentResponeState: ARTCAIChatAgentResponseState { get }

voiceIdList

Retrieves the 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

The custom user information. The information is 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. The agent reply will be interrupted before sending the message (when the agent is thinking or replying).

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 to read 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 object to send messages with images, videos, or other files.

func createAttachmentUploader() -> ARTCAIChatAttachmentUploader?

startPushVoiceMessage

Starts push-to-talk voice recording. When the button is tapped, recording starts and the voice input is sent in real time. Make sure that the recording permission is granted.

A return value of true indicates that the operation is successful. A return value of false indicates that the operation failed. The failure may be caused by an incorrect status or disabled recording permission.

func startPushVoiceMessage(request: ARTCAIChatSendMessageRequest) -> Bool

finishPushVoiceMessage

Ends push-to-talk voice recording. This method is called when the button is released, indicating that the voice message has been sent.

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

cancelPushVoiceMessage

Cancels push-to-talk voice recording. This method is called when the button is released, indicating that the sending of the voice message is canceled.

func cancelPushVoiceMessage()

destroy

Releases resources.

func destroy()

parseShareAgentChat

Parses the information about a shared agent.

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 occurred.

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

onRequestAuthToken

Requests an authentication token. This callback is triggered when ChatEngine needs to log on to interactive messaging or when the authentication token for logon 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

A response is received from the AI agent. This callback is triggered when the agent sends a new reply or when the status of a message changes during the current 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 the 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 a message from the AI agent changes.

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

CreateChatEngine

Creates a default agent engine.

public static func createChatEngine() -> ARTCAIChatEngineInterface