huaweicloudsdkdwr 3.1.154__py2.py3-none-any.whl → 3.1.156__py2.py3-none-any.whl

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.

Potentially problematic release.


This version of huaweicloudsdkdwr might be problematic. Click here for more details.

Files changed (74) hide show
  1. huaweicloudsdkdwr/v1/__init__.py +7 -5
  2. huaweicloudsdkdwr/v1/dwr_async_client.py +266 -266
  3. huaweicloudsdkdwr/v1/dwr_client.py +266 -266
  4. huaweicloudsdkdwr/v1/model/__init__.py +7 -5
  5. huaweicloudsdkdwr/v1/model/build_progress.py +15 -15
  6. huaweicloudsdkdwr/v1/model/charge_info.py +15 -15
  7. huaweicloudsdkdwr/v1/model/collection_base_info.py +6 -6
  8. huaweicloudsdkdwr/v1/model/create_collection_body.py +18 -18
  9. huaweicloudsdkdwr/v1/model/create_collection_response.py +6 -6
  10. huaweicloudsdkdwr/v1/model/create_index_body.py +6 -6
  11. huaweicloudsdkdwr/v1/model/create_index_response.py +6 -6
  12. huaweicloudsdkdwr/v1/model/create_store_body.py +12 -12
  13. huaweicloudsdkdwr/v1/model/create_store_data.py +21 -21
  14. huaweicloudsdkdwr/v1/model/create_store_response.py +6 -6
  15. huaweicloudsdkdwr/v1/model/decribe_collection_data.py +41 -41
  16. huaweicloudsdkdwr/v1/model/delete_collection_response.py +6 -6
  17. huaweicloudsdkdwr/v1/model/delete_entities_body.py +9 -9
  18. huaweicloudsdkdwr/v1/model/delete_entities_response.py +6 -6
  19. huaweicloudsdkdwr/v1/model/delete_index_body.py +9 -9
  20. huaweicloudsdkdwr/v1/model/delete_index_response.py +6 -6
  21. huaweicloudsdkdwr/v1/model/delete_store_data.py +3 -3
  22. huaweicloudsdkdwr/v1/model/delete_store_response.py +6 -6
  23. huaweicloudsdkdwr/v1/model/describe_collection_response.py +6 -6
  24. huaweicloudsdkdwr/v1/model/describe_index_body.py +9 -9
  25. huaweicloudsdkdwr/v1/model/{describe_index_respose_data.py → describe_index_data.py} +25 -26
  26. huaweicloudsdkdwr/v1/model/describe_index_response.py +10 -10
  27. huaweicloudsdkdwr/v1/model/describe_job_body.py +3 -3
  28. huaweicloudsdkdwr/v1/model/describe_job_response.py +6 -6
  29. huaweicloudsdkdwr/v1/model/describe_store_response.py +10 -10
  30. huaweicloudsdkdwr/v1/model/entities_data.py +114 -0
  31. huaweicloudsdkdwr/v1/model/field.py +15 -15
  32. huaweicloudsdkdwr/v1/model/field_data.py +102 -15
  33. huaweicloudsdkdwr/v1/model/flavor.py +6 -6
  34. huaweicloudsdkdwr/v1/model/get_index_progress_body.py +9 -9
  35. huaweicloudsdkdwr/v1/model/{get_index_progress_response_data.py → get_progress_data.py} +21 -21
  36. huaweicloudsdkdwr/v1/model/get_progress_response.py +10 -10
  37. huaweicloudsdkdwr/v1/model/hybrid_search_body.py +20 -16
  38. huaweicloudsdkdwr/v1/model/hybrid_search_response.py +11 -15
  39. huaweicloudsdkdwr/v1/model/index_desc.py +14 -16
  40. huaweicloudsdkdwr/v1/model/index_params.py +9 -9
  41. huaweicloudsdkdwr/v1/model/insert_entities_body.py +9 -9
  42. huaweicloudsdkdwr/v1/model/{insert_entities_response_data.py → insert_entities_data.py} +17 -17
  43. huaweicloudsdkdwr/v1/model/insert_entities_response.py +10 -10
  44. huaweicloudsdkdwr/v1/model/job_data.py +24 -24
  45. huaweicloudsdkdwr/v1/model/list_collection_data.py +6 -6
  46. huaweicloudsdkdwr/v1/model/list_collection_details.py +18 -18
  47. huaweicloudsdkdwr/v1/model/list_collections_body.py +6 -6
  48. huaweicloudsdkdwr/v1/model/list_collections_response.py +6 -6
  49. huaweicloudsdkdwr/v1/model/list_jobs_data.py +3 -3
  50. huaweicloudsdkdwr/v1/model/list_jobs_request.py +15 -15
  51. huaweicloudsdkdwr/v1/model/list_jobs_response.py +6 -6
  52. huaweicloudsdkdwr/v1/model/list_store_data.py +114 -0
  53. huaweicloudsdkdwr/v1/model/list_stores_response.py +11 -15
  54. huaweicloudsdkdwr/v1/model/load_collection_body.py +6 -6
  55. huaweicloudsdkdwr/v1/model/load_collection_response.py +6 -6
  56. huaweicloudsdkdwr/v1/model/primary_field.py +6 -6
  57. huaweicloudsdkdwr/v1/model/query_entities_body.py +18 -18
  58. huaweicloudsdkdwr/v1/model/query_entities_response.py +11 -15
  59. huaweicloudsdkdwr/v1/model/release_collection_response.py +6 -6
  60. huaweicloudsdkdwr/v1/model/rerank.py +6 -6
  61. huaweicloudsdkdwr/v1/model/search_entities_body.py +27 -27
  62. huaweicloudsdkdwr/v1/model/search_entities_response.py +11 -15
  63. huaweicloudsdkdwr/v1/model/store_data.py +364 -0
  64. huaweicloudsdkdwr/v1/model/store_info.py +3 -3
  65. huaweicloudsdkdwr/v1/model/sub_search.py +18 -18
  66. huaweicloudsdkdwr/v1/model/upsert_entities_body.py +9 -9
  67. huaweicloudsdkdwr/v1/model/{upsert_entities_response_data.py → upsert_entities_data.py} +18 -19
  68. huaweicloudsdkdwr/v1/model/upsert_entities_response.py +10 -10
  69. {huaweicloudsdkdwr-3.1.154.dist-info → huaweicloudsdkdwr-3.1.156.dist-info}/METADATA +2 -2
  70. {huaweicloudsdkdwr-3.1.154.dist-info → huaweicloudsdkdwr-3.1.156.dist-info}/RECORD +73 -71
  71. huaweicloudsdkdwr/v1/model/describe_store_data.py +0 -364
  72. {huaweicloudsdkdwr-3.1.154.dist-info → huaweicloudsdkdwr-3.1.156.dist-info}/LICENSE +0 -0
  73. {huaweicloudsdkdwr-3.1.154.dist-info → huaweicloudsdkdwr-3.1.156.dist-info}/WHEEL +0 -0
  74. {huaweicloudsdkdwr-3.1.154.dist-info → huaweicloudsdkdwr-3.1.156.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,364 @@
1
+ # coding: utf-8
2
+
3
+ import six
4
+
5
+ from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
6
+
7
+
8
+ class StoreData:
9
+
10
+ """
11
+ Attributes:
12
+ openapi_types (dict): The key is attribute name
13
+ and the value is attribute type.
14
+ attribute_map (dict): The key is attribute name
15
+ and the value is json key in definition.
16
+ """
17
+ sensitive_list = []
18
+
19
+ openapi_types = {
20
+ 'id': 'str',
21
+ 'store_name': 'str',
22
+ 'status': 'str',
23
+ 'create_time': 'str',
24
+ 'region': 'str',
25
+ 'availability_zones': 'list[str]',
26
+ 'flavor': 'Flavor',
27
+ 'charge_info': 'ChargeInfo',
28
+ 'description': 'str',
29
+ 'private_link': 'str'
30
+ }
31
+
32
+ attribute_map = {
33
+ 'id': 'id',
34
+ 'store_name': 'store_name',
35
+ 'status': 'status',
36
+ 'create_time': 'create_time',
37
+ 'region': 'region',
38
+ 'availability_zones': 'availability_zones',
39
+ 'flavor': 'flavor',
40
+ 'charge_info': 'charge_info',
41
+ 'description': 'description',
42
+ 'private_link': 'private_link'
43
+ }
44
+
45
+ def __init__(self, id=None, store_name=None, status=None, create_time=None, region=None, availability_zones=None, flavor=None, charge_info=None, description=None, private_link=None):
46
+ r"""StoreData
47
+
48
+ The model defined in huaweicloud sdk
49
+
50
+ :param id: **参数解释:** 知识仓实例id。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
51
+ :type id: str
52
+ :param store_name: **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
53
+ :type store_name: str
54
+ :param status: **参数解释:** 知识仓实例状态。 **约束限制:** 不涉及。 **取值范围:** CREATING:创建中 NORMAL:正常 CREATED_FAILED:创建失败 ABNORMAL:异常 FROZEN:被冻结 DISK_FULL:存储空间已满 DROPPING:删除中 DELETE_FAILED:删除失败 **默认取值:** 不涉及。
55
+ :type status: str
56
+ :param create_time: **参数解释:** 创建时间。 **约束限制:** 格式为“yyyy-mm-ddThh:mm:ssZ”。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
57
+ :type create_time: str
58
+ :param region: **参数解释:** 区域ID。 **约束限制**: 不涉及。 **取值范围:** 取值:非空,请参见地区和终端节点。 **默认取值:** 不涉及。
59
+ :type region: str
60
+ :param availability_zones: **参数解释:** 可用区ID列表,支持1个,或者多个。 **约束限制:** 不涉及。
61
+ :type availability_zones: list[str]
62
+ :param flavor:
63
+ :type flavor: :class:`huaweicloudsdkdwr.v1.Flavor`
64
+ :param charge_info:
65
+ :type charge_info: :class:`huaweicloudsdkdwr.v1.ChargeInfo`
66
+ :param description: **参数解释:** 知识仓实例描述信息。 **约束限制:** 有效长度0-255 **取值范围:** 不涉及。 **默认取值:** 不涉及。
67
+ :type description: str
68
+ :param private_link: **参数解释:** 知识仓实例的私网链接信息,参考\"VPCEP终端节点对接LMS知识仓实例\"。 **约束限制:** 当前不支持公网访问。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
69
+ :type private_link: str
70
+ """
71
+
72
+
73
+
74
+ self._id = None
75
+ self._store_name = None
76
+ self._status = None
77
+ self._create_time = None
78
+ self._region = None
79
+ self._availability_zones = None
80
+ self._flavor = None
81
+ self._charge_info = None
82
+ self._description = None
83
+ self._private_link = None
84
+ self.discriminator = None
85
+
86
+ self.id = id
87
+ self.store_name = store_name
88
+ self.status = status
89
+ if create_time is not None:
90
+ self.create_time = create_time
91
+ if region is not None:
92
+ self.region = region
93
+ if availability_zones is not None:
94
+ self.availability_zones = availability_zones
95
+ if flavor is not None:
96
+ self.flavor = flavor
97
+ if charge_info is not None:
98
+ self.charge_info = charge_info
99
+ if description is not None:
100
+ self.description = description
101
+ self.private_link = private_link
102
+
103
+ @property
104
+ def id(self):
105
+ r"""Gets the id of this StoreData.
106
+
107
+ **参数解释:** 知识仓实例id。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
108
+
109
+ :return: The id of this StoreData.
110
+ :rtype: str
111
+ """
112
+ return self._id
113
+
114
+ @id.setter
115
+ def id(self, id):
116
+ r"""Sets the id of this StoreData.
117
+
118
+ **参数解释:** 知识仓实例id。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
119
+
120
+ :param id: The id of this StoreData.
121
+ :type id: str
122
+ """
123
+ self._id = id
124
+
125
+ @property
126
+ def store_name(self):
127
+ r"""Gets the store_name of this StoreData.
128
+
129
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
130
+
131
+ :return: The store_name of this StoreData.
132
+ :rtype: str
133
+ """
134
+ return self._store_name
135
+
136
+ @store_name.setter
137
+ def store_name(self, store_name):
138
+ r"""Sets the store_name of this StoreData.
139
+
140
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
141
+
142
+ :param store_name: The store_name of this StoreData.
143
+ :type store_name: str
144
+ """
145
+ self._store_name = store_name
146
+
147
+ @property
148
+ def status(self):
149
+ r"""Gets the status of this StoreData.
150
+
151
+ **参数解释:** 知识仓实例状态。 **约束限制:** 不涉及。 **取值范围:** CREATING:创建中 NORMAL:正常 CREATED_FAILED:创建失败 ABNORMAL:异常 FROZEN:被冻结 DISK_FULL:存储空间已满 DROPPING:删除中 DELETE_FAILED:删除失败 **默认取值:** 不涉及。
152
+
153
+ :return: The status of this StoreData.
154
+ :rtype: str
155
+ """
156
+ return self._status
157
+
158
+ @status.setter
159
+ def status(self, status):
160
+ r"""Sets the status of this StoreData.
161
+
162
+ **参数解释:** 知识仓实例状态。 **约束限制:** 不涉及。 **取值范围:** CREATING:创建中 NORMAL:正常 CREATED_FAILED:创建失败 ABNORMAL:异常 FROZEN:被冻结 DISK_FULL:存储空间已满 DROPPING:删除中 DELETE_FAILED:删除失败 **默认取值:** 不涉及。
163
+
164
+ :param status: The status of this StoreData.
165
+ :type status: str
166
+ """
167
+ self._status = status
168
+
169
+ @property
170
+ def create_time(self):
171
+ r"""Gets the create_time of this StoreData.
172
+
173
+ **参数解释:** 创建时间。 **约束限制:** 格式为“yyyy-mm-ddThh:mm:ssZ”。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
174
+
175
+ :return: The create_time of this StoreData.
176
+ :rtype: str
177
+ """
178
+ return self._create_time
179
+
180
+ @create_time.setter
181
+ def create_time(self, create_time):
182
+ r"""Sets the create_time of this StoreData.
183
+
184
+ **参数解释:** 创建时间。 **约束限制:** 格式为“yyyy-mm-ddThh:mm:ssZ”。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
185
+
186
+ :param create_time: The create_time of this StoreData.
187
+ :type create_time: str
188
+ """
189
+ self._create_time = create_time
190
+
191
+ @property
192
+ def region(self):
193
+ r"""Gets the region of this StoreData.
194
+
195
+ **参数解释:** 区域ID。 **约束限制**: 不涉及。 **取值范围:** 取值:非空,请参见地区和终端节点。 **默认取值:** 不涉及。
196
+
197
+ :return: The region of this StoreData.
198
+ :rtype: str
199
+ """
200
+ return self._region
201
+
202
+ @region.setter
203
+ def region(self, region):
204
+ r"""Sets the region of this StoreData.
205
+
206
+ **参数解释:** 区域ID。 **约束限制**: 不涉及。 **取值范围:** 取值:非空,请参见地区和终端节点。 **默认取值:** 不涉及。
207
+
208
+ :param region: The region of this StoreData.
209
+ :type region: str
210
+ """
211
+ self._region = region
212
+
213
+ @property
214
+ def availability_zones(self):
215
+ r"""Gets the availability_zones of this StoreData.
216
+
217
+ **参数解释:** 可用区ID列表,支持1个,或者多个。 **约束限制:** 不涉及。
218
+
219
+ :return: The availability_zones of this StoreData.
220
+ :rtype: list[str]
221
+ """
222
+ return self._availability_zones
223
+
224
+ @availability_zones.setter
225
+ def availability_zones(self, availability_zones):
226
+ r"""Sets the availability_zones of this StoreData.
227
+
228
+ **参数解释:** 可用区ID列表,支持1个,或者多个。 **约束限制:** 不涉及。
229
+
230
+ :param availability_zones: The availability_zones of this StoreData.
231
+ :type availability_zones: list[str]
232
+ """
233
+ self._availability_zones = availability_zones
234
+
235
+ @property
236
+ def flavor(self):
237
+ r"""Gets the flavor of this StoreData.
238
+
239
+ :return: The flavor of this StoreData.
240
+ :rtype: :class:`huaweicloudsdkdwr.v1.Flavor`
241
+ """
242
+ return self._flavor
243
+
244
+ @flavor.setter
245
+ def flavor(self, flavor):
246
+ r"""Sets the flavor of this StoreData.
247
+
248
+ :param flavor: The flavor of this StoreData.
249
+ :type flavor: :class:`huaweicloudsdkdwr.v1.Flavor`
250
+ """
251
+ self._flavor = flavor
252
+
253
+ @property
254
+ def charge_info(self):
255
+ r"""Gets the charge_info of this StoreData.
256
+
257
+ :return: The charge_info of this StoreData.
258
+ :rtype: :class:`huaweicloudsdkdwr.v1.ChargeInfo`
259
+ """
260
+ return self._charge_info
261
+
262
+ @charge_info.setter
263
+ def charge_info(self, charge_info):
264
+ r"""Sets the charge_info of this StoreData.
265
+
266
+ :param charge_info: The charge_info of this StoreData.
267
+ :type charge_info: :class:`huaweicloudsdkdwr.v1.ChargeInfo`
268
+ """
269
+ self._charge_info = charge_info
270
+
271
+ @property
272
+ def description(self):
273
+ r"""Gets the description of this StoreData.
274
+
275
+ **参数解释:** 知识仓实例描述信息。 **约束限制:** 有效长度0-255 **取值范围:** 不涉及。 **默认取值:** 不涉及。
276
+
277
+ :return: The description of this StoreData.
278
+ :rtype: str
279
+ """
280
+ return self._description
281
+
282
+ @description.setter
283
+ def description(self, description):
284
+ r"""Sets the description of this StoreData.
285
+
286
+ **参数解释:** 知识仓实例描述信息。 **约束限制:** 有效长度0-255 **取值范围:** 不涉及。 **默认取值:** 不涉及。
287
+
288
+ :param description: The description of this StoreData.
289
+ :type description: str
290
+ """
291
+ self._description = description
292
+
293
+ @property
294
+ def private_link(self):
295
+ r"""Gets the private_link of this StoreData.
296
+
297
+ **参数解释:** 知识仓实例的私网链接信息,参考\"VPCEP终端节点对接LMS知识仓实例\"。 **约束限制:** 当前不支持公网访问。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
298
+
299
+ :return: The private_link of this StoreData.
300
+ :rtype: str
301
+ """
302
+ return self._private_link
303
+
304
+ @private_link.setter
305
+ def private_link(self, private_link):
306
+ r"""Sets the private_link of this StoreData.
307
+
308
+ **参数解释:** 知识仓实例的私网链接信息,参考\"VPCEP终端节点对接LMS知识仓实例\"。 **约束限制:** 当前不支持公网访问。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
309
+
310
+ :param private_link: The private_link of this StoreData.
311
+ :type private_link: str
312
+ """
313
+ self._private_link = private_link
314
+
315
+ def to_dict(self):
316
+ """Returns the model properties as a dict"""
317
+ result = {}
318
+
319
+ for attr, _ in six.iteritems(self.openapi_types):
320
+ value = getattr(self, attr)
321
+ if isinstance(value, list):
322
+ result[attr] = list(map(
323
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
324
+ value
325
+ ))
326
+ elif hasattr(value, "to_dict"):
327
+ result[attr] = value.to_dict()
328
+ elif isinstance(value, dict):
329
+ result[attr] = dict(map(
330
+ lambda item: (item[0], item[1].to_dict())
331
+ if hasattr(item[1], "to_dict") else item,
332
+ value.items()
333
+ ))
334
+ else:
335
+ if attr in self.sensitive_list:
336
+ result[attr] = "****"
337
+ else:
338
+ result[attr] = value
339
+
340
+ return result
341
+
342
+ def to_str(self):
343
+ """Returns the string representation of the model"""
344
+ import simplejson as json
345
+ if six.PY2:
346
+ import sys
347
+ reload(sys)
348
+ sys.setdefaultencoding("utf-8")
349
+ return json.dumps(sanitize_for_serialization(self), ensure_ascii=False)
350
+
351
+ def __repr__(self):
352
+ """For `print`"""
353
+ return self.to_str()
354
+
355
+ def __eq__(self, other):
356
+ """Returns true if both objects are equal"""
357
+ if not isinstance(other, StoreData):
358
+ return False
359
+
360
+ return self.__dict__ == other.__dict__
361
+
362
+ def __ne__(self, other):
363
+ """Returns true if both objects are not equal"""
364
+ return not self == other
@@ -29,7 +29,7 @@ class StoreInfo:
29
29
 
30
30
  The model defined in huaweicloud sdk
31
31
 
32
- :param store_name: 知识仓实例名称,全域唯一。 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。
32
+ :param store_name: **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
33
33
  :type store_name: str
34
34
  """
35
35
 
@@ -44,7 +44,7 @@ class StoreInfo:
44
44
  def store_name(self):
45
45
  r"""Gets the store_name of this StoreInfo.
46
46
 
47
- 知识仓实例名称,全域唯一。 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。
47
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
48
48
 
49
49
  :return: The store_name of this StoreInfo.
50
50
  :rtype: str
@@ -55,7 +55,7 @@ class StoreInfo:
55
55
  def store_name(self, store_name):
56
56
  r"""Sets the store_name of this StoreInfo.
57
57
 
58
- 知识仓实例名称,全域唯一。 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。
58
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
59
59
 
60
60
  :param store_name: The store_name of this StoreInfo.
61
61
  :type store_name: str
@@ -39,17 +39,17 @@ class SubSearch:
39
39
 
40
40
  The model defined in huaweicloud sdk
41
41
 
42
- :param vector_field: 指定向量列名称
42
+ :param vector_field: **参数解释:** 要搜索的向量字段名称。 **约束限制:** 必须是collection field schema中存在的向量字段名称。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
43
43
  :type vector_field: str
44
- :param vector: 向量的数据,稠密向量是float,稀疏向量对应其他类型
44
+ :param vector: **参数解释:** 要搜索的向量字段数据。 **约束限制:** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
45
45
  :type vector: list[object]
46
- :param top_k: 返回个数限制
46
+ :param top_k: **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 与offset取值的总和应小于16384。 **取值范围:** `[1, 16384]` **默认取值:** 10
47
47
  :type top_k: int
48
- :param offset: 搜索结果中要跳过的entity数。
48
+ :param offset: **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
49
49
  :type offset: int
50
- :param filter: 标量过滤条件
50
+ :param filter: **参数解释:** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 空字符串,不就行标量过滤。
51
51
  :type filter: str
52
- :param params: 向量查询自定义参数 1、稀疏向量: cut_off_frequency: 通过停用词出现频率决定是否作为查询结果 2、稠密向量: - ef:每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。 - search_list: 候选列表的大小,越大召回率越高,但性能会下降。
52
+ :param params: **参数解释:** 额外的搜索参数配置。 可以配置的参数: * ef: 每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。(仅对HNSW索引类型生效) * search_list: 候选列表的大小,越大召回率越高,但性能会下降。(仅对HANNS索引类型生效) * cut_off_frequency: 通过停用词出现频率决定是否作为查询结果。(仅对稀疏向量搜索生效) **约束限制:** 不涉及。 **取值范围:** ef: [top_k + offset, int32_max] search_list: [top_k + offset, int32_max] cut_off_frequency:[0, 1.0] **默认取值:** ef: top_k search_list: 16 cut_off_frequency: 0
53
53
  :type params: dict(str, object)
54
54
  """
55
55
 
@@ -78,7 +78,7 @@ class SubSearch:
78
78
  def vector_field(self):
79
79
  r"""Gets the vector_field of this SubSearch.
80
80
 
81
- 指定向量列名称
81
+ **参数解释:** 要搜索的向量字段名称。 **约束限制:** 必须是collection field schema中存在的向量字段名称。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
82
82
 
83
83
  :return: The vector_field of this SubSearch.
84
84
  :rtype: str
@@ -89,7 +89,7 @@ class SubSearch:
89
89
  def vector_field(self, vector_field):
90
90
  r"""Sets the vector_field of this SubSearch.
91
91
 
92
- 指定向量列名称
92
+ **参数解释:** 要搜索的向量字段名称。 **约束限制:** 必须是collection field schema中存在的向量字段名称。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
93
93
 
94
94
  :param vector_field: The vector_field of this SubSearch.
95
95
  :type vector_field: str
@@ -100,7 +100,7 @@ class SubSearch:
100
100
  def vector(self):
101
101
  r"""Gets the vector of this SubSearch.
102
102
 
103
- 向量的数据,稠密向量是float,稀疏向量对应其他类型
103
+ **参数解释:** 要搜索的向量字段数据。 **约束限制:** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
104
104
 
105
105
  :return: The vector of this SubSearch.
106
106
  :rtype: list[object]
@@ -111,7 +111,7 @@ class SubSearch:
111
111
  def vector(self, vector):
112
112
  r"""Sets the vector of this SubSearch.
113
113
 
114
- 向量的数据,稠密向量是float,稀疏向量对应其他类型
114
+ **参数解释:** 要搜索的向量字段数据。 **约束限制:** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
115
115
 
116
116
  :param vector: The vector of this SubSearch.
117
117
  :type vector: list[object]
@@ -122,7 +122,7 @@ class SubSearch:
122
122
  def top_k(self):
123
123
  r"""Gets the top_k of this SubSearch.
124
124
 
125
- 返回个数限制
125
+ **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 与offset取值的总和应小于16384。 **取值范围:** `[1, 16384]` **默认取值:** 10
126
126
 
127
127
  :return: The top_k of this SubSearch.
128
128
  :rtype: int
@@ -133,7 +133,7 @@ class SubSearch:
133
133
  def top_k(self, top_k):
134
134
  r"""Sets the top_k of this SubSearch.
135
135
 
136
- 返回个数限制
136
+ **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 与offset取值的总和应小于16384。 **取值范围:** `[1, 16384]` **默认取值:** 10
137
137
 
138
138
  :param top_k: The top_k of this SubSearch.
139
139
  :type top_k: int
@@ -144,7 +144,7 @@ class SubSearch:
144
144
  def offset(self):
145
145
  r"""Gets the offset of this SubSearch.
146
146
 
147
- 搜索结果中要跳过的entity数。
147
+ **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
148
148
 
149
149
  :return: The offset of this SubSearch.
150
150
  :rtype: int
@@ -155,7 +155,7 @@ class SubSearch:
155
155
  def offset(self, offset):
156
156
  r"""Sets the offset of this SubSearch.
157
157
 
158
- 搜索结果中要跳过的entity数。
158
+ **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
159
159
 
160
160
  :param offset: The offset of this SubSearch.
161
161
  :type offset: int
@@ -166,7 +166,7 @@ class SubSearch:
166
166
  def filter(self):
167
167
  r"""Gets the filter of this SubSearch.
168
168
 
169
- 标量过滤条件
169
+ **参数解释:** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 空字符串,不就行标量过滤。
170
170
 
171
171
  :return: The filter of this SubSearch.
172
172
  :rtype: str
@@ -177,7 +177,7 @@ class SubSearch:
177
177
  def filter(self, filter):
178
178
  r"""Sets the filter of this SubSearch.
179
179
 
180
- 标量过滤条件
180
+ **参数解释:** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 空字符串,不就行标量过滤。
181
181
 
182
182
  :param filter: The filter of this SubSearch.
183
183
  :type filter: str
@@ -188,7 +188,7 @@ class SubSearch:
188
188
  def params(self):
189
189
  r"""Gets the params of this SubSearch.
190
190
 
191
- 向量查询自定义参数 1、稀疏向量: cut_off_frequency: 通过停用词出现频率决定是否作为查询结果 2、稠密向量: - ef:每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。 - search_list: 候选列表的大小,越大召回率越高,但性能会下降。
191
+ **参数解释:** 额外的搜索参数配置。 可以配置的参数: * ef: 每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。(仅对HNSW索引类型生效) * search_list: 候选列表的大小,越大召回率越高,但性能会下降。(仅对HANNS索引类型生效) * cut_off_frequency: 通过停用词出现频率决定是否作为查询结果。(仅对稀疏向量搜索生效) **约束限制:** 不涉及。 **取值范围:** ef: [top_k + offset, int32_max] search_list: [top_k + offset, int32_max] cut_off_frequency:[0, 1.0] **默认取值:** ef: top_k search_list: 16 cut_off_frequency: 0
192
192
 
193
193
  :return: The params of this SubSearch.
194
194
  :rtype: dict(str, object)
@@ -199,7 +199,7 @@ class SubSearch:
199
199
  def params(self, params):
200
200
  r"""Sets the params of this SubSearch.
201
201
 
202
- 向量查询自定义参数 1、稀疏向量: cut_off_frequency: 通过停用词出现频率决定是否作为查询结果 2、稠密向量: - ef:每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。 - search_list: 候选列表的大小,越大召回率越高,但性能会下降。
202
+ **参数解释:** 额外的搜索参数配置。 可以配置的参数: * ef: 每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。(仅对HNSW索引类型生效) * search_list: 候选列表的大小,越大召回率越高,但性能会下降。(仅对HANNS索引类型生效) * cut_off_frequency: 通过停用词出现频率决定是否作为查询结果。(仅对稀疏向量搜索生效) **约束限制:** 不涉及。 **取值范围:** ef: [top_k + offset, int32_max] search_list: [top_k + offset, int32_max] cut_off_frequency:[0, 1.0] **默认取值:** ef: top_k search_list: 16 cut_off_frequency: 0
203
203
 
204
204
  :param params: The params of this SubSearch.
205
205
  :type params: dict(str, object)
@@ -33,11 +33,11 @@ class UpsertEntitiesBody:
33
33
 
34
34
  The model defined in huaweicloud sdk
35
35
 
36
- :param store_name: 知识仓实例名称
36
+ :param store_name: **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
37
37
  :type store_name: str
38
- :param collection_name: collection名称
38
+ :param collection_name: **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
39
39
  :type collection_name: str
40
- :param data: 满足collection的field schema
40
+ :param data: **参数解释:** 更新插入collection的entity数据。 **约束限制:** 满足插入collection的field schema。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
41
41
  :type data: list[dict(str, object)]
42
42
  """
43
43
 
@@ -56,7 +56,7 @@ class UpsertEntitiesBody:
56
56
  def store_name(self):
57
57
  r"""Gets the store_name of this UpsertEntitiesBody.
58
58
 
59
- 知识仓实例名称
59
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
60
60
 
61
61
  :return: The store_name of this UpsertEntitiesBody.
62
62
  :rtype: str
@@ -67,7 +67,7 @@ class UpsertEntitiesBody:
67
67
  def store_name(self, store_name):
68
68
  r"""Sets the store_name of this UpsertEntitiesBody.
69
69
 
70
- 知识仓实例名称
70
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
71
71
 
72
72
  :param store_name: The store_name of this UpsertEntitiesBody.
73
73
  :type store_name: str
@@ -78,7 +78,7 @@ class UpsertEntitiesBody:
78
78
  def collection_name(self):
79
79
  r"""Gets the collection_name of this UpsertEntitiesBody.
80
80
 
81
- collection名称
81
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
82
82
 
83
83
  :return: The collection_name of this UpsertEntitiesBody.
84
84
  :rtype: str
@@ -89,7 +89,7 @@ class UpsertEntitiesBody:
89
89
  def collection_name(self, collection_name):
90
90
  r"""Sets the collection_name of this UpsertEntitiesBody.
91
91
 
92
- collection名称
92
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
93
93
 
94
94
  :param collection_name: The collection_name of this UpsertEntitiesBody.
95
95
  :type collection_name: str
@@ -100,7 +100,7 @@ class UpsertEntitiesBody:
100
100
  def data(self):
101
101
  r"""Gets the data of this UpsertEntitiesBody.
102
102
 
103
- 满足collection的field schema
103
+ **参数解释:** 更新插入collection的entity数据。 **约束限制:** 满足插入collection的field schema。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
104
104
 
105
105
  :return: The data of this UpsertEntitiesBody.
106
106
  :rtype: list[dict(str, object)]
@@ -111,7 +111,7 @@ class UpsertEntitiesBody:
111
111
  def data(self, data):
112
112
  r"""Sets the data of this UpsertEntitiesBody.
113
113
 
114
- 满足collection的field schema
114
+ **参数解释:** 更新插入collection的entity数据。 **约束限制:** 满足插入collection的field schema。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
115
115
 
116
116
  :param data: The data of this UpsertEntitiesBody.
117
117
  :type data: list[dict(str, object)]