@alicloud/eventbridge20200401 6.6.1 → 6.7.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 (196) hide show
  1. package/dist/client.d.ts +192 -6
  2. package/dist/client.js +667 -6
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/Agent.d.ts +6 -0
  5. package/dist/models/Agent.js.map +1 -1
  6. package/dist/models/AiTranslateTransformParameters.d.ts +13 -0
  7. package/dist/models/AiTranslateTransformParameters.js.map +1 -1
  8. package/dist/models/CreateKnowledgeBaseRequest.d.ts +305 -0
  9. package/dist/models/CreateKnowledgeBaseRequest.js +192 -0
  10. package/dist/models/CreateKnowledgeBaseRequest.js.map +1 -0
  11. package/dist/models/CreateKnowledgeBaseResponse.d.ts +19 -0
  12. package/dist/models/CreateKnowledgeBaseResponse.js +69 -0
  13. package/dist/models/CreateKnowledgeBaseResponse.js.map +1 -0
  14. package/dist/models/CreateKnowledgeBaseResponseBody.d.ts +51 -0
  15. package/dist/models/CreateKnowledgeBaseResponseBody.js +70 -0
  16. package/dist/models/CreateKnowledgeBaseResponseBody.js.map +1 -0
  17. package/dist/models/CreateKnowledgeBaseShrinkRequest.d.ts +85 -0
  18. package/dist/models/CreateKnowledgeBaseShrinkRequest.js +74 -0
  19. package/dist/models/CreateKnowledgeBaseShrinkRequest.js.map +1 -0
  20. package/dist/models/DeleteKnowledgeBaseRequest.d.ts +43 -0
  21. package/dist/models/DeleteKnowledgeBaseRequest.js +62 -0
  22. package/dist/models/DeleteKnowledgeBaseRequest.js.map +1 -0
  23. package/dist/models/DeleteKnowledgeBaseResponse.d.ts +19 -0
  24. package/dist/models/DeleteKnowledgeBaseResponse.js +69 -0
  25. package/dist/models/DeleteKnowledgeBaseResponse.js.map +1 -0
  26. package/dist/models/DeleteKnowledgeBaseResponseBody.d.ts +51 -0
  27. package/dist/models/DeleteKnowledgeBaseResponseBody.js +70 -0
  28. package/dist/models/DeleteKnowledgeBaseResponseBody.js.map +1 -0
  29. package/dist/models/GetAgentRequest.d.ts +1 -1
  30. package/dist/models/GetAgentResponseBody.d.ts +1 -1
  31. package/dist/models/GetChunkRequest.d.ts +63 -0
  32. package/dist/models/GetChunkRequest.js +66 -0
  33. package/dist/models/GetChunkRequest.js.map +1 -0
  34. package/dist/models/GetChunkResponse.d.ts +19 -0
  35. package/dist/models/GetChunkResponse.js +69 -0
  36. package/dist/models/GetChunkResponse.js.map +1 -0
  37. package/dist/models/GetChunkResponseBody.d.ts +51 -0
  38. package/dist/models/GetChunkResponseBody.js +70 -0
  39. package/dist/models/GetChunkResponseBody.js.map +1 -0
  40. package/dist/models/GetDocumentDownloadUrlRequest.d.ts +64 -0
  41. package/dist/models/GetDocumentDownloadUrlRequest.js +66 -0
  42. package/dist/models/GetDocumentDownloadUrlRequest.js.map +1 -0
  43. package/dist/models/GetDocumentDownloadUrlResponse.d.ts +19 -0
  44. package/dist/models/GetDocumentDownloadUrlResponse.js +69 -0
  45. package/dist/models/GetDocumentDownloadUrlResponse.js.map +1 -0
  46. package/dist/models/GetDocumentDownloadUrlResponseBody.d.ts +78 -0
  47. package/dist/models/GetDocumentDownloadUrlResponseBody.js +90 -0
  48. package/dist/models/GetDocumentDownloadUrlResponseBody.js.map +1 -0
  49. package/dist/models/GetDocumentRequest.d.ts +53 -0
  50. package/dist/models/GetDocumentRequest.js +64 -0
  51. package/dist/models/GetDocumentRequest.js.map +1 -0
  52. package/dist/models/GetDocumentResponse.d.ts +19 -0
  53. package/dist/models/GetDocumentResponse.js +69 -0
  54. package/dist/models/GetDocumentResponse.js.map +1 -0
  55. package/dist/models/GetDocumentResponseBody.d.ts +51 -0
  56. package/dist/models/GetDocumentResponseBody.js +70 -0
  57. package/dist/models/GetDocumentResponseBody.js.map +1 -0
  58. package/dist/models/GetKnowledgeBaseRequest.d.ts +43 -0
  59. package/dist/models/GetKnowledgeBaseRequest.js +62 -0
  60. package/dist/models/GetKnowledgeBaseRequest.js.map +1 -0
  61. package/dist/models/GetKnowledgeBaseResponse.d.ts +19 -0
  62. package/dist/models/GetKnowledgeBaseResponse.js +69 -0
  63. package/dist/models/GetKnowledgeBaseResponse.js.map +1 -0
  64. package/dist/models/GetKnowledgeBaseResponseBody.d.ts +51 -0
  65. package/dist/models/GetKnowledgeBaseResponseBody.js +70 -0
  66. package/dist/models/GetKnowledgeBaseResponseBody.js.map +1 -0
  67. package/dist/models/ListAgentsRequest.d.ts +3 -3
  68. package/dist/models/ListAgentsResponseBody.d.ts +6 -6
  69. package/dist/models/ListChunksRequest.d.ts +83 -0
  70. package/dist/models/ListChunksRequest.js +72 -0
  71. package/dist/models/ListChunksRequest.js.map +1 -0
  72. package/dist/models/ListChunksResponse.d.ts +19 -0
  73. package/dist/models/ListChunksResponse.js +69 -0
  74. package/dist/models/ListChunksResponse.js.map +1 -0
  75. package/dist/models/ListChunksResponseBody.d.ts +95 -0
  76. package/dist/models/ListChunksResponseBody.js +98 -0
  77. package/dist/models/ListChunksResponseBody.js.map +1 -0
  78. package/dist/models/ListConnectionsRequest.d.ts +5 -5
  79. package/dist/models/ListConnectionsResponseBody.d.ts +15 -14
  80. package/dist/models/ListConnectionsResponseBody.js.map +1 -1
  81. package/dist/models/ListDocumentsRequest.d.ts +84 -0
  82. package/dist/models/ListDocumentsRequest.js +70 -0
  83. package/dist/models/ListDocumentsRequest.js.map +1 -0
  84. package/dist/models/ListDocumentsResponse.d.ts +19 -0
  85. package/dist/models/ListDocumentsResponse.js +69 -0
  86. package/dist/models/ListDocumentsResponse.js.map +1 -0
  87. package/dist/models/ListDocumentsResponseBody.d.ts +95 -0
  88. package/dist/models/ListDocumentsResponseBody.js +98 -0
  89. package/dist/models/ListDocumentsResponseBody.js.map +1 -0
  90. package/dist/models/ListKnowledgeBasesRequest.d.ts +49 -0
  91. package/dist/models/ListKnowledgeBasesRequest.js +64 -0
  92. package/dist/models/ListKnowledgeBasesRequest.js.map +1 -0
  93. package/dist/models/ListKnowledgeBasesResponse.d.ts +19 -0
  94. package/dist/models/ListKnowledgeBasesResponse.js +69 -0
  95. package/dist/models/ListKnowledgeBasesResponse.js.map +1 -0
  96. package/dist/models/ListKnowledgeBasesResponseBody.d.ts +95 -0
  97. package/dist/models/ListKnowledgeBasesResponseBody.js +98 -0
  98. package/dist/models/ListKnowledgeBasesResponseBody.js.map +1 -0
  99. package/dist/models/ListLumaCatalogsRequest.d.ts +3 -3
  100. package/dist/models/ListLumaCatalogsResponseBody.d.ts +9 -9
  101. package/dist/models/ListLumaNamespacesRequest.d.ts +4 -4
  102. package/dist/models/ListLumaNamespacesResponseBody.d.ts +9 -9
  103. package/dist/models/QueryWithSqlrequest.d.ts +31 -0
  104. package/dist/models/QueryWithSqlrequest.js +60 -0
  105. package/dist/models/QueryWithSqlrequest.js.map +1 -0
  106. package/dist/models/QueryWithSqlresponse.d.ts +19 -0
  107. package/dist/models/QueryWithSqlresponse.js +69 -0
  108. package/dist/models/QueryWithSqlresponse.js.map +1 -0
  109. package/dist/models/QueryWithSqlresponseBody.d.ts +80 -0
  110. package/dist/models/QueryWithSqlresponseBody.js +94 -0
  111. package/dist/models/QueryWithSqlresponseBody.js.map +1 -0
  112. package/dist/models/SearchKnowledgeBaseRequest.d.ts +117 -0
  113. package/dist/models/SearchKnowledgeBaseRequest.js +80 -0
  114. package/dist/models/SearchKnowledgeBaseRequest.js.map +1 -0
  115. package/dist/models/SearchKnowledgeBaseResponse.d.ts +19 -0
  116. package/dist/models/SearchKnowledgeBaseResponse.js +69 -0
  117. package/dist/models/SearchKnowledgeBaseResponse.js.map +1 -0
  118. package/dist/models/SearchKnowledgeBaseResponseBody.d.ts +79 -0
  119. package/dist/models/SearchKnowledgeBaseResponseBody.js +94 -0
  120. package/dist/models/SearchKnowledgeBaseResponseBody.js.map +1 -0
  121. package/dist/models/UpdateAgentRequest.d.ts +11 -5
  122. package/dist/models/UpdateAgentRequest.js.map +1 -1
  123. package/dist/models/UpdateAgentResponseBody.d.ts +3 -3
  124. package/dist/models/UpdateAgentShrinkRequest.d.ts +9 -3
  125. package/dist/models/UpdateAgentShrinkRequest.js.map +1 -1
  126. package/dist/models/UpdateKnowledgeBaseRequest.d.ts +222 -0
  127. package/dist/models/UpdateKnowledgeBaseRequest.js +158 -0
  128. package/dist/models/UpdateKnowledgeBaseRequest.js.map +1 -0
  129. package/dist/models/UpdateKnowledgeBaseResponse.d.ts +19 -0
  130. package/dist/models/UpdateKnowledgeBaseResponse.js +69 -0
  131. package/dist/models/UpdateKnowledgeBaseResponse.js.map +1 -0
  132. package/dist/models/UpdateKnowledgeBaseResponseBody.d.ts +51 -0
  133. package/dist/models/UpdateKnowledgeBaseResponseBody.js +70 -0
  134. package/dist/models/UpdateKnowledgeBaseResponseBody.js.map +1 -0
  135. package/dist/models/UpdateKnowledgeBaseShrinkRequest.d.ts +61 -0
  136. package/dist/models/UpdateKnowledgeBaseShrinkRequest.js +68 -0
  137. package/dist/models/UpdateKnowledgeBaseShrinkRequest.js.map +1 -0
  138. package/dist/models/model.d.ts +51 -0
  139. package/dist/models/model.js +123 -20
  140. package/dist/models/model.js.map +1 -1
  141. package/package.json +1 -1
  142. package/src/client.ts +768 -10
  143. package/src/models/Agent.ts +6 -0
  144. package/src/models/AiTranslateTransformParameters.ts +13 -0
  145. package/src/models/CreateKnowledgeBaseRequest.ts +416 -0
  146. package/src/models/CreateKnowledgeBaseResponse.ts +40 -0
  147. package/src/models/CreateKnowledgeBaseResponseBody.ts +75 -0
  148. package/src/models/CreateKnowledgeBaseShrinkRequest.ts +114 -0
  149. package/src/models/DeleteKnowledgeBaseRequest.ts +60 -0
  150. package/src/models/DeleteKnowledgeBaseResponse.ts +40 -0
  151. package/src/models/DeleteKnowledgeBaseResponseBody.ts +75 -0
  152. package/src/models/GetAgentRequest.ts +1 -1
  153. package/src/models/GetAgentResponseBody.ts +1 -1
  154. package/src/models/GetChunkRequest.ts +84 -0
  155. package/src/models/GetChunkResponse.ts +40 -0
  156. package/src/models/GetChunkResponseBody.ts +75 -0
  157. package/src/models/GetDocumentDownloadUrlRequest.ts +85 -0
  158. package/src/models/GetDocumentDownloadUrlResponse.ts +40 -0
  159. package/src/models/GetDocumentDownloadUrlResponseBody.ts +114 -0
  160. package/src/models/GetDocumentRequest.ts +72 -0
  161. package/src/models/GetDocumentResponse.ts +40 -0
  162. package/src/models/GetDocumentResponseBody.ts +75 -0
  163. package/src/models/GetKnowledgeBaseRequest.ts +60 -0
  164. package/src/models/GetKnowledgeBaseResponse.ts +40 -0
  165. package/src/models/GetKnowledgeBaseResponseBody.ts +75 -0
  166. package/src/models/ListAgentsRequest.ts +3 -3
  167. package/src/models/ListAgentsResponseBody.ts +6 -6
  168. package/src/models/ListChunksRequest.ts +110 -0
  169. package/src/models/ListChunksResponse.ts +40 -0
  170. package/src/models/ListChunksResponseBody.ts +138 -0
  171. package/src/models/ListConnectionsRequest.ts +5 -5
  172. package/src/models/ListConnectionsResponseBody.ts +15 -14
  173. package/src/models/ListDocumentsRequest.ts +109 -0
  174. package/src/models/ListDocumentsResponse.ts +40 -0
  175. package/src/models/ListDocumentsResponseBody.ts +138 -0
  176. package/src/models/ListKnowledgeBasesRequest.ts +68 -0
  177. package/src/models/ListKnowledgeBasesResponse.ts +40 -0
  178. package/src/models/ListKnowledgeBasesResponseBody.ts +138 -0
  179. package/src/models/ListLumaCatalogsRequest.ts +3 -3
  180. package/src/models/ListLumaCatalogsResponseBody.ts +9 -9
  181. package/src/models/ListLumaNamespacesRequest.ts +4 -4
  182. package/src/models/ListLumaNamespacesResponseBody.ts +9 -9
  183. package/src/models/QueryWithSqlrequest.ts +46 -0
  184. package/src/models/QueryWithSqlresponse.ts +40 -0
  185. package/src/models/QueryWithSqlresponseBody.ts +119 -0
  186. package/src/models/SearchKnowledgeBaseRequest.ts +152 -0
  187. package/src/models/SearchKnowledgeBaseResponse.ts +40 -0
  188. package/src/models/SearchKnowledgeBaseResponseBody.ts +118 -0
  189. package/src/models/UpdateAgentRequest.ts +11 -5
  190. package/src/models/UpdateAgentResponseBody.ts +3 -3
  191. package/src/models/UpdateAgentShrinkRequest.ts +9 -3
  192. package/src/models/UpdateKnowledgeBaseRequest.ts +308 -0
  193. package/src/models/UpdateKnowledgeBaseResponse.ts +40 -0
  194. package/src/models/UpdateKnowledgeBaseResponseBody.ts +75 -0
  195. package/src/models/UpdateKnowledgeBaseShrinkRequest.ts +84 -0
  196. package/src/models/model.ts +51 -0
