@alicloud/bailian20231229 2.5.0 → 2.6.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.
Files changed (74) hide show
  1. package/dist/client.d.ts +102 -20
  2. package/dist/client.js +129 -20
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ApplyTempStorageLeaseRequest.d.ts +29 -0
  5. package/dist/models/ApplyTempStorageLeaseRequest.js +60 -0
  6. package/dist/models/ApplyTempStorageLeaseRequest.js.map +1 -0
  7. package/dist/models/ApplyTempStorageLeaseResponse.d.ts +19 -0
  8. package/dist/models/ApplyTempStorageLeaseResponse.js +69 -0
  9. package/dist/models/ApplyTempStorageLeaseResponse.js.map +1 -0
  10. package/dist/models/ApplyTempStorageLeaseResponseBody.d.ts +80 -0
  11. package/dist/models/ApplyTempStorageLeaseResponseBody.js +118 -0
  12. package/dist/models/ApplyTempStorageLeaseResponseBody.js.map +1 -0
  13. package/dist/models/ChangeParseSettingRequest.d.ts +27 -0
  14. package/dist/models/ChangeParseSettingRequest.js.map +1 -1
  15. package/dist/models/ChangeParseSettingResponseBody.d.ts +25 -0
  16. package/dist/models/ChangeParseSettingResponseBody.js.map +1 -1
  17. package/dist/models/ChangeParseSettingShrinkRequest.d.ts +15 -0
  18. package/dist/models/ChangeParseSettingShrinkRequest.js.map +1 -1
  19. package/dist/models/CreateIndexRequest.d.ts +147 -44
  20. package/dist/models/CreateIndexRequest.js.map +1 -1
  21. package/dist/models/CreateIndexResponseBody.d.ts +5 -5
  22. package/dist/models/CreateIndexShrinkRequest.d.ts +81 -44
  23. package/dist/models/CreateIndexShrinkRequest.js.map +1 -1
  24. package/dist/models/DeleteChunkRequest.d.ts +4 -0
  25. package/dist/models/DeleteChunkRequest.js.map +1 -1
  26. package/dist/models/DeleteChunkResponseBody.d.ts +19 -1
  27. package/dist/models/DeleteChunkResponseBody.js.map +1 -1
  28. package/dist/models/DeleteChunkShrinkRequest.d.ts +4 -0
  29. package/dist/models/DeleteChunkShrinkRequest.js.map +1 -1
  30. package/dist/models/GetAvailableParserTypesRequest.d.ts +2 -0
  31. package/dist/models/GetAvailableParserTypesRequest.js.map +1 -1
  32. package/dist/models/GetAvailableParserTypesResponseBody.d.ts +41 -0
  33. package/dist/models/GetAvailableParserTypesResponseBody.js.map +1 -1
  34. package/dist/models/GetParseSettingsRequest.d.ts +3 -0
  35. package/dist/models/GetParseSettingsRequest.js.map +1 -1
  36. package/dist/models/GetParseSettingsResponseBody.d.ts +58 -0
  37. package/dist/models/GetParseSettingsResponseBody.js.map +1 -1
  38. package/dist/models/ListFileRequest.d.ts +2 -0
  39. package/dist/models/ListFileRequest.js.map +1 -1
  40. package/dist/models/ListFileResponseBody.d.ts +11 -0
  41. package/dist/models/ListFileResponseBody.js.map +1 -1
  42. package/dist/models/ListIndexFileDetailsResponseBody.d.ts +72 -0
  43. package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
  44. package/dist/models/UpdateChunkRequest.d.ts +19 -0
  45. package/dist/models/UpdateChunkRequest.js.map +1 -1
  46. package/dist/models/UpdateChunkResponseBody.d.ts +19 -1
  47. package/dist/models/UpdateChunkResponseBody.js.map +1 -1
  48. package/dist/models/model.d.ts +5 -0
  49. package/dist/models/model.js +15 -5
  50. package/dist/models/model.js.map +1 -1
  51. package/package.json +1 -1
  52. package/src/client.ts +133 -20
  53. package/src/models/ApplyTempStorageLeaseRequest.ts +44 -0
  54. package/src/models/ApplyTempStorageLeaseResponse.ts +40 -0
  55. package/src/models/ApplyTempStorageLeaseResponseBody.ts +135 -0
  56. package/src/models/ChangeParseSettingRequest.ts +27 -0
  57. package/src/models/ChangeParseSettingResponseBody.ts +25 -0
  58. package/src/models/ChangeParseSettingShrinkRequest.ts +15 -0
  59. package/src/models/CreateIndexRequest.ts +147 -44
  60. package/src/models/CreateIndexResponseBody.ts +5 -5
  61. package/src/models/CreateIndexShrinkRequest.ts +81 -44
  62. package/src/models/DeleteChunkRequest.ts +4 -0
  63. package/src/models/DeleteChunkResponseBody.ts +19 -1
  64. package/src/models/DeleteChunkShrinkRequest.ts +4 -0
  65. package/src/models/GetAvailableParserTypesRequest.ts +2 -0
  66. package/src/models/GetAvailableParserTypesResponseBody.ts +41 -0
  67. package/src/models/GetParseSettingsRequest.ts +3 -0
  68. package/src/models/GetParseSettingsResponseBody.ts +58 -0
  69. package/src/models/ListFileRequest.ts +2 -0
  70. package/src/models/ListFileResponseBody.ts +11 -0
  71. package/src/models/ListIndexFileDetailsResponseBody.ts +72 -0
  72. package/src/models/UpdateChunkRequest.ts +19 -0
  73. package/src/models/UpdateChunkResponseBody.ts +19 -1
  74. package/src/models/model.ts +5 -0
