@alicloud/dms-enterprise20181101 2.6.1 → 2.8.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 (69) hide show
  1. package/dist/client.d.ts +84 -0
  2. package/dist/client.js +204 -0
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ColumnKnowledgeVo.d.ts +31 -0
  5. package/dist/models/ColumnKnowledgeVo.js +92 -0
  6. package/dist/models/ColumnKnowledgeVo.js.map +1 -0
  7. package/dist/models/GetTableColumnListRequest.d.ts +29 -0
  8. package/dist/models/GetTableColumnListRequest.js +60 -0
  9. package/dist/models/GetTableColumnListRequest.js.map +1 -0
  10. package/dist/models/GetTableColumnListResponse.d.ts +19 -0
  11. package/dist/models/GetTableColumnListResponse.js +69 -0
  12. package/dist/models/GetTableColumnListResponse.js.map +1 -0
  13. package/dist/models/GetTableColumnListResponseBody.d.ts +38 -0
  14. package/dist/models/GetTableColumnListResponseBody.js +70 -0
  15. package/dist/models/GetTableColumnListResponseBody.js.map +1 -0
  16. package/dist/models/GetTableInstructionsRequest.d.ts +29 -0
  17. package/dist/models/GetTableInstructionsRequest.js +60 -0
  18. package/dist/models/GetTableInstructionsRequest.js.map +1 -0
  19. package/dist/models/GetTableInstructionsResponse.d.ts +19 -0
  20. package/dist/models/GetTableInstructionsResponse.js +69 -0
  21. package/dist/models/GetTableInstructionsResponse.js.map +1 -0
  22. package/dist/models/GetTableInstructionsResponseBody.d.ts +45 -0
  23. package/dist/models/GetTableInstructionsResponseBody.js +70 -0
  24. package/dist/models/GetTableInstructionsResponseBody.js.map +1 -0
  25. package/dist/models/GetTableKnowledgeDetailsRequest.d.ts +29 -0
  26. package/dist/models/GetTableKnowledgeDetailsRequest.js +60 -0
  27. package/dist/models/GetTableKnowledgeDetailsRequest.js.map +1 -0
  28. package/dist/models/GetTableKnowledgeDetailsResponse.d.ts +19 -0
  29. package/dist/models/GetTableKnowledgeDetailsResponse.js +69 -0
  30. package/dist/models/GetTableKnowledgeDetailsResponse.js.map +1 -0
  31. package/dist/models/GetTableKnowledgeDetailsResponseBody.d.ts +45 -0
  32. package/dist/models/GetTableKnowledgeDetailsResponseBody.js +70 -0
  33. package/dist/models/GetTableKnowledgeDetailsResponseBody.js.map +1 -0
  34. package/dist/models/SearchTableAssetKnowledgeRequest.d.ts +49 -0
  35. package/dist/models/SearchTableAssetKnowledgeRequest.js +68 -0
  36. package/dist/models/SearchTableAssetKnowledgeRequest.js.map +1 -0
  37. package/dist/models/SearchTableAssetKnowledgeResponse.d.ts +19 -0
  38. package/dist/models/SearchTableAssetKnowledgeResponse.js +69 -0
  39. package/dist/models/SearchTableAssetKnowledgeResponse.js.map +1 -0
  40. package/dist/models/SearchTableAssetKnowledgeResponseBody.d.ts +56 -0
  41. package/dist/models/SearchTableAssetKnowledgeResponseBody.js +94 -0
  42. package/dist/models/SearchTableAssetKnowledgeResponseBody.js.map +1 -0
  43. package/dist/models/TableInstructionsVo.d.ts +20 -0
  44. package/dist/models/TableInstructionsVo.js +70 -0
  45. package/dist/models/TableInstructionsVo.js.map +1 -0
  46. package/dist/models/TableKnowledgeVo.d.ts +34 -0
  47. package/dist/models/TableKnowledgeVo.js +98 -0
  48. package/dist/models/TableKnowledgeVo.js.map +1 -0
  49. package/dist/models/model.d.ts +16 -0
  50. package/dist/models/model.js +54 -22
  51. package/dist/models/model.js.map +1 -1
  52. package/package.json +1 -1
  53. package/src/client.ts +224 -0
  54. package/src/models/ColumnKnowledgeVo.ts +78 -0
  55. package/src/models/GetTableColumnListRequest.ts +44 -0
  56. package/src/models/GetTableColumnListResponse.ts +40 -0
  57. package/src/models/GetTableColumnListResponseBody.ts +62 -0
  58. package/src/models/GetTableInstructionsRequest.ts +44 -0
  59. package/src/models/GetTableInstructionsResponse.ts +40 -0
  60. package/src/models/GetTableInstructionsResponseBody.ts +69 -0
  61. package/src/models/GetTableKnowledgeDetailsRequest.ts +44 -0
  62. package/src/models/GetTableKnowledgeDetailsResponse.ts +40 -0
  63. package/src/models/GetTableKnowledgeDetailsResponseBody.ts +69 -0
  64. package/src/models/SearchTableAssetKnowledgeRequest.ts +72 -0
  65. package/src/models/SearchTableAssetKnowledgeResponse.ts +40 -0
  66. package/src/models/SearchTableAssetKnowledgeResponseBody.ts +95 -0
  67. package/src/models/TableInstructionsVo.ts +45 -0
  68. package/src/models/TableKnowledgeVo.ts +87 -0
  69. package/src/models/model.ts +16 -0
