@alicloud/winnexo20260512 1.9.0 → 1.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +81 -81
- package/dist/client.js +81 -81
- package/dist/models/ConvertDirectConversationToWorkRequest.d.ts +2 -2
- package/dist/models/ConvertDirectConversationToWorkResponseBody.d.ts +13 -13
- package/dist/models/CreateScheduledTaskRequest.d.ts +29 -38
- package/dist/models/CreateScheduledTaskRequest.js.map +1 -1
- package/dist/models/CreateScheduledTaskShrinkRequest.d.ts +7 -7
- package/dist/models/GetScheduledTaskExecutionRecordsRequest.d.ts +5 -5
- package/dist/models/GetScheduledTaskExecutionRecordsResponseBody.d.ts +11 -11
- package/dist/models/ListOutputFilesRequest.d.ts +9 -9
- package/dist/models/ListOutputFilesResponseBody.d.ts +7 -7
- package/dist/models/ListOutputFilesShrinkRequest.d.ts +9 -9
- package/dist/models/SendAsyncChatMessageRequest.d.ts +47 -43
- package/dist/models/SendAsyncChatMessageRequest.js.map +1 -1
- package/dist/models/SendAsyncChatMessageResponseBody.d.ts +4 -4
- package/dist/models/SendAsyncChatMessageShrinkRequest.d.ts +17 -13
- package/dist/models/SendAsyncChatMessageShrinkRequest.js.map +1 -1
- package/dist/models/SendChatMessageRequest.d.ts +37 -37
- package/dist/models/SendChatMessageResponseBody.d.ts +3 -3
- package/dist/models/SendChatMessageShrinkRequest.d.ts +9 -9
- package/dist/models/TranscribeChatVoiceAdvanceRequest.d.ts +4 -4
- package/dist/models/TranscribeChatVoiceRequest.d.ts +4 -4
- package/dist/models/TranscribeChatVoiceResponseBody.d.ts +2 -2
- package/dist/models/UpdateScheduledTaskRequest.d.ts +30 -30
- package/dist/models/UpdateScheduledTaskResponseBody.d.ts +5 -5
- package/dist/models/UpdateScheduledTaskShrinkRequest.d.ts +11 -11
- package/dist/models/UploadChatFileByBase64request.d.ts +4 -4
- package/dist/models/UploadChatFileByBase64responseBody.d.ts +4 -4
- package/package.json +1 -1
- package/src/client.ts +81 -81
- package/src/models/ConvertDirectConversationToWorkRequest.ts +2 -2
- package/src/models/ConvertDirectConversationToWorkResponseBody.ts +13 -13
- package/src/models/CreateScheduledTaskRequest.ts +30 -39
- package/src/models/CreateScheduledTaskShrinkRequest.ts +7 -7
- package/src/models/GetScheduledTaskExecutionRecordsRequest.ts +5 -5
- package/src/models/GetScheduledTaskExecutionRecordsResponseBody.ts +11 -11
- package/src/models/ListOutputFilesRequest.ts +9 -9
- package/src/models/ListOutputFilesResponseBody.ts +7 -7
- package/src/models/ListOutputFilesShrinkRequest.ts +9 -9
- package/src/models/SendAsyncChatMessageRequest.ts +47 -43
- package/src/models/SendAsyncChatMessageResponseBody.ts +4 -4
- package/src/models/SendAsyncChatMessageShrinkRequest.ts +17 -13
- package/src/models/SendChatMessageRequest.ts +37 -37
- package/src/models/SendChatMessageResponseBody.ts +3 -3
- package/src/models/SendChatMessageShrinkRequest.ts +9 -9
- package/src/models/TranscribeChatVoiceAdvanceRequest.ts +4 -4
- package/src/models/TranscribeChatVoiceRequest.ts +4 -4
- package/src/models/TranscribeChatVoiceResponseBody.ts +2 -2
- package/src/models/UpdateScheduledTaskRequest.ts +30 -30
- package/src/models/UpdateScheduledTaskResponseBody.ts +5 -5
- package/src/models/UpdateScheduledTaskShrinkRequest.ts +11 -11
- package/src/models/UploadChatFileByBase64request.ts +4 -4
- package/src/models/UploadChatFileByBase64responseBody.ts +4 -4
package/dist/client.d.ts
CHANGED
|
@@ -280,10 +280,10 @@ export default class Client extends OpenApi {
|
|
|
280
280
|
*/
|
|
281
281
|
closeWorkflowTodos(request: $_model.CloseWorkflowTodosRequest): Promise<$_model.CloseWorkflowTodosResponse>;
|
|
282
282
|
/**
|
|
283
|
-
*
|
|
283
|
+
* Converts a direct session to a work session.
|
|
284
284
|
*
|
|
285
285
|
* @remarks
|
|
286
|
-
*
|
|
286
|
+
* Freezes the currently valid and completed direct model history of the source session and performs replication into a new work session, while retaining the source session. For hybrid sessions, only the direct history is transformed, and ordinary work history or old history containing only display records is not included. The transform scope is not limited by directMaxHistoryRounds. The transform itself does not initiate a chat or run a skill. To query or continue the same transform, invoke the operation repeatedly for the same source session, producing at most one successful target. Upon success, the original target is always returned, and no automatic synchronization applies to subsequent messages in the source session. Only status=succeeded indicates that the target is ready for use. When the status is processing, continue querying with the same source sessionId. You cannot send messages to, fork, or share a target that is not yet ready. SourceBusy is returned if the source session is currently generating content. NoConvertibleHistory is returned if there is no valid model history. ConvertedTargetUnavailable is returned if a previously successful target is deleted or its history is unrecoverable, and the target is not rebuilt. Only ordinary sessions that the user can operate and that have work permissions are allowed. Access control rules deny restricted sources such as group_shared, task_follow_up, skill_follow_up, and skill_output_backfill. Background view permissions do not grant transform rights.
|
|
287
287
|
*
|
|
288
288
|
* @param request - ConvertDirectConversationToWorkRequest
|
|
289
289
|
* @param headers - map
|
|
@@ -294,10 +294,10 @@ export default class Client extends OpenApi {
|
|
|
294
294
|
[key: string]: string;
|
|
295
295
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ConvertDirectConversationToWorkResponse>;
|
|
296
296
|
/**
|
|
297
|
-
*
|
|
297
|
+
* Converts a direct session to a work session.
|
|
298
298
|
*
|
|
299
299
|
* @remarks
|
|
300
|
-
*
|
|
300
|
+
* Freezes the currently valid and completed direct model history of the source session and performs replication into a new work session, while retaining the source session. For hybrid sessions, only the direct history is transformed, and ordinary work history or old history containing only display records is not included. The transform scope is not limited by directMaxHistoryRounds. The transform itself does not initiate a chat or run a skill. To query or continue the same transform, invoke the operation repeatedly for the same source session, producing at most one successful target. Upon success, the original target is always returned, and no automatic synchronization applies to subsequent messages in the source session. Only status=succeeded indicates that the target is ready for use. When the status is processing, continue querying with the same source sessionId. You cannot send messages to, fork, or share a target that is not yet ready. SourceBusy is returned if the source session is currently generating content. NoConvertibleHistory is returned if there is no valid model history. ConvertedTargetUnavailable is returned if a previously successful target is deleted or its history is unrecoverable, and the target is not rebuilt. Only ordinary sessions that the user can operate and that have work permissions are allowed. Access control rules deny restricted sources such as group_shared, task_follow_up, skill_follow_up, and skill_output_backfill. Background view permissions do not grant transform rights.
|
|
301
301
|
*
|
|
302
302
|
* @param request - ConvertDirectConversationToWorkRequest
|
|
303
303
|
* @returns ConvertDirectConversationToWorkResponse
|
|
@@ -1442,13 +1442,13 @@ export default class Client extends OpenApi {
|
|
|
1442
1442
|
*
|
|
1443
1443
|
* @remarks
|
|
1444
1444
|
* ## Request description
|
|
1445
|
-
* - This API
|
|
1446
|
-
* - You must have the DEVELOPMENT_KB_MANAGE feature permission to call this API
|
|
1447
|
-
* -
|
|
1448
|
-
* - Optional parameters include the public access URL and the original file name to enhance the completeness of the file information.
|
|
1449
|
-
* - If directoryId is specified, the file is placed in the corresponding enterprise knowledge base directory. Otherwise,
|
|
1450
|
-
* - You can
|
|
1451
|
-
* - This operation
|
|
1445
|
+
* - This API is used to upload files to the enterprise knowledge base.
|
|
1446
|
+
* - You must have the DEVELOPMENT_KB_MANAGE feature permission to call this API.
|
|
1447
|
+
* - When uploading a file, you must provide the OSS persistence address of the file (filePath).
|
|
1448
|
+
* - Optional parameters include the public access URL of the file and the original file name to enhance the completeness of the file information.
|
|
1449
|
+
* - If directoryId is specified, the file is placed in the corresponding enterprise knowledge base directory. Otherwise, it is bound to the default root directory of the current digital employee by default.
|
|
1450
|
+
* - You can add tags to resources by using sourceTags for subsequent management and retrieval.
|
|
1451
|
+
* - This operation triggers a billing bill (UNSTRUCTURED_PARSE). Make sure your account balance is sufficient.
|
|
1452
1452
|
*
|
|
1453
1453
|
* @param tmpReq - CreateScheduledTaskRequest
|
|
1454
1454
|
* @param headers - map
|
|
@@ -1463,13 +1463,13 @@ export default class Client extends OpenApi {
|
|
|
1463
1463
|
*
|
|
1464
1464
|
* @remarks
|
|
1465
1465
|
* ## Request description
|
|
1466
|
-
* - This API
|
|
1467
|
-
* - You must have the DEVELOPMENT_KB_MANAGE feature permission to call this API
|
|
1468
|
-
* -
|
|
1469
|
-
* - Optional parameters include the public access URL and the original file name to enhance the completeness of the file information.
|
|
1470
|
-
* - If directoryId is specified, the file is placed in the corresponding enterprise knowledge base directory. Otherwise,
|
|
1471
|
-
* - You can
|
|
1472
|
-
* - This operation
|
|
1466
|
+
* - This API is used to upload files to the enterprise knowledge base.
|
|
1467
|
+
* - You must have the DEVELOPMENT_KB_MANAGE feature permission to call this API.
|
|
1468
|
+
* - When uploading a file, you must provide the OSS persistence address of the file (filePath).
|
|
1469
|
+
* - Optional parameters include the public access URL of the file and the original file name to enhance the completeness of the file information.
|
|
1470
|
+
* - If directoryId is specified, the file is placed in the corresponding enterprise knowledge base directory. Otherwise, it is bound to the default root directory of the current digital employee by default.
|
|
1471
|
+
* - You can add tags to resources by using sourceTags for subsequent management and retrieval.
|
|
1472
|
+
* - This operation triggers a billing bill (UNSTRUCTURED_PARSE). Make sure your account balance is sufficient.
|
|
1473
1473
|
*
|
|
1474
1474
|
* @param request - CreateScheduledTaskRequest
|
|
1475
1475
|
* @returns CreateScheduledTaskResponse
|
|
@@ -2518,12 +2518,12 @@ export default class Client extends OpenApi {
|
|
|
2518
2518
|
*
|
|
2519
2519
|
* @remarks
|
|
2520
2520
|
* ## Request description
|
|
2521
|
-
* - This
|
|
2522
|
-
* - You must have the
|
|
2523
|
-
* -
|
|
2524
|
-
* - Optional parameters include the public access URL and original file name
|
|
2525
|
-
* - If
|
|
2526
|
-
* - You can use
|
|
2521
|
+
* - This operation uploads files to the enterprise knowledge base.
|
|
2522
|
+
* - You must have the DEVELOPMENT_KB_MANAGE feature permission to call this API operation.
|
|
2523
|
+
* - You must provide the OSS persistence address (filePath) of the file when uploading the file.
|
|
2524
|
+
* - Optional parameters include the public access URL and original file name to improve the completeness of the file information.
|
|
2525
|
+
* - If you specify directoryId, the file is placed in the corresponding enterprise knowledge base directory. Otherwise, the file is bound to the default root directory of the current digital employee.
|
|
2526
|
+
* - You can use sourceTags to add tags to resources for subsequent management and retrieval.
|
|
2527
2527
|
* - This operation generates a bill (UNSTRUCTURED_PARSE). Make sure that your account balance is sufficient.
|
|
2528
2528
|
*
|
|
2529
2529
|
* @param request - GetScheduledTaskExecutionRecordsRequest
|
|
@@ -2539,12 +2539,12 @@ export default class Client extends OpenApi {
|
|
|
2539
2539
|
*
|
|
2540
2540
|
* @remarks
|
|
2541
2541
|
* ## Request description
|
|
2542
|
-
* - This
|
|
2543
|
-
* - You must have the
|
|
2544
|
-
* -
|
|
2545
|
-
* - Optional parameters include the public access URL and original file name
|
|
2546
|
-
* - If
|
|
2547
|
-
* - You can use
|
|
2542
|
+
* - This operation uploads files to the enterprise knowledge base.
|
|
2543
|
+
* - You must have the DEVELOPMENT_KB_MANAGE feature permission to call this API operation.
|
|
2544
|
+
* - You must provide the OSS persistence address (filePath) of the file when uploading the file.
|
|
2545
|
+
* - Optional parameters include the public access URL and original file name to improve the completeness of the file information.
|
|
2546
|
+
* - If you specify directoryId, the file is placed in the corresponding enterprise knowledge base directory. Otherwise, the file is bound to the default root directory of the current digital employee.
|
|
2547
|
+
* - You can use sourceTags to add tags to resources for subsequent management and retrieval.
|
|
2548
2548
|
* - This operation generates a bill (UNSTRUCTURED_PARSE). Make sure that your account balance is sufficient.
|
|
2549
2549
|
*
|
|
2550
2550
|
* @param request - GetScheduledTaskExecutionRecordsRequest
|
|
@@ -3912,14 +3912,14 @@ export default class Client extends OpenApi {
|
|
|
3912
3912
|
*/
|
|
3913
3913
|
listOperatingObjectFavorites(request: $_model.ListOperatingObjectFavoritesRequest): Promise<$_model.ListOperatingObjectFavoritesResponse>;
|
|
3914
3914
|
/**
|
|
3915
|
-
* Performs a paged query
|
|
3915
|
+
* Performs a paged query to retrieve the visible outputs and the latest published file versions for the current user or a specified collaboration workspace. Supports filtering by session, label, and business ID. Paging and the total count are calculated based on the primary output records.
|
|
3916
3916
|
*
|
|
3917
3917
|
* @remarks
|
|
3918
3918
|
* If collaborationGroupId is not provided, queries the personal outputs of the current caller. If provided, queries the outputs of the specified collaboration workspace and verifies the real-time access permissions of the current workspace members and source resources. The caller identity and tenant permissions are determined by the authentication context.
|
|
3919
|
-
* The sessionId parameter requires an exact match for regular
|
|
3920
|
-
* Tags and business IDs are derived from file
|
|
3921
|
-
* For versioned files, the latest published version is returned by default without expanding historical versions. This API operation does not currently support querying specific versions. Pagination and the total count are still based on primary output records, deduplicated by outputId, and are not counted by the number of files or historical versions.
|
|
3922
|
-
* For versioned files, fileInfo.path is a time-sensitive download link attached to the published version and content revisions selected during the query. Downloads do not
|
|
3919
|
+
* The sessionId parameter requires an exact match for a regular session, skill session, or node execution session. The tags parameter requires all specified labels to match simultaneously. The bizId parameter requires an exact match for the business ID of a file registration or an associated workflow instance. The new conditions are combined with the existing operatingObjectName, itemType, keyword, and sharedOnly conditions using the AND operator, and are executed before counting and paging.
|
|
3920
|
+
* Tags and business IDs are derived from file registrations or workflow instance associations. Unregistered tags or business IDs are not inferred from titles. Pagination defaults to page 1 with 20 entries per page, up to a maximum of 100 entries, sorted in descending order by update time. The response structure remains compatible with the original API operation.
|
|
3921
|
+
* For versioned files, the latest published version is returned by default without expanding historical versions. This API operation does not currently support querying specific versions. Pagination and the total count are still based on the primary output records, deduplicated by outputId, and are not counted by the number of files or historical versions.
|
|
3922
|
+
* For versioned files, fileInfo.path is a time-sensitive download link attached to the published version and content revisions selected during the query. Downloads do not trigger an automatic switchover to other versions published later. Invoke this API operation again to obtain a new link after the current one expires. Historical files that have not yet formed a published version may not return download information.
|
|
3923
3923
|
*
|
|
3924
3924
|
* @param tmpReq - ListOutputFilesRequest
|
|
3925
3925
|
* @param headers - map
|
|
@@ -3930,14 +3930,14 @@ export default class Client extends OpenApi {
|
|
|
3930
3930
|
[key: string]: string;
|
|
3931
3931
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListOutputFilesResponse>;
|
|
3932
3932
|
/**
|
|
3933
|
-
* Performs a paged query
|
|
3933
|
+
* Performs a paged query to retrieve the visible outputs and the latest published file versions for the current user or a specified collaboration workspace. Supports filtering by session, label, and business ID. Paging and the total count are calculated based on the primary output records.
|
|
3934
3934
|
*
|
|
3935
3935
|
* @remarks
|
|
3936
3936
|
* If collaborationGroupId is not provided, queries the personal outputs of the current caller. If provided, queries the outputs of the specified collaboration workspace and verifies the real-time access permissions of the current workspace members and source resources. The caller identity and tenant permissions are determined by the authentication context.
|
|
3937
|
-
* The sessionId parameter requires an exact match for regular
|
|
3938
|
-
* Tags and business IDs are derived from file
|
|
3939
|
-
* For versioned files, the latest published version is returned by default without expanding historical versions. This API operation does not currently support querying specific versions. Pagination and the total count are still based on primary output records, deduplicated by outputId, and are not counted by the number of files or historical versions.
|
|
3940
|
-
* For versioned files, fileInfo.path is a time-sensitive download link attached to the published version and content revisions selected during the query. Downloads do not
|
|
3937
|
+
* The sessionId parameter requires an exact match for a regular session, skill session, or node execution session. The tags parameter requires all specified labels to match simultaneously. The bizId parameter requires an exact match for the business ID of a file registration or an associated workflow instance. The new conditions are combined with the existing operatingObjectName, itemType, keyword, and sharedOnly conditions using the AND operator, and are executed before counting and paging.
|
|
3938
|
+
* Tags and business IDs are derived from file registrations or workflow instance associations. Unregistered tags or business IDs are not inferred from titles. Pagination defaults to page 1 with 20 entries per page, up to a maximum of 100 entries, sorted in descending order by update time. The response structure remains compatible with the original API operation.
|
|
3939
|
+
* For versioned files, the latest published version is returned by default without expanding historical versions. This API operation does not currently support querying specific versions. Pagination and the total count are still based on the primary output records, deduplicated by outputId, and are not counted by the number of files or historical versions.
|
|
3940
|
+
* For versioned files, fileInfo.path is a time-sensitive download link attached to the published version and content revisions selected during the query. Downloads do not trigger an automatic switchover to other versions published later. Invoke this API operation again to obtain a new link after the current one expires. Historical files that have not yet formed a published version may not return download information.
|
|
3941
3941
|
*
|
|
3942
3942
|
* @param request - ListOutputFilesRequest
|
|
3943
3943
|
* @returns ListOutputFilesResponse
|
|
@@ -6040,11 +6040,11 @@ export default class Client extends OpenApi {
|
|
|
6040
6040
|
*
|
|
6041
6041
|
* @remarks
|
|
6042
6042
|
* ## Request description
|
|
6043
|
-
* - This API
|
|
6044
|
-
* - The source_type is fixed to FILE, the scope is fixed to PERSONAL, and the platform is fixed to LOCAL.
|
|
6045
|
-
* -
|
|
6046
|
-
* - If
|
|
6047
|
-
* -
|
|
6043
|
+
* - This API operation uploads a file to the My Resources section of a specified digital employee.
|
|
6044
|
+
* - The source_type parameter is fixed to FILE, the scope parameter is fixed to PERSONAL, and the platform parameter is fixed to LOCAL.
|
|
6045
|
+
* - You must provide an OSS persistence address (filePath) for the file. Other information, such as the public access URL and the original file name, is optional.
|
|
6046
|
+
* - If you do not specify a target folder ID (directoryId), the file is automatically attached to the default root folder of the current digital employee. If you specify a folder ID, make sure that the folder belongs to the personal folder of the user who invokes the API.
|
|
6047
|
+
* - You can authenticate through multiple methods (such as AK, BearerToken, and APP) for security authentication.
|
|
6048
6048
|
* - The operation type is write, and operation logs are recorded for subsequent auditing.
|
|
6049
6049
|
*
|
|
6050
6050
|
* @param tmpReq - SendChatMessageRequest
|
|
@@ -6060,11 +6060,11 @@ export default class Client extends OpenApi {
|
|
|
6060
6060
|
*
|
|
6061
6061
|
* @remarks
|
|
6062
6062
|
* ## Request description
|
|
6063
|
-
* - This API
|
|
6064
|
-
* - The source_type is fixed to FILE, the scope is fixed to PERSONAL, and the platform is fixed to LOCAL.
|
|
6065
|
-
* -
|
|
6066
|
-
* - If
|
|
6067
|
-
* -
|
|
6063
|
+
* - This API operation uploads a file to the My Resources section of a specified digital employee.
|
|
6064
|
+
* - The source_type parameter is fixed to FILE, the scope parameter is fixed to PERSONAL, and the platform parameter is fixed to LOCAL.
|
|
6065
|
+
* - You must provide an OSS persistence address (filePath) for the file. Other information, such as the public access URL and the original file name, is optional.
|
|
6066
|
+
* - If you do not specify a target folder ID (directoryId), the file is automatically attached to the default root folder of the current digital employee. If you specify a folder ID, make sure that the folder belongs to the personal folder of the user who invokes the API.
|
|
6067
|
+
* - You can authenticate through multiple methods (such as AK, BearerToken, and APP) for security authentication.
|
|
6068
6068
|
* - The operation type is write, and operation logs are recorded for subsequent auditing.
|
|
6069
6069
|
*
|
|
6070
6070
|
* @param tmpReq - SendChatMessageRequest
|
|
@@ -6080,11 +6080,11 @@ export default class Client extends OpenApi {
|
|
|
6080
6080
|
*
|
|
6081
6081
|
* @remarks
|
|
6082
6082
|
* ## Request description
|
|
6083
|
-
* - This API
|
|
6084
|
-
* - The source_type is fixed to FILE, the scope is fixed to PERSONAL, and the platform is fixed to LOCAL.
|
|
6085
|
-
* -
|
|
6086
|
-
* - If
|
|
6087
|
-
* -
|
|
6083
|
+
* - This API operation uploads a file to the My Resources section of a specified digital employee.
|
|
6084
|
+
* - The source_type parameter is fixed to FILE, the scope parameter is fixed to PERSONAL, and the platform parameter is fixed to LOCAL.
|
|
6085
|
+
* - You must provide an OSS persistence address (filePath) for the file. Other information, such as the public access URL and the original file name, is optional.
|
|
6086
|
+
* - If you do not specify a target folder ID (directoryId), the file is automatically attached to the default root folder of the current digital employee. If you specify a folder ID, make sure that the folder belongs to the personal folder of the user who invokes the API.
|
|
6087
|
+
* - You can authenticate through multiple methods (such as AK, BearerToken, and APP) for security authentication.
|
|
6088
6088
|
* - The operation type is write, and operation logs are recorded for subsequent auditing.
|
|
6089
6089
|
*
|
|
6090
6090
|
* @param request - SendChatMessageRequest
|
|
@@ -6350,23 +6350,23 @@ export default class Client extends OpenApi {
|
|
|
6350
6350
|
*/
|
|
6351
6351
|
togglePrimaryObjectFavorite(request: $_model.TogglePrimaryObjectFavoriteRequest): Promise<$_model.TogglePrimaryObjectFavoriteResponse>;
|
|
6352
6352
|
/**
|
|
6353
|
-
*
|
|
6353
|
+
* Transcribes speech to text.
|
|
6354
6354
|
*
|
|
6355
6355
|
* @remarks
|
|
6356
6356
|
* ## Request description
|
|
6357
|
-
* This API
|
|
6357
|
+
* This API performs automatic speech recognition (ASR) and uses the **file transfer upload** mode (`fileTransfer`). Audio files are not transmitted in the request body. Instead, they are first uploaded to Object Storage Service (OSS). The OSS URL is then passed to the backend through the `FileUrl` request parameter. The backend retrieves the audio bytes from the URL and calls the ASR model to transcribe the audio into text.
|
|
6358
6358
|
* ### Call methods
|
|
6359
|
-
* - **Recommended**: Use the `TranscribeChatVoiceAdvance` method generated by the SDK
|
|
6360
|
-
* - **Direct upload**: Upload the audio file to an OSS
|
|
6359
|
+
* - **Recommended**: Use the `TranscribeChatVoiceAdvance` method generated by the SDK and pass in the local audio file stream. The SDK automatically completes the transfer upload and populates the `FileUrl` parameter.
|
|
6360
|
+
* - **Direct upload**: Upload the audio file to an OSS URL that is accessible by the server. Then, call this API directly and pass in the `FileUrl` parameter.
|
|
6361
6361
|
* ### Request parameters
|
|
6362
|
-
* - **FileUrl**: Required. The OSS
|
|
6363
|
-
* - **FileName**: Required. The original file name including the extension, such as `meeting.mp3`. The OSS
|
|
6364
|
-
* - **ContentType**: Optional. The MIME type of the audio, such as `audio/mpeg`. If
|
|
6365
|
-
* - Supported audio formats:
|
|
6362
|
+
* - **FileUrl**: Required. The OSS URL of the audio file. If you use the Advance method, the SDK automatically populates this parameter. You do not need to manually assign a value.
|
|
6363
|
+
* - **FileName**: Required. The original file name, including the extension, such as `meeting.mp3`. The OSS URL generated during the transfer does not contain the original file name. The backend determines the audio format based on this parameter. Therefore, you must explicitly pass it.
|
|
6364
|
+
* - **ContentType**: Optional. The MIME type of the audio, such as `audio/mpeg`. If you do not pass this parameter, the format is determined based on the file name extension.
|
|
6365
|
+
* - Supported audio formats: MP3, WAV, M4A, MP4, WebM, OGG, OGA, Opus, FLAC, and AMR. Maximum size: 25 MB.
|
|
6366
6366
|
* ### Response parameters
|
|
6367
|
-
* Returns the recognized text content `text
|
|
6368
|
-
* ###
|
|
6369
|
-
* The tenant must have
|
|
6367
|
+
* Returns the recognized text content in the `text` field.
|
|
6368
|
+
* ### Prerequisites
|
|
6369
|
+
* The tenant must have configured a speech recognition model (model_audio_flash). If the model is not configured, the `ERR.Robject.Chat.VoiceAudioNotConfigured` error is returned.
|
|
6370
6370
|
*
|
|
6371
6371
|
* @param request - TranscribeChatVoiceRequest
|
|
6372
6372
|
* @param headers - map
|
|
@@ -6377,23 +6377,23 @@ export default class Client extends OpenApi {
|
|
|
6377
6377
|
[key: string]: string;
|
|
6378
6378
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.TranscribeChatVoiceResponse>;
|
|
6379
6379
|
/**
|
|
6380
|
-
*
|
|
6380
|
+
* Transcribes speech to text.
|
|
6381
6381
|
*
|
|
6382
6382
|
* @remarks
|
|
6383
6383
|
* ## Request description
|
|
6384
|
-
* This API
|
|
6384
|
+
* This API performs automatic speech recognition (ASR) and uses the **file transfer upload** mode (`fileTransfer`). Audio files are not transmitted in the request body. Instead, they are first uploaded to Object Storage Service (OSS). The OSS URL is then passed to the backend through the `FileUrl` request parameter. The backend retrieves the audio bytes from the URL and calls the ASR model to transcribe the audio into text.
|
|
6385
6385
|
* ### Call methods
|
|
6386
|
-
* - **Recommended**: Use the `TranscribeChatVoiceAdvance` method generated by the SDK
|
|
6387
|
-
* - **Direct upload**: Upload the audio file to an OSS
|
|
6386
|
+
* - **Recommended**: Use the `TranscribeChatVoiceAdvance` method generated by the SDK and pass in the local audio file stream. The SDK automatically completes the transfer upload and populates the `FileUrl` parameter.
|
|
6387
|
+
* - **Direct upload**: Upload the audio file to an OSS URL that is accessible by the server. Then, call this API directly and pass in the `FileUrl` parameter.
|
|
6388
6388
|
* ### Request parameters
|
|
6389
|
-
* - **FileUrl**: Required. The OSS
|
|
6390
|
-
* - **FileName**: Required. The original file name including the extension, such as `meeting.mp3`. The OSS
|
|
6391
|
-
* - **ContentType**: Optional. The MIME type of the audio, such as `audio/mpeg`. If
|
|
6392
|
-
* - Supported audio formats:
|
|
6389
|
+
* - **FileUrl**: Required. The OSS URL of the audio file. If you use the Advance method, the SDK automatically populates this parameter. You do not need to manually assign a value.
|
|
6390
|
+
* - **FileName**: Required. The original file name, including the extension, such as `meeting.mp3`. The OSS URL generated during the transfer does not contain the original file name. The backend determines the audio format based on this parameter. Therefore, you must explicitly pass it.
|
|
6391
|
+
* - **ContentType**: Optional. The MIME type of the audio, such as `audio/mpeg`. If you do not pass this parameter, the format is determined based on the file name extension.
|
|
6392
|
+
* - Supported audio formats: MP3, WAV, M4A, MP4, WebM, OGG, OGA, Opus, FLAC, and AMR. Maximum size: 25 MB.
|
|
6393
6393
|
* ### Response parameters
|
|
6394
|
-
* Returns the recognized text content `text
|
|
6395
|
-
* ###
|
|
6396
|
-
* The tenant must have
|
|
6394
|
+
* Returns the recognized text content in the `text` field.
|
|
6395
|
+
* ### Prerequisites
|
|
6396
|
+
* The tenant must have configured a speech recognition model (model_audio_flash). If the model is not configured, the `ERR.Robject.Chat.VoiceAudioNotConfigured` error is returned.
|
|
6397
6397
|
*
|
|
6398
6398
|
* @param request - TranscribeChatVoiceRequest
|
|
6399
6399
|
* @returns TranscribeChatVoiceResponse
|
|
@@ -7046,10 +7046,10 @@ export default class Client extends OpenApi {
|
|
|
7046
7046
|
[key: string]: string;
|
|
7047
7047
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UploadChatFileResponse>;
|
|
7048
7048
|
/**
|
|
7049
|
-
* Base64
|
|
7049
|
+
* Uploads a session file in Base64 format.
|
|
7050
7050
|
*
|
|
7051
7051
|
* @remarks
|
|
7052
|
-
*
|
|
7052
|
+
* Submits a local attachment by using standard Base64 encoding (the maximum decoding limit on the application side is 50 MiB) and returns the session file record ID.
|
|
7053
7053
|
*
|
|
7054
7054
|
* @param request - UploadChatFileByBase64Request
|
|
7055
7055
|
* @param headers - map
|
|
@@ -7060,10 +7060,10 @@ export default class Client extends OpenApi {
|
|
|
7060
7060
|
[key: string]: string;
|
|
7061
7061
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UploadChatFileByBase64Response>;
|
|
7062
7062
|
/**
|
|
7063
|
-
* Base64
|
|
7063
|
+
* Uploads a session file in Base64 format.
|
|
7064
7064
|
*
|
|
7065
7065
|
* @remarks
|
|
7066
|
-
*
|
|
7066
|
+
* Submits a local attachment by using standard Base64 encoding (the maximum decoding limit on the application side is 50 MiB) and returns the session file record ID.
|
|
7067
7067
|
*
|
|
7068
7068
|
* @param request - UploadChatFileByBase64Request
|
|
7069
7069
|
* @returns UploadChatFileByBase64Response
|