[Android]Update convoai api &&doc. TEN-2427

Android/common/src/main/res/layout/common_debug_cov_config_fragment.xml

@@ -356,7 +356,7 @@
             android:id="@+id/tv_render_mode"
             android:layout_width="wrap_content"
             android:layout_height="wrap_content"
-            android:text="@string/common_debug_transcription_render_mode"
+            android:text="@string/common_debug_transcript_render_mode"
             android:textColor="@color/ai_icontext1"
             android:textSize="14sp"
             android:layout_marginTop="10dp"

Android/common/src/main/res/values/strings.xml

@@ -7,7 +7,7 @@
     <string name="common_debug_user_config">User Config</string>
     <string name="common_debug_quick_setting_for_current_user">Quick Setting for Current User</string>
     <string name="common_debug_click_to_copy">Copy to Clipboard</string>
-    <string name="common_debug_transcription_render_mode">Transcription Render Mode</string>
+    <string name="common_debug_transcript_render_mode">Transcript Render Mode</string>
     <string name="common_debug_text_mode">Text</string>
     <string name="common_debug_word_mode">Word</string>
     <string name="common_debug_text_word_mode">Text-Word</string>

Android/scenes/convoai/src/main/java/io/agora/scene/convoai/convoaiApi/ConversationalAIAPIImpl.kt

@@ -14,10 +14,10 @@ import io.agora.rtm.PresenceEvent
 import io.agora.rtm.RtmConstants
 import io.agora.rtm.RtmEventListener
 import io.agora.rtm.SubscribeOptions
-import io.agora.scene.convoai.convoaiApi.subRender.v3.IConversationTranscriptionCallback
+import io.agora.scene.convoai.convoaiApi.subRender.v3.IConversationTranscriptCallback
 import io.agora.scene.convoai.convoaiApi.subRender.v3.MessageParser
