@alicloud/bailian20231229 2.14.3 → 2.14.4
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 +36 -34
- package/dist/client.js +36 -38
- package/dist/client.js.map +1 -1
- package/dist/models/AddFileRequest.d.ts +20 -20
- package/dist/models/AddFileResponseBody.d.ts +5 -5
- package/dist/models/AddFileShrinkRequest.d.ts +16 -16
- package/dist/models/BatchUpdateFileTagRequest.d.ts +6 -4
- package/dist/models/BatchUpdateFileTagRequest.js.map +1 -1
- package/dist/models/BatchUpdateFileTagResponseBody.d.ts +14 -18
- package/dist/models/BatchUpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/BatchUpdateFileTagShrinkRequest.d.ts +4 -2
- package/dist/models/BatchUpdateFileTagShrinkRequest.js.map +1 -1
- package/dist/models/CreateIndexRequest.d.ts +60 -60
- package/dist/models/CreateIndexResponseBody.d.ts +3 -3
- package/dist/models/CreateIndexShrinkRequest.d.ts +52 -52
- package/dist/models/ListIndicesRequest.d.ts +2 -2
- package/dist/models/ListIndicesResponseBody.d.ts +82 -26
- package/dist/models/ListIndicesResponseBody.js +6 -0
- package/dist/models/ListIndicesResponseBody.js.map +1 -1
- package/dist/models/UpdateFileTagRequest.d.ts +1 -1
- package/dist/models/UpdateFileTagResponseBody.d.ts +8 -9
- package/dist/models/UpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/UpdateFileTagShrinkRequest.d.ts +1 -1
- package/package.json +1 -1
- package/src/client.ts +36 -38
- package/src/models/AddFileRequest.ts +20 -20
- package/src/models/AddFileResponseBody.ts +5 -5
- package/src/models/AddFileShrinkRequest.ts +16 -16
- package/src/models/BatchUpdateFileTagRequest.ts +6 -4
- package/src/models/BatchUpdateFileTagResponseBody.ts +14 -18
- package/src/models/BatchUpdateFileTagShrinkRequest.ts +4 -2
- package/src/models/CreateIndexRequest.ts +60 -60
- package/src/models/CreateIndexResponseBody.ts +3 -3
- package/src/models/CreateIndexShrinkRequest.ts +52 -52
- package/src/models/ListIndicesRequest.ts +2 -2
- package/src/models/ListIndicesResponseBody.ts +88 -26
- package/src/models/UpdateFileTagRequest.ts +1 -1
- package/src/models/UpdateFileTagResponseBody.ts +8 -9
- package/src/models/UpdateFileTagShrinkRequest.ts +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -106,10 +106,10 @@ export default class Client extends OpenApi {
|
|
|
106
106
|
* Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
107
107
|
*
|
|
108
108
|
* @remarks
|
|
109
|
-
* -
|
|
109
|
+
* - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
110
110
|
* - This operation is not idempotent.
|
|
111
|
-
* **
|
|
112
|
-
* This operation is
|
|
111
|
+
* **Rate limiting:**
|
|
112
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
113
113
|
*
|
|
114
114
|
* @param tmpReq - AddFileRequest
|
|
115
115
|
* @param headers - map
|
|
@@ -123,10 +123,10 @@ export default class Client extends OpenApi {
|
|
|
123
123
|
* Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
124
124
|
*
|
|
125
125
|
* @remarks
|
|
126
|
-
* -
|
|
126
|
+
* - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
127
127
|
* - This operation is not idempotent.
|
|
128
|
-
* **
|
|
129
|
-
* This operation is
|
|
128
|
+
* **Rate limiting:**
|
|
129
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
130
130
|
*
|
|
131
131
|
* @param request - AddFileRequest
|
|
132
132
|
* @returns AddFileResponse
|
|
@@ -255,7 +255,7 @@ export default class Client extends OpenApi {
|
|
|
255
255
|
*/
|
|
256
256
|
applyTempStorageLease(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest): Promise<$_model.ApplyTempStorageLeaseResponse>;
|
|
257
257
|
/**
|
|
258
|
-
*
|
|
258
|
+
* Batch updates document tags in a data connection.
|
|
259
259
|
*
|
|
260
260
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
261
261
|
* @param headers - map
|
|
@@ -266,7 +266,7 @@ export default class Client extends OpenApi {
|
|
|
266
266
|
[key: string]: string;
|
|
267
267
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.BatchUpdateFileTagResponse>;
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
* Batch updates document tags in a data connection.
|
|
270
270
|
*
|
|
271
271
|
* @param request - BatchUpdateFileTagRequest
|
|
272
272
|
* @returns BatchUpdateFileTagResponse
|
|
@@ -321,17 +321,17 @@ export default class Client extends OpenApi {
|
|
|
321
321
|
*/
|
|
322
322
|
createAndPulishAgent(workspaceId: string, request: $_model.CreateAndPulishAgentRequest): Promise<$_model.CreateAndPulishAgentResponse>;
|
|
323
323
|
/**
|
|
324
|
-
* Creates a knowledge base
|
|
324
|
+
* Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
|
|
325
325
|
*
|
|
326
326
|
* @remarks
|
|
327
327
|
* - **Permission requirements**:
|
|
328
|
-
* - **Resource Access Management (RAM) user**:
|
|
328
|
+
* - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
|
|
329
329
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
330
|
-
* - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK
|
|
331
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples,
|
|
332
|
-
* - **Idempotence**: This operation
|
|
333
|
-
* **Rate
|
|
334
|
-
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are
|
|
330
|
+
* - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
331
|
+
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
332
|
+
* - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
|
|
333
|
+
* **Rate limiting:**
|
|
334
|
+
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
|
|
335
335
|
*
|
|
336
336
|
* @param tmpReq - CreateIndexRequest
|
|
337
337
|
* @param headers - map
|
|
@@ -342,17 +342,17 @@ export default class Client extends OpenApi {
|
|
|
342
342
|
[key: string]: string;
|
|
343
343
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIndexResponse>;
|
|
344
344
|
/**
|
|
345
|
-
* Creates a knowledge base
|
|
345
|
+
* Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
|
|
346
346
|
*
|
|
347
347
|
* @remarks
|
|
348
348
|
* - **Permission requirements**:
|
|
349
|
-
* - **Resource Access Management (RAM) user**:
|
|
349
|
+
* - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
|
|
350
350
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
351
|
-
* - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK
|
|
352
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples,
|
|
353
|
-
* - **Idempotence**: This operation
|
|
354
|
-
* **Rate
|
|
355
|
-
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are
|
|
351
|
+
* - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
352
|
+
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
353
|
+
* - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
|
|
354
|
+
* **Rate limiting:**
|
|
355
|
+
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
|
|
356
356
|
*
|
|
357
357
|
* @param request - CreateIndexRequest
|
|
358
358
|
* @returns CreateIndexResponse
|
|
@@ -1242,10 +1242,10 @@ export default class Client extends OpenApi {
|
|
|
1242
1242
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
1243
1243
|
*
|
|
1244
1244
|
* @remarks
|
|
1245
|
-
* -
|
|
1246
|
-
* - This operation
|
|
1245
|
+
* - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Only then can they call this operation. Alibaba Cloud accounts (primary accounts) can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
1246
|
+
* - This operation is idempotent.
|
|
1247
1247
|
* **Rate limit:**
|
|
1248
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1248
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1249
1249
|
*
|
|
1250
1250
|
* @param request - ListIndicesRequest
|
|
1251
1251
|
* @param headers - map
|
|
@@ -1259,10 +1259,10 @@ export default class Client extends OpenApi {
|
|
|
1259
1259
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
1260
1260
|
*
|
|
1261
1261
|
* @remarks
|
|
1262
|
-
* -
|
|
1263
|
-
* - This operation
|
|
1262
|
+
* - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Only then can they call this operation. Alibaba Cloud accounts (primary accounts) can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
1263
|
+
* - This operation is idempotent.
|
|
1264
1264
|
* **Rate limit:**
|
|
1265
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1265
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1266
1266
|
*
|
|
1267
1267
|
* @param request - ListIndicesRequest
|
|
1268
1268
|
* @returns ListIndicesResponse
|
|
@@ -1585,11 +1585,12 @@ export default class Client extends OpenApi {
|
|
|
1585
1585
|
*/
|
|
1586
1586
|
updateConnector(WorkspaceId: string, ConnectorId: string, request: $_model.UpdateConnectorRequest): Promise<$_model.UpdateConnectorResponse>;
|
|
1587
1587
|
/**
|
|
1588
|
-
* Updates the tags
|
|
1588
|
+
* Updates the tags of a specified file.
|
|
1589
1589
|
*
|
|
1590
1590
|
* @remarks
|
|
1591
|
-
* -
|
|
1592
|
-
* **
|
|
1591
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
1592
|
+
* **Rate limiting:**
|
|
1593
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1593
1594
|
*
|
|
1594
1595
|
* @param tmpReq - UpdateFileTagRequest
|
|
1595
1596
|
* @param headers - map
|
|
@@ -1600,11 +1601,12 @@ export default class Client extends OpenApi {
|
|
|
1600
1601
|
[key: string]: string;
|
|
1601
1602
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateFileTagResponse>;
|
|
1602
1603
|
/**
|
|
1603
|
-
* Updates the tags
|
|
1604
|
+
* Updates the tags of a specified file.
|
|
1604
1605
|
*
|
|
1605
1606
|
* @remarks
|
|
1606
|
-
* -
|
|
1607
|
-
* **
|
|
1607
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
1608
|
+
* **Rate limiting:**
|
|
1609
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1608
1610
|
*
|
|
1609
1611
|
* @param request - UpdateFileTagRequest
|
|
1610
1612
|
* @returns UpdateFileTagResponse
|
package/dist/client.js
CHANGED
|
@@ -49,10 +49,6 @@ class Client extends openapi_core_1.default {
|
|
|
49
49
|
constructor(config) {
|
|
50
50
|
super(config);
|
|
51
51
|
this._endpointRule = "regional";
|
|
52
|
-
this._endpointMap = {
|
|
53
|
-
'cn-beijing': "bailian.cn-beijing.aliyuncs.com",
|
|
54
|
-
'ap-southeast-1': "bailian.ap-southeast-1.aliyuncs.com",
|
|
55
|
-
};
|
|
56
52
|
this.checkConfig(config);
|
|
57
53
|
this._endpoint = this.getEndpoint("bailian", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
|
|
58
54
|
}
|
|
@@ -269,10 +265,10 @@ class Client extends openapi_core_1.default {
|
|
|
269
265
|
* Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
270
266
|
*
|
|
271
267
|
* @remarks
|
|
272
|
-
* -
|
|
268
|
+
* - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
273
269
|
* - This operation is not idempotent.
|
|
274
|
-
* **
|
|
275
|
-
* This operation is
|
|
270
|
+
* **Rate limiting:**
|
|
271
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
276
272
|
*
|
|
277
273
|
* @param tmpReq - AddFileRequest
|
|
278
274
|
* @param headers - map
|
|
@@ -332,10 +328,10 @@ class Client extends openapi_core_1.default {
|
|
|
332
328
|
* Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
333
329
|
*
|
|
334
330
|
* @remarks
|
|
335
|
-
* -
|
|
331
|
+
* - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
336
332
|
* - This operation is not idempotent.
|
|
337
|
-
* **
|
|
338
|
-
* This operation is
|
|
333
|
+
* **Rate limiting:**
|
|
334
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
339
335
|
*
|
|
340
336
|
* @param request - AddFileRequest
|
|
341
337
|
* @returns AddFileResponse
|
|
@@ -619,7 +615,7 @@ class Client extends openapi_core_1.default {
|
|
|
619
615
|
return await this.applyTempStorageLeaseWithOptions(WorkspaceId, request, headers, runtime);
|
|
620
616
|
}
|
|
621
617
|
/**
|
|
622
|
-
*
|
|
618
|
+
* Batch updates document tags in a data connection.
|
|
623
619
|
*
|
|
624
620
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
625
621
|
* @param headers - map
|
|
@@ -658,7 +654,7 @@ class Client extends openapi_core_1.default {
|
|
|
658
654
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.BatchUpdateFileTagResponse({}));
|
|
659
655
|
}
|
|
660
656
|
/**
|
|
661
|
-
*
|
|
657
|
+
* Batch updates document tags in a data connection.
|
|
662
658
|
*
|
|
663
659
|
* @param request - BatchUpdateFileTagRequest
|
|
664
660
|
* @returns BatchUpdateFileTagResponse
|
|
@@ -799,17 +795,17 @@ class Client extends openapi_core_1.default {
|
|
|
799
795
|
return await this.createAndPulishAgentWithOptions(workspaceId, request, headers, runtime);
|
|
800
796
|
}
|
|
801
797
|
/**
|
|
802
|
-
* Creates a knowledge base
|
|
798
|
+
* Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
|
|
803
799
|
*
|
|
804
800
|
* @remarks
|
|
805
801
|
* - **Permission requirements**:
|
|
806
|
-
* - **Resource Access Management (RAM) user**:
|
|
802
|
+
* - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
|
|
807
803
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
808
|
-
* - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK
|
|
809
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples,
|
|
810
|
-
* - **Idempotence**: This operation
|
|
811
|
-
* **Rate
|
|
812
|
-
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are
|
|
804
|
+
* - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
805
|
+
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
806
|
+
* - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
|
|
807
|
+
* **Rate limiting:**
|
|
808
|
+
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
|
|
813
809
|
*
|
|
814
810
|
* @param tmpReq - CreateIndexRequest
|
|
815
811
|
* @param headers - map
|
|
@@ -956,17 +952,17 @@ class Client extends openapi_core_1.default {
|
|
|
956
952
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIndexResponse({}));
|
|
957
953
|
}
|
|
958
954
|
/**
|
|
959
|
-
* Creates a knowledge base
|
|
955
|
+
* Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
|
|
960
956
|
*
|
|
961
957
|
* @remarks
|
|
962
958
|
* - **Permission requirements**:
|
|
963
|
-
* - **Resource Access Management (RAM) user**:
|
|
959
|
+
* - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
|
|
964
960
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
965
|
-
* - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK
|
|
966
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples,
|
|
967
|
-
* - **Idempotence**: This operation
|
|
968
|
-
* **Rate
|
|
969
|
-
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are
|
|
961
|
+
* - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
962
|
+
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
963
|
+
* - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
|
|
964
|
+
* **Rate limiting:**
|
|
965
|
+
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
|
|
970
966
|
*
|
|
971
967
|
* @param request - CreateIndexRequest
|
|
972
968
|
* @returns CreateIndexResponse
|
|
@@ -2708,10 +2704,10 @@ class Client extends openapi_core_1.default {
|
|
|
2708
2704
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2709
2705
|
*
|
|
2710
2706
|
* @remarks
|
|
2711
|
-
* -
|
|
2712
|
-
* - This operation
|
|
2707
|
+
* - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Only then can they call this operation. Alibaba Cloud accounts (primary accounts) can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
2708
|
+
* - This operation is idempotent.
|
|
2713
2709
|
* **Rate limit:**
|
|
2714
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2710
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2715
2711
|
*
|
|
2716
2712
|
* @param request - ListIndicesRequest
|
|
2717
2713
|
* @param headers - map
|
|
@@ -2751,10 +2747,10 @@ class Client extends openapi_core_1.default {
|
|
|
2751
2747
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2752
2748
|
*
|
|
2753
2749
|
* @remarks
|
|
2754
|
-
* -
|
|
2755
|
-
* - This operation
|
|
2750
|
+
* - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Only then can they call this operation. Alibaba Cloud accounts (primary accounts) can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
2751
|
+
* - This operation is idempotent.
|
|
2756
2752
|
* **Rate limit:**
|
|
2757
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2753
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2758
2754
|
*
|
|
2759
2755
|
* @param request - ListIndicesRequest
|
|
2760
2756
|
* @returns ListIndicesResponse
|
|
@@ -3529,11 +3525,12 @@ class Client extends openapi_core_1.default {
|
|
|
3529
3525
|
return await this.updateConnectorWithOptions(WorkspaceId, ConnectorId, request, headers, runtime);
|
|
3530
3526
|
}
|
|
3531
3527
|
/**
|
|
3532
|
-
* Updates the tags
|
|
3528
|
+
* Updates the tags of a specified file.
|
|
3533
3529
|
*
|
|
3534
3530
|
* @remarks
|
|
3535
|
-
* -
|
|
3536
|
-
* **
|
|
3531
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
3532
|
+
* **Rate limiting:**
|
|
3533
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
3537
3534
|
*
|
|
3538
3535
|
* @param tmpReq - UpdateFileTagRequest
|
|
3539
3536
|
* @param headers - map
|
|
@@ -3569,11 +3566,12 @@ class Client extends openapi_core_1.default {
|
|
|
3569
3566
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateFileTagResponse({}));
|
|
3570
3567
|
}
|
|
3571
3568
|
/**
|
|
3572
|
-
* Updates the tags
|
|
3569
|
+
* Updates the tags of a specified file.
|
|
3573
3570
|
*
|
|
3574
3571
|
* @remarks
|
|
3575
|
-
* -
|
|
3576
|
-
* **
|
|
3572
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
3573
|
+
* **Rate limiting:**
|
|
3574
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
3577
3575
|
*
|
|
3578
3576
|
* @param request - UpdateFileTagRequest
|
|
3579
3577
|
* @returns UpdateFileTagResponse
|