@alicloud/gpdb20160503 3.6.0 → 3.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 (189) hide show
  1. package/dist/client.d.ts +267 -36
  2. package/dist/client.js +648 -36
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ChatWithKnowledgeBaseRequest.d.ts +68 -111
  5. package/dist/models/ChatWithKnowledgeBaseRequest.js +2 -0
  6. package/dist/models/ChatWithKnowledgeBaseRequest.js.map +1 -1
  7. package/dist/models/ChatWithKnowledgeBaseResponseBody.d.ts +45 -52
  8. package/dist/models/ChatWithKnowledgeBaseResponseBody.js.map +1 -1
  9. package/dist/models/ChatWithKnowledgeBaseShrinkRequest.d.ts +5 -6
  10. package/dist/models/ChatWithKnowledgeBaseShrinkRequest.js.map +1 -1
  11. package/dist/models/ChatWithKnowledgeBaseStreamRequest.d.ts +71 -87
  12. package/dist/models/ChatWithKnowledgeBaseStreamRequest.js +2 -0
  13. package/dist/models/ChatWithKnowledgeBaseStreamRequest.js.map +1 -1
  14. package/dist/models/ChatWithKnowledgeBaseStreamResponseBody.d.ts +44 -50
  15. package/dist/models/ChatWithKnowledgeBaseStreamResponseBody.js.map +1 -1
  16. package/dist/models/ChatWithKnowledgeBaseStreamShrinkRequest.d.ts +6 -6
  17. package/dist/models/CreateBranchRequest.d.ts +150 -0
  18. package/dist/models/CreateBranchRequest.js +104 -0
  19. package/dist/models/CreateBranchRequest.js.map +1 -0
  20. package/dist/models/CreateBranchResponse.d.ts +19 -0
  21. package/dist/models/CreateBranchResponse.js +69 -0
  22. package/dist/models/CreateBranchResponse.js.map +1 -0
  23. package/dist/models/CreateBranchResponseBody.d.ts +37 -0
  24. package/dist/models/CreateBranchResponseBody.js +62 -0
  25. package/dist/models/CreateBranchResponseBody.js.map +1 -0
  26. package/dist/models/CreateSnapshotRequest.d.ts +55 -0
  27. package/dist/models/CreateSnapshotRequest.js +66 -0
  28. package/dist/models/CreateSnapshotRequest.js.map +1 -0
  29. package/dist/models/CreateSnapshotResponse.d.ts +19 -0
  30. package/dist/models/CreateSnapshotResponse.js +69 -0
  31. package/dist/models/CreateSnapshotResponse.js.map +1 -0
  32. package/dist/models/CreateSnapshotResponseBody.d.ts +45 -0
  33. package/dist/models/CreateSnapshotResponseBody.js +64 -0
  34. package/dist/models/CreateSnapshotResponseBody.js.map +1 -0
  35. package/dist/models/CreateSupabaseProjectRequest.d.ts +62 -48
  36. package/dist/models/CreateSupabaseProjectRequest.js.map +1 -1
  37. package/dist/models/CreateSupabaseProjectResponseBody.d.ts +4 -4
  38. package/dist/models/DeleteBranchRequest.d.ts +31 -0
  39. package/dist/models/DeleteBranchRequest.js +60 -0
  40. package/dist/models/DeleteBranchRequest.js.map +1 -0
  41. package/dist/models/DeleteBranchResponse.d.ts +19 -0
  42. package/dist/models/DeleteBranchResponse.js +69 -0
  43. package/dist/models/DeleteBranchResponse.js.map +1 -0
  44. package/dist/models/DeleteBranchResponseBody.d.ts +21 -0
  45. package/dist/models/DeleteBranchResponseBody.js +58 -0
  46. package/dist/models/DeleteBranchResponseBody.js.map +1 -0
  47. package/dist/models/DeleteSnapshotRequest.d.ts +34 -0
  48. package/dist/models/DeleteSnapshotRequest.js +62 -0
  49. package/dist/models/DeleteSnapshotRequest.js.map +1 -0
  50. package/dist/models/DeleteSnapshotResponse.d.ts +19 -0
  51. package/dist/models/DeleteSnapshotResponse.js +69 -0
  52. package/dist/models/DeleteSnapshotResponse.js.map +1 -0
  53. package/dist/models/DeleteSnapshotResponseBody.d.ts +18 -0
  54. package/dist/models/DeleteSnapshotResponseBody.js +58 -0
  55. package/dist/models/DeleteSnapshotResponseBody.js.map +1 -0
  56. package/dist/models/DescribeBranchRequest.d.ts +31 -0
  57. package/dist/models/DescribeBranchRequest.js +60 -0
  58. package/dist/models/DescribeBranchRequest.js.map +1 -0
  59. package/dist/models/DescribeBranchResponse.d.ts +19 -0
  60. package/dist/models/DescribeBranchResponse.js +69 -0
  61. package/dist/models/DescribeBranchResponse.js.map +1 -0
  62. package/dist/models/DescribeBranchResponseBody.d.ts +211 -0
  63. package/dist/models/DescribeBranchResponseBody.js +138 -0
  64. package/dist/models/DescribeBranchResponseBody.js.map +1 -0
  65. package/dist/models/GetBranchSchemaRequest.d.ts +51 -0
  66. package/dist/models/GetBranchSchemaRequest.js +64 -0
  67. package/dist/models/GetBranchSchemaRequest.js.map +1 -0
  68. package/dist/models/GetBranchSchemaResponse.d.ts +19 -0
  69. package/dist/models/GetBranchSchemaResponse.js +69 -0
  70. package/dist/models/GetBranchSchemaResponse.js.map +1 -0
  71. package/dist/models/GetBranchSchemaResponseBody.d.ts +29 -0
  72. package/dist/models/GetBranchSchemaResponseBody.js +60 -0
  73. package/dist/models/GetBranchSchemaResponseBody.js.map +1 -0
  74. package/dist/models/ListBranchesRequest.d.ts +106 -0
  75. package/dist/models/ListBranchesRequest.js +74 -0
  76. package/dist/models/ListBranchesRequest.js.map +1 -0
  77. package/dist/models/ListBranchesResponse.d.ts +19 -0
  78. package/dist/models/ListBranchesResponse.js +69 -0
  79. package/dist/models/ListBranchesResponse.js.map +1 -0
  80. package/dist/models/ListBranchesResponseBody.d.ts +138 -0
  81. package/dist/models/ListBranchesResponseBody.js +190 -0
  82. package/dist/models/ListBranchesResponseBody.js.map +1 -0
  83. package/dist/models/PauseSaasServiceRequest.d.ts +26 -0
  84. package/dist/models/PauseSaasServiceRequest.js +60 -0
  85. package/dist/models/PauseSaasServiceRequest.js.map +1 -0
  86. package/dist/models/PauseSaasServiceResponse.d.ts +19 -0
  87. package/dist/models/PauseSaasServiceResponse.js +69 -0
  88. package/dist/models/PauseSaasServiceResponse.js.map +1 -0
  89. package/dist/models/PauseSaasServiceResponseBody.d.ts +23 -0
  90. package/dist/models/PauseSaasServiceResponseBody.js +60 -0
  91. package/dist/models/PauseSaasServiceResponseBody.js.map +1 -0
  92. package/dist/models/QueryContentAdvanceRequest.d.ts +57 -70
  93. package/dist/models/QueryContentAdvanceRequest.js +2 -0
  94. package/dist/models/QueryContentAdvanceRequest.js.map +1 -1
  95. package/dist/models/QueryContentRequest.d.ts +57 -70
  96. package/dist/models/QueryContentRequest.js +2 -0
  97. package/dist/models/QueryContentRequest.js.map +1 -1
  98. package/dist/models/QueryContentResponseBody.d.ts +10 -11
  99. package/dist/models/QueryContentResponseBody.js.map +1 -1
  100. package/dist/models/QueryContentShrinkRequest.d.ts +52 -66
  101. package/dist/models/QueryContentShrinkRequest.js.map +1 -1
  102. package/dist/models/QueryKnowledgeBasesContentRequest.d.ts +62 -78
  103. package/dist/models/QueryKnowledgeBasesContentRequest.js +2 -0
  104. package/dist/models/QueryKnowledgeBasesContentRequest.js.map +1 -1
  105. package/dist/models/QueryKnowledgeBasesContentResponseBody.d.ts +11 -25
  106. package/dist/models/QueryKnowledgeBasesContentResponseBody.js.map +1 -1
  107. package/dist/models/QueryKnowledgeBasesContentShrinkRequest.d.ts +11 -15
  108. package/dist/models/QueryKnowledgeBasesContentShrinkRequest.js.map +1 -1
  109. package/dist/models/RestartSupabaseProjectRequest.d.ts +31 -0
  110. package/dist/models/RestartSupabaseProjectRequest.js +60 -0
  111. package/dist/models/RestartSupabaseProjectRequest.js.map +1 -0
  112. package/dist/models/RestartSupabaseProjectResponse.d.ts +19 -0
  113. package/dist/models/RestartSupabaseProjectResponse.js +69 -0
  114. package/dist/models/RestartSupabaseProjectResponse.js.map +1 -0
  115. package/dist/models/RestartSupabaseProjectResponseBody.d.ts +21 -0
  116. package/dist/models/RestartSupabaseProjectResponseBody.js +58 -0
  117. package/dist/models/RestartSupabaseProjectResponseBody.js.map +1 -0
  118. package/dist/models/RestoreSnapshotRequest.d.ts +73 -0
  119. package/dist/models/RestoreSnapshotRequest.js +70 -0
  120. package/dist/models/RestoreSnapshotRequest.js.map +1 -0
  121. package/dist/models/RestoreSnapshotResponse.d.ts +19 -0
  122. package/dist/models/RestoreSnapshotResponse.js +69 -0
  123. package/dist/models/RestoreSnapshotResponse.js.map +1 -0
  124. package/dist/models/RestoreSnapshotResponseBody.d.ts +37 -0
  125. package/dist/models/RestoreSnapshotResponseBody.js +62 -0
  126. package/dist/models/RestoreSnapshotResponseBody.js.map +1 -0
  127. package/dist/models/ResumeSaasServiceRequest.d.ts +26 -0
  128. package/dist/models/ResumeSaasServiceRequest.js +60 -0
  129. package/dist/models/ResumeSaasServiceRequest.js.map +1 -0
  130. package/dist/models/ResumeSaasServiceResponse.d.ts +19 -0
  131. package/dist/models/ResumeSaasServiceResponse.js +69 -0
  132. package/dist/models/ResumeSaasServiceResponse.js.map +1 -0
  133. package/dist/models/ResumeSaasServiceResponseBody.d.ts +23 -0
  134. package/dist/models/ResumeSaasServiceResponseBody.js +60 -0
  135. package/dist/models/ResumeSaasServiceResponseBody.js.map +1 -0
  136. package/dist/models/model.d.ts +40 -0
  137. package/dist/models/model.js +103 -22
  138. package/dist/models/model.js.map +1 -1
  139. package/package.json +1 -1
  140. package/src/client.ts +720 -36
  141. package/src/models/ChatWithKnowledgeBaseRequest.ts +70 -111
  142. package/src/models/ChatWithKnowledgeBaseResponseBody.ts +45 -52
  143. package/src/models/ChatWithKnowledgeBaseShrinkRequest.ts +5 -6
  144. package/src/models/ChatWithKnowledgeBaseStreamRequest.ts +73 -87
  145. package/src/models/ChatWithKnowledgeBaseStreamResponseBody.ts +44 -50
  146. package/src/models/ChatWithKnowledgeBaseStreamShrinkRequest.ts +6 -6
  147. package/src/models/CreateBranchRequest.ts +200 -0
  148. package/src/models/CreateBranchResponse.ts +40 -0
  149. package/src/models/CreateBranchResponseBody.ts +54 -0
  150. package/src/models/CreateSnapshotRequest.ts +76 -0
  151. package/src/models/CreateSnapshotResponse.ts +40 -0
  152. package/src/models/CreateSnapshotResponseBody.ts +64 -0
  153. package/src/models/CreateSupabaseProjectRequest.ts +62 -48
  154. package/src/models/CreateSupabaseProjectResponseBody.ts +4 -4
  155. package/src/models/DeleteBranchRequest.ts +46 -0
  156. package/src/models/DeleteBranchResponse.ts +40 -0
  157. package/src/models/DeleteBranchResponseBody.ts +34 -0
  158. package/src/models/DeleteSnapshotRequest.ts +51 -0
  159. package/src/models/DeleteSnapshotResponse.ts +40 -0
  160. package/src/models/DeleteSnapshotResponseBody.ts +31 -0
  161. package/src/models/DescribeBranchRequest.ts +46 -0
  162. package/src/models/DescribeBranchResponse.ts +40 -0
  163. package/src/models/DescribeBranchResponseBody.ts +286 -0
  164. package/src/models/GetBranchSchemaRequest.ts +70 -0
  165. package/src/models/GetBranchSchemaResponse.ts +40 -0
  166. package/src/models/GetBranchSchemaResponseBody.ts +44 -0
  167. package/src/models/ListBranchesRequest.ts +135 -0
  168. package/src/models/ListBranchesResponse.ts +40 -0
  169. package/src/models/ListBranchesResponseBody.ts +247 -0
  170. package/src/models/PauseSaasServiceRequest.ts +41 -0
  171. package/src/models/PauseSaasServiceResponse.ts +40 -0
  172. package/src/models/PauseSaasServiceResponseBody.ts +38 -0
  173. package/src/models/QueryContentAdvanceRequest.ts +60 -71
  174. package/src/models/QueryContentRequest.ts +60 -71
  175. package/src/models/QueryContentResponseBody.ts +10 -11
  176. package/src/models/QueryContentShrinkRequest.ts +53 -67
  177. package/src/models/QueryKnowledgeBasesContentRequest.ts +64 -78
  178. package/src/models/QueryKnowledgeBasesContentResponseBody.ts +11 -25
  179. package/src/models/QueryKnowledgeBasesContentShrinkRequest.ts +11 -15
  180. package/src/models/RestartSupabaseProjectRequest.ts +46 -0
  181. package/src/models/RestartSupabaseProjectResponse.ts +40 -0
  182. package/src/models/RestartSupabaseProjectResponseBody.ts +34 -0
  183. package/src/models/RestoreSnapshotRequest.ts +98 -0
  184. package/src/models/RestoreSnapshotResponse.ts +40 -0
  185. package/src/models/RestoreSnapshotResponseBody.ts +54 -0
  186. package/src/models/ResumeSaasServiceRequest.ts +41 -0
  187. package/src/models/ResumeSaasServiceResponse.ts +40 -0
  188. package/src/models/ResumeSaasServiceResponseBody.ts +38 -0
  189. package/src/models/model.ts +40 -0