-import io.agora.scene.convoai.convoaiApi.subRender.v3.TranscriptionController
-import io.agora.scene.convoai.convoaiApi.subRender.v3.TranscriptionConfig
+import io.agora.scene.convoai.convoaiApi.subRender.v3.TranscriptController
+import io.agora.scene.convoai.convoaiApi.subRender.v3.TranscriptConfig
 import java.util.UUID
 
 /**
@@ -29,9 +29,9 @@ import java.util.UUID
  *
  * Key responsibilities:
  * - Manage RTM subscriptions and message routing
- * - Parse and handle different message types (state, error, metrics, transcription)
+ * - Parse and handle different message types (state, error, metrics, transcript)
  * - Configure audio parameters for optimal AI conversation quality
- * - Coordinate with transcription rendering system
+ * - Coordinate with transcript rendering system
  * - Provide thread-safe delegate notifications
  *
  * @see IConversationalAIAPI
@@ -40,7 +40,7 @@ class ConversationalAIAPIImpl(val config: ConversationalAIAPIConfig) : IConversa
 
     private var mMessageParser = MessageParser()
 
-    private var transcriptionController: TranscriptionController
+    private var transcriptController: TranscriptController
     private var channelName: String? = null
 
     private val conversationalAIHandlerHelper = ObservableHelper<IConversationalAIAPIEventHandler>()
@@ -113,8 +113,8 @@ class ConversationalAIAPIImpl(val config: ConversationalAIAPIConfig) : IConversa
         }
 
         private fun dealMessageWithMap(publisherId: String, msg: Map<String, Any>) {
-            val transcriptionObj = msg["object"] as? String ?: return
-            val objectType = MessageType.fromValue(transcriptionObj)
+            val transcriptObj = msg["object"] as? String ?: return
+            val objectType = MessageType.fromValue(transcriptObj)
             when (objectType) {
                 /**
                  * {object=message.metrics, module=tts, metric_name=ttfb, turn_id=4, latency_ms=182, data_type=message, message_id=2d7de2a2, send_ts=1749630519485}
@@ -248,14 +248,14 @@ class ConversationalAIAPIImpl(val config: ConversationalAIAPIConfig) : IConversa
     }
 
     init {
-        val transcriptionConfig = TranscriptionConfig(
+        val transcriptConfig = TranscriptConfig(
             rtcEngine = config.rtcEngine,
             rtmClient = config.rtmClient,
-            renderMode = if (config.renderMode == TranscriptionRenderMode.Word) TranscriptionRenderMode.Word else TranscriptionRenderMode.Text,
-            callback = object : IConversationTranscriptionCallback {
-                override fun onTranscriptionUpdated(agentUserId: String, transcription: Transcription) {
+            renderMode = if (config.renderMode == TranscriptRenderMode.Word) TranscriptRenderMode.Word else TranscriptRenderMode.Text,
+            callback = object : IConversationTranscriptCallback {
+                override fun onTranscriptUpdated(agentUserId: String, transcript: Transcript) {
                     conversationalAIHandlerHelper.notifyEventHandlers { delegate ->
-                        delegate.onTranscriptionUpdated(agentUserId, transcription)
+                        delegate.onTranscriptUpdated(agentUserId, transcript)
                     }
                 }
 
@@ -274,8 +274,8 @@ class ConversationalAIAPIImpl(val config: ConversationalAIAPIConfig) : IConversa
         mMessageParser.onError = { message ->
             callMessagePrint(TAG, message)
         }
-        // Initialize transcription controller for transcription
-        transcriptionController = TranscriptionController(transcriptionConfig)
+        // Initialize transcript controller for transcript
+        transcriptController = TranscriptController(transcriptConfig)
         // Register RTC event handler to receive audio/video events
         config.rtcEngine.addHandler(covRtcHandler)
         // Register RTM event listener to receive real-time messages
@@ -297,7 +297,7 @@ class ConversationalAIAPIImpl(val config: ConversationalAIAPIConfig) : IConversa
     override fun subscribeMessage(channel: String, completion: (ConversationalAIAPIError?) -> Unit) {
         val traceId = genTraceId
         callMessagePrint(TAG, ">>> [traceId:$traceId] [subscribeMessage] $channel")
-        transcriptionController.reset()
+        transcriptController.reset()
         channelName = channel
         stateChangeEvent = null
         val option = SubscribeOptions().apply {
@@ -329,7 +329,7 @@ class ConversationalAIAPIImpl(val config: ConversationalAIAPIConfig) : IConversa
         channelName = null
         val traceId = genTraceId
         callMessagePrint(TAG, ">>> [traceId:$traceId] [unsubscribeMessage] $channel")
-        transcriptionController.reset()
+        transcriptController.reset()
         config.rtmClient.unsubscribe(channel, object : ResultCallback<Void> {
             override fun onSuccess(responseInfo: Void?) {
                 callMessagePrint(TAG, "<<< [traceId:$traceId] rtm unsubscribe onSuccess")
@@ -540,7 +540,7 @@ class ConversationalAIAPIImpl(val config: ConversationalAIAPIConfig) : IConversa
         config.rtcEngine.removeHandler(covRtcHandler)
         config.rtmClient.removeEventListener(covRtmMsgProxy)
         conversationalAIHandlerHelper.unSubscribeAll()
-        transcriptionController.release()
+        transcriptController.release()
     }
 
     // set audio config parameters

Android/scenes/convoai/src/main/java/io/agora/scene/convoai/convoaiApi/IConversationalAIAPI.kt

@@ -335,18 +335,18 @@ data class ModuleError(
  *
  * Used to distinguish different types of messages in the system.
  *
- * @property ASSISTANT AI assistant transcription message
- * @property USER User transcription message
+ * @property ASSISTANT AI assistant transcript message
+ * @property USER User transcript message
  * @property ERROR Error message
  * @property METRICS Performance metrics message
  * @property INTERRUPT Interrupt message
  * @property UNKNOWN Unknown type
  */
 enum class MessageType(val value: String) {
-    /** AI assistant transcription message */
+    /** AI assistant transcript message */
     ASSISTANT("assistant.transcription"),
 
-    /** User transcription message */
+    /** User transcript message */
     USER("user.transcription"),
 
     /** Error message */
@@ -377,71 +377,71 @@ enum class MessageType(val value: String) {
 }
 
 /**
- * Defines different modes for transcription rendering.
+ * Defines different modes for transcript rendering.
  *
- * @property Word Word-by-word transcriptions are rendered.
- * @property Text Full text transcriptions are rendered.
+ * @property Word Word-by-word transcripts are rendered.
+ * @property Text Full text transcripts are rendered.
  */
-enum class TranscriptionRenderMode {
-    /** Word-by-word transcription rendering */
+enum class TranscriptRenderMode {
+    /** Word-by-word transcript rendering */
     Word,
 
-    /** Full text transcription rendering */
+    /** Full text transcript rendering */
     Text
 }
 
 /**
- * Data class representing a complete transcription message for UI rendering.
+ * Data class representing a complete transcript message for UI rendering.
  *
  * @property turnId Unique identifier for the conversation turn
- * @property userId User identifier associated with this transcription
- * @property text The actual transcription text content
- * @property status Current status of the transcription
- * @property type Transcription type (AGENT/USER)
+ * @property userId User identifier associated with this transcript
+ * @property text The actual transcript text content
+ * @property status Current status of the transcript
+ * @property type transcript type (AGENT/USER)
  */
-data class Transcription constructor(
+data class Transcript constructor(
     /** Unique identifier for the conversation turn */
     val turnId: Long,
-    /** User identifier associated with this transcription */
+    /** User identifier associated with this transcript */
     val userId: String = "",
-    /** The actual transcription text content */
+    /** The actual transcript text content */
     val text: String,
-    /** Current status of the transcription */
-    var status: TranscriptionStatus,
-    /** Transcription type (AGENT/USER) */
-    var type: TranscriptionType,
+    /** Current status of the transcript */
+    var status: TranscriptStatus,
+    /** transcript type (AGENT/USER) */
+    var type: TranscriptType,
 )
 
 /**
- * Transcription type enum.
+ * Transcript type enum.
  *
- * @property AGENT AI assistant transcription
- * @property USER User transcription
+ * @property AGENT AI assistant transcript
+ * @property USER User transcript
  */
-enum class TranscriptionType {
-    /** AI assistant transcription */
+enum class TranscriptType {
+    /** AI assistant transcript */
     AGENT,
 
-    /** User transcription */
+    /** User transcript */
     USER
 }
 
 /**
- * Represents the current status of a transcription.
+ * Represents the current status of a transcript.
  *
- * @property IN_PROGRESS Transcription is still being generated or spoken
- * @property END Transcription has completed normally
- * @property INTERRUPTED Transcription was interrupted before completion
+ * @property IN_PROGRESS transcript is still being generated or spoken
+ * @property END transcript has completed normally
+ * @property INTERRUPTED transcript was interrupted before completion
  * @property UNKNOWN Unknown status
  */
-enum class TranscriptionStatus {
-    /** Transcription is still being generated or spoken */
+enum class TranscriptStatus {
+    /** transcript is still being generated or spoken */
     IN_PROGRESS,
 
-    /** Transcription has completed normally */
+    /** transcript has completed normally */
     END,
 
-    /** Transcription was interrupted before completion */
+    /** transcript was interrupted before completion */
     INTERRUPTED,
 
     /** Unknown status */
@@ -453,20 +453,20 @@ enum class TranscriptionStatus {
  *
  * Contains the necessary configuration parameters to initialize the Conversational AI API.
  * This configuration includes RTC engine for audio communication, RTM client for messaging,
- * and transcription rendering mode settings.
+ * and transcript rendering mode settings.
  *
  * @property rtcEngine RTC engine instance for audio/video communication
  * @property rtmClient RTM client instance for real-time messaging
- * @property renderMode Transcription rendering mode (Word or Text level)
+ * @property renderMode transcript rendering mode (Word or Text level)
  * @property enableLog Whether to enable logging (default: true). When set to true, logs will be written to the RTC SDK log file.
  */
 data class ConversationalAIAPIConfig(
     /** RTC engine instance for audio/video communication */
     val rtcEngine: RtcEngine,
     /** RTM client instance for real-time messaging */
     val rtmClient: RtmClient,
-    /** Transcription rendering mode, default is word-level */
-    val renderMode: TranscriptionRenderMode = TranscriptionRenderMode.Word,
+    /** transcript rendering mode, default is word-level */
+    val renderMode: TranscriptRenderMode = TranscriptRenderMode.Word,
     /** Whether to enable logging, default is true. When true, logs will be written to the RTC SDK log file. */
     val enableLog: Boolean = true
 )
@@ -513,10 +513,10 @@ sealed class ConversationalAIAPIError : Exception() {
 /**
  * Conversational AI API event handler interface.
  *
- * Implement this interface to receive AI conversation events such as state changes, transcriptions, errors, and metrics.
+ * Implement this interface to receive AI conversation events such as state changes, transcripts, errors, and metrics.
  * All callbacks are invoked on the main thread for UI updates.
  *
- * @note Some callbacks (such as onTranscriptionUpdated) may be triggered at high frequency for reliability. If your business requires deduplication, please handle it at the business layer.
+ * @note Some callbacks (such as onTranscriptUpdated) may be triggered at high frequency for reliability. If your business requires deduplication, please handle it at the business layer.
  */
 interface IConversationalAIAPIEventHandler {
     /**
@@ -564,12 +564,12 @@ interface IConversationalAIAPIEventHandler {
     fun onMessageReceiptUpdated(agentUserId: String, receipt: MessageReceipt)
 
     /**
-     * Called when transcription content is updated.
+     * Called when transcript content is updated.
      * @param agentUserId Agent user ID
-     * @param transcription Transcription data
+     * @param transcript transcript data
      * @note This callback may be triggered at high frequency. If you need to deduplicate, please handle it at the business layer.
      */
-    fun onTranscriptionUpdated(agentUserId: String, transcription: Transcription)
+    fun onTranscriptUpdated(agentUserId: String, transcript: Transcript)
 
     /**
      * Called for internal debug logs.

Android/scenes/convoai/src/main/java/io/agora/scene/convoai/convoaiApi/README.md

@@ -34,7 +34,7 @@ Follow these steps to quickly integrate and use the ConversationalAI API:
    val config = ConversationalAIAPIConfig(
        rtcEngine = rtcEngineInstance,
        rtmClient = rtmClientInstance,
-       renderMode = TranscriptionRenderMode.Word, // or TranscriptionRenderMode.Text
+       renderMode = TranscriptRenderMode.Word, // or TranscriptRenderMode.Text
        enableLog = true
    )
    ```
@@ -47,7 +47,7 @@ Follow these steps to quickly integrate and use the ConversationalAI API:
 
 3. **Register an event handler**
 
-   Implement and add your event handler to receive agent events and transcriptions:
+   Implement and add your event handler to receive agent events and transcripts:
    ```kotlin
    api.addHandler(object : IConversationalAIAPIEventHandler {
        override fun onAgentStateChanged(agentUserId: String, event: StateChangeEvent) { /* ... */ }
@@ -56,7 +56,7 @@ Follow these steps to quickly integrate and use the ConversationalAI API:
        override fun onAgentError(agentUserId: String, error: ModuleError) { /* ... */ }
        override fun onMessageError(agentUserId: String, error: MessageError) { /* ... */ } 
        override fun onMessageReceiptUpdated(agentUserId: String, receipt: MessageReceipt) { /* ... */ }
-       override fun onTranscriptionUpdated(agentUserId: String, transcription: Transcription) { /* ... */ }
+       override fun onTranscriptUpdated(agentUserId: String, transcript: Transcript) { /* ... */ }
        override fun onDebugLog(log: String) { /* ... */ }
    })
    ```
@@ -288,8 +288,8 @@ override fun onMessageError(agentUserId: String, error: MessageError) {
 - [ConversationalAIAPIImpl.kt](./ConversationalAIAPIImpl.kt) — Main implementation of the ConversationalAI API logic
 - [ConversationalAIUtils.kt](./ConversationalAIUtils.kt) — Utility functions and event handler management
 - [subRender/](./subRender/) 
-    - [v3/](./subRender/v3/) — Transcription module
-        - [TranscriptionController.kt](./subRender/v3/TranscriptionController.kt)
+    - [v3/](./subRender/v3/) — transcript module
+        - [TranscriptController.kt](./subRender/v3/TranscriptController.kt)
         - [MessageParser.kt](./subRender/v3/MessageParser.kt) 
 
 > The above files and folders are all you need to integrate the ConversationalAI API. No other files are required.