@alicloud/winnexo20260512 1.2.0 → 1.3.0
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 +229 -159
- package/dist/client.js +351 -164
- package/dist/client.js.map +1 -1
- package/dist/models/BatchRemoveOperatingObjectFavoritesRequest.d.ts +61 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesRequest.js +69 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesRequest.js.map +1 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesResponse.d.ts +19 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesResponse.js +69 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesResponse.js.map +1 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesResponseBody.d.ts +128 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesResponseBody.js +104 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesResponseBody.js.map +1 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesShrinkRequest.d.ts +61 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesShrinkRequest.js +66 -0
- package/dist/models/BatchRemoveOperatingObjectFavoritesShrinkRequest.js.map +1 -0
- package/dist/models/CheckHealthResponseBody.d.ts +3 -3
- package/dist/models/ClearOperatingObjectFavoritesRequest.d.ts +51 -0
- package/dist/models/ClearOperatingObjectFavoritesRequest.js +64 -0
- package/dist/models/ClearOperatingObjectFavoritesRequest.js.map +1 -0
- package/dist/models/ClearOperatingObjectFavoritesResponse.d.ts +19 -0
- package/dist/models/ClearOperatingObjectFavoritesResponse.js +69 -0
- package/dist/models/ClearOperatingObjectFavoritesResponse.js.map +1 -0
- package/dist/models/ClearOperatingObjectFavoritesResponseBody.d.ts +85 -0
- package/dist/models/ClearOperatingObjectFavoritesResponseBody.js +74 -0
- package/dist/models/ClearOperatingObjectFavoritesResponseBody.js.map +1 -0
- package/dist/models/CreateAnnouncementRequest.d.ts +2 -2
- package/dist/models/CreateAnnouncementResponseBody.d.ts +3 -3
- package/dist/models/CreateAnnouncementShrinkRequest.d.ts +2 -2
- package/dist/models/CreateConversationResponseBody.d.ts +3 -3
- package/dist/models/CreateGroupAliDingChatRequest.d.ts +0 -2
- package/dist/models/CreateGroupAliDingChatRequest.js +0 -2
- package/dist/models/CreateGroupAliDingChatRequest.js.map +1 -1
- package/dist/models/CreateGroupDingtalkChatRequest.d.ts +6 -6
- package/dist/models/CreateGroupDingtalkChatResponseBody.d.ts +4 -4
- package/dist/models/CreateGroupDingtalkChatShrinkRequest.d.ts +6 -6
- package/dist/models/CreateGroupFeishuDocRequest.d.ts +2 -2
- package/dist/models/CreateGroupFeishuDocResponseBody.d.ts +3 -3
- package/dist/models/CreateGroupFeishuDocShrinkRequest.d.ts +2 -2
- package/dist/models/CreateKnowledgeBaseAliDingDocResponseBody.d.ts +1 -1
- package/dist/models/CreatePersonalDingtalkMeetingResponseBody.d.ts +1 -1
- package/dist/models/CreatePersonalDirectoryRequest.d.ts +2 -2
- package/dist/models/CreatePersonalDirectoryResponseBody.d.ts +4 -4
- package/dist/models/CreateTenantDirectoryRequest.d.ts +1 -1
- package/dist/models/CreateTenantDirectoryResponseBody.d.ts +3 -3
- package/dist/models/CreateUserRequest.d.ts +10 -2
- package/dist/models/CreateUserRequest.js +2 -0
- package/dist/models/CreateUserRequest.js.map +1 -1
- package/dist/models/CreateUserShrinkRequest.d.ts +10 -2
- package/dist/models/CreateUserShrinkRequest.js +2 -0
- package/dist/models/CreateUserShrinkRequest.js.map +1 -1
- package/dist/models/CreateUserWithGroupsRequest.d.ts +7 -7
- package/dist/models/CreateUserWithGroupsResponseBody.d.ts +7 -7
- package/dist/models/CreateUserWithGroupsShrinkRequest.d.ts +7 -7
- package/dist/models/DeleteChatSessionRequest.d.ts +2 -2
- package/dist/models/GetChatSessionRequest.d.ts +1 -1
- package/dist/models/GetChatSessionResponseBody.d.ts +3 -3
- package/dist/models/GetScheduledTaskUnderstandDetailRequest.d.ts +3 -3
- package/dist/models/GetScheduledTaskUnderstandDetailResponseBody.d.ts +1 -1
- package/dist/models/GetScheduledTaskUnderstandDetailShrinkRequest.d.ts +2 -2
- package/dist/models/GetSourceRequest.d.ts +1 -1
- package/dist/models/GetSourceResponseBody.d.ts +4 -4
- package/dist/models/ListActiveAnnouncementsRequest.d.ts +3 -3
- package/dist/models/ListActiveAnnouncementsResponseBody.d.ts +7 -7
- package/dist/models/ListBillingRequest.d.ts +6 -6
- package/dist/models/ListBillingResponseBody.d.ts +5 -5
- package/dist/models/ListOperatingObjectFavoritesRequest.d.ts +67 -0
- package/dist/models/ListOperatingObjectFavoritesRequest.js +68 -0
- package/dist/models/ListOperatingObjectFavoritesRequest.js.map +1 -0
- package/dist/models/ListOperatingObjectFavoritesResponse.d.ts +19 -0
- package/dist/models/ListOperatingObjectFavoritesResponse.js +69 -0
- package/dist/models/ListOperatingObjectFavoritesResponse.js.map +1 -0
- package/dist/models/ListOperatingObjectFavoritesResponseBody.d.ts +158 -0
- package/dist/models/ListOperatingObjectFavoritesResponseBody.js +110 -0
- package/dist/models/ListOperatingObjectFavoritesResponseBody.js.map +1 -0
- package/dist/models/ListOutputFilesRequest.d.ts +3 -3
- package/dist/models/ListOutputFilesResponseBody.d.ts +2 -2
- package/dist/models/ListScheduledTasksRequest.d.ts +3 -3
- package/dist/models/ListScheduledTasksResponseBody.d.ts +7 -7
- package/dist/models/ListScheduledTasksShrinkRequest.d.ts +3 -3
- package/dist/models/ListSkillsRequest.d.ts +1 -1
- package/dist/models/ListSkillsResponseBody.d.ts +3 -3
- package/dist/models/ListSkillsShrinkRequest.d.ts +1 -1
- package/dist/models/ListVisibleKnowledgeBasesHeaders.d.ts +1 -1
- package/dist/models/ListVisibleKnowledgeBasesResponseBody.d.ts +7 -7
- package/dist/models/OfflineAnnouncementRequest.d.ts +1 -1
- package/dist/models/OfflineAnnouncementResponseBody.d.ts +1 -1
- package/dist/models/QueryPrimaryObjectDataRequest.d.ts +5 -5
- package/dist/models/QueryPrimaryObjectDataResponseBody.d.ts +1 -1
- package/dist/models/RecommendNextActionsRequest.d.ts +1 -1
- package/dist/models/RecommendNextActionsResponseBody.d.ts +1 -1
- package/dist/models/RetryDirectoryFailedSourcesRequest.d.ts +1 -1
- package/dist/models/RetryDirectoryFailedSourcesResponseBody.d.ts +2 -2
- package/dist/models/RetryKnowledgeBaseFailedSourcesRequest.d.ts +2 -2
- package/dist/models/RetryKnowledgeBaseFailedSourcesResponseBody.d.ts +2 -2
- package/dist/models/SendAsyncChatMessageResponseBody.d.ts +1 -1
- package/dist/models/SendChatMessageRequest.d.ts +2 -2
- package/dist/models/SendChatMessageShrinkRequest.d.ts +2 -2
- package/dist/models/StreamChatMessageRequest.d.ts +2 -2
- package/dist/models/StreamChatMessageResponseBody.d.ts +17 -1
- package/dist/models/StreamChatMessageResponseBody.js +4 -0
- package/dist/models/StreamChatMessageResponseBody.js.map +1 -1
- package/dist/models/UpdateChatSessionResponseBody.d.ts +1 -1
- package/dist/models/UploadChatFileAdvanceRequest.d.ts +13 -13
- package/dist/models/UploadChatFileRequest.d.ts +13 -13
- package/dist/models/UploadChatFileResponseBody.d.ts +13 -13
- package/dist/models/model.d.ts +12 -0
- package/dist/models/model.js +35 -11
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +374 -164
- package/src/models/BatchRemoveOperatingObjectFavoritesRequest.ts +85 -0
- package/src/models/BatchRemoveOperatingObjectFavoritesResponse.ts +40 -0
- package/src/models/BatchRemoveOperatingObjectFavoritesResponseBody.ts +176 -0
- package/src/models/BatchRemoveOperatingObjectFavoritesShrinkRequest.ts +82 -0
- package/src/models/CheckHealthResponseBody.ts +3 -3
- package/src/models/ClearOperatingObjectFavoritesRequest.ts +70 -0
- package/src/models/ClearOperatingObjectFavoritesResponse.ts +40 -0
- package/src/models/ClearOperatingObjectFavoritesResponseBody.ts +114 -0
- package/src/models/CreateAnnouncementRequest.ts +2 -2
- package/src/models/CreateAnnouncementResponseBody.ts +3 -3
- package/src/models/CreateAnnouncementShrinkRequest.ts +2 -2
- package/src/models/CreateConversationResponseBody.ts +3 -3
- package/src/models/CreateGroupAliDingChatRequest.ts +0 -2
- package/src/models/CreateGroupDingtalkChatRequest.ts +6 -6
- package/src/models/CreateGroupDingtalkChatResponseBody.ts +4 -4
- package/src/models/CreateGroupDingtalkChatShrinkRequest.ts +6 -6
- package/src/models/CreateGroupFeishuDocRequest.ts +2 -2
- package/src/models/CreateGroupFeishuDocResponseBody.ts +3 -3
- package/src/models/CreateGroupFeishuDocShrinkRequest.ts +2 -2
- package/src/models/CreateKnowledgeBaseAliDingDocResponseBody.ts +1 -1
- package/src/models/CreatePersonalDingtalkMeetingResponseBody.ts +1 -1
- package/src/models/CreatePersonalDirectoryRequest.ts +2 -2
- package/src/models/CreatePersonalDirectoryResponseBody.ts +4 -4
- package/src/models/CreateTenantDirectoryRequest.ts +1 -1
- package/src/models/CreateTenantDirectoryResponseBody.ts +3 -3
- package/src/models/CreateUserRequest.ts +12 -2
- package/src/models/CreateUserShrinkRequest.ts +12 -2
- package/src/models/CreateUserWithGroupsRequest.ts +7 -7
- package/src/models/CreateUserWithGroupsResponseBody.ts +7 -7
- package/src/models/CreateUserWithGroupsShrinkRequest.ts +7 -7
- package/src/models/DeleteChatSessionRequest.ts +2 -2
- package/src/models/GetChatSessionRequest.ts +1 -1
- package/src/models/GetChatSessionResponseBody.ts +3 -3
- package/src/models/GetScheduledTaskUnderstandDetailRequest.ts +3 -3
- package/src/models/GetScheduledTaskUnderstandDetailResponseBody.ts +1 -1
- package/src/models/GetScheduledTaskUnderstandDetailShrinkRequest.ts +2 -2
- package/src/models/GetSourceRequest.ts +1 -1
- package/src/models/GetSourceResponseBody.ts +4 -4
- package/src/models/ListActiveAnnouncementsRequest.ts +3 -3
- package/src/models/ListActiveAnnouncementsResponseBody.ts +7 -7
- package/src/models/ListBillingRequest.ts +6 -6
- package/src/models/ListBillingResponseBody.ts +5 -5
- package/src/models/ListOperatingObjectFavoritesRequest.ts +90 -0
- package/src/models/ListOperatingObjectFavoritesResponse.ts +40 -0
- package/src/models/ListOperatingObjectFavoritesResponseBody.ts +214 -0
- package/src/models/ListOutputFilesRequest.ts +3 -3
- package/src/models/ListOutputFilesResponseBody.ts +2 -2
- package/src/models/ListScheduledTasksRequest.ts +3 -3
- package/src/models/ListScheduledTasksResponseBody.ts +7 -7
- package/src/models/ListScheduledTasksShrinkRequest.ts +3 -3
- package/src/models/ListSkillsRequest.ts +1 -1
- package/src/models/ListSkillsResponseBody.ts +3 -3
- package/src/models/ListSkillsShrinkRequest.ts +1 -1
- package/src/models/ListVisibleKnowledgeBasesHeaders.ts +1 -1
- package/src/models/ListVisibleKnowledgeBasesResponseBody.ts +7 -7
- package/src/models/OfflineAnnouncementRequest.ts +1 -1
- package/src/models/OfflineAnnouncementResponseBody.ts +1 -1
- package/src/models/QueryPrimaryObjectDataRequest.ts +5 -5
- package/src/models/QueryPrimaryObjectDataResponseBody.ts +1 -1
- package/src/models/RecommendNextActionsRequest.ts +1 -1
- package/src/models/RecommendNextActionsResponseBody.ts +1 -1
- package/src/models/RetryDirectoryFailedSourcesRequest.ts +1 -1
- package/src/models/RetryDirectoryFailedSourcesResponseBody.ts +2 -2
- package/src/models/RetryKnowledgeBaseFailedSourcesRequest.ts +2 -2
- package/src/models/RetryKnowledgeBaseFailedSourcesResponseBody.ts +2 -2
- package/src/models/SendAsyncChatMessageResponseBody.ts +1 -1
- package/src/models/SendChatMessageRequest.ts +2 -2
- package/src/models/SendChatMessageShrinkRequest.ts +2 -2
- package/src/models/StreamChatMessageRequest.ts +2 -2
- package/src/models/StreamChatMessageResponseBody.ts +21 -1
- package/src/models/UpdateChatSessionResponseBody.ts +1 -1
- package/src/models/UploadChatFileAdvanceRequest.ts +13 -13
- package/src/models/UploadChatFileRequest.ts +13 -13
- package/src/models/UploadChatFileResponseBody.ts +13 -13
- package/src/models/model.ts +12 -0
package/dist/client.d.ts
CHANGED
|
@@ -45,6 +45,30 @@ export default class Client extends OpenApi {
|
|
|
45
45
|
* @returns AddUserGroupMembersResponse
|
|
46
46
|
*/
|
|
47
47
|
addUserGroupMembers(request: $_model.AddUserGroupMembersRequest): Promise<$_model.AddUserGroupMembersResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* Batch cancels digital employee favorites for specific object types.
|
|
50
|
+
*
|
|
51
|
+
* @remarks
|
|
52
|
+
* Idempotently cancels favorites across three independent dimensions: graphName, operatingObjectName, and objectType. The input array accepts 1 to 200 items per request. Each item must be a non-empty string with a maximum length of 128 characters. The server validates and deduplicates items while preserving order. Non-string values, values that exceed the length limit, or arrays that exceed the size limit are rejected. Deletion, per-item status updates, and remaining valid count are completed within a single transaction. To safely cancel all favorites, you must also call ClearOperatingObjectFavorites to clean up historical records, MISSING records, or permission-hidden records that are not visible in the list. Then read back the result to confirm that total is 0.
|
|
53
|
+
*
|
|
54
|
+
* @param tmpReq - BatchRemoveOperatingObjectFavoritesRequest
|
|
55
|
+
* @param headers - map
|
|
56
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
57
|
+
* @returns BatchRemoveOperatingObjectFavoritesResponse
|
|
58
|
+
*/
|
|
59
|
+
batchRemoveOperatingObjectFavoritesWithOptions(tmpReq: $_model.BatchRemoveOperatingObjectFavoritesRequest, headers: {
|
|
60
|
+
[key: string]: string;
|
|
61
|
+
}, runtime: $dara.RuntimeOptions): Promise<$_model.BatchRemoveOperatingObjectFavoritesResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Batch cancels digital employee favorites for specific object types.
|
|
64
|
+
*
|
|
65
|
+
* @remarks
|
|
66
|
+
* Idempotently cancels favorites across three independent dimensions: graphName, operatingObjectName, and objectType. The input array accepts 1 to 200 items per request. Each item must be a non-empty string with a maximum length of 128 characters. The server validates and deduplicates items while preserving order. Non-string values, values that exceed the length limit, or arrays that exceed the size limit are rejected. Deletion, per-item status updates, and remaining valid count are completed within a single transaction. To safely cancel all favorites, you must also call ClearOperatingObjectFavorites to clean up historical records, MISSING records, or permission-hidden records that are not visible in the list. Then read back the result to confirm that total is 0.
|
|
67
|
+
*
|
|
68
|
+
* @param request - BatchRemoveOperatingObjectFavoritesRequest
|
|
69
|
+
* @returns BatchRemoveOperatingObjectFavoritesResponse
|
|
70
|
+
*/
|
|
71
|
+
batchRemoveOperatingObjectFavorites(request: $_model.BatchRemoveOperatingObjectFavoritesRequest): Promise<$_model.BatchRemoveOperatingObjectFavoritesResponse>;
|
|
48
72
|
/**
|
|
49
73
|
* Performs a service health check.
|
|
50
74
|
*
|
|
@@ -63,15 +87,39 @@ export default class Client extends OpenApi {
|
|
|
63
87
|
* @returns CheckHealthResponse
|
|
64
88
|
*/
|
|
65
89
|
checkHealth(request: $_model.CheckHealthRequest): Promise<$_model.CheckHealthResponse>;
|
|
90
|
+
/**
|
|
91
|
+
* Clears all follows of a specific object type for a digital employee.
|
|
92
|
+
*
|
|
93
|
+
* @remarks
|
|
94
|
+
* Clears all persisted follows for the current calling user across three independent dimensions: graphName, operatingObjectName, and objectType. This includes historical records, MISSING records, and permission-hidden records that are not visible in the list. The operation does not return invisible object IDs and verifies that the remaining physical record count is zero within the same transaction.
|
|
95
|
+
*
|
|
96
|
+
* @param request - ClearOperatingObjectFavoritesRequest
|
|
97
|
+
* @param headers - map
|
|
98
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
99
|
+
* @returns ClearOperatingObjectFavoritesResponse
|
|
100
|
+
*/
|
|
101
|
+
clearOperatingObjectFavoritesWithOptions(request: $_model.ClearOperatingObjectFavoritesRequest, headers: {
|
|
102
|
+
[key: string]: string;
|
|
103
|
+
}, runtime: $dara.RuntimeOptions): Promise<$_model.ClearOperatingObjectFavoritesResponse>;
|
|
104
|
+
/**
|
|
105
|
+
* Clears all follows of a specific object type for a digital employee.
|
|
106
|
+
*
|
|
107
|
+
* @remarks
|
|
108
|
+
* Clears all persisted follows for the current calling user across three independent dimensions: graphName, operatingObjectName, and objectType. This includes historical records, MISSING records, and permission-hidden records that are not visible in the list. The operation does not return invisible object IDs and verifies that the remaining physical record count is zero within the same transaction.
|
|
109
|
+
*
|
|
110
|
+
* @param request - ClearOperatingObjectFavoritesRequest
|
|
111
|
+
* @returns ClearOperatingObjectFavoritesResponse
|
|
112
|
+
*/
|
|
113
|
+
clearOperatingObjectFavorites(request: $_model.ClearOperatingObjectFavoritesRequest): Promise<$_model.ClearOperatingObjectFavoritesResponse>;
|
|
66
114
|
/**
|
|
67
115
|
* Creates a service notice.
|
|
68
116
|
*
|
|
69
117
|
* @remarks
|
|
70
|
-
* ##
|
|
71
|
-
* Creates a service notice. The caller
|
|
118
|
+
* ## Request description
|
|
119
|
+
* Creates a service notice. The caller must be mapped to a real platform user in the system O&M tenant and must have announcement management permissions.
|
|
72
120
|
* - `priority`: The importance level of the notice. Valid values: URGENT, IMPORTANT, and GENERAL.
|
|
73
121
|
* - `targetTenantIds` / `targetRoleCodes`: Used only when the corresponding target mode is set to SPECIFIED. Pass values as a JSON array.
|
|
74
|
-
* - `effectiveStart` / `effectiveEnd`: ISO 8601
|
|
122
|
+
* - `effectiveStart` / `effectiveEnd`: ISO 8601 time with time zone.
|
|
75
123
|
* - `publishNow`: If set to true, the notice is published immediately after creation. Otherwise, it is saved as a draft.
|
|
76
124
|
*
|
|
77
125
|
* @param tmpReq - CreateAnnouncementRequest
|
|
@@ -86,11 +134,11 @@ export default class Client extends OpenApi {
|
|
|
86
134
|
* Creates a service notice.
|
|
87
135
|
*
|
|
88
136
|
* @remarks
|
|
89
|
-
* ##
|
|
90
|
-
* Creates a service notice. The caller
|
|
137
|
+
* ## Request description
|
|
138
|
+
* Creates a service notice. The caller must be mapped to a real platform user in the system O&M tenant and must have announcement management permissions.
|
|
91
139
|
* - `priority`: The importance level of the notice. Valid values: URGENT, IMPORTANT, and GENERAL.
|
|
92
140
|
* - `targetTenantIds` / `targetRoleCodes`: Used only when the corresponding target mode is set to SPECIFIED. Pass values as a JSON array.
|
|
93
|
-
* - `effectiveStart` / `effectiveEnd`: ISO 8601
|
|
141
|
+
* - `effectiveStart` / `effectiveEnd`: ISO 8601 time with time zone.
|
|
94
142
|
* - `publishNow`: If set to true, the notice is published immediately after creation. Otherwise, it is saved as a draft.
|
|
95
143
|
*
|
|
96
144
|
* @param request - CreateAnnouncementRequest
|
|
@@ -184,15 +232,15 @@ export default class Client extends OpenApi {
|
|
|
184
232
|
*/
|
|
185
233
|
createGroupAliDingChat(request: $_model.CreateGroupAliDingChatRequest): Promise<$_model.CreateGroupAliDingChatResponse>;
|
|
186
234
|
/**
|
|
187
|
-
* Creates a
|
|
235
|
+
* Creates knowledge from a standard DingTalk group chat for a group.
|
|
188
236
|
*
|
|
189
237
|
* @remarks
|
|
190
|
-
* ##
|
|
191
|
-
* - Connects a specified DingTalk chat to the knowledge base
|
|
238
|
+
* ## Request description
|
|
239
|
+
* - Connects a specified standard DingTalk group chat to the group knowledge base that the caller has joined.
|
|
192
240
|
* - The resource type is fixed to DINGTALK, the scope is fixed to GROUP, and the owning user is parsed from the gateway authentication identity.
|
|
193
241
|
* - groupId, chatId, and historyStartTime are required.
|
|
194
|
-
* - updateFrequency can be configured
|
|
195
|
-
* - The server verifies the caller\\"s group
|
|
242
|
+
* - updateFrequency can be configured through preset or a five-segment cron expression for subsequent synchronization frequency.
|
|
243
|
+
* - The server verifies the caller\\"s group member identity and target group directory permissions. The same group chat can be created as different Sources.
|
|
196
244
|
*
|
|
197
245
|
* @param tmpReq - CreateGroupDingtalkChatRequest
|
|
198
246
|
* @param headers - map
|
|
@@ -203,15 +251,15 @@ export default class Client extends OpenApi {
|
|
|
203
251
|
[key: string]: string;
|
|
204
252
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateGroupDingtalkChatResponse>;
|
|
205
253
|
/**
|
|
206
|
-
* Creates a
|
|
254
|
+
* Creates knowledge from a standard DingTalk group chat for a group.
|
|
207
255
|
*
|
|
208
256
|
* @remarks
|
|
209
|
-
* ##
|
|
210
|
-
* - Connects a specified DingTalk chat to the knowledge base
|
|
257
|
+
* ## Request description
|
|
258
|
+
* - Connects a specified standard DingTalk group chat to the group knowledge base that the caller has joined.
|
|
211
259
|
* - The resource type is fixed to DINGTALK, the scope is fixed to GROUP, and the owning user is parsed from the gateway authentication identity.
|
|
212
260
|
* - groupId, chatId, and historyStartTime are required.
|
|
213
|
-
* - updateFrequency can be configured
|
|
214
|
-
* - The server verifies the caller\\"s group
|
|
261
|
+
* - updateFrequency can be configured through preset or a five-segment cron expression for subsequent synchronization frequency.
|
|
262
|
+
* - The server verifies the caller\\"s group member identity and target group directory permissions. The same group chat can be created as different Sources.
|
|
215
263
|
*
|
|
216
264
|
* @param request - CreateGroupDingtalkChatRequest
|
|
217
265
|
* @returns CreateGroupDingtalkChatResponse
|
|
@@ -671,9 +719,9 @@ export default class Client extends OpenApi {
|
|
|
671
719
|
* @remarks
|
|
672
720
|
* ## Request description
|
|
673
721
|
* - This API is used to create a personal folder (category) under "My Resources".
|
|
674
|
-
* - If `parentDirectoryId` is not specified, the system automatically uses or creates the default root folder of the current digital
|
|
675
|
-
* - If `parentDirectoryId` is specified, it must be an existing personal folder of the current user under the current digital
|
|
676
|
-
* - `tenant_id` and `user_id` are derived from the
|
|
722
|
+
* - If `parentDirectoryId` is not specified, the system automatically uses or creates the default root folder of the current digital employee as the parent folder.
|
|
723
|
+
* - If `parentDirectoryId` is specified, it must be an existing personal folder of the current user under the current digital employee.
|
|
724
|
+
* - `tenant_id` and `user_id` are derived from the authenticated identity only. These fields are ignored if passed in the request body.
|
|
677
725
|
*
|
|
678
726
|
* @param request - CreatePersonalDirectoryRequest
|
|
679
727
|
* @param headers - map
|
|
@@ -689,9 +737,9 @@ export default class Client extends OpenApi {
|
|
|
689
737
|
* @remarks
|
|
690
738
|
* ## Request description
|
|
691
739
|
* - This API is used to create a personal folder (category) under "My Resources".
|
|
692
|
-
* - If `parentDirectoryId` is not specified, the system automatically uses or creates the default root folder of the current digital
|
|
693
|
-
* - If `parentDirectoryId` is specified, it must be an existing personal folder of the current user under the current digital
|
|
694
|
-
* - `tenant_id` and `user_id` are derived from the
|
|
740
|
+
* - If `parentDirectoryId` is not specified, the system automatically uses or creates the default root folder of the current digital employee as the parent folder.
|
|
741
|
+
* - If `parentDirectoryId` is specified, it must be an existing personal folder of the current user under the current digital employee.
|
|
742
|
+
* - `tenant_id` and `user_id` are derived from the authenticated identity only. These fields are ignored if passed in the request body.
|
|
695
743
|
*
|
|
696
744
|
* @param request - CreatePersonalDirectoryRequest
|
|
697
745
|
* @returns CreatePersonalDirectoryResponse
|
|
@@ -956,11 +1004,11 @@ export default class Client extends OpenApi {
|
|
|
956
1004
|
*
|
|
957
1005
|
* @remarks
|
|
958
1006
|
* ## Request description
|
|
959
|
-
* - This API is used to create a new enterprise knowledge base
|
|
960
|
-
* - You can
|
|
961
|
-
* - The `path` parameter is optional. If this parameter is not specified, the system automatically calculates the path based on the parent
|
|
1007
|
+
* - This API is used to create a new enterprise knowledge base folder under a specified tenant.
|
|
1008
|
+
* - You can set the `parentId` parameter to specify the parent folder of the new folder. If this parameter is not specified, the folder is created as a root folder by default.
|
|
1009
|
+
* - The `path` parameter is optional. If this parameter is not specified, the system automatically calculates the path based on the parent folder.
|
|
962
1010
|
* - Calling this operation requires the corresponding permissions. Multiple authentication methods are supported, including AK, BearerToken, and APP authentication.
|
|
963
|
-
* - After the
|
|
1011
|
+
* - After the folder is created, the related information about the new folder is returned, such as the folder ID and name.
|
|
964
1012
|
*
|
|
965
1013
|
* @param request - CreateTenantDirectoryRequest
|
|
966
1014
|
* @param headers - map
|
|
@@ -975,11 +1023,11 @@ export default class Client extends OpenApi {
|
|
|
975
1023
|
*
|
|
976
1024
|
* @remarks
|
|
977
1025
|
* ## Request description
|
|
978
|
-
* - This API is used to create a new enterprise knowledge base
|
|
979
|
-
* - You can
|
|
980
|
-
* - The `path` parameter is optional. If this parameter is not specified, the system automatically calculates the path based on the parent
|
|
1026
|
+
* - This API is used to create a new enterprise knowledge base folder under a specified tenant.
|
|
1027
|
+
* - You can set the `parentId` parameter to specify the parent folder of the new folder. If this parameter is not specified, the folder is created as a root folder by default.
|
|
1028
|
+
* - The `path` parameter is optional. If this parameter is not specified, the system automatically calculates the path based on the parent folder.
|
|
981
1029
|
* - Calling this operation requires the corresponding permissions. Multiple authentication methods are supported, including AK, BearerToken, and APP authentication.
|
|
982
|
-
* - After the
|
|
1030
|
+
* - After the folder is created, the related information about the new folder is returned, such as the folder ID and name.
|
|
983
1031
|
*
|
|
984
1032
|
* @param request - CreateTenantDirectoryRequest
|
|
985
1033
|
* @returns CreateTenantDirectoryResponse
|
|
@@ -991,12 +1039,12 @@ export default class Client extends OpenApi {
|
|
|
991
1039
|
* @remarks
|
|
992
1040
|
* Creates a user by using OpenAPI.
|
|
993
1041
|
* Business orchestration:
|
|
994
|
-
* 1. Parses roleCodes
|
|
1042
|
+
* 1. Parses roleCodes into role_ids (validates against system role enumerations).
|
|
995
1043
|
* 2. Checks whether the user already exists (used to return the isNewUser flag).
|
|
996
|
-
* 3. Calls UserManagementService.add_tenant_member to create or add the user (the password must be passed
|
|
1044
|
+
* 3. Calls UserManagementService.add_tenant_member to create or add the user (the password must be passed by the caller as an RSA ciphertext).
|
|
997
1045
|
* 4. Returns the creation result (including the isNewUser flag).
|
|
998
1046
|
* Error codes:
|
|
999
|
-
* - ERR.User.DeactivatedInTenant: The user is deactivated in the tenant. Use updateUser to
|
|
1047
|
+
* - ERR.User.DeactivatedInTenant: The user is deactivated in the tenant. Use updateUser to restore the user.
|
|
1000
1048
|
* - ERR.User.AlreadyInTenant: The user is already an active member of the tenant.
|
|
1001
1049
|
* - ERR.User.DisplayNameDuplicateInTenant: The display name is duplicate within the tenant.
|
|
1002
1050
|
*
|
|
@@ -1014,12 +1062,12 @@ export default class Client extends OpenApi {
|
|
|
1014
1062
|
* @remarks
|
|
1015
1063
|
* Creates a user by using OpenAPI.
|
|
1016
1064
|
* Business orchestration:
|
|
1017
|
-
* 1. Parses roleCodes
|
|
1065
|
+
* 1. Parses roleCodes into role_ids (validates against system role enumerations).
|
|
1018
1066
|
* 2. Checks whether the user already exists (used to return the isNewUser flag).
|
|
1019
|
-
* 3. Calls UserManagementService.add_tenant_member to create or add the user (the password must be passed
|
|
1067
|
+
* 3. Calls UserManagementService.add_tenant_member to create or add the user (the password must be passed by the caller as an RSA ciphertext).
|
|
1020
1068
|
* 4. Returns the creation result (including the isNewUser flag).
|
|
1021
1069
|
* Error codes:
|
|
1022
|
-
* - ERR.User.DeactivatedInTenant: The user is deactivated in the tenant. Use updateUser to
|
|
1070
|
+
* - ERR.User.DeactivatedInTenant: The user is deactivated in the tenant. Use updateUser to restore the user.
|
|
1023
1071
|
* - ERR.User.AlreadyInTenant: The user is already an active member of the tenant.
|
|
1024
1072
|
* - ERR.User.DisplayNameDuplicateInTenant: The display name is duplicate within the tenant.
|
|
1025
1073
|
*
|
|
@@ -1055,16 +1103,15 @@ export default class Client extends OpenApi {
|
|
|
1055
1103
|
* Creates a WINNEXO user in the current tenant and assigns roles and user groups to the user.
|
|
1056
1104
|
*
|
|
1057
1105
|
* @remarks
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1067
|
-
* - ERR.User.DisplayNameDuplicateInTenant: The display name is duplicate within the tenant.
|
|
1106
|
+
* ## Request description
|
|
1107
|
+
* - This operation creates a WINNEXO user under a specified tenant and optionally assigns system roles and user groups to the user.
|
|
1108
|
+
* - The `accountId` parameter serves as the logon account for the user and must be unique.
|
|
1109
|
+
* - The `displayName` parameter specifies the display name of the user, which must also be unique within the tenant and cannot exceed 100 characters in length.
|
|
1110
|
+
* - The optional `roleCodes` parameter specifies a list of roles for the user. By default, the `APPLICATION_USER` role is assigned.
|
|
1111
|
+
* - The `userGroupIds` parameter allows you to add up to 100 user group IDs to the new user. Make sure that all specified user groups belong to the same tenant.
|
|
1112
|
+
* - The password must be encrypted by using the RSA-OAEP-SHA256 algorithm and submitted in Base64 format.
|
|
1113
|
+
* - This operation supports calls over HTTPS and requires the request body in JSON format.
|
|
1114
|
+
* - For security authentication, AK, BearerToken, and APP are supported.
|
|
1068
1115
|
*
|
|
1069
1116
|
* @param tmpReq - CreateUserWithGroupsRequest
|
|
1070
1117
|
* @param headers - map
|
|
@@ -1078,16 +1125,15 @@ export default class Client extends OpenApi {
|
|
|
1078
1125
|
* Creates a WINNEXO user in the current tenant and assigns roles and user groups to the user.
|
|
1079
1126
|
*
|
|
1080
1127
|
* @remarks
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1083
|
-
*
|
|
1084
|
-
*
|
|
1085
|
-
*
|
|
1086
|
-
*
|
|
1087
|
-
*
|
|
1088
|
-
*
|
|
1089
|
-
*
|
|
1090
|
-
* - ERR.User.DisplayNameDuplicateInTenant: The display name is duplicate within the tenant.
|
|
1128
|
+
* ## Request description
|
|
1129
|
+
* - This operation creates a WINNEXO user under a specified tenant and optionally assigns system roles and user groups to the user.
|
|
1130
|
+
* - The `accountId` parameter serves as the logon account for the user and must be unique.
|
|
1131
|
+
* - The `displayName` parameter specifies the display name of the user, which must also be unique within the tenant and cannot exceed 100 characters in length.
|
|
1132
|
+
* - The optional `roleCodes` parameter specifies a list of roles for the user. By default, the `APPLICATION_USER` role is assigned.
|
|
1133
|
+
* - The `userGroupIds` parameter allows you to add up to 100 user group IDs to the new user. Make sure that all specified user groups belong to the same tenant.
|
|
1134
|
+
* - The password must be encrypted by using the RSA-OAEP-SHA256 algorithm and submitted in Base64 format.
|
|
1135
|
+
* - This operation supports calls over HTTPS and requires the request body in JSON format.
|
|
1136
|
+
* - For security authentication, AK, BearerToken, and APP are supported.
|
|
1091
1137
|
*
|
|
1092
1138
|
* @param request - CreateUserWithGroupsRequest
|
|
1093
1139
|
* @returns CreateUserWithGroupsResponse
|
|
@@ -1101,8 +1147,8 @@ export default class Client extends OpenApi {
|
|
|
1101
1147
|
* - This API is used to upload a file to the "My Resources" section of a specified digital employee.
|
|
1102
1148
|
* - `source_type` is fixed to `FILE`, `scope` is fixed to `PERSONAL`, and `platform` is fixed to `LOCAL`.
|
|
1103
1149
|
* - The file must include an OSS persistent address (`filePath`). Other information such as the public access URL and original file name is optional.
|
|
1104
|
-
* - If the target directory ID (`directoryId`) is not specified, the file is automatically
|
|
1105
|
-
* -
|
|
1150
|
+
* - If the target directory ID (`directoryId`) is not specified, the file is automatically bound to the default root directory of the current digital employee. If specified, ensure that the directory belongs to the caller\\"s personal directory.
|
|
1151
|
+
* - Multiple authentication methods (AK, BearerToken, APP) are supported for security authentication.
|
|
1106
1152
|
* - The operation type is write (`write`), and operation logs are recorded for subsequent auditing.
|
|
1107
1153
|
*
|
|
1108
1154
|
* @param request - DeleteChatSessionRequest
|
|
@@ -1121,8 +1167,8 @@ export default class Client extends OpenApi {
|
|
|
1121
1167
|
* - This API is used to upload a file to the "My Resources" section of a specified digital employee.
|
|
1122
1168
|
* - `source_type` is fixed to `FILE`, `scope` is fixed to `PERSONAL`, and `platform` is fixed to `LOCAL`.
|
|
1123
1169
|
* - The file must include an OSS persistent address (`filePath`). Other information such as the public access URL and original file name is optional.
|
|
1124
|
-
* - If the target directory ID (`directoryId`) is not specified, the file is automatically
|
|
1125
|
-
* -
|
|
1170
|
+
* - If the target directory ID (`directoryId`) is not specified, the file is automatically bound to the default root directory of the current digital employee. If specified, ensure that the directory belongs to the caller\\"s personal directory.
|
|
1171
|
+
* - Multiple authentication methods (AK, BearerToken, APP) are supported for security authentication.
|
|
1126
1172
|
* - The operation type is write (`write`), and operation logs are recorded for subsequent auditing.
|
|
1127
1173
|
*
|
|
1128
1174
|
* @param request - DeleteChatSessionRequest
|
|
@@ -1276,7 +1322,7 @@ export default class Client extends OpenApi {
|
|
|
1276
1322
|
* - `source_type` is fixed to `FILE`, `scope` is fixed to `PERSONAL`, and `platform` is fixed to `LOCAL`.
|
|
1277
1323
|
* - The file must include an OSS persistent address (`filePath`). Other information such as the public access URL and original file name is optional.
|
|
1278
1324
|
* - If no target folder ID (`directoryId`) is specified, the file is automatically attached to the default root folder of the current digital employee. If specified, ensure that the folder belongs to the invoker\\"s personal folder.
|
|
1279
|
-
* -
|
|
1325
|
+
* - Multiple authentication methods (AK, BearerToken, APP) are supported to authenticate requests.
|
|
1280
1326
|
* - The operation type is write (`write`), and operation logs are recorded for subsequent auditing.
|
|
1281
1327
|
*
|
|
1282
1328
|
* @param request - GetChatSessionRequest
|
|
@@ -1296,7 +1342,7 @@ export default class Client extends OpenApi {
|
|
|
1296
1342
|
* - `source_type` is fixed to `FILE`, `scope` is fixed to `PERSONAL`, and `platform` is fixed to `LOCAL`.
|
|
1297
1343
|
* - The file must include an OSS persistent address (`filePath`). Other information such as the public access URL and original file name is optional.
|
|
1298
1344
|
* - If no target folder ID (`directoryId`) is specified, the file is automatically attached to the default root folder of the current digital employee. If specified, ensure that the folder belongs to the invoker\\"s personal folder.
|
|
1299
|
-
* -
|
|
1345
|
+
* - Multiple authentication methods (AK, BearerToken, APP) are supported to authenticate requests.
|
|
1300
1346
|
* - The operation type is write (`write`), and operation logs are recorded for subsequent auditing.
|
|
1301
1347
|
*
|
|
1302
1348
|
* @param request - GetChatSessionRequest
|
|
@@ -1503,12 +1549,12 @@ export default class Client extends OpenApi {
|
|
|
1503
1549
|
* Retrieves the details of scheduled task understanding.
|
|
1504
1550
|
*
|
|
1505
1551
|
* @remarks
|
|
1506
|
-
* ##
|
|
1552
|
+
* ## Operation description
|
|
1507
1553
|
* - This operation uploads a file to the enterprise knowledge base.
|
|
1508
|
-
* -
|
|
1509
|
-
* -
|
|
1510
|
-
* - Optional parameters include the public access URL
|
|
1511
|
-
* - If `directoryId` is specified, 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
|
|
1554
|
+
* - The `DEVELOPMENT_KB_MANAGE` feature permission is required to call this API.
|
|
1555
|
+
* - The OSS persistent address (`filePath`) of the file must be provided during upload.
|
|
1556
|
+
* - Optional parameters include the public access URL and original file name to enhance the completeness of file information.
|
|
1557
|
+
* - If `directoryId` is specified, 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.
|
|
1512
1558
|
* - You can add tags to the resource by using `sourceTags` for subsequent management and retrieval.
|
|
1513
1559
|
* - This operation initiates a billing item (UNSTRUCTURED_PARSE). Ensure that your account balance is sufficient.
|
|
1514
1560
|
*
|
|
@@ -1526,12 +1572,12 @@ export default class Client extends OpenApi {
|
|
|
1526
1572
|
* Retrieves the details of scheduled task understanding.
|
|
1527
1573
|
*
|
|
1528
1574
|
* @remarks
|
|
1529
|
-
* ##
|
|
1575
|
+
* ## Operation description
|
|
1530
1576
|
* - This operation uploads a file to the enterprise knowledge base.
|
|
1531
|
-
* -
|
|
1532
|
-
* -
|
|
1533
|
-
* - Optional parameters include the public access URL
|
|
1534
|
-
* - If `directoryId` is specified, 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
|
|
1577
|
+
* - The `DEVELOPMENT_KB_MANAGE` feature permission is required to call this API.
|
|
1578
|
+
* - The OSS persistent address (`filePath`) of the file must be provided during upload.
|
|
1579
|
+
* - Optional parameters include the public access URL and original file name to enhance the completeness of file information.
|
|
1580
|
+
* - If `directoryId` is specified, 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.
|
|
1535
1581
|
* - You can add tags to the resource by using `sourceTags` for subsequent management and retrieval.
|
|
1536
1582
|
* - This operation initiates a billing item (UNSTRUCTURED_PARSE). Ensure that your account balance is sufficient.
|
|
1537
1583
|
*
|
|
@@ -1937,8 +1983,8 @@ export default class Client extends OpenApi {
|
|
|
1937
1983
|
* Queries currently effective service notices.
|
|
1938
1984
|
*
|
|
1939
1985
|
* @remarks
|
|
1940
|
-
* ##
|
|
1941
|
-
* Performs a paging query for published platform
|
|
1986
|
+
* ## Operation description
|
|
1987
|
+
* Performs a paging query for published platform announcements that are effective within the current database time window. The caller must be a real user in the system O&M tenant who has the permission to view announcements.
|
|
1942
1988
|
*
|
|
1943
1989
|
* @param request - ListActiveAnnouncementsRequest
|
|
1944
1990
|
* @param headers - map
|
|
@@ -1952,8 +1998,8 @@ export default class Client extends OpenApi {
|
|
|
1952
1998
|
* Queries currently effective service notices.
|
|
1953
1999
|
*
|
|
1954
2000
|
* @remarks
|
|
1955
|
-
* ##
|
|
1956
|
-
* Performs a paging query for published platform
|
|
2001
|
+
* ## Operation description
|
|
2002
|
+
* Performs a paging query for published platform announcements that are effective within the current database time window. The caller must be a real user in the system O&M tenant who has the permission to view announcements.
|
|
1957
2003
|
*
|
|
1958
2004
|
* @param request - ListActiveAnnouncementsRequest
|
|
1959
2005
|
* @returns ListActiveAnnouncementsResponse
|
|
@@ -2141,12 +2187,12 @@ export default class Client extends OpenApi {
|
|
|
2141
2187
|
* Queries and filters the bill list through OpenAPI with support for multiple filter conditions.
|
|
2142
2188
|
*
|
|
2143
2189
|
* @remarks
|
|
2144
|
-
* ##
|
|
2190
|
+
* ## Request description
|
|
2145
2191
|
* - This operation queries the bill list based on specified conditions.
|
|
2146
2192
|
* - Supports filtering by tenant, user, operation type, status, time range, business source, and other conditions.
|
|
2147
2193
|
* - Returns bill data in pages. The default page size is 20 records.
|
|
2148
2194
|
* - You can choose whether to filter out bills with zero credit consumption. By default, such bills are filtered out.
|
|
2149
|
-
* - Authentication information (such as AK, BearerToken, or APP authentication) is required
|
|
2195
|
+
* - Authentication information (such as AK, BearerToken, or APP authentication) is required for the request.
|
|
2150
2196
|
*
|
|
2151
2197
|
* @param request - ListBillingRequest
|
|
2152
2198
|
* @param headers - map
|
|
@@ -2160,12 +2206,12 @@ export default class Client extends OpenApi {
|
|
|
2160
2206
|
* Queries and filters the bill list through OpenAPI with support for multiple filter conditions.
|
|
2161
2207
|
*
|
|
2162
2208
|
* @remarks
|
|
2163
|
-
* ##
|
|
2209
|
+
* ## Request description
|
|
2164
2210
|
* - This operation queries the bill list based on specified conditions.
|
|
2165
2211
|
* - Supports filtering by tenant, user, operation type, status, time range, business source, and other conditions.
|
|
2166
2212
|
* - Returns bill data in pages. The default page size is 20 records.
|
|
2167
2213
|
* - You can choose whether to filter out bills with zero credit consumption. By default, such bills are filtered out.
|
|
2168
|
-
* - Authentication information (such as AK, BearerToken, or APP authentication) is required
|
|
2214
|
+
* - Authentication information (such as AK, BearerToken, or APP authentication) is required for the request.
|
|
2169
2215
|
*
|
|
2170
2216
|
* @param request - ListBillingRequest
|
|
2171
2217
|
* @returns ListBillingResponse
|
|
@@ -2264,17 +2310,41 @@ export default class Client extends OpenApi {
|
|
|
2264
2310
|
*/
|
|
2265
2311
|
listKnowledgeBaseDirectories(request: $_model.ListKnowledgeBaseDirectoriesRequest): Promise<$_model.ListKnowledgeBaseDirectoriesResponse>;
|
|
2266
2312
|
/**
|
|
2267
|
-
* Queries the
|
|
2313
|
+
* Queries the precise object type follows of a digital employee by page.
|
|
2314
|
+
*
|
|
2315
|
+
* @remarks
|
|
2316
|
+
* Queries follows by three independent dimensions: graphName, operatingObjectName, and objectType. Supports primary objects and explicit first-level associated objects. Uses opaque cursor pagination and is not limited by the 1000-item display window of the follow panel.
|
|
2317
|
+
*
|
|
2318
|
+
* @param request - ListOperatingObjectFavoritesRequest
|
|
2319
|
+
* @param headers - map
|
|
2320
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2321
|
+
* @returns ListOperatingObjectFavoritesResponse
|
|
2322
|
+
*/
|
|
2323
|
+
listOperatingObjectFavoritesWithOptions(request: $_model.ListOperatingObjectFavoritesRequest, headers: {
|
|
2324
|
+
[key: string]: string;
|
|
2325
|
+
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListOperatingObjectFavoritesResponse>;
|
|
2326
|
+
/**
|
|
2327
|
+
* Queries the precise object type follows of a digital employee by page.
|
|
2328
|
+
*
|
|
2329
|
+
* @remarks
|
|
2330
|
+
* Queries follows by three independent dimensions: graphName, operatingObjectName, and objectType. Supports primary objects and explicit first-level associated objects. Uses opaque cursor pagination and is not limited by the 1000-item display window of the follow panel.
|
|
2331
|
+
*
|
|
2332
|
+
* @param request - ListOperatingObjectFavoritesRequest
|
|
2333
|
+
* @returns ListOperatingObjectFavoritesResponse
|
|
2334
|
+
*/
|
|
2335
|
+
listOperatingObjectFavorites(request: $_model.ListOperatingObjectFavoritesRequest): Promise<$_model.ListOperatingObjectFavoritesResponse>;
|
|
2336
|
+
/**
|
|
2337
|
+
* Queries the output list of the current user, with support for conditional filtering and pagination.
|
|
2268
2338
|
*
|
|
2269
2339
|
* @remarks
|
|
2270
2340
|
* ## Operation description
|
|
2271
|
-
* - This API operation queries the output list of the current
|
|
2272
|
-
* - `tenantId` is a common parameter. If
|
|
2273
|
-
* -
|
|
2274
|
-
* - Set `sharedOnly` to `true` to display only
|
|
2275
|
-
* - Pagination is controlled by `page` (page number) and `pageSize` (number of
|
|
2341
|
+
* - This API operation queries the output list of the current logged-in user.
|
|
2342
|
+
* - `tenantId` is a common parameter. If not specified, the default tenant of the caller is used.
|
|
2343
|
+
* - Supports filtering by parameters such as `operatingObjectName`, `itemType`, and `keyword`.
|
|
2344
|
+
* - Set `sharedOnly` to `true` to display only outputs with sharing enabled.
|
|
2345
|
+
* - Pagination is controlled by `page` (page number) and `pageSize` (number of items per page). By default, results start from page 1 with 20 records per page.
|
|
2276
2346
|
* - Results are sorted by update time in descending order by default.
|
|
2277
|
-
* - The `tenant_id` or `user_id`
|
|
2347
|
+
* - The `tenant_id` or `user_id` passed in the request body by the caller is ignored. This information is derived only from the authenticated identity.
|
|
2278
2348
|
*
|
|
2279
2349
|
* @param request - ListOutputFilesRequest
|
|
2280
2350
|
* @param headers - map
|
|
@@ -2285,17 +2355,17 @@ export default class Client extends OpenApi {
|
|
|
2285
2355
|
[key: string]: string;
|
|
2286
2356
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListOutputFilesResponse>;
|
|
2287
2357
|
/**
|
|
2288
|
-
* Queries the output list of the current user with support for conditional filtering and pagination.
|
|
2358
|
+
* Queries the output list of the current user, with support for conditional filtering and pagination.
|
|
2289
2359
|
*
|
|
2290
2360
|
* @remarks
|
|
2291
2361
|
* ## Operation description
|
|
2292
|
-
* - This API operation queries the output list of the current
|
|
2293
|
-
* - `tenantId` is a common parameter. If
|
|
2294
|
-
* -
|
|
2295
|
-
* - Set `sharedOnly` to `true` to display only
|
|
2296
|
-
* - Pagination is controlled by `page` (page number) and `pageSize` (number of
|
|
2362
|
+
* - This API operation queries the output list of the current logged-in user.
|
|
2363
|
+
* - `tenantId` is a common parameter. If not specified, the default tenant of the caller is used.
|
|
2364
|
+
* - Supports filtering by parameters such as `operatingObjectName`, `itemType`, and `keyword`.
|
|
2365
|
+
* - Set `sharedOnly` to `true` to display only outputs with sharing enabled.
|
|
2366
|
+
* - Pagination is controlled by `page` (page number) and `pageSize` (number of items per page). By default, results start from page 1 with 20 records per page.
|
|
2297
2367
|
* - Results are sorted by update time in descending order by default.
|
|
2298
|
-
* - The `tenant_id` or `user_id`
|
|
2368
|
+
* - The `tenant_id` or `user_id` passed in the request body by the caller is ignored. This information is derived only from the authenticated identity.
|
|
2299
2369
|
*
|
|
2300
2370
|
* @param request - ListOutputFilesRequest
|
|
2301
2371
|
* @returns ListOutputFilesResponse
|
|
@@ -2379,7 +2449,7 @@ export default class Client extends OpenApi {
|
|
|
2379
2449
|
* @remarks
|
|
2380
2450
|
* ## Operation description
|
|
2381
2451
|
* - This operation uploads a file to an enterprise knowledge base.
|
|
2382
|
-
* - The
|
|
2452
|
+
* - The DEVELOPMENT_KB_MANAGE permission is required to call this operation.
|
|
2383
2453
|
* - You must provide the OSS persistent address (`filePath`) of the file when uploading.
|
|
2384
2454
|
* - Optional parameters include the public access URL and original file name to enhance the completeness of file information.
|
|
2385
2455
|
* - If `directoryId` is specified, 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.
|
|
@@ -2400,7 +2470,7 @@ export default class Client extends OpenApi {
|
|
|
2400
2470
|
* @remarks
|
|
2401
2471
|
* ## Operation description
|
|
2402
2472
|
* - This operation uploads a file to an enterprise knowledge base.
|
|
2403
|
-
* - The
|
|
2473
|
+
* - The DEVELOPMENT_KB_MANAGE permission is required to call this operation.
|
|
2404
2474
|
* - You must provide the OSS persistent address (`filePath`) of the file when uploading.
|
|
2405
2475
|
* - Optional parameters include the public access URL and original file name to enhance the completeness of file information.
|
|
2406
2476
|
* - If `directoryId` is specified, 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.
|
|
@@ -2416,15 +2486,15 @@ export default class Client extends OpenApi {
|
|
|
2416
2486
|
*
|
|
2417
2487
|
* @remarks
|
|
2418
2488
|
* ## Request description
|
|
2419
|
-
* This API retrieves all visible skills under the current tenant. It supports filtering by digital employee binding relationship, skill source, tags,
|
|
2489
|
+
* This API retrieves all visible skills under the current tenant. It supports filtering by digital employee binding relationship, skill source, tags, and keywords, and supports pagination.
|
|
2420
2490
|
* ### Request parameters
|
|
2421
2491
|
* - **TenantId**: Optional. A common parameter passed through by the gateway to the backend header. If not specified, the default tenant of the current caller is used.
|
|
2422
2492
|
* - **FilterType**: Optional. The skill filtering dimension. Valid values: `ALL` (all published), `BUILTIN` (built-in published), `CUSTOM` (custom published), `DRAFT` (drafts, including published skills with unpublished modifications). Default value: `ALL`.
|
|
2423
|
-
* - **Tags**: Optional. Filters by tags. A match
|
|
2424
|
-
* - **Keyword**: Optional. Performs fuzzy
|
|
2493
|
+
* - **Tags**: Optional. Filters by tags. A match is returned if any tag in the array is hit.
|
|
2494
|
+
* - **Keyword**: Optional. Performs a fuzzy match on the skill name or description.
|
|
2425
2495
|
* - **Page**: Optional. The page number. Minimum value: 1. Default value: 1.
|
|
2426
|
-
* - **PageSize**: Optional. The number of entries per page.
|
|
2427
|
-
* - **OperatingObjectName**: Optional. The digital employee name. If specified,
|
|
2496
|
+
* - **PageSize**: Optional. The number of entries per page. Valid values: 1 to 100. Default value: 20.
|
|
2497
|
+
* - **OperatingObjectName**: Optional. The digital employee name. If specified, results are filtered by binding relationship. Must be used together with `BindStatus`.
|
|
2428
2498
|
* - **BindStatus**: Optional. The binding status. Valid values: `BOUND` (bound), `UNBOUND` (unbound global skills).
|
|
2429
2499
|
* ### Response parameters
|
|
2430
2500
|
* The response contains the skill list `items`, total count `total`, current page `page`, and page size `pageSize`.
|
|
@@ -2442,15 +2512,15 @@ export default class Client extends OpenApi {
|
|
|
2442
2512
|
*
|
|
2443
2513
|
* @remarks
|
|
2444
2514
|
* ## Request description
|
|
2445
|
-
* This API retrieves all visible skills under the current tenant. It supports filtering by digital employee binding relationship, skill source, tags,
|
|
2515
|
+
* This API retrieves all visible skills under the current tenant. It supports filtering by digital employee binding relationship, skill source, tags, and keywords, and supports pagination.
|
|
2446
2516
|
* ### Request parameters
|
|
2447
2517
|
* - **TenantId**: Optional. A common parameter passed through by the gateway to the backend header. If not specified, the default tenant of the current caller is used.
|
|
2448
2518
|
* - **FilterType**: Optional. The skill filtering dimension. Valid values: `ALL` (all published), `BUILTIN` (built-in published), `CUSTOM` (custom published), `DRAFT` (drafts, including published skills with unpublished modifications). Default value: `ALL`.
|
|
2449
|
-
* - **Tags**: Optional. Filters by tags. A match
|
|
2450
|
-
* - **Keyword**: Optional. Performs fuzzy
|
|
2519
|
+
* - **Tags**: Optional. Filters by tags. A match is returned if any tag in the array is hit.
|
|
2520
|
+
* - **Keyword**: Optional. Performs a fuzzy match on the skill name or description.
|
|
2451
2521
|
* - **Page**: Optional. The page number. Minimum value: 1. Default value: 1.
|
|
2452
|
-
* - **PageSize**: Optional. The number of entries per page.
|
|
2453
|
-
* - **OperatingObjectName**: Optional. The digital employee name. If specified,
|
|
2522
|
+
* - **PageSize**: Optional. The number of entries per page. Valid values: 1 to 100. Default value: 20.
|
|
2523
|
+
* - **OperatingObjectName**: Optional. The digital employee name. If specified, results are filtered by binding relationship. Must be used together with `BindStatus`.
|
|
2454
2524
|
* - **BindStatus**: Optional. The binding status. Valid values: `BOUND` (bound), `UNBOUND` (unbound global skills).
|
|
2455
2525
|
* ### Response parameters
|
|
2456
2526
|
* The response contains the skill list `items`, total count `total`, current page `page`, and page size `pageSize`.
|
|
@@ -2766,11 +2836,11 @@ export default class Client extends OpenApi {
|
|
|
2766
2836
|
*/
|
|
2767
2837
|
moveResource(request: $_model.MoveResourceRequest): Promise<$_model.MoveResourceResponse>;
|
|
2768
2838
|
/**
|
|
2769
|
-
*
|
|
2839
|
+
* Takes a service notice offline.
|
|
2770
2840
|
*
|
|
2771
2841
|
* @remarks
|
|
2772
|
-
* ##
|
|
2773
|
-
* Idempotently
|
|
2842
|
+
* ## Operation description
|
|
2843
|
+
* Idempotently takes a platform announcement offline by announcement ID. Returns `changed=true` when a PUBLISHED announcement is taken offline for the first time. Returns `changed=false` when the announcement is already offline or expired.
|
|
2774
2844
|
* The caller must belong to the system operations tenant and have announcement management permissions.
|
|
2775
2845
|
*
|
|
2776
2846
|
* @param request - OfflineAnnouncementRequest
|
|
@@ -2782,11 +2852,11 @@ export default class Client extends OpenApi {
|
|
|
2782
2852
|
[key: string]: string;
|
|
2783
2853
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.OfflineAnnouncementResponse>;
|
|
2784
2854
|
/**
|
|
2785
|
-
*
|
|
2855
|
+
* Takes a service notice offline.
|
|
2786
2856
|
*
|
|
2787
2857
|
* @remarks
|
|
2788
|
-
* ##
|
|
2789
|
-
* Idempotently
|
|
2858
|
+
* ## Operation description
|
|
2859
|
+
* Idempotently takes a platform announcement offline by announcement ID. Returns `changed=true` when a PUBLISHED announcement is taken offline for the first time. Returns `changed=false` when the announcement is already offline or expired.
|
|
2790
2860
|
* The caller must belong to the system operations tenant and have announcement management permissions.
|
|
2791
2861
|
*
|
|
2792
2862
|
* @param request - OfflineAnnouncementRequest
|
|
@@ -2858,15 +2928,15 @@ export default class Client extends OpenApi {
|
|
|
2858
2928
|
*/
|
|
2859
2929
|
previewPersonalSource(request: $_model.PreviewPersonalSourceRequest): Promise<$_model.PreviewPersonalSourceResponse>;
|
|
2860
2930
|
/**
|
|
2861
|
-
* Queries primary object data by operating object name with
|
|
2931
|
+
* Queries primary object data by operating object name with pagination, and supports filtering and searching.
|
|
2862
2932
|
*
|
|
2863
2933
|
* @remarks
|
|
2864
|
-
* ##
|
|
2865
|
-
* - This API queries primary object data
|
|
2866
|
-
* -
|
|
2867
|
-
* - Complex filter conditions can be used to further
|
|
2934
|
+
* ## Request description
|
|
2935
|
+
* - This API queries primary object data with pagination based on a specified operating object name (such as `customer_1`).
|
|
2936
|
+
* - Supports keyword-based searching and allows you to specify whether to return only objects marked as favorites.
|
|
2937
|
+
* - Complex filter conditions can be used to further refine results, including but not limited to logical operators such as equal to, not equal to, greater than, and less than.
|
|
2868
2938
|
* - If no primary object type is configured, an empty result set is returned.
|
|
2869
|
-
* - Data in the request undergoes authentication and filtering to ensure security and accuracy.
|
|
2939
|
+
* - Data included in the request undergoes authentication and filtering to ensure security and accuracy.
|
|
2870
2940
|
*
|
|
2871
2941
|
* @param request - QueryPrimaryObjectDataRequest
|
|
2872
2942
|
* @param headers - map
|
|
@@ -2877,15 +2947,15 @@ export default class Client extends OpenApi {
|
|
|
2877
2947
|
[key: string]: string;
|
|
2878
2948
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.QueryPrimaryObjectDataResponse>;
|
|
2879
2949
|
/**
|
|
2880
|
-
* Queries primary object data by operating object name with
|
|
2950
|
+
* Queries primary object data by operating object name with pagination, and supports filtering and searching.
|
|
2881
2951
|
*
|
|
2882
2952
|
* @remarks
|
|
2883
|
-
* ##
|
|
2884
|
-
* - This API queries primary object data
|
|
2885
|
-
* -
|
|
2886
|
-
* - Complex filter conditions can be used to further
|
|
2953
|
+
* ## Request description
|
|
2954
|
+
* - This API queries primary object data with pagination based on a specified operating object name (such as `customer_1`).
|
|
2955
|
+
* - Supports keyword-based searching and allows you to specify whether to return only objects marked as favorites.
|
|
2956
|
+
* - Complex filter conditions can be used to further refine results, including but not limited to logical operators such as equal to, not equal to, greater than, and less than.
|
|
2887
2957
|
* - If no primary object type is configured, an empty result set is returned.
|
|
2888
|
-
* - Data in the request undergoes authentication and filtering to ensure security and accuracy.
|
|
2958
|
+
* - Data included in the request undergoes authentication and filtering to ensure security and accuracy.
|
|
2889
2959
|
*
|
|
2890
2960
|
* @param request - QueryPrimaryObjectDataRequest
|
|
2891
2961
|
* @returns QueryPrimaryObjectDataResponse
|
|
@@ -3355,7 +3425,7 @@ export default class Client extends OpenApi {
|
|
|
3355
3425
|
* - Ensure that `tenantId` and `userId` come from verified identity information.
|
|
3356
3426
|
* ### Precautions
|
|
3357
3427
|
* - `directoryId` is a required parameter that specifies the target folder in which to check and retry failed data sources.
|
|
3358
|
-
* - If `tenantId` is not provided, the tenant ID
|
|
3428
|
+
* - If `tenantId` is not provided, the caller\\"s tenant ID is used by default.
|
|
3359
3429
|
* - The API supports multiple authentication methods, including AccessKey, BearerToken, and APP authentication.
|
|
3360
3430
|
*
|
|
3361
3431
|
* @param request - RetryDirectoryFailedSourcesRequest
|
|
@@ -3378,7 +3448,7 @@ export default class Client extends OpenApi {
|
|
|
3378
3448
|
* - Ensure that `tenantId` and `userId` come from verified identity information.
|
|
3379
3449
|
* ### Precautions
|
|
3380
3450
|
* - `directoryId` is a required parameter that specifies the target folder in which to check and retry failed data sources.
|
|
3381
|
-
* - If `tenantId` is not provided, the tenant ID
|
|
3451
|
+
* - If `tenantId` is not provided, the caller\\"s tenant ID is used by default.
|
|
3382
3452
|
* - The API supports multiple authentication methods, including AccessKey, BearerToken, and APP authentication.
|
|
3383
3453
|
*
|
|
3384
3454
|
* @param request - RetryDirectoryFailedSourcesRequest
|
|
@@ -3386,15 +3456,15 @@ export default class Client extends OpenApi {
|
|
|
3386
3456
|
*/
|
|
3387
3457
|
retryDirectoryFailedSources(request: $_model.RetryDirectoryFailedSourcesRequest): Promise<$_model.RetryDirectoryFailedSourcesResponse>;
|
|
3388
3458
|
/**
|
|
3389
|
-
* Retries all data sources in failed status under a specified directory in
|
|
3459
|
+
* Retries all data sources in failed status under a specified directory in batches.
|
|
3390
3460
|
*
|
|
3391
3461
|
* @remarks
|
|
3392
|
-
* ##
|
|
3462
|
+
* ## Operation description
|
|
3393
3463
|
* This API retrieves and retries all data sources in FAILED status under a specified enterprise knowledge base directory (including its subdirectories). The request returns immediately, and the actual retry operations are executed asynchronously in the background.
|
|
3394
3464
|
* - **Authentication**: In addition to basic authentication, the `DEVELOPMENT_KB_MANAGE` permission is required.
|
|
3395
3465
|
* - **Security constraints**: Only callers with the corresponding tenant and user identity are allowed access, and KB management permission is required. Administrators can initiate retries for failed resources of any user.
|
|
3396
3466
|
* - **Parameters**:
|
|
3397
|
-
* - `directoryId` (required): The ID of the enterprise knowledge base directory
|
|
3467
|
+
* - `directoryId` (required): The ID of the enterprise knowledge base directory to check and retry failed data sources.
|
|
3398
3468
|
* - `tenantId` (optional): The tenant ID. The default tenant of the caller is used if this parameter is not specified.
|
|
3399
3469
|
* - **Response**: On success, returns the number of data sources enqueued for retry and related details.
|
|
3400
3470
|
*
|
|
@@ -3407,15 +3477,15 @@ export default class Client extends OpenApi {
|
|
|
3407
3477
|
[key: string]: string;
|
|
3408
3478
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.RetryKnowledgeBaseFailedSourcesResponse>;
|
|
3409
3479
|
/**
|
|
3410
|
-
* Retries all data sources in failed status under a specified directory in
|
|
3480
|
+
* Retries all data sources in failed status under a specified directory in batches.
|
|
3411
3481
|
*
|
|
3412
3482
|
* @remarks
|
|
3413
|
-
* ##
|
|
3483
|
+
* ## Operation description
|
|
3414
3484
|
* This API retrieves and retries all data sources in FAILED status under a specified enterprise knowledge base directory (including its subdirectories). The request returns immediately, and the actual retry operations are executed asynchronously in the background.
|
|
3415
3485
|
* - **Authentication**: In addition to basic authentication, the `DEVELOPMENT_KB_MANAGE` permission is required.
|
|
3416
3486
|
* - **Security constraints**: Only callers with the corresponding tenant and user identity are allowed access, and KB management permission is required. Administrators can initiate retries for failed resources of any user.
|
|
3417
3487
|
* - **Parameters**:
|
|
3418
|
-
* - `directoryId` (required): The ID of the enterprise knowledge base directory
|
|
3488
|
+
* - `directoryId` (required): The ID of the enterprise knowledge base directory to check and retry failed data sources.
|
|
3419
3489
|
* - `tenantId` (optional): The tenant ID. The default tenant of the caller is used if this parameter is not specified.
|
|
3420
3490
|
* - **Response**: On success, returns the number of data sources enqueued for retry and related details.
|
|
3421
3491
|
*
|
|
@@ -3633,11 +3703,11 @@ export default class Client extends OpenApi {
|
|
|
3633
3703
|
* Sends a message.
|
|
3634
3704
|
*
|
|
3635
3705
|
* @remarks
|
|
3636
|
-
* ##
|
|
3706
|
+
* ## Request description
|
|
3637
3707
|
* - This API is used to upload a file to the "My Resources" section of a specified digital employee.
|
|
3638
3708
|
* - `source_type` is fixed to `FILE`, `scope` is fixed to `PERSONAL`, and `platform` is fixed to `LOCAL`.
|
|
3639
|
-
* -
|
|
3640
|
-
* - If
|
|
3709
|
+
* - The file must include an OSS persistent address (`filePath`). Other information such as the public access URL and original file name is optional.
|
|
3710
|
+
* - If no target folder ID (`directoryId`) is specified, the file is automatically attached to the default root folder of the current digital employee. If specified, ensure that the folder belongs to the invoker\\"s personal folder.
|
|
3641
3711
|
* - Multiple authentication methods (AK, BearerToken, APP) are supported to authenticate requests.
|
|
3642
3712
|
* - The operation type is write, and operation logs are recorded for subsequent auditing.
|
|
3643
3713
|
*
|
|
@@ -3653,11 +3723,11 @@ export default class Client extends OpenApi {
|
|
|
3653
3723
|
* Sends a message.
|
|
3654
3724
|
*
|
|
3655
3725
|
* @remarks
|
|
3656
|
-
* ##
|
|
3726
|
+
* ## Request description
|
|
3657
3727
|
* - This API is used to upload a file to the "My Resources" section of a specified digital employee.
|
|
3658
3728
|
* - `source_type` is fixed to `FILE`, `scope` is fixed to `PERSONAL`, and `platform` is fixed to `LOCAL`.
|
|
3659
|
-
* -
|
|
3660
|
-
* - If
|
|
3729
|
+
* - The file must include an OSS persistent address (`filePath`). Other information such as the public access URL and original file name is optional.
|
|
3730
|
+
* - If no target folder ID (`directoryId`) is specified, the file is automatically attached to the default root folder of the current digital employee. If specified, ensure that the folder belongs to the invoker\\"s personal folder.
|
|
3661
3731
|
* - Multiple authentication methods (AK, BearerToken, APP) are supported to authenticate requests.
|
|
3662
3732
|
* - The operation type is write, and operation logs are recorded for subsequent auditing.
|
|
3663
3733
|
*
|
|
@@ -3673,11 +3743,11 @@ export default class Client extends OpenApi {
|
|
|
3673
3743
|
* Sends a message.
|
|
3674
3744
|
*
|
|
3675
3745
|
* @remarks
|
|
3676
|
-
* ##
|
|
3746
|
+
* ## Request description
|
|
3677
3747
|
* - This API is used to upload a file to the "My Resources" section of a specified digital employee.
|
|
3678
3748
|
* - `source_type` is fixed to `FILE`, `scope` is fixed to `PERSONAL`, and `platform` is fixed to `LOCAL`.
|
|
3679
|
-
* -
|
|
3680
|
-
* - If
|
|
3749
|
+
* - The file must include an OSS persistent address (`filePath`). Other information such as the public access URL and original file name is optional.
|
|
3750
|
+
* - If no target folder ID (`directoryId`) is specified, the file is automatically attached to the default root folder of the current digital employee. If specified, ensure that the folder belongs to the invoker\\"s personal folder.
|
|
3681
3751
|
* - Multiple authentication methods (AK, BearerToken, APP) are supported to authenticate requests.
|
|
3682
3752
|
* - The operation type is write, and operation logs are recorded for subsequent auditing.
|
|
3683
3753
|
*
|
|
@@ -4214,21 +4284,21 @@ export default class Client extends OpenApi {
|
|
|
4214
4284
|
*/
|
|
4215
4285
|
updateUserInfo(request: $_model.UpdateUserInfoRequest): Promise<$_model.UpdateUserInfoResponse>;
|
|
4216
4286
|
/**
|
|
4217
|
-
* Uploads a local file
|
|
4287
|
+
* Uploads a local file for a session.
|
|
4218
4288
|
*
|
|
4219
4289
|
* @remarks
|
|
4220
4290
|
* ## Operation description
|
|
4221
|
-
* This API
|
|
4222
|
-
* ###
|
|
4223
|
-
* - **Recommended**: Use the `UploadChatFileAdvance` method generated by the SDK. Pass in the local file stream, and the SDK automatically completes the transfer upload and populates `FileUrl
|
|
4224
|
-
* - **Direct upload**: Upload the file to an OSS address accessible by the server, and then
|
|
4291
|
+
* This API operation uploads a temporary temporary file by using the **file transfer upload** mode (`fileTransfer`). The file binary data is not transmitted in the request body of this API operation. Instead, the file is first uploaded to Object Storage Service (OSS), and then the OSS address is passed to the backend through the `FileUrl` parameter. The backend retrieves the bytes from that address, writes them to its own OSS bucket, and creates a temporary temporary file record.
|
|
4292
|
+
* ### How to call
|
|
4293
|
+
* - **Recommended**: Use the `UploadChatFileAdvance` method generated by the SDK. Pass in the local file stream, and the SDK automatically completes the transfer upload and populates the `FileUrl` parameter.
|
|
4294
|
+
* - **Direct upload**: Upload the file to an OSS address accessible by the server, and then call this API operation directly with the `FileUrl` parameter.
|
|
4225
4295
|
* ### Request parameters
|
|
4226
|
-
* - **FileUrl**: Required. The OSS address of the file. When you use the Advance method, the SDK automatically populates this parameter. You do not need to manually
|
|
4227
|
-
* - **FileName**: Required. The original file name including the extension, such as `report.pdf`. The OSS address generated during transfer does not carry the original file name. The backend uses this parameter to determine the file extension and display name. Therefore, you must explicitly pass in this parameter.
|
|
4296
|
+
* - **FileUrl**: Required. The OSS address of the file. When you use the Advance method, the SDK automatically populates this parameter. You do not need to manually set it.
|
|
4297
|
+
* - **FileName**: Required. The original file name including the extension, such as `report.pdf`. The OSS address generated during the transfer does not carry the original file name. The backend uses this parameter to determine the file extension and display name. Therefore, you must explicitly pass in this parameter.
|
|
4228
4298
|
* - **ContentType**: Optional. The MIME type of the file. If this parameter is not specified, `application/octet-stream` is used.
|
|
4229
|
-
* - **OperatingObjectName**: Optional. The
|
|
4299
|
+
* - **OperatingObjectName**: Optional. The agent namespace identifier that determines the file storage path.
|
|
4230
4300
|
* ### Response parameters
|
|
4231
|
-
* The response includes the OSS object path `objectName`, the storage address `fileUrl`, the
|
|
4301
|
+
* The response includes the OSS object path `objectName`, the storage address `fileUrl`, the publicly accessible address `filePublicUrl` (valid for 1 hour), and the file record ID `fileRecordId`. The `uploadSignatureUrl` parameter is always empty in this mode.
|
|
4232
4302
|
*
|
|
4233
4303
|
* @param request - UploadChatFileRequest
|
|
4234
4304
|
* @param headers - map
|
|
@@ -4239,21 +4309,21 @@ export default class Client extends OpenApi {
|
|
|
4239
4309
|
[key: string]: string;
|
|
4240
4310
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UploadChatFileResponse>;
|
|
4241
4311
|
/**
|
|
4242
|
-
* Uploads a local file
|
|
4312
|
+
* Uploads a local file for a session.
|
|
4243
4313
|
*
|
|
4244
4314
|
* @remarks
|
|
4245
4315
|
* ## Operation description
|
|
4246
|
-
* This API
|
|
4247
|
-
* ###
|
|
4248
|
-
* - **Recommended**: Use the `UploadChatFileAdvance` method generated by the SDK. Pass in the local file stream, and the SDK automatically completes the transfer upload and populates `FileUrl
|
|
4249
|
-
* - **Direct upload**: Upload the file to an OSS address accessible by the server, and then
|
|
4316
|
+
* This API operation uploads a temporary temporary file by using the **file transfer upload** mode (`fileTransfer`). The file binary data is not transmitted in the request body of this API operation. Instead, the file is first uploaded to Object Storage Service (OSS), and then the OSS address is passed to the backend through the `FileUrl` parameter. The backend retrieves the bytes from that address, writes them to its own OSS bucket, and creates a temporary temporary file record.
|
|
4317
|
+
* ### How to call
|
|
4318
|
+
* - **Recommended**: Use the `UploadChatFileAdvance` method generated by the SDK. Pass in the local file stream, and the SDK automatically completes the transfer upload and populates the `FileUrl` parameter.
|
|
4319
|
+
* - **Direct upload**: Upload the file to an OSS address accessible by the server, and then call this API operation directly with the `FileUrl` parameter.
|
|
4250
4320
|
* ### Request parameters
|
|
4251
|
-
* - **FileUrl**: Required. The OSS address of the file. When you use the Advance method, the SDK automatically populates this parameter. You do not need to manually
|
|
4252
|
-
* - **FileName**: Required. The original file name including the extension, such as `report.pdf`. The OSS address generated during transfer does not carry the original file name. The backend uses this parameter to determine the file extension and display name. Therefore, you must explicitly pass in this parameter.
|
|
4321
|
+
* - **FileUrl**: Required. The OSS address of the file. When you use the Advance method, the SDK automatically populates this parameter. You do not need to manually set it.
|
|
4322
|
+
* - **FileName**: Required. The original file name including the extension, such as `report.pdf`. The OSS address generated during the transfer does not carry the original file name. The backend uses this parameter to determine the file extension and display name. Therefore, you must explicitly pass in this parameter.
|
|
4253
4323
|
* - **ContentType**: Optional. The MIME type of the file. If this parameter is not specified, `application/octet-stream` is used.
|
|
4254
|
-
* - **OperatingObjectName**: Optional. The
|
|
4324
|
+
* - **OperatingObjectName**: Optional. The agent namespace identifier that determines the file storage path.
|
|
4255
4325
|
* ### Response parameters
|
|
4256
|
-
* The response includes the OSS object path `objectName`, the storage address `fileUrl`, the
|
|
4326
|
+
* The response includes the OSS object path `objectName`, the storage address `fileUrl`, the publicly accessible address `filePublicUrl` (valid for 1 hour), and the file record ID `fileRecordId`. The `uploadSignatureUrl` parameter is always empty in this mode.
|
|
4257
4327
|
*
|
|
4258
4328
|
* @param request - UploadChatFileRequest
|
|
4259
4329
|
* @returns UploadChatFileResponse
|