@@ -3,7 +3,7 @@ import * as $dara from '@darabonba/typescript';
3
3
  export declare class QueryContentAdvanceRequestGraphSearchArgs extends $dara.Model {
4
4
  /**
5
5
  * @remarks
6
- * The number of top entities and relationship edges to return. The default value is `60`.
6
+ * The number of top entities and relationship edges to return. Default value: 60.
7
7
  *
8
8
  * @example
9
9
  * 60
@@ -23,8 +23,8 @@ export declare class QueryContentAdvanceRequestGraphSearchArgs extends $dara.Mod
23
23
  export declare class QueryContentAdvanceRequestRerankModel extends $dara.Model {
24
24
  /**
25
25
  * @remarks
26
- * This parameter is available only when `RerankModel.Name` is set to `qwen3-rerank`.
27
- * You can add a custom task description to guide the model\\"s sorting strategy.
26
+ * This parameter can be set when RerankModel.Name is qwen3-rerank.
27
+ * Adds a custom sorting task type description. This parameter guides the model to adopt different sorting strategies.
28
28
  *
29
29
  * @example
30
30
  * Given a web search query, retrieve relevant passages that answer the query
@@ -32,12 +32,13 @@ export declare class QueryContentAdvanceRequestRerankModel extends $dara.Model {
32
32
  instruct?: string;
33
33
  /**
34
34
  * @remarks
35
- * The name of the reranking model. Valid values: `qwen3-rerank`, `gte-rerank-v2`.
35
+ * The name of the rerank model. Valid values: qwen3-rerank, gte-rerank-v2.
36
36
  *
37
37
  * @example
38
38
  * qwen3-rerank
39
39
  */
40
40
  name?: string;
41
+ rerankMetadataFields?: string;
41
42
  static names(): {
42
43
  [key: string]: string;
43
44
  };
@@ -54,7 +55,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
54
55
  * @remarks
55
56
  * The name of the document collection.
56
57
  *
57
- * > A document collection is created by calling the [CreateDocumentCollection](https://help.aliyun.com/document_detail/2618448.html) operation. Call the [ListDocumentCollections](https://help.aliyun.com/document_detail/2618452.html) operation to list your document collections.
58
+ * > The document collection is created by calling the [CreateDocumentCollection](https://help.aliyun.com/document_detail/2618448.html) operation. You can call the [ListDocumentCollections](https://help.aliyun.com/document_detail/2618452.html) operation to query existing document collections.
58
59
  *
59
60
  * This parameter is required.
60
61
  *
@@ -64,7 +65,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
64
65
  collection?: string;
65
66
  /**
66
67
  * @remarks
67
- * The text to use for retrieval.
68
+ * The text content used for retrieval.
68
69
  *
69
70
  * @example
70
71
  * What is AnalyticDB for PostgreSQL?
@@ -74,7 +75,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
74
75
  * @remarks
75
76
  * The instance ID.
76
77
  *
77
- * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to find the IDs of all AnalyticDB for PostgreSQL instances in a region.
78
+ * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.
78
79
  *
79
80
  * This parameter is required.
80
81
  *
@@ -84,9 +85,9 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
84
85
  DBInstanceId?: string;
85
86
  /**
86
87
  * @remarks
87
- * The filename of the source image for a search-by-image query.
88
+ * The name of the source image file to search in image-to-image search scenarios.
88
89
  *
89
- * > The image file must have a file extension. The supported extensions are bmp, jpg, jpeg, png, and tiff.
90
+ * > The image file must have a file extension. Supported image extensions: bmp, jpg, jpeg, png, and tiff.
90
91
  *
91
92
  * @example
92
93
  * test.jpg
@@ -94,9 +95,9 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
94
95
  fileName?: string;
95
96
  /**
96
97
  * @remarks
97
- * The publicly accessible URL of the image file for a search-by-image query.
98
+ * The publicly accessible URL of the image file in image-to-image search scenarios.
98
99
  *
99
- * > The image file must have a file extension. The supported extensions are bmp, jpg, jpeg, png, and tiff.
100
+ * > The image file must have a file extension. Supported image extensions: bmp, jpg, jpeg, png, and tiff.
100
101
  *
101
102
  * @example
102
103
  * https://xx/myImage.jpg
@@ -104,9 +105,10 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
104
105
  fileUrlObject?: Readable;
105
106
  /**
106
107
  * @remarks
107
- * A filter condition for the query, specified as a SQL `WHERE` clause that returns a boolean value. The clause can use comparison operators (such as `=`, `<>`, `!=`, `>`, `<`, `>=`, and `<=`), logical operators (`AND`, `OR`, and `NOT`), and keywords such as `IN`, `BETWEEN`, and `LIKE`.
108
+ * The filter condition for the data to query, in SQL WHERE clause format. The filter is an expression that returns a Boolean value (true or false). Conditions can be simple comparison operators such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), and less than or equal to (<=). Conditions can also be more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using the IN, BETWEEN, and LIKE keywords.
108
109
  *
109
- * > - For details about the syntax, see https\\://www\\.postgresqltutorial.com/postgresql-tutorial/postgresql-where/.
110
+ * >
111
+ * > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/.
110
112
  *
111
113
  * @example
112
114
  * title = \\"test\\" AND name like \\"test%\\"
@@ -114,7 +116,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
114
116
  filter?: string;
115
117
  /**
116
118
  * @remarks
117
- * Specifies whether to enable knowledge graph enhancement. The default value is `false`.
119
+ * Specifies whether to enable knowledge graph enhancement. Default value: false.
118
120
  *
119
121
  * @example
120
122
  * false
@@ -122,20 +124,18 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
122
124
  graphEnhance?: boolean;
123
125
  /**
124
126
  * @remarks
125
- * The parameters for knowledge graph retrieval.
127
+ * The knowledge graph retrieval parameters.
126
128
  */
127
129
  graphSearchArgs?: QueryContentAdvanceRequestGraphSearchArgs;
128
130
  /**
129
131
  * @remarks
130
- * Specifies the hybrid search algorithm. If this parameter is not specified, the system directly compares and sorts the scores from dense vector retrieval and full-text search.
132
+ * The multi-channel recall algorithm. Default value: empty, which indicates that the dense vector and full-text index scores are directly compared and sorted.
131
133
  *
132
134
  * Valid values:
133
135
  *
134
- * - RRF: reciprocal rank fusion. This method uses a `k` parameter to control the fusion effect. For more information, see the `HybridSearchArgs` parameter.
135
- *
136
- * - Weight: A weighted sorting method. This method uses parameters to control the score weights of vector retrieval and full-text search before sorting. For more information, see the `HybridSearchArgs` parameter.
137
- *
138
- * - Cascaded: Performs full-text search first, and then performs vector retrieval on the results.
136
+ * - RRF: Reciprocal Rank Fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.
137
+ * - Weight: Weighted sorting. Parameters control the score weights of AISearch retrieve and full-text index results before sorting. For more information, see the HybridSearchArgs configuration.
138
+ * - Cascaded: Full-text index retrieve is performed first, followed by AISearch retrieve based on the full-text index results.
139
139
  *
140
140
  * @example
141
141
  * RRF
@@ -143,10 +143,9 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
143
143
  hybridSearch?: string;
144
144
  /**
145
145
  * @remarks
146
- * Parameters for the multi-channel recall algorithm. Currently, `RRF` and `Weight` are supported. `HybridPathsSetting` can be used to specify the recall paths, including dense vector search (`dense`), sparse vector search (`sparse`), and full-text search (`fulltext`). If this parameter is not specified, the system recalls dense vectors and full-text search results by default.
147
- *
148
- * - RRF: Specifies the constant `k` in the scoring formula `1/(k+rank_i)`. The value must be an integer greater than 1. Example:
146
+ * The algorithm parameters for multi-channel recall. RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text index (fulltext). If this value is empty, dense vectors (dense) and full-text index (fulltext) are used by default.
149
147
  *
148
+ * - RRF: Specifies the constant k in the score calculation formula `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:
150
149
  * ```
151
150
  * {
152
151
  * "HybridPathsSetting": {
@@ -159,11 +158,8 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
159
158
  * ```
160
159
  *
161
160
  * - Weight:
162
- *
163
- * - For dual-channel recall (if `HybridPathsSetting` is not specified, only `alpha` is configured):
164
- *
165
- * - The score is calculated using the formula: `alpha * dense_score + (1-alpha) * fulltext_score`. The `alpha` parameter represents the score weight of dense vector retrieval relative to full-text search. The value must be in the range of 0 to 1. A value of 0 indicates that only full-text search is used, and a value of 1 indicates that only dense vector retrieval is used.
166
- *
161
+ * - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):
162
+ * - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text index retrieve. Valid values: 0 to 1, where 0 indicates full-text index only and 1 indicates dense vector only:
167
163
  * ```
168
164
  * {
169
165
  * "Weight": {
@@ -171,11 +167,8 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
171
167
  * }
172
168
  * }
173
169
  * ```
174
- *
175
- * - For three-channel recall:
176
- *
177
- * - The score is calculated using the formula: `normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score`. The `dense`, `sparse`, and `fulltext` parameters represent the weights for the dense vector, sparse vector, and full-text search results, respectively. Their values must be greater than or equal to 0. The system automatically normalizes the weights to a sum of 1 (for example, `normalized_x = x / (dense + sparse + fulltext)`).
178
- *
170
+ * - Three-path recall pattern:
171
+ * - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext values represent the weights for dense vectors, sparse vectors, and full-text index retrieve respectively. Valid values: greater than or equal to 0. The system automatically performs normalization of the weights to 0 to 1 (normalized_x = x / (dense + sparse + fulltext)).
179
172
  * ```
180
173
  * {
181
174
  * "HybridPathsSetting": {
@@ -196,7 +189,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
196
189
  };
197
190
  /**
198
191
  * @remarks
199
- * Specifies whether to return the URL of the document. The default value is `false`.
192
+ * Specifies whether to synchronously return the URL of the document. By default, the URL is not returned.
200
193
  *
201
194
  * @example
202
195
  * false
@@ -204,7 +197,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
204
197
  includeFileUrl?: boolean;
205
198
  /**
206
199
  * @remarks
207
- * The metadata fields to include in the response. If left empty, no metadata is returned. To specify multiple fields, use a comma-separated list.
200
+ * The metadata fields to return. Default value: empty. Separate multiple fields with commas.
208
201
  *
209
202
  * @example
210
203
  * title,page
@@ -212,11 +205,9 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
212
205
  includeMetadataFields?: string;
213
206
  /**
214
207
  * @remarks
215
- * Specifies whether to include the vector in the results. The default value is `false`.
216
- *
217
- * > - **false**: The vector is not returned.
218
- * >
219
- * > - **true**: The vector is returned.
208
+ * Specifies whether to return vectors. Default value: false.
209
+ * > - **false**: Does not return vectors.
210
+ * > - **true**: Returns vectors.
220
211
  *
221
212
  * @example
222
213
  * true
@@ -224,14 +215,11 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
224
215
  includeVector?: boolean;
225
216
  /**
226
217
  * @remarks
227
- * The similarity algorithm used for retrieval. If this parameter is not specified, the algorithm that was specified when the document collection was created is used. We recommend that you do not set this parameter unless you have specific requirements.
218
+ * The similarity algorithm used for retrieval. If this value is empty, the algorithm specified when the knowledge base was created is used. Leave this parameter empty unless you have specific requirements.
228
219
  *
229
220
  * > Valid values:
230
- * >
231
221
  * > - **l2**: Euclidean distance.
232
- * >
233
- * > - **ip**: dot product (inner product) distance.
234
- * >
222
+ * > - **ip**: inner product distance.
235
223
  * > - **cosine**: cosine similarity.
236
224
  *
237
225
  * @example
@@ -240,9 +228,9 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
240
228
  metrics?: string;
241
229
  /**
242
230
  * @remarks
243
- * The namespace. The default value is `public`.
231
+ * The namespace. Default value: public.
244
232
  *
245
- * > You can call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation to create a namespace and the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to list existing namespaces.
233
+ * > You can create a namespace by calling the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation and query namespaces by calling the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
246
234
  *
247
235
  * @example
248
236
  * mynamespace
@@ -250,9 +238,9 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
250
238
  namespace?: string;
251
239
  /**
252
240
  * @remarks
253
- * The password for the namespace.
241
+ * The password of the namespace.
254
242
  *
255
- * > This password is set when you call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation.
243
+ * > This value is specified by the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation.
256
244
  *
257
245
  * This parameter is required.
258
246
  *
@@ -262,7 +250,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
262
250
  namespacePassword?: string;
263
251
  /**
264
252
  * @remarks
265
- * The offset for paginated queries.
253
+ * The offset for paged query. Used for paging through results.
266
254
  *
267
255
  * @example
268
256
  * 0
@@ -270,9 +258,13 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
270
258
  offset?: number;
271
259
  /**
272
260
  * @remarks
273
- * The field to sort the results by. By default, this parameter is empty.
261
+ * The field used for sorting. Default value: empty.
274
262
  *
275
- * The field must be a metadata field or a default field from the table, such as `id`. Supported formats include single fields (e.g., `chunk_id`), multiple comma-separated fields (e.g., `block_id, chunk_id`), and fields with a sort direction (e.g., `block_id DESC, chunk_id DESC`).
263
+ * The field must belong to metadata or a default field in the table, such as id. Supported formats:
264
+ *
265
+ * A single field, such as chunk_id.
266
+ * Multiple fields separated by commas, such as block_id, chunk_id.
267
+ * Descending order, such as block_id DESC, chunk_id DESC.
276
268
  *
277
269
  * @example
278
270
  * created_at
@@ -281,11 +273,9 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
281
273
  ownerId?: number;
282
274
  /**
283
275
  * @remarks
284
- * The recall window. If this parameter is specified, additional context is returned with the retrieval results. The value must be a two-element array, `[A, B]`, where `-10 <= A <= 0` and `0 <= B <= 10`.
285
- *
286
- * > - Use this parameter when documents are finely chunked and retrieval might otherwise lose contextual information.
287
- * >
288
- * > - Reranking is prioritized over windowing. The system first applies reranking and then processes the window.
276
+ * The recall window. When this value is not empty, additional context around the retrieval results is returned. The format is a two-element array: List<A, B>, where -10<=A<=0 and 0<=B<=10.
277
+ * > - Use this parameter when documents are split into overly small chunks and retrieval may lose contextual information.
278
+ * > - Reranking takes priority over windowing. Reranking is performed first, followed by windowing.
289
279
  */
290
280
  recallWindow?: number[];
291
281
  /**
@@ -300,11 +290,9 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
300
290
  regionId?: string;
301
291
  /**
302
292
  * @remarks
303
- * The factor for reranking vector retrieval results. The value must be greater than 1 and less than or equal to 5.
304
- *
305
- * > - Reranking may be slower if document chunks are sparse.
306
- * >
307
- * > - For best performance, the number of items to be reranked (`TopK` \\* `RerankFactor`, rounded up) should not exceed 50.
293
+ * The reranking factor. When this value is not empty, the AISearch retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.
294
+ * > - Reranking is slow when documents are sparsely chunked.
295
+ * > - The total number of reranked results (TopK × Factor, rounded up) should not exceed 50.
308
296
  *
309
297
  * @example
310
298
  * 2
@@ -312,7 +300,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
312
300
  rerankFactor?: number;
313
301
  /**
314
302
  * @remarks
315
- * The parameters for the reranking model.
303
+ * The rerank model parameters.
316
304
  */
317
305
  rerankModel?: QueryContentAdvanceRequestRerankModel;
318
306
  /**
@@ -327,11 +315,10 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
327
315
  * @remarks
328
316
  * The validity period of the returned image URL.
329
317
  *
330
- * > - The value can be specified in seconds (s) or days (d). For example, `300s` indicates that the link is valid for 300 seconds, and `60d` indicates that the link is valid for 60 days.
331
- * >
332
- * > - The value must be in the range of `60s` to `365d`.
333
- * >
334
- * > - Default value: `7200s` (2 hours).
318
+ * > Valid values:
319
+ * > - Supports seconds (s) and days (d) as units. For example, 300s indicates a validity period of 300 seconds, and 60d indicates a validity period of 60 days.
320
+ * > - Valid values: 60s to 365d.
321
+ * > - Default value: 7200s (2 hours).
335
322
  *
336
323
  * @example
337
324
  * 7200s
@@ -339,7 +326,7 @@ export declare class QueryContentAdvanceRequest extends $dara.Model {
339
326
  urlExpiration?: string;
340
327
  /**
341
328
  * @remarks
342
- * (Deprecated) Specifies whether to use full-text search (dual-channel recall). The default value is `false`, which means only vector retrieval is used.
329
+ * (Deprecated) Specifies whether to use full-text retrieval (dual-path recall). Default value: false, which indicates that only vector retrieval is used.
343
330
  *
344
331
  * @example
345
332
  * true
@@ -59,12 +59,14 @@ class QueryContentAdvanceRequestRerankModel extends $dara.Model {
59
59
  return {
60
60
  instruct: 'Instruct',
61
61
  name: 'Name',
62
+ rerankMetadataFields: 'RerankMetadataFields',
62
63
  };
63
64
  }
64
65
  static types() {
65
66
  return {
66
67
  instruct: 'string',
67
68
  name: 'string',
69
+ rerankMetadataFields: 'string',
68
70
  };
69
71
  }
70
72
  validate() {
@@ -1 +1 @@
1
- {"version":3,"file":"QueryContentAdvanceRequest.js","sourceRoot":"","sources":["../../src/models/QueryContentAdvanceRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,6DAA+C;AAG/C,MAAa,yCAA0C,SAAQ,KAAK,CAAC,KAAK;IASxE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA5BD,8FA4BC;AAED,MAAa,qCAAsC,SAAQ,KAAK,CAAC,KAAK;IAkBpE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,MAAM;SACb,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ;SACf,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAvCD,sFAuCC;AAED,MAAa,0BAA2B,SAAQ,KAAK,CAAC,KAAK;IAoSzD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,YAAY;YACxB,OAAO,EAAE,SAAS;YAClB,YAAY,EAAE,cAAc;YAC5B,QAAQ,EAAE,UAAU;YACpB,aAAa,EAAE,SAAS;YACxB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,cAAc;YAC5B,eAAe,EAAE,iBAAiB;YAClC,YAAY,EAAE,cAAc;YAC5B,gBAAgB,EAAE,kBAAkB;YACpC,cAAc,EAAE,gBAAgB;YAChC,qBAAqB,EAAE,uBAAuB;YAC9C,aAAa,EAAE,eAAe;YAC9B,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,iBAAiB,EAAE,mBAAmB;YACtC,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,SAAS;YAClB,YAAY,EAAE,cAAc;YAC5B,QAAQ,EAAE,UAAU;YACpB,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,IAAI,EAAE,MAAM;YACZ,aAAa,EAAE,eAAe;YAC9B,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,QAAQ;YACtB,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,UAAU;YACzB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,SAAS;YACvB,eAAe,EAAE,yCAAyC;YAC1D,YAAY,EAAE,QAAQ;YACtB,gBAAgB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,sBAAsB,EAAE;YAC7F,cAAc,EAAE,SAAS;YACzB,qBAAqB,EAAE,QAAQ;YAC/B,aAAa,EAAE,SAAS;YACxB,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,iBAAiB,EAAE,QAAQ;YAC3B,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACvD,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,qCAAqC;YAClD,IAAI,EAAE,QAAQ;YACd,aAAa,EAAE,QAAQ;YACvB,oBAAoB,EAAE,SAAS;SAChC,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,eAAe,IAAI,OAAQ,IAAI,CAAC,eAAuB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACvF,IAAI,CAAC,eAAuB,CAAC,QAAQ,EAAE,CAAC;QAC3C,CAAC;QACD,IAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzB,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACjD,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACpC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC;QACD,IAAG,IAAI,CAAC,WAAW,IAAI,OAAQ,IAAI,CAAC,WAAmB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC/E,IAAI,CAAC,WAAmB,CAAC,QAAQ,EAAE,CAAC;QACvC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AArXD,gEAqXC"}
1
+ {"version":3,"file":"QueryContentAdvanceRequest.js","sourceRoot":"","sources":["../../src/models/QueryContentAdvanceRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,6DAA+C;AAG/C,MAAa,yCAA0C,SAAQ,KAAK,CAAC,KAAK;IASxE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA5BD,8FA4BC;AAED,MAAa,qCAAsC,SAAQ,KAAK,CAAC,KAAK;IAmBpE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,MAAM;YACZ,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,QAAQ;SAC/B,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA1CD,sFA0CC;AAED,MAAa,0BAA2B,SAAQ,KAAK,CAAC,KAAK;IAsRzD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,YAAY;YACxB,OAAO,EAAE,SAAS;YAClB,YAAY,EAAE,cAAc;YAC5B,QAAQ,EAAE,UAAU;YACpB,aAAa,EAAE,SAAS;YACxB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,cAAc;YAC5B,eAAe,EAAE,iBAAiB;YAClC,YAAY,EAAE,cAAc;YAC5B,gBAAgB,EAAE,kBAAkB;YACpC,cAAc,EAAE,gBAAgB;YAChC,qBAAqB,EAAE,uBAAuB;YAC9C,aAAa,EAAE,eAAe;YAC9B,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,iBAAiB,EAAE,mBAAmB;YACtC,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,SAAS;YAClB,YAAY,EAAE,cAAc;YAC5B,QAAQ,EAAE,UAAU;YACpB,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,IAAI,EAAE,MAAM;YACZ,aAAa,EAAE,eAAe;YAC9B,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,QAAQ;YACtB,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,UAAU;YACzB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,SAAS;YACvB,eAAe,EAAE,yCAAyC;YAC1D,YAAY,EAAE,QAAQ;YACtB,gBAAgB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,sBAAsB,EAAE;YAC7F,cAAc,EAAE,SAAS;YACzB,qBAAqB,EAAE,QAAQ;YAC/B,aAAa,EAAE,SAAS;YACxB,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,iBAAiB,EAAE,QAAQ;YAC3B,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACvD,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,qCAAqC;YAClD,IAAI,EAAE,QAAQ;YACd,aAAa,EAAE,QAAQ;YACvB,oBAAoB,EAAE,SAAS;SAChC,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,eAAe,IAAI,OAAQ,IAAI,CAAC,eAAuB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACvF,IAAI,CAAC,eAAuB,CAAC,QAAQ,EAAE,CAAC;QAC3C,CAAC;QACD,IAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzB,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACjD,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACpC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC;QACD,IAAG,IAAI,CAAC,WAAW,IAAI,OAAQ,IAAI,CAAC,WAAmB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC/E,IAAI,CAAC,WAAmB,CAAC,QAAQ,EAAE,CAAC;QACvC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAvWD,gEAuWC"}