package/dist/client.d.ts CHANGED
@@ -2814,6 +2814,27 @@ export default class Client extends OpenApi {
2814
2814
  * @returns GetStructSyncOrderDetailResponse
2815
2815
  */
2816
2816
  getStructSyncOrderDetail(request: $_model.GetStructSyncOrderDetailRequest): Promise<$_model.GetStructSyncOrderDetailResponse>;
2817
+ /**
2818
+ * 查询表的字段知识列表,包含字段元信息、业务描述、安全信息等
2819
+ *
2820
+ * @remarks
2821
+ * 查询表的字段知识列表,返回每个字段的元信息(类型、可空、自增等)、业务描述、术语、数据标准、安全等级与索引信息
2822
+ *
2823
+ * @param request - GetTableColumnListRequest
2824
+ * @param runtime - runtime options for this request RuntimeOptions
2825
+ * @returns GetTableColumnListResponse
2826
+ */
2827
+ getTableColumnListWithOptions(request: $_model.GetTableColumnListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTableColumnListResponse>;
2828
+ /**
2829
+ * 查询表的字段知识列表,包含字段元信息、业务描述、安全信息等
2830
+ *
2831
+ * @remarks
2832
+ * 查询表的字段知识列表,返回每个字段的元信息(类型、可空、自增等)、业务描述、术语、数据标准、安全等级与索引信息
2833
+ *
2834
+ * @param request - GetTableColumnListRequest
2835
+ * @returns GetTableColumnListResponse
2836
+ */
2837
+ getTableColumnList(request: $_model.GetTableColumnListRequest): Promise<$_model.GetTableColumnListResponse>;
2817
2838
  /**
2818
2839
  * Queries the topology of a data table.
2819
2840
  *
@@ -2859,6 +2880,48 @@ export default class Client extends OpenApi {
2859
2880
  * @returns GetTableDesignProjectInfoResponse
2860
2881
  */
2861
2882
  getTableDesignProjectInfo(request: $_model.GetTableDesignProjectInfoRequest): Promise<$_model.GetTableDesignProjectInfoResponse>;
2883
+ /**
2884
+ * 查询表的业务知识/使用说明(业务描述、摘要、关联资产)
2885
+ *
2886
+ * @remarks
2887
+ * 查询表的业务知识/使用说明,返回 AI 增强业务描述、表业务摘要、关联资产列表,用于辅助语义找表与表用法说明
2888
+ *
2889
+ * @param request - GetTableInstructionsRequest
2890
+ * @param runtime - runtime options for this request RuntimeOptions
2891
+ * @returns GetTableInstructionsResponse
2892
+ */
2893
+ getTableInstructionsWithOptions(request: $_model.GetTableInstructionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTableInstructionsResponse>;
2894
+ /**
2895
+ * 查询表的业务知识/使用说明(业务描述、摘要、关联资产)
2896
+ *
2897
+ * @remarks
2898
+ * 查询表的业务知识/使用说明,返回 AI 增强业务描述、表业务摘要、关联资产列表,用于辅助语义找表与表用法说明
2899
+ *
2900
+ * @param request - GetTableInstructionsRequest
2901
+ * @returns GetTableInstructionsResponse
2902
+ */
2903
+ getTableInstructions(request: $_model.GetTableInstructionsRequest): Promise<$_model.GetTableInstructionsResponse>;
2904
+ /**
2905
+ * 查询表的资产知识详情,包含表元信息、业务描述、字段列表等
2906
+ *
2907
+ * @remarks
2908
+ * 查询表的资产知识详情,返回表的基本元信息、AI 增强的业务描述、汇总信息以及字段知识列表
2909
+ *
2910
+ * @param request - GetTableKnowledgeDetailsRequest
2911
+ * @param runtime - runtime options for this request RuntimeOptions
2912
+ * @returns GetTableKnowledgeDetailsResponse
2913
+ */
2914
+ getTableKnowledgeDetailsWithOptions(request: $_model.GetTableKnowledgeDetailsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTableKnowledgeDetailsResponse>;
2915
+ /**
2916
+ * 查询表的资产知识详情,包含表元信息、业务描述、字段列表等
2917
+ *
2918
+ * @remarks
2919
+ * 查询表的资产知识详情,返回表的基本元信息、AI 增强的业务描述、汇总信息以及字段知识列表
2920
+ *
2921
+ * @param request - GetTableKnowledgeDetailsRequest
2922
+ * @returns GetTableKnowledgeDetailsResponse
2923
+ */
2924
+ getTableKnowledgeDetails(request: $_model.GetTableKnowledgeDetailsRequest): Promise<$_model.GetTableKnowledgeDetailsResponse>;
2862
2925
  /**
2863
2926
  * Gets metadata knowledge for a specified GUID.
2864
2927
  *
@@ -4815,6 +4878,27 @@ export default class Client extends OpenApi {
4815
4878
  * @returns SearchTableResponse
4816
4879
  */
4817
4880
  searchTable(request: $_model.SearchTableRequest): Promise<$_model.SearchTableResponse>;
4881
+ /**
4882
+ * 分页查询某张表相关的资产知识列表(含表/字段/SQL/片段等)
4883
+ *
4884
+ * @remarks
4885
+ * 分页查询某张表相关的资产知识列表,支持按知识类型、关键词等条件筛选,返回 KnowledgeBaseVO 分页结果
4886
+ *
4887
+ * @param request - SearchTableAssetKnowledgeRequest
4888
+ * @param runtime - runtime options for this request RuntimeOptions
4889
+ * @returns SearchTableAssetKnowledgeResponse
4890
+ */
4891
+ searchTableAssetKnowledgeWithOptions(request: $_model.SearchTableAssetKnowledgeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SearchTableAssetKnowledgeResponse>;
4892
+ /**
4893
+ * 分页查询某张表相关的资产知识列表(含表/字段/SQL/片段等)
4894
+ *
4895
+ * @remarks
4896
+ * 分页查询某张表相关的资产知识列表,支持按知识类型、关键词等条件筛选,返回 KnowledgeBaseVO 分页结果
4897
+ *
4898
+ * @param request - SearchTableAssetKnowledgeRequest
4899
+ * @returns SearchTableAssetKnowledgeResponse
4900
+ */
4901
+ searchTableAssetKnowledge(request: $_model.SearchTableAssetKnowledgeRequest): Promise<$_model.SearchTableAssetKnowledgeResponse>;
4818
4902
  /**
4819
4903
  * 根据用户提供的问题,智能搜索获取表知识
4820
4904
  *
package/dist/client.js CHANGED
@@ -8731,6 +8731,54 @@ class Client extends openapi_core_1.default {
8731
8731
  let runtime = new $dara.RuntimeOptions({});
8732
8732
  return await this.getStructSyncOrderDetailWithOptions(request, runtime);
8733
8733
  }
8734
+ /**
8735
+ * 查询表的字段知识列表,包含字段元信息、业务描述、安全信息等
8736
+ *
8737
+ * @remarks
8738
+ * 查询表的字段知识列表,返回每个字段的元信息(类型、可空、自增等)、业务描述、术语、数据标准、安全等级与索引信息
8739
+ *
8740
+ * @param request - GetTableColumnListRequest
8741
+ * @param runtime - runtime options for this request RuntimeOptions
8742
+ * @returns GetTableColumnListResponse
8743
+ */
8744
+ async getTableColumnListWithOptions(request, runtime) {
8745
+ request.validate();
8746
+ let query = {};
8747
+ if (!$dara.isNull(request.dbId)) {
8748
+ query["DbId"] = request.dbId;
8749
+ }
8750
+ if (!$dara.isNull(request.tableName)) {
8751
+ query["TableName"] = request.tableName;
8752
+ }
8753
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
8754
+ query: openapi_core_2.OpenApiUtil.query(query),
8755
+ });
8756
+ let params = new openapi_core_2.$OpenApiUtil.Params({
8757
+ action: "GetTableColumnList",
8758
+ version: "2018-11-01",
8759
+ protocol: "HTTPS",
8760
+ pathname: "/",
8761
+ method: "POST",
8762
+ authType: "AK",
8763
+ style: "RPC",
8764
+ reqBodyType: "formData",
8765
+ bodyType: "json",
8766
+ });
8767
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetTableColumnListResponse({}));
8768
+ }
8769
+ /**
8770
+ * 查询表的字段知识列表,包含字段元信息、业务描述、安全信息等
8771
+ *
8772
+ * @remarks
8773
+ * 查询表的字段知识列表,返回每个字段的元信息(类型、可空、自增等)、业务描述、术语、数据标准、安全等级与索引信息
8774
+ *
8775
+ * @param request - GetTableColumnListRequest
8776
+ * @returns GetTableColumnListResponse
8777
+ */
8778
+ async getTableColumnList(request) {
8779
+ let runtime = new $dara.RuntimeOptions({});
8780
+ return await this.getTableColumnListWithOptions(request, runtime);
8781
+ }
8734
8782
  /**
8735
8783
  * Queries the topology of a data table.
8736
8784
  *
@@ -8857,6 +8905,102 @@ class Client extends openapi_core_1.default {
8857
8905
  let runtime = new $dara.RuntimeOptions({});
8858
8906
  return await this.getTableDesignProjectInfoWithOptions(request, runtime);
8859
8907
  }
8908
+ /**
8909
+ * 查询表的业务知识/使用说明(业务描述、摘要、关联资产)
8910
+ *
8911
+ * @remarks
8912
+ * 查询表的业务知识/使用说明,返回 AI 增强业务描述、表业务摘要、关联资产列表,用于辅助语义找表与表用法说明
8913
+ *
8914
+ * @param request - GetTableInstructionsRequest
8915
+ * @param runtime - runtime options for this request RuntimeOptions
8916
+ * @returns GetTableInstructionsResponse
8917
+ */
8918
+ async getTableInstructionsWithOptions(request, runtime) {
8919
+ request.validate();
8920
+ let query = {};
8921
+ if (!$dara.isNull(request.dbId)) {
8922
+ query["DbId"] = request.dbId;
8923
+ }
8924
+ if (!$dara.isNull(request.tableName)) {
8925
+ query["TableName"] = request.tableName;
8926
+ }
8927
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
8928
+ query: openapi_core_2.OpenApiUtil.query(query),
8929
+ });
8930
+ let params = new openapi_core_2.$OpenApiUtil.Params({
8931
+ action: "GetTableInstructions",
8932
+ version: "2018-11-01",
8933
+ protocol: "HTTPS",
8934
+ pathname: "/",
8935
+ method: "POST",
8936
+ authType: "AK",
8937
+ style: "RPC",
8938
+ reqBodyType: "formData",
8939
+ bodyType: "json",
8940
+ });
8941
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetTableInstructionsResponse({}));
8942
+ }
8943
+ /**
8944
+ * 查询表的业务知识/使用说明(业务描述、摘要、关联资产)
8945
+ *
8946
+ * @remarks
8947
+ * 查询表的业务知识/使用说明,返回 AI 增强业务描述、表业务摘要、关联资产列表,用于辅助语义找表与表用法说明
8948
+ *
8949
+ * @param request - GetTableInstructionsRequest
8950
+ * @returns GetTableInstructionsResponse
8951
+ */
8952
+ async getTableInstructions(request) {
8953
+ let runtime = new $dara.RuntimeOptions({});
8954
+ return await this.getTableInstructionsWithOptions(request, runtime);
8955
+ }
8956
+ /**
8957
+ * 查询表的资产知识详情,包含表元信息、业务描述、字段列表等
8958
+ *
8959
+ * @remarks
8960
+ * 查询表的资产知识详情,返回表的基本元信息、AI 增强的业务描述、汇总信息以及字段知识列表
8961
+ *
8962
+ * @param request - GetTableKnowledgeDetailsRequest
8963
+ * @param runtime - runtime options for this request RuntimeOptions
8964
+ * @returns GetTableKnowledgeDetailsResponse
8965
+ */
8966
+ async getTableKnowledgeDetailsWithOptions(request, runtime) {
8967
+ request.validate();
8968
+ let query = {};
8969
+ if (!$dara.isNull(request.dbId)) {
8970
+ query["DbId"] = request.dbId;
8971
+ }
8972
+ if (!$dara.isNull(request.tableName)) {
8973
+ query["TableName"] = request.tableName;
8974
+ }
8975
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
8976
+ query: openapi_core_2.OpenApiUtil.query(query),
8977
+ });
8978
+ let params = new openapi_core_2.$OpenApiUtil.Params({
8979
+ action: "GetTableKnowledgeDetails",
8980
+ version: "2018-11-01",
8981
+ protocol: "HTTPS",
8982
+ pathname: "/",
8983
+ method: "POST",
8984
+ authType: "AK",
8985
+ style: "RPC",
8986
+ reqBodyType: "formData",
8987
+ bodyType: "json",
8988
+ });
8989
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetTableKnowledgeDetailsResponse({}));
8990
+ }
8991
+ /**
8992
+ * 查询表的资产知识详情,包含表元信息、业务描述、字段列表等
8993
+ *
8994
+ * @remarks
8995
+ * 查询表的资产知识详情,返回表的基本元信息、AI 增强的业务描述、汇总信息以及字段知识列表
8996
+ *
8997
+ * @param request - GetTableKnowledgeDetailsRequest
8998
+ * @returns GetTableKnowledgeDetailsResponse
8999
+ */
9000
+ async getTableKnowledgeDetails(request) {
9001
+ let runtime = new $dara.RuntimeOptions({});
9002
+ return await this.getTableKnowledgeDetailsWithOptions(request, runtime);
9003
+ }
8860
9004
  /**
8861
9005
  * Gets metadata knowledge for a specified GUID.
8862
9006
  *
@@ -15196,6 +15340,66 @@ class Client extends openapi_core_1.default {
15196
15340
  let runtime = new $dara.RuntimeOptions({});
15197
15341
  return await this.searchTableWithOptions(request, runtime);
15198
15342
  }
15343
+ /**
15344
+ * 分页查询某张表相关的资产知识列表(含表/字段/SQL/片段等)
15345
+ *
15346
+ * @remarks
15347
+ * 分页查询某张表相关的资产知识列表,支持按知识类型、关键词等条件筛选,返回 KnowledgeBaseVO 分页结果
15348
+ *
15349
+ * @param request - SearchTableAssetKnowledgeRequest
15350
+ * @param runtime - runtime options for this request RuntimeOptions
15351
+ * @returns SearchTableAssetKnowledgeResponse
15352
+ */
15353
+ async searchTableAssetKnowledgeWithOptions(request, runtime) {
15354
+ request.validate();
15355
+ let query = {};
15356
+ if (!$dara.isNull(request.dbId)) {
15357
+ query["DbId"] = request.dbId;
15358
+ }
15359
+ if (!$dara.isNull(request.offset)) {
15360
+ query["Offset"] = request.offset;
15361
+ }
15362
+ if (!$dara.isNull(request.searchKey)) {
15363
+ query["SearchKey"] = request.searchKey;
15364
+ }
15365
+ if (!$dara.isNull(request.showType)) {
15366
+ query["ShowType"] = request.showType;
15367
+ }
15368
+ if (!$dara.isNull(request.size)) {
15369
+ query["Size"] = request.size;
15370
+ }
15371
+ if (!$dara.isNull(request.tableName)) {
15372
+ query["TableName"] = request.tableName;
15373
+ }
15374
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
15375
+ query: openapi_core_2.OpenApiUtil.query(query),
15376
+ });
15377
+ let params = new openapi_core_2.$OpenApiUtil.Params({
15378
+ action: "SearchTableAssetKnowledge",
15379
+ version: "2018-11-01",
15380
+ protocol: "HTTPS",
15381
+ pathname: "/",
15382
+ method: "POST",
15383
+ authType: "AK",
15384
+ style: "RPC",
15385
+ reqBodyType: "formData",
15386
+ bodyType: "json",
15387
+ });
15388
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.SearchTableAssetKnowledgeResponse({}));
15389
+ }
15390
+ /**
15391
+ * 分页查询某张表相关的资产知识列表(含表/字段/SQL/片段等)
15392
+ *
15393
+ * @remarks
15394
+ * 分页查询某张表相关的资产知识列表,支持按知识类型、关键词等条件筛选,返回 KnowledgeBaseVO 分页结果
15395
+ *
15396
+ * @param request - SearchTableAssetKnowledgeRequest
15397
+ * @returns SearchTableAssetKnowledgeResponse
15398
+ */
15399
+ async searchTableAssetKnowledge(request) {
15400
+ let runtime = new $dara.RuntimeOptions({});
15401
+ return await this.searchTableAssetKnowledgeWithOptions(request, runtime);
15402
+ }
15199
15403
  /**
15200
15404
  * 根据用户提供的问题,智能搜索获取表知识
15201
15405
  *