@@ -6,7 +6,7 @@ import { Catalog } from "./Catalog";
6
6
  export class ListLumaCatalogsResponseBodyData extends $dara.Model {
7
7
  /**
8
8
  * @remarks
9
- * The list of data catalogs bound to the Agent.
9
+ * The list of data catalogs bound to the agent.
10
10
  *
11
11
  * @example
12
12
  * [{"Name":"my_catalog"}]
@@ -14,7 +14,7 @@ export class ListLumaCatalogsResponseBodyData extends $dara.Model {
14
14
  catalogs?: Catalog[];
15
15
  /**
16
16
  * @remarks
17
- * 本次请求实际生效的每页数量。未传 Limit 时为服务端默认值,超出上限时为收敛后的值
17
+ * The effective page size for this request. If the Limit parameter is not specified, the server default value is used. If the specified value exceeds the upper limit, the value is adjusted to the maximum allowed value.
18
18
  *
19
19
  * @example
20
20
  * 10
@@ -22,7 +22,7 @@ export class ListLumaCatalogsResponseBodyData extends $dara.Model {
22
22
  limit?: number;
23
23
  /**
24
24
  * @remarks
25
- * 下一页起始Token,传入下次请求的 NextToken 可获取下一页;为空表示已无更多数据
25
+ * The token for the next page. Pass this value as the NextToken in the next request to retrieve the next page. An empty value indicates that no more data is available.
26
26
  *
27
27
  * @example
28
28
  * 10
@@ -30,7 +30,7 @@ export class ListLumaCatalogsResponseBodyData extends $dara.Model {
30
30
  nextToken?: string;
31
31
  /**
32
32
  * @remarks
33
- * Agent 绑定的数据目录总数,与本页返回条数无关
33
+ * The total number of data catalogs bound to the agent, regardless of the number of entries returned on the current page.
34
34
  *
35
35
  * @example
36
36
  * 10
@@ -69,7 +69,7 @@ export class ListLumaCatalogsResponseBodyData extends $dara.Model {
69
69
  export class ListLumaCatalogsResponseBody extends $dara.Model {
70
70
  /**
71
71
  * @remarks
72
- * The response code. A value of Success indicates a successful call. A specific error code is returned when the call fails.
72
+ * The response code. A value of Success indicates a successful call. If the call fails, a specific error code is returned.
73
73
  *
74
74
  * @example
75
75
  * Success
@@ -77,12 +77,12 @@ export class ListLumaCatalogsResponseBody extends $dara.Model {
77
77
  code?: string;
78
78
  /**
79
79
  * @remarks
80
- * The list of data catalogs bound to the Agent. All results are returned at once without pagination.
80
+ * The list of data catalogs bound to the agent, including entries and pagination information.
81
81
  */
82
82
  data?: ListLumaCatalogsResponseBodyData;
83
83
  /**
84
84
  * @remarks
85
- * The message returned by the operation. The value is Operation success when the call succeeds, or a specific error description when the call fails.
85
+ * The response message. A value of Operation success is returned if the call succeeds. A specific error description is returned if the call fails.
86
86
  *
87
87
  * @example
88
88
  * Operation success
@@ -90,7 +90,7 @@ export class ListLumaCatalogsResponseBody extends $dara.Model {
90
90
  message?: string;
91
91
  /**
92
92
  * @remarks
93
- * The unique identifier of the request, used for troubleshooting and ticket submission.
93
+ * The unique ID of the request. Use this ID for troubleshooting and when submitting a ticket.
94
94
  *
95
95
  * @example
96
96
  * 34AD682D-5B91-5773-8132-AA38C130****
@@ -98,7 +98,7 @@ export class ListLumaCatalogsResponseBody extends $dara.Model {
98
98
  requestId?: string;
99
99
  /**
100
100
  * @remarks
101
- * Indicates whether the call was successful. A value of true indicates success.
101
+ * Indicates whether the call is successful. A value of true indicates success.
102
102
  *
103
103
  * @example
104
104
  * true
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class ListLumaNamespacesRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The name of the Agent.
8
+ * The name of the agent.
9
9
  *
10
10
  * This parameter is required.
11
11
  *
@@ -15,7 +15,7 @@ export class ListLumaNamespacesRequest extends $dara.Model {
15
15
  agentName?: string;
16
16
  /**
17
17
  * @remarks
18
- * The name of the data catalog bound to the Agent. You can call ListLumaCatalogs to obtain the catalog name.
18
+ * The name of the data catalog bound to the agent. You can call the ListLumaCatalogs operation to obtain the catalog name.
19
19
  *
20
20
  * This parameter is required.
21
21
  *
@@ -25,7 +25,7 @@ export class ListLumaNamespacesRequest extends $dara.Model {
25
25
  catalog?: string;
26
26
  /**
27
27
  * @remarks
28
- * 每页返回的最大数据条数。取值范围 1~100,不传时默认 100。每条记录都需回源查询一次元数据,因此该值同时限制单次调用的回源次数
28
+ * The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 100. Each entry requires a back-to-origin metadata query, so this value also limits the number of back-to-origin requests per call.
29
29
  *
30
30
  * @example
31
31
  * 10
@@ -33,7 +33,7 @@ export class ListLumaNamespacesRequest extends $dara.Model {
33
33
  limit?: number;
34
34
  /**
35
35
  * @remarks
36
- * 分页查询的起始Token。首次查询不传或传 "0";后续翻页使用上一次响应中返回的 NextToken 值
36
+ * The token for the paging query. Leave this parameter empty or set it to "0" for the first query. For subsequent pages, use the NextToken value returned in the previous response.
37
37
  *
38
38
  * @example
39
39
  * 0
@@ -6,7 +6,7 @@ import { Namespace } from "./Namespace";
6
6
  export class ListLumaNamespacesResponseBodyData extends $dara.Model {
7
7
  /**
8
8
  * @remarks
9
- * 本次请求实际生效的每页数量。未传 Limit 时为服务端默认值,超出上限时为收敛后的值
9
+ * The effective page size for this request. If the Limit parameter is not specified, the server default value is used. If the specified value exceeds the upper limit, the value is adjusted to the maximum allowed value.
10
10
  *
11
11
  * @example
12
12
  * 10
@@ -14,7 +14,7 @@ export class ListLumaNamespacesResponseBodyData extends $dara.Model {
14
14
  limit?: number;
15
15
  /**
16
16
  * @remarks
17
- * The list of namespaces bound to the Agent.
17
+ * The list of namespaces bound to the agent.
18
18
  *
19
19
  * @example
20
20
  * [{"Name":"my_namespace"}]
@@ -22,7 +22,7 @@ export class ListLumaNamespacesResponseBodyData extends $dara.Model {
22
22
  namespaces?: Namespace[];
23
23
  /**
24
24
  * @remarks
25
- * 下一页起始Token,传入下次请求的 NextToken 可获取下一页;为空表示已无更多数据
25
+ * The token for the next page. Pass this value as the NextToken parameter in the next request to retrieve the next page. An empty value indicates that no more data is available.
26
26
  *
27
27
  * @example
28
28
  * 10
@@ -30,7 +30,7 @@ export class ListLumaNamespacesResponseBodyData extends $dara.Model {
30
30
  nextToken?: string;
31
31
  /**
32
32
  * @remarks
33
- * Agent 绑定的命名空间总数,与本页返回条数无关
33
+ * The total number of namespaces bound to the agent, regardless of the number of entries returned on the current page.
34
34
  *
35
35
  * @example
36
36
  * 10
@@ -69,7 +69,7 @@ export class ListLumaNamespacesResponseBodyData extends $dara.Model {
69
69
  export class ListLumaNamespacesResponseBody extends $dara.Model {
70
70
  /**
71
71
  * @remarks
72
- * The response code. A value of Success indicates a successful call. A specific error code is returned upon failure.
72
+ * The response code. A value of Success indicates a successful operation. If the operation fails, a specific error code is returned.
73
73
  *
74
74
  * @example
75
75
  * Success
@@ -77,12 +77,12 @@ export class ListLumaNamespacesResponseBody extends $dara.Model {
77
77
  code?: string;
78
78
  /**
79
79
  * @remarks
80
- * The list of namespaces bound to the Agent. All results are returned at once without pagination.
80
+ * The list of namespaces bound to the agent, including entries and pagination information.
81
81
  */
82
82
  data?: ListLumaNamespacesResponseBodyData;
83
83
  /**
84
84
  * @remarks
85
- * The message returned by the operation. The value is Operation success when the call succeeds, or a specific error description when the call fails.
85
+ * The response message. A value of Operation success is returned if the operation succeeds. A specific error description is returned if the operation fails.
86
86
  *
87
87
  * @example
88
88
  * Operation success
@@ -90,7 +90,7 @@ export class ListLumaNamespacesResponseBody extends $dara.Model {
90
90
  message?: string;
91
91
  /**
92
92
  * @remarks
93
- * The unique identifier of the request, used for troubleshooting and ticket feedback.
93
+ * The unique ID of the request. Use this ID for troubleshooting and when submitting a ticket.
94
94
  *
95
95
  * @example
96
96
  * 34AD682D-5B91-5773-8132-AA38C130****
@@ -98,7 +98,7 @@ export class ListLumaNamespacesResponseBody extends $dara.Model {
98
98
  requestId?: string;
99
99
  /**
100
100
  * @remarks
101
- * Indicates whether the call was successful. A value of true indicates success.
101
+ * Indicates whether the call is successful. A value of true indicates success.
102
102
  *
103
103
  * @example
104
104
  * true
@@ -0,0 +1,46 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class QueryWithSQLRequest extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * The maximum number of rows to return. Default value: 20. Maximum value: 50.
9
+ *
10
+ * @example
11
+ * 10
12
+ */
13
+ limit?: number;
14
+ /**
15
+ * @remarks
16
+ * The query statement. Typically uses a three-part table name in the format of catalog.namespace.table.
17
+ *
18
+ * This parameter is required.
19
+ *
20
+ * @example
21
+ * SELECT * FROM "test-es"."default"."product_info"
22
+ */
23
+ query?: string;
24
+ static names(): { [key: string]: string } {
25
+ return {
26
+ limit: 'Limit',
27
+ query: 'Query',
28
+ };
29
+ }
30
+
31
+ static types(): { [key: string]: any } {
32
+ return {
33
+ limit: 'number',
34
+ query: 'string',
35
+ };
36
+ }
37
+
38
+ validate() {
39
+ super.validate();
40
+ }
41
+
42
+ constructor(map?: { [key: string]: any }) {
43
+ super(map);
44
+ }
45
+ }
46
+
@@ -0,0 +1,40 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+ import { QueryWithSQLResponseBody } from "./QueryWithSqlresponseBody";
4
+
5
+
6
+ export class QueryWithSQLResponse extends $dara.Model {
7
+ headers?: { [key: string]: string };
8
+ statusCode?: number;
9
+ body?: QueryWithSQLResponseBody;
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: QueryWithSQLResponseBody,
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,119 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+ import { Row } from "./Row";
4
+
5
+
6
+ export class QueryWithSQLResponseBodyData extends $dara.Model {
7
+ /**
8
+ * @remarks
9
+ * The query result rows.
10
+ */
11
+ rows?: Row[];
12
+ /**
13
+ * @remarks
14
+ * The total number of entries.
15
+ *
16
+ * @example
17
+ * 1
18
+ */
19
+ total?: number;
20
+ static names(): { [key: string]: string } {
21
+ return {
22
+ rows: 'Rows',
23
+ total: 'Total',
24
+ };
25
+ }
26
+
27
+ static types(): { [key: string]: any } {
28
+ return {
29
+ rows: { 'type': 'array', 'itemType': Row },
30
+ total: 'number',
31
+ };
32
+ }
33
+
34
+ validate() {
35
+ if(Array.isArray(this.rows)) {
36
+ $dara.Model.validateArray(this.rows);
37
+ }
38
+ super.validate();
39
+ }
40
+
41
+ constructor(map?: { [key: string]: any }) {
42
+ super(map);
43
+ }
44
+ }
45
+
46
+ export class QueryWithSQLResponseBody extends $dara.Model {
47
+ /**
48
+ * @remarks
49
+ * The response code. Valid values:
50
+ *
51
+ * - Success: The request was successful.
52
+ *
53
+ * - Other values: An error occurred. For more information, see error codes.
54
+ *
55
+ * @example
56
+ * Success
57
+ */
58
+ code?: string;
59
+ /**
60
+ * @remarks
61
+ * The event trace information.
62
+ */
63
+ data?: QueryWithSQLResponseBodyData;
64
+ /**
65
+ * @remarks
66
+ * The error message.
67
+ *
68
+ * @example
69
+ * Operation success
70
+ */
71
+ message?: string;
72
+ /**
73
+ * @remarks
74
+ * The request ID.
75
+ *
76
+ * @example
77
+ * 34AD682D-5B91-5773-8132-AA38C130****
78
+ */
79
+ requestId?: string;
80
+ /**
81
+ * @remarks
82
+ * Indicates whether the operation was successful. A value of true indicates success. A value of false indicates failure.
83
+ *
84
+ * @example
85
+ * true
86
+ */
87
+ success?: boolean;
88
+ static names(): { [key: string]: string } {
89
+ return {
90
+ code: 'Code',
91
+ data: 'Data',
92
+ message: 'Message',
93
+ requestId: 'RequestId',
94
+ success: 'Success',
95
+ };
96
+ }
97
+
98
+ static types(): { [key: string]: any } {
99
+ return {
100
+ code: 'string',
101
+ data: QueryWithSQLResponseBodyData,
102
+ message: 'string',
103
+ requestId: 'string',
104
+ success: 'boolean',
105
+ };
106
+ }
107
+
108
+ validate() {
109
+ if(this.data && typeof (this.data as any).validate === 'function') {
110
+ (this.data as any).validate();
111
+ }
112
+ super.validate();
113
+ }
114
+
115
+ constructor(map?: { [key: string]: any }) {
116
+ super(map);
117
+ }
118
+ }
119
+
@@ -0,0 +1,152 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class SearchKnowledgeBaseRequest extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * The data catalog to which the knowledge base belongs. This parameter, together with Namespace and KnowledgeBaseName, uniquely identifies a knowledge base. You can call ListCatalogs to obtain the value.
9
+ *
10
+ * This parameter is required.
11
+ *
12
+ * @example
13
+ * my_catalog
14
+ */
15
+ catalog?: string;
16
+ /**
17
+ * @remarks
18
+ * The name of the knowledge base. The name is unique within a namespace and is specified at creation time. It cannot be modified.
19
+ *
20
+ * This parameter is required.
21
+ *
22
+ * @example
23
+ * my-knowledge-base
24
+ */
25
+ knowledgeBaseName?: string;
26
+ /**
27
+ * @remarks
28
+ * Filters search results by document metadata. The value is a JSON expression tree. Nodes are classified into two types: logical nodes {"AndAll": [child nodes...]} (all conditions must be met), {"OrAll": [child nodes...]} (any condition must be met), or {"NotAll": [child nodes...]} (none of the conditions must be met), which support arbitrary nesting; and leaf conditions {"Key": field name, "Operator": operator, "Value": value}, where the In and NotIn operators use "Values": [values...]. Valid values of Operator: Equals, NotEquals, In, NotIn, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual (the last four range operators apply only to LONG, DOUBLE, or DATETIME fields), StartsWith, and StringContains (applies only to STRING fields). Fields must be declared in the knowledge base schema. The nesting depth cannot exceed 5, and the total number of leaf conditions cannot exceed 20. DATETIME field value format: ISO-8601 with time zone, yyyy-MM-dd HH:mm:ss, or yyyy-MM-dd.
29
+ *
30
+ * @example
31
+ * {"AndAll": [{"Key": "env", "Operator": "In", "Values": ["prod", "staging"]}, {"OrAll": [{"Key": "score", "Operator": "GreaterThan", "Value": "0.8"}, {"Key": "owner", "Operator": "Equals", "Value": "alice"}]}]}
32
+ */
33
+ metadataFilter?: string;
34
+ /**
35
+ * @remarks
36
+ * The retrieval mode. KEYWORD indicates keyword retrieval. VECTOR indicates vector retrieval. HYBRID indicates hybrid retrieval.
37
+ *
38
+ * @example
39
+ * HYBRID
40
+ */
41
+ mode?: string;
42
+ /**
43
+ * @remarks
44
+ * The namespace to which the knowledge base belongs. The namespace must belong to the specified data catalog. This parameter, together with Catalog and KnowledgeBaseName, uniquely identifies a knowledge base. You can call ListNamespaces to obtain the value.
45
+ *
46
+ * This parameter is required.
47
+ *
48
+ * @example
49
+ * my_namespace
50
+ */
51
+ namespace?: string;
52
+ /**
53
+ * @remarks
54
+ * The query text. Both keyword retrieval and vector retrieval are based on this text.
55
+ *
56
+ * This parameter is required.
57
+ *
58
+ * @example
59
+ * How to configure event rules
60
+ */
61
+ query?: string;
62
+ /**
63
+ * @remarks
64
+ * Optional. Overrides the fusion algorithm configured for the knowledge base for this request. This parameter takes effect only in hybrid search (HYBRID) mode. RRF indicates reciprocal rank fusion. WEIGHTED indicates weighted normalization fusion (used together with VectorWeight). If you set this parameter to WEIGHTED in keyword-only or vector-only mode, an InvalidParameter error is returned.
65
+ *
66
+ * @example
67
+ * RRF
68
+ */
69
+ rankAlgorithm?: string;
70
+ /**
71
+ * @remarks
72
+ * Specifies whether to enable reranking for search results. Default value: false.
73
+ *
74
+ * @example
75
+ * false
76
+ */
77
+ rerank?: boolean;
78
+ /**
79
+ * @remarks
80
+ * Optional. Overrides the reranking model configured for the knowledge base for this request. This parameter takes effect when reranking is enabled (in all search modes). Valid values: qwen3-rerank, gte-rerank-v2, and qwen3-vl-rerank. If this parameter is not specified, the value configured for the knowledge base is used. If no value is configured, the default value qwen3-rerank is used. Score distributions differ across models and cannot be compared. Use the same model consistently for a given knowledge base.
81
+ *
82
+ * @example
83
+ * qwen3-rerank
84
+ */
85
+ rerankModel?: string;
86
+ /**
87
+ * @remarks
88
+ * Optional. Overrides the reciprocal rank fusion (RRF) parameter k configured for the knowledge base for this request. This parameter takes effect only in hybrid search (HYBRID) mode. The value must be greater than 0.
89
+ *
90
+ * @example
91
+ * 60
92
+ */
93
+ rrfK?: number;
94
+ /**
95
+ * @remarks
96
+ * The number of most relevant results to return. Default value: 10. Maximum value: 100.
97
+ *
98
+ * @example
99
+ * 10
100
+ */
101
+ topK?: number;
102
+ /**
103
+ * @remarks
104
+ * Optional. The vector weight for the WEIGHTED fusion algorithm. Valid values: 0 to 1. The keyword weight equals 1 minus this value. If this parameter is not specified, the value configured for the knowledge base is used. If no value is configured, the default value 0.7 is used.
105
+ *
106
+ * @example
107
+ * 0.7
108
+ */
109
+ vectorWeight?: number;
110
+ static names(): { [key: string]: string } {
111
+ return {
112
+ catalog: 'Catalog',
113
+ knowledgeBaseName: 'KnowledgeBaseName',
114
+ metadataFilter: 'MetadataFilter',
115
+ mode: 'Mode',
116
+ namespace: 'Namespace',
117
+ query: 'Query',
118
+ rankAlgorithm: 'RankAlgorithm',
119
+ rerank: 'Rerank',
120
+ rerankModel: 'RerankModel',
121
+ rrfK: 'RrfK',
122
+ topK: 'TopK',
123
+ vectorWeight: 'VectorWeight',
124
+ };
125
+ }
126
+
127
+ static types(): { [key: string]: any } {
128
+ return {
129
+ catalog: 'string',
130
+ knowledgeBaseName: 'string',
131
+ metadataFilter: 'string',
132
+ mode: 'string',
133
+ namespace: 'string',
134
+ query: 'string',
135
+ rankAlgorithm: 'string',
136
+ rerank: 'boolean',
137
+ rerankModel: 'string',
138
+ rrfK: 'number',
139
+ topK: 'number',
140
+ vectorWeight: 'number',
141
+ };
142
+ }
143
+
144
+ validate() {
145
+ super.validate();
146
+ }
147
+
148
+ constructor(map?: { [key: string]: any }) {
149
+ super(map);
150
+ }
151
+ }
152
+
@@ -0,0 +1,40 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+ import { SearchKnowledgeBaseResponseBody } from "./SearchKnowledgeBaseResponseBody";
4
+
5
+
6
+ export class SearchKnowledgeBaseResponse extends $dara.Model {
7
+ headers?: { [key: string]: string };
8
+ statusCode?: number;
9
+ body?: SearchKnowledgeBaseResponseBody;
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: SearchKnowledgeBaseResponseBody,
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
+