package/src/client.ts CHANGED
@@ -320,7 +320,56 @@ export default class Client extends OpenApi {
320
320
  }
321
321
 
322
322
  /**
323
- * 修改类目解析配置
323
+ * 申请临时文件存储上传许可
324
+ *
325
+ * @param request - ApplyTempStorageLeaseRequest
326
+ * @param headers - map
327
+ * @param runtime - runtime options for this request RuntimeOptions
328
+ * @returns ApplyTempStorageLeaseResponse
329
+ */
330
+ async applyTempStorageLeaseWithOptions(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.ApplyTempStorageLeaseResponse> {
331
+ request.validate();
332
+ let body : {[key: string ]: any} = { };
333
+ if (!$dara.isNull(request.fileName)) {
334
+ body["FileName"] = request.fileName;
335
+ }
336
+
337
+ if (!$dara.isNull(request.sizeInBytes)) {
338
+ body["SizeInBytes"] = request.sizeInBytes;
339
+ }
340
+
341
+ let req = new $OpenApiUtil.OpenApiRequest({
342
+ headers: headers,
343
+ body: OpenApiUtil.parseToMap(body),
344
+ });
345
+ let params = new $OpenApiUtil.Params({
346
+ action: "ApplyTempStorageLease",
347
+ version: "2023-12-29",
348
+ protocol: "HTTPS",
349
+ pathname: `/${$dara.URL.percentEncode(WorkspaceId)}/datacenter`,
350
+ method: "POST",
351
+ authType: "AK",
352
+ style: "ROA",
353
+ reqBodyType: "formData",
354
+ bodyType: "json",
355
+ });
356
+ return $dara.cast<$_model.ApplyTempStorageLeaseResponse>(await this.callApi(params, req, runtime), new $_model.ApplyTempStorageLeaseResponse({}));
357
+ }
358
+
359
+ /**
360
+ * 申请临时文件存储上传许可
361
+ *
362
+ * @param request - ApplyTempStorageLeaseRequest
363
+ * @returns ApplyTempStorageLeaseResponse
364
+ */
365
+ async applyTempStorageLease(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest): Promise<$_model.ApplyTempStorageLeaseResponse> {
366
+ let runtime = new $dara.RuntimeOptions({ });
367
+ let headers : {[key: string ]: string} = { };
368
+ return await this.applyTempStorageLeaseWithOptions(WorkspaceId, request, headers, runtime);
369
+ }
370
+
371
+ /**
372
+ * Configure the parsing method for a specific file type. For example, use LLM parsing for .pdf files, or use Qwen VL parsing for .jpg files.
324
373
  *
325
374
  * @param tmpReq - ChangeParseSettingRequest
326
375
  * @param headers - map
@@ -371,7 +420,7 @@ export default class Client extends OpenApi {
371
420
  }
372
421
 
373
422
  /**
374
- * 修改类目解析配置
423
+ * Configure the parsing method for a specific file type. For example, use LLM parsing for .pdf files, or use Qwen VL parsing for .jpg files.
375
424
  *
376
425
  * @param request - ChangeParseSettingRequest
377
426
  * @returns ChangeParseSettingResponse
@@ -454,12 +503,17 @@ export default class Client extends OpenApi {
454
503
  }
455
504
 
456
505
  /**
457
- * Creates an unstructured knowledge base and imports one or more parsed documents into the knowledge base. You cannot create a structured knowledge base by calling an API operation. Use the console instead.
506
+ * Create a knowledge base of the document search type.
458
507
  *
459
508
  * @remarks
460
- * 1. You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
461
- * 2. This operation only initializes a knowledge base creation job. You must also call the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to complete the job.
462
- * 3. This interface is not idempotent.
509
+ * **Limits**: This operation can create only knowledge base of the document search type. Data query and image Q\\&A types are not supported. Use the console instead.
510
+ * * **Required permissions**
511
+ * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
512
+ * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
513
+ * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
514
+ * * **What to do next**: This operation only initializes knowledge base creation job. After that, call **SubmitIndexJob** to complete the creation. Otherwise, you will get an empty knowledge base. For more information about the sample code, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
515
+ * * **Idempotence**: This operation is not idempotent. If you call the operation for multiple times, you may create several knowledge bases with the same name. We recommend following a "query first, then create" logic.
516
+ * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
463
517
  *
464
518
  * @param tmpReq - CreateIndexRequest
465
519
  * @param headers - map
@@ -606,12 +660,17 @@ export default class Client extends OpenApi {
606
660
  }
607
661
 
608
662
  /**
609
- * Creates an unstructured knowledge base and imports one or more parsed documents into the knowledge base. You cannot create a structured knowledge base by calling an API operation. Use the console instead.
663
+ * Create a knowledge base of the document search type.
610
664
  *
611
665
  * @remarks
612
- * 1. You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
613
- * 2. This operation only initializes a knowledge base creation job. You must also call the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to complete the job.
614
- * 3. This interface is not idempotent.
666
+ * **Limits**: This operation can create only knowledge base of the document search type. Data query and image Q\\&A types are not supported. Use the console instead.
667
+ * * **Required permissions**
668
+ * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
669
+ * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
670
+ * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
671
+ * * **What to do next**: This operation only initializes knowledge base creation job. After that, call **SubmitIndexJob** to complete the creation. Otherwise, you will get an empty knowledge base. For more information about the sample code, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
672
+ * * **Idempotence**: This operation is not idempotent. If you call the operation for multiple times, you may create several knowledge bases with the same name. We recommend following a "query first, then create" logic.
673
+ * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
615
674
  *
616
675
  * @param request - CreateIndexRequest
617
676
  * @returns CreateIndexResponse
@@ -832,7 +891,18 @@ export default class Client extends OpenApi {
832
891
  }
833
892
 
834
893
  /**
835
- * 删除切片信息
894
+ * Deletes a specified text chunk from a knowledge base. The deleted chunk cannot be retrieved or recalled.
895
+ *
896
+ * @remarks
897
+ * *
898
+ * **Warning** After a text chunk is deleted, it cannot be restored. Proceed with caution.
899
+ * * **Required permissions**:
900
+ * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
901
+ * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
902
+ * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
903
+ * * **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
904
+ * * **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been deleted, the interface returns a success.
905
+ * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
836
906
  *
837
907
  * @param tmpReq - DeleteChunkRequest
838
908
  * @param headers - map
@@ -875,7 +945,18 @@ export default class Client extends OpenApi {
875
945
  }
876
946
 
877
947
  /**
878
- * 删除切片信息
948
+ * Deletes a specified text chunk from a knowledge base. The deleted chunk cannot be retrieved or recalled.
949
+ *
950
+ * @remarks
951
+ * *
952
+ * **Warning** After a text chunk is deleted, it cannot be restored. Proceed with caution.
953
+ * * **Required permissions**:
954
+ * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
955
+ * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
956
+ * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
957
+ * * **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
958
+ * * **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been deleted, the interface returns a success.
959
+ * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
879
960
  *
880
961
  * @param request - DeleteChunkRequest
881
962
  * @returns DeleteChunkResponse
@@ -1300,7 +1381,7 @@ export default class Client extends OpenApi {
1300
1381
  }
1301
1382
 
1302
1383
  /**
1303
- * 获取文件支持的解析器类型
1384
+ * Lists all supported parser types based on the input file type (file extension).
1304
1385
  *
1305
1386
  * @param request - GetAvailableParserTypesRequest
1306
1387
  * @param headers - map
@@ -1333,7 +1414,7 @@ export default class Client extends OpenApi {
1333
1414
  }
1334
1415
 
1335
1416
  /**
1336
- * 获取文件支持的解析器类型
1417
+ * Lists all supported parser types based on the input file type (file extension).
1337
1418
  *
1338
1419
  * @param request - GetAvailableParserTypesRequest
1339
1420
  * @returns GetAvailableParserTypesResponse
@@ -1482,7 +1563,7 @@ export default class Client extends OpenApi {
1482
1563
  }
1483
1564
 
1484
1565
  /**
1485
- * 获取类目解析配置
1566
+ * Queries the data parsing settings in a specified category.
1486
1567
  *
1487
1568
  * @param request - GetParseSettingsRequest
1488
1569
  * @param headers - map
@@ -1515,7 +1596,7 @@ export default class Client extends OpenApi {
1515
1596
  }
1516
1597
 
1517
1598
  /**
1518
- * 获取类目解析配置
1599
+ * Queries the data parsing settings in a specified category.
1519
1600
  *
1520
1601
  * @param request - GetParseSettingsRequest
1521
1602
  * @returns GetParseSettingsResponse
@@ -1796,7 +1877,13 @@ export default class Client extends OpenApi {
1796
1877
  }
1797
1878
 
1798
1879
  /**
1799
- * 获取文档列表
1880
+ * Queries the details of one or more documents in a specified category.
1881
+ *
1882
+ * @remarks
1883
+ * If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:ListFile) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
1884
+ * * During a paged query, set `MaxResults` to specify the maximum number of entries to return. The return value of `NextToken` is a pagination token that can be used in the next call to retrieve a new page of results. When you query subsequent pages, set the `NextToken` parameter to the `NextToken` obtained in the last returned result. You can also set the `MaxResults` parameter to limit the number of entries to be returned. If no `NextToken` is returned, the result is completely returned and no more requests are required.
1885
+ * * This operation is idempotent.
1886
+ * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
1800
1887
  *
1801
1888
  * @param request - ListFileRequest
1802
1889
  * @param headers - map
@@ -1841,7 +1928,13 @@ export default class Client extends OpenApi {
1841
1928
  }
1842
1929
 
1843
1930
  /**
1844
- * 获取文档列表
1931
+ * Queries the details of one or more documents in a specified category.
1932
+ *
1933
+ * @remarks
1934
+ * If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:ListFile) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
1935
+ * * During a paged query, set `MaxResults` to specify the maximum number of entries to return. The return value of `NextToken` is a pagination token that can be used in the next call to retrieve a new page of results. When you query subsequent pages, set the `NextToken` parameter to the `NextToken` obtained in the last returned result. You can also set the `MaxResults` parameter to limit the number of entries to be returned. If no `NextToken` is returned, the result is completely returned and no more requests are required.
1936
+ * * This operation is idempotent.
1937
+ * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
1845
1938
  *
1846
1939
  * @param request - ListFileRequest
1847
1940
  * @returns ListFileResponse
@@ -2681,7 +2774,17 @@ export default class Client extends OpenApi {
2681
2774
  }
2682
2775
 
2683
2776
  /**
2684
- * 更新切片信息
2777
+ * Modifies the content and title of a specified text chunk in the knowledge base, and sets whether the chunk participates in knowledge base retrieval.
2778
+ *
2779
+ * @remarks
2780
+ * **Limits**: This operation supports only knowledge base of the document search type. Data query and image Q\\&A types are not supported.
2781
+ * * **Required permissions**:
2782
+ * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
2783
+ * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
2784
+ * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
2785
+ * * **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
2786
+ * * **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been updated, the interface returns a success.
2787
+ * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
2685
2788
  *
2686
2789
  * @param request - UpdateChunkRequest
2687
2790
  * @param headers - map
@@ -2734,7 +2837,17 @@ export default class Client extends OpenApi {
2734
2837
  }
2735
2838
 
2736
2839
  /**
2737
- * 更新切片信息
2840
+ * Modifies the content and title of a specified text chunk in the knowledge base, and sets whether the chunk participates in knowledge base retrieval.
2841
+ *
2842
+ * @remarks
2843
+ * **Limits**: This operation supports only knowledge base of the document search type. Data query and image Q\\&A types are not supported.
2844
+ * * **Required permissions**:
2845
+ * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
2846
+ * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
2847
+ * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
2848
+ * * **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
2849
+ * * **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been updated, the interface returns a success.
2850
+ * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
2738
2851
  *
2739
2852
  * @param request - UpdateChunkRequest
2740
2853
  * @returns UpdateChunkResponse
@@ -0,0 +1,44 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class ApplyTempStorageLeaseRequest extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * This parameter is required.
9
+ *
10
+ * @example
11
+ * example.txt
12
+ */
13
+ fileName?: string;
14
+ /**
15
+ * @remarks
16
+ * This parameter is required.
17
+ *
18
+ * @example
19
+ * 1024
20
+ */
21
+ sizeInBytes?: number;
22
+ static names(): { [key: string]: string } {
23
+ return {
24
+ fileName: 'FileName',
25
+ sizeInBytes: 'SizeInBytes',
26
+ };
27
+ }
28
+
29
+ static types(): { [key: string]: any } {
30
+ return {
31
+ fileName: 'string',
32
+ sizeInBytes: 'number',
33
+ };
34
+ }
35
+
36
+ validate() {
37
+ super.validate();
38
+ }
39
+
40
+ constructor(map?: { [key: string]: any }) {
41
+ super(map);
42
+ }
43
+ }
44
+
@@ -0,0 +1,40 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+ import { ApplyTempStorageLeaseResponseBody } from "./ApplyTempStorageLeaseResponseBody";
4
+
5
+
6
+ export class ApplyTempStorageLeaseResponse extends $dara.Model {
7
+ headers?: { [key: string]: string };
8
+ statusCode?: number;
9
+ body?: ApplyTempStorageLeaseResponseBody;
10
+ static names(): { [key: string]: string } {
11
+ return {
12
+ headers: 'headers',
13
+ statusCode: 'statusCode',
14
+ body: 'body',
15
+ };
16
+ }
17
+
18
+ static types(): { [key: string]: any } {
19
+ return {
20
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
21
+ statusCode: 'number',
22
+ body: ApplyTempStorageLeaseResponseBody,
23
+ };
24
+ }
25
+
26
+ validate() {
27
+ if(this.headers) {
28
+ $dara.Model.validateMap(this.headers);
29
+ }
30
+ if(this.body && typeof (this.body as any).validate === 'function') {
31
+ (this.body as any).validate();
32
+ }
33
+ super.validate();
34
+ }
35
+
36
+ constructor(map?: { [key: string]: any }) {
37
+ super(map);
38
+ }
39
+ }
40
+
@@ -0,0 +1,135 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class ApplyTempStorageLeaseResponseBodyDataParam extends $dara.Model {
6
+ /**
7
+ * @example
8
+ * Content-Type: application/json
9
+ */
10
+ headers?: any;
11
+ /**
12
+ * @example
13
+ * PUT
14
+ */
15
+ method?: string;
16
+ /**
17
+ * @example
18
+ * https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D
19
+ */
20
+ url?: string;
21
+ static names(): { [key: string]: string } {
22
+ return {
23
+ headers: 'Headers',
24
+ method: 'Method',
25
+ url: 'Url',
26
+ };
27
+ }
28
+
29
+ static types(): { [key: string]: any } {
30
+ return {
31
+ headers: 'any',
32
+ method: 'string',
33
+ url: 'string',
34
+ };
35
+ }
36
+
37
+ validate() {
38
+ super.validate();
39
+ }
40
+
41
+ constructor(map?: { [key: string]: any }) {
42
+ super(map);
43
+ }
44
+ }
45
+
46
+ export class ApplyTempStorageLeaseResponseBodyData extends $dara.Model {
47
+ param?: ApplyTempStorageLeaseResponseBodyDataParam;
48
+ /**
49
+ * @example
50
+ * 1e6a159107384782be5e45ac4759b247.1719325231035
51
+ */
52
+ tempStorageLeaseId?: string;
53
+ static names(): { [key: string]: string } {
54
+ return {
55
+ param: 'Param',
56
+ tempStorageLeaseId: 'TempStorageLeaseId',
57
+ };
58
+ }
59
+
60
+ static types(): { [key: string]: any } {
61
+ return {
62
+ param: ApplyTempStorageLeaseResponseBodyDataParam,
63
+ tempStorageLeaseId: 'string',
64
+ };
65
+ }
66
+
67
+ validate() {
68
+ if(this.param && typeof (this.param as any).validate === 'function') {
69
+ (this.param as any).validate();
70
+ }
71
+ super.validate();
72
+ }
73
+
74
+ constructor(map?: { [key: string]: any }) {
75
+ super(map);
76
+ }
77
+ }
78
+
79
+ export class ApplyTempStorageLeaseResponseBody extends $dara.Model {
80
+ /**
81
+ * @example
82
+ * DataCenter.FileTooLarge
83
+ */
84
+ code?: string;
85
+ data?: ApplyTempStorageLeaseResponseBodyData;
86
+ /**
87
+ * @example
88
+ * User not authorized to operate on the specified resource
89
+ */
90
+ message?: string;
91
+ /**
92
+ * @example
93
+ * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
94
+ */
95
+ requestId?: string;
96
+ /**
97
+ * @example
98
+ * 200
99
+ */
100
+ status?: string;
101
+ success?: boolean;
102
+ static names(): { [key: string]: string } {
103
+ return {
104
+ code: 'Code',
105
+ data: 'Data',
106
+ message: 'Message',
107
+ requestId: 'RequestId',
108
+ status: 'Status',
109
+ success: 'Success',
110
+ };
111
+ }
112
+
113
+ static types(): { [key: string]: any } {
114
+ return {
115
+ code: 'string',
116
+ data: ApplyTempStorageLeaseResponseBodyData,
117
+ message: 'string',
118
+ requestId: 'string',
119
+ status: 'string',
120
+ success: 'boolean',
121
+ };
122
+ }
123
+
124
+ validate() {
125
+ if(this.data && typeof (this.data as any).validate === 'function') {
126
+ (this.data as any).validate();
127
+ }
128
+ super.validate();
129
+ }
130
+
131
+ constructor(map?: { [key: string]: any }) {
132
+ super(map);
133
+ }
134
+ }
135
+
@@ -4,10 +4,22 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class ChangeParseSettingRequestParserConfig extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The model name.
9
+ *
10
+ * Valid values:
11
+ *
12
+ * * qwen-vl-max
13
+ * * qwen-vl-plus
14
+ *
7
15
  * @example
8
16
  * qwen-vl-max
9
17
  */
10
18
  modelName?: string;
19
+ /**
20
+ * @remarks
21
+ * The prompt used for parsing.
22
+ */
11
23
  modelPrompt?: string;
12
24
  static names(): { [key: string]: string } {
13
25
  return {
@@ -35,6 +47,8 @@ export class ChangeParseSettingRequestParserConfig extends $dara.Model {
35
47
  export class ChangeParseSettingRequest extends $dara.Model {
36
48
  /**
37
49
  * @remarks
50
+ * The category ID, which is the `CategoryId` returned by **AddCategory**. To view the category ID, click the ID icon next to the category name on the Unstructured Data tab of the [Application Data](https://bailian.console.alibabacloud.com/?tab=app#/data-center) page.
51
+ *
38
52
  * This parameter is required.
39
53
  *
40
54
  * @example
@@ -43,6 +57,8 @@ export class ChangeParseSettingRequest extends $dara.Model {
43
57
  categoryId?: string;
44
58
  /**
45
59
  * @remarks
60
+ * The file type. Valid values: pdf, docx, and doc.
61
+ *
46
62
  * This parameter is required.
47
63
  *
48
64
  * @example
@@ -51,12 +67,23 @@ export class ChangeParseSettingRequest extends $dara.Model {
51
67
  fileType?: string;
52
68
  /**
53
69
  * @remarks
70
+ * The parser code. Valid values:
71
+ *
72
+ * * DOCMIND (Intelligent parsing)
73
+ * * DOCMIND_DIGITAL (Digital parsing)
74
+ * * DOCMIND_LLM_VERSION (LLM parsing)
75
+ * * DASH_QWEN_VL_PARSER (Qwen VL parsing)
76
+ *
54
77
  * This parameter is required.
55
78
  *
56
79
  * @example
57
80
  * DOCMIND
58
81
  */
59
82
  parser?: string;
83
+ /**
84
+ * @remarks
85
+ * The parser configuration. Currently, this is available only for Qwen VL parsing.
86
+ */
60
87
  parserConfig?: ChangeParseSettingRequestParserConfig;
61
88
  static names(): { [key: string]: string } {
62
89
  return {
@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class ChangeParseSettingResponseBodyData extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The result of the modification.
9
+ *
7
10
  * @example
8
11
  * true
9
12
  */
@@ -31,27 +34,49 @@ export class ChangeParseSettingResponseBodyData extends $dara.Model {
31
34
 
32
35
  export class ChangeParseSettingResponseBody extends $dara.Model {
33
36
  /**
37
+ * @remarks
38
+ * The status code.
39
+ *
34
40
  * @example
35
41
  * InvalidParameter
36
42
  */
37
43
  code?: string;
44
+ /**
45
+ * @remarks
46
+ * The returned data fields.
47
+ */
38
48
  data?: ChangeParseSettingResponseBodyData;
39
49
  /**
50
+ * @remarks
51
+ * The error message.
52
+ *
40
53
  * @example
41
54
  * User not authorized to operate on the specified resource.
42
55
  */
43
56
  message?: string;
44
57
  /**
58
+ * @remarks
59
+ * The request ID.
60
+ *
45
61
  * @example
46
62
  * 7BA8ADD9-53D6-53F0-918F-A1E776AD230E
47
63
  */
48
64
  requestId?: string;
49
65
  /**
66
+ * @remarks
67
+ * The HTTP status code returned.
68
+ *
50
69
  * @example
51
70
  * 200
52
71
  */
53
72
  status?: string;
54
73
  /**
74
+ * @remarks
75
+ * Indicates whether the call is successful. Valid values:
76
+ *
77
+ * * true
78
+ * * false
79
+ *
55
80
  * @example
56
81
  * true
57
82
  */
@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class ChangeParseSettingShrinkRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
+ * The category ID, which is the `CategoryId` returned by **AddCategory**. To view the category ID, click the ID icon next to the category name on the Unstructured Data tab of the [Application Data](https://bailian.console.alibabacloud.com/?tab=app#/data-center) page.
9
+ *
8
10
  * This parameter is required.
9
11
  *
10
12
  * @example
@@ -13,6 +15,8 @@ export class ChangeParseSettingShrinkRequest extends $dara.Model {
13
15
  categoryId?: string;
14
16
  /**
15
17
  * @remarks
18
+ * The file type. Valid values: pdf, docx, and doc.
19
+ *
16
20
  * This parameter is required.
17
21
  *
18
22
  * @example
@@ -21,12 +25,23 @@ export class ChangeParseSettingShrinkRequest extends $dara.Model {
21
25
  fileType?: string;
22
26
  /**
23
27
  * @remarks
28
+ * The parser code. Valid values:
29
+ *
30
+ * * DOCMIND (Intelligent parsing)
31
+ * * DOCMIND_DIGITAL (Digital parsing)
32
+ * * DOCMIND_LLM_VERSION (LLM parsing)
33
+ * * DASH_QWEN_VL_PARSER (Qwen VL parsing)
34
+ *
24
35
  * This parameter is required.
25
36
  *
26
37
  * @example
27
38
  * DOCMIND
28
39
  */
29
40
  parser?: string;
41
+ /**
42
+ * @remarks
43
+ * The parser configuration. Currently, this is available only for Qwen VL parsing.
44
+ */
30
45
  parserConfigShrink?: string;
31
46
  static names(): { [key: string]: string } {
32
47
  return {