huaweicloudsdkdwr 3.1.155__py2.py3-none-any.whl → 3.1.157__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 (76) 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 +102 -73
  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} +27 -32
  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/v1/region/dwr_region.py +6 -0
  70. huaweicloudsdkdwr/v3/region/dwr_region.py +6 -0
  71. {huaweicloudsdkdwr-3.1.155.dist-info → huaweicloudsdkdwr-3.1.157.dist-info}/METADATA +2 -2
  72. {huaweicloudsdkdwr-3.1.155.dist-info → huaweicloudsdkdwr-3.1.157.dist-info}/RECORD +75 -73
  73. huaweicloudsdkdwr/v1/model/describe_store_data.py +0 -364
  74. {huaweicloudsdkdwr-3.1.155.dist-info → huaweicloudsdkdwr-3.1.157.dist-info}/LICENSE +0 -0
  75. {huaweicloudsdkdwr-3.1.155.dist-info → huaweicloudsdkdwr-3.1.157.dist-info}/WHEEL +0 -0
  76. {huaweicloudsdkdwr-3.1.155.dist-info → huaweicloudsdkdwr-3.1.157.dist-info}/top_level.txt +0 -0
@@ -20,29 +20,41 @@ class FieldData:
20
20
  'field_name': 'str',
21
21
  'data_type': 'str',
22
22
  'primary_key': 'bool',
23
- 'partition_key': 'bool'
23
+ 'partition_key': 'bool',
24
+ 'dim': 'str',
25
+ 'max_length': 'str',
26
+ 'max_capacity': 'str'
24
27
  }
25
28
 
26
29
  attribute_map = {
27
30
  'field_name': 'field_name',
28
31
  'data_type': 'data_type',
29
32
  'primary_key': 'primary_key',
30
- 'partition_key': 'partition_key'
33
+ 'partition_key': 'partition_key',
34
+ 'dim': 'dim',
35
+ 'max_length': 'max_length',
36
+ 'max_capacity': 'max_capacity'
31
37
  }
32
38
 
33
- def __init__(self, field_name=None, data_type=None, primary_key=None, partition_key=None):
39
+ def __init__(self, field_name=None, data_type=None, primary_key=None, partition_key=None, dim=None, max_length=None, max_capacity=None):
34
40
  r"""FieldData
35
41
 
36
42
  The model defined in huaweicloud sdk
37
43
 
38
- :param field_name: 要在集合中创建的字段名称
44
+ :param field_name: **参数解释:** 要在集合中创建的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
39
45
  :type field_name: str
40
- :param data_type: 字段的数据类型;“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\",\"SparseFloatVector\"。注意向量类型后会添加维度信息,如\"SparseFloatVector(256)
46
+ :param data_type: **参数解释:** 字段的数据类型。 **约束限制:** 不涉及。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"。 **默认取值:** 不涉及。
41
47
  :type data_type: str
42
- :param primary_key: 是否是主键字段
48
+ :param primary_key: **参数解释:** 是否是主键字段。 **约束限制:** 不涉及。 **取值范围:** true,false。 **默认取值:** 不涉及。
43
49
  :type primary_key: bool
44
- :param partition_key: 是否是partition key
50
+ :param partition_key: **参数解释:** 是否是partition key。 **约束限制:** 不涉及。 **取值范围:** true,false。 **默认取值:** 不涉及。
45
51
  :type partition_key: bool
52
+ :param dim: **参数解释:** 向量列的维度值。 **约束限制:** field的数据类型是FloatVector, SparseFloatVector时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
53
+ :type dim: str
54
+ :param max_length: **参数解释:** 字符串列设置的最大长度值。 **约束限制:** field的数据类型是String或者 Array 元素类型为String类型时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
55
+ :type max_length: str
56
+ :param max_capacity: **参数解释:** 数组列设置的最大容量值。 **约束限制:** field的数据类型是 Array 类型时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
57
+ :type max_capacity: str
46
58
  """
47
59
 
48
60
 
@@ -51,18 +63,27 @@ class FieldData:
51
63
  self._data_type = None
52
64
  self._primary_key = None
53
65
  self._partition_key = None
66
+ self._dim = None
67
+ self._max_length = None
68
+ self._max_capacity = None
54
69
  self.discriminator = None
55
70
 
56
71
  self.field_name = field_name
57
72
  self.data_type = data_type
58
73
  self.primary_key = primary_key
59
74
  self.partition_key = partition_key
75
+ if dim is not None:
76
+ self.dim = dim
77
+ if max_length is not None:
78
+ self.max_length = max_length
79
+ if max_capacity is not None:
80
+ self.max_capacity = max_capacity
60
81
 
61
82
  @property
62
83
  def field_name(self):
63
84
  r"""Gets the field_name of this FieldData.
64
85
 
65
- 要在集合中创建的字段名称
86
+ **参数解释:** 要在集合中创建的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
66
87
 
67
88
  :return: The field_name of this FieldData.
68
89
  :rtype: str
@@ -73,7 +94,7 @@ class FieldData:
73
94
  def field_name(self, field_name):
74
95
  r"""Sets the field_name of this FieldData.
75
96
 
76
- 要在集合中创建的字段名称
97
+ **参数解释:** 要在集合中创建的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
77
98
 
78
99
  :param field_name: The field_name of this FieldData.
79
100
  :type field_name: str
@@ -84,7 +105,7 @@ class FieldData:
84
105
  def data_type(self):
85
106
  r"""Gets the data_type of this FieldData.
86
107
 
87
- 字段的数据类型;“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\",\"SparseFloatVector\"。注意向量类型后会添加维度信息,如\"SparseFloatVector(256)
108
+ **参数解释:** 字段的数据类型。 **约束限制:** 不涉及。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"。 **默认取值:** 不涉及。
88
109
 
89
110
  :return: The data_type of this FieldData.
90
111
  :rtype: str
@@ -95,7 +116,7 @@ class FieldData:
95
116
  def data_type(self, data_type):
96
117
  r"""Sets the data_type of this FieldData.
97
118
 
98
- 字段的数据类型;“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\",\"SparseFloatVector\"。注意向量类型后会添加维度信息,如\"SparseFloatVector(256)
119
+ **参数解释:** 字段的数据类型。 **约束限制:** 不涉及。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"。 **默认取值:** 不涉及。
99
120
 
100
121
  :param data_type: The data_type of this FieldData.
101
122
  :type data_type: str
@@ -106,7 +127,7 @@ class FieldData:
106
127
  def primary_key(self):
107
128
  r"""Gets the primary_key of this FieldData.
108
129
 
109
- 是否是主键字段
130
+ **参数解释:** 是否是主键字段。 **约束限制:** 不涉及。 **取值范围:** true,false。 **默认取值:** 不涉及。
110
131
 
111
132
  :return: The primary_key of this FieldData.
112
133
  :rtype: bool
@@ -117,7 +138,7 @@ class FieldData:
117
138
  def primary_key(self, primary_key):
118
139
  r"""Sets the primary_key of this FieldData.
119
140
 
120
- 是否是主键字段
141
+ **参数解释:** 是否是主键字段。 **约束限制:** 不涉及。 **取值范围:** true,false。 **默认取值:** 不涉及。
121
142
 
122
143
  :param primary_key: The primary_key of this FieldData.
123
144
  :type primary_key: bool
@@ -128,7 +149,7 @@ class FieldData:
128
149
  def partition_key(self):
129
150
  r"""Gets the partition_key of this FieldData.
130
151
 
131
- 是否是partition key
152
+ **参数解释:** 是否是partition key。 **约束限制:** 不涉及。 **取值范围:** true,false。 **默认取值:** 不涉及。
132
153
 
133
154
  :return: The partition_key of this FieldData.
134
155
  :rtype: bool
@@ -139,13 +160,79 @@ class FieldData:
139
160
  def partition_key(self, partition_key):
140
161
  r"""Sets the partition_key of this FieldData.
141
162
 
142
- 是否是partition key
163
+ **参数解释:** 是否是partition key。 **约束限制:** 不涉及。 **取值范围:** true,false。 **默认取值:** 不涉及。
143
164
 
144
165
  :param partition_key: The partition_key of this FieldData.
145
166
  :type partition_key: bool
146
167
  """
147
168
  self._partition_key = partition_key
148
169
 
170
+ @property
171
+ def dim(self):
172
+ r"""Gets the dim of this FieldData.
173
+
174
+ **参数解释:** 向量列的维度值。 **约束限制:** field的数据类型是FloatVector, SparseFloatVector时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
175
+
176
+ :return: The dim of this FieldData.
177
+ :rtype: str
178
+ """
179
+ return self._dim
180
+
181
+ @dim.setter
182
+ def dim(self, dim):
183
+ r"""Sets the dim of this FieldData.
184
+
185
+ **参数解释:** 向量列的维度值。 **约束限制:** field的数据类型是FloatVector, SparseFloatVector时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
186
+
187
+ :param dim: The dim of this FieldData.
188
+ :type dim: str
189
+ """
190
+ self._dim = dim
191
+
192
+ @property
193
+ def max_length(self):
194
+ r"""Gets the max_length of this FieldData.
195
+
196
+ **参数解释:** 字符串列设置的最大长度值。 **约束限制:** field的数据类型是String或者 Array 元素类型为String类型时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
197
+
198
+ :return: The max_length of this FieldData.
199
+ :rtype: str
200
+ """
201
+ return self._max_length
202
+
203
+ @max_length.setter
204
+ def max_length(self, max_length):
205
+ r"""Sets the max_length of this FieldData.
206
+
207
+ **参数解释:** 字符串列设置的最大长度值。 **约束限制:** field的数据类型是String或者 Array 元素类型为String类型时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
208
+
209
+ :param max_length: The max_length of this FieldData.
210
+ :type max_length: str
211
+ """
212
+ self._max_length = max_length
213
+
214
+ @property
215
+ def max_capacity(self):
216
+ r"""Gets the max_capacity of this FieldData.
217
+
218
+ **参数解释:** 数组列设置的最大容量值。 **约束限制:** field的数据类型是 Array 类型时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
219
+
220
+ :return: The max_capacity of this FieldData.
221
+ :rtype: str
222
+ """
223
+ return self._max_capacity
224
+
225
+ @max_capacity.setter
226
+ def max_capacity(self, max_capacity):
227
+ r"""Sets the max_capacity of this FieldData.
228
+
229
+ **参数解释:** 数组列设置的最大容量值。 **约束限制:** field的数据类型是 Array 类型时生效。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
230
+
231
+ :param max_capacity: The max_capacity of this FieldData.
232
+ :type max_capacity: str
233
+ """
234
+ self._max_capacity = max_capacity
235
+
149
236
  def to_dict(self):
150
237
  """Returns the model properties as a dict"""
151
238
  result = {}
@@ -31,9 +31,9 @@ class Flavor:
31
31
 
32
32
  The model defined in huaweicloud sdk
33
33
 
34
- :param cu: cu规格,取值范围xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge
34
+ :param cu: **参数解释:** CU规格。 **约束限制:** 不涉及。 **取值范围:** xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge。 **默认取值:** 不涉及。
35
35
  :type cu: str
36
- :param num: 选择cu规格的数量。不能超过CU配额,如有大量需求,请提工单申请
36
+ :param num: **参数解释:** 选择CU规格的数量。 **约束限制:** 不能超过CU配额,如有大量需求,请提工单申请。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
37
37
  :type num: int
38
38
  """
39
39
 
@@ -50,7 +50,7 @@ class Flavor:
50
50
  def cu(self):
51
51
  r"""Gets the cu of this Flavor.
52
52
 
53
- cu规格,取值范围xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge
53
+ **参数解释:** CU规格。 **约束限制:** 不涉及。 **取值范围:** xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge。 **默认取值:** 不涉及。
54
54
 
55
55
  :return: The cu of this Flavor.
56
56
  :rtype: str
@@ -61,7 +61,7 @@ class Flavor:
61
61
  def cu(self, cu):
62
62
  r"""Sets the cu of this Flavor.
63
63
 
64
- cu规格,取值范围xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge
64
+ **参数解释:** CU规格。 **约束限制:** 不涉及。 **取值范围:** xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge。 **默认取值:** 不涉及。
65
65
 
66
66
  :param cu: The cu of this Flavor.
67
67
  :type cu: str
@@ -72,7 +72,7 @@ class Flavor:
72
72
  def num(self):
73
73
  r"""Gets the num of this Flavor.
74
74
 
75
- 选择cu规格的数量。不能超过CU配额,如有大量需求,请提工单申请
75
+ **参数解释:** 选择CU规格的数量。 **约束限制:** 不能超过CU配额,如有大量需求,请提工单申请。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
76
76
 
77
77
  :return: The num of this Flavor.
78
78
  :rtype: int
@@ -83,7 +83,7 @@ class Flavor:
83
83
  def num(self, num):
84
84
  r"""Sets the num of this Flavor.
85
85
 
86
- 选择cu规格的数量。不能超过CU配额,如有大量需求,请提工单申请
86
+ **参数解释:** 选择CU规格的数量。 **约束限制:** 不能超过CU配额,如有大量需求,请提工单申请。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
87
87
 
88
88
  :param num: The num of this Flavor.
89
89
  :type num: int
@@ -33,11 +33,11 @@ class GetIndexProgressBody:
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 index_name: 对应的索引名
40
+ :param index_name: **参数解释:** 创建的索引名称,collection内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
41
41
  :type index_name: str
42
42
  """
43
43
 
@@ -56,7 +56,7 @@ class GetIndexProgressBody:
56
56
  def store_name(self):
57
57
  r"""Gets the store_name of this GetIndexProgressBody.
58
58
 
59
- 知识仓实例名称
59
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
60
60
 
61
61
  :return: The store_name of this GetIndexProgressBody.
62
62
  :rtype: str
@@ -67,7 +67,7 @@ class GetIndexProgressBody:
67
67
  def store_name(self, store_name):
68
68
  r"""Sets the store_name of this GetIndexProgressBody.
69
69
 
70
- 知识仓实例名称
70
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
71
71
 
72
72
  :param store_name: The store_name of this GetIndexProgressBody.
73
73
  :type store_name: str
@@ -78,7 +78,7 @@ class GetIndexProgressBody:
78
78
  def collection_name(self):
79
79
  r"""Gets the collection_name of this GetIndexProgressBody.
80
80
 
81
- Collection 名称
81
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
82
82
 
83
83
  :return: The collection_name of this GetIndexProgressBody.
84
84
  :rtype: str
@@ -89,7 +89,7 @@ class GetIndexProgressBody:
89
89
  def collection_name(self, collection_name):
90
90
  r"""Sets the collection_name of this GetIndexProgressBody.
91
91
 
92
- Collection 名称
92
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
93
93
 
94
94
  :param collection_name: The collection_name of this GetIndexProgressBody.
95
95
  :type collection_name: str
@@ -100,7 +100,7 @@ class GetIndexProgressBody:
100
100
  def index_name(self):
101
101
  r"""Gets the index_name of this GetIndexProgressBody.
102
102
 
103
- 对应的索引名
103
+ **参数解释:** 创建的索引名称,collection内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
104
104
 
105
105
  :return: The index_name of this GetIndexProgressBody.
106
106
  :rtype: str
@@ -111,7 +111,7 @@ class GetIndexProgressBody:
111
111
  def index_name(self, index_name):
112
112
  r"""Sets the index_name of this GetIndexProgressBody.
113
113
 
114
- 对应的索引名
114
+ **参数解释:** 创建的索引名称,collection内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
115
115
 
116
116
  :param index_name: The index_name of this GetIndexProgressBody.
117
117
  :type index_name: str
@@ -5,7 +5,7 @@ import six
5
5
  from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
6
6
 
7
7
 
8
- class GetIndexProgressResponseData:
8
+ class GetProgressData:
9
9
 
10
10
  """
11
11
  Attributes:
@@ -29,13 +29,13 @@ class GetIndexProgressResponseData:
29
29
  }
30
30
 
31
31
  def __init__(self, store_name=None, collection_name=None, build_progress=None):
32
- r"""GetIndexProgressResponseData
32
+ r"""GetProgressData
33
33
 
34
34
  The model defined in huaweicloud sdk
35
35
 
36
- :param store_name: 知识仓实例名称。
36
+ :param store_name: **参数解释:** 知识仓实例名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
37
37
  :type store_name: str
38
- :param collection_name: Collection 名称。
38
+ :param collection_name: **参数解释:** Collection 名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
39
39
  :type collection_name: str
40
40
  :param build_progress:
41
41
  :type build_progress: :class:`huaweicloudsdkdwr.v1.BuildProgress`
@@ -55,62 +55,62 @@ class GetIndexProgressResponseData:
55
55
 
56
56
  @property
57
57
  def store_name(self):
58
- r"""Gets the store_name of this GetIndexProgressResponseData.
58
+ r"""Gets the store_name of this GetProgressData.
59
59
 
60
- 知识仓实例名称。
60
+ **参数解释:** 知识仓实例名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
61
61
 
62
- :return: The store_name of this GetIndexProgressResponseData.
62
+ :return: The store_name of this GetProgressData.
63
63
  :rtype: str
64
64
  """
65
65
  return self._store_name
66
66
 
67
67
  @store_name.setter
68
68
  def store_name(self, store_name):
69
- r"""Sets the store_name of this GetIndexProgressResponseData.
69
+ r"""Sets the store_name of this GetProgressData.
70
70
 
71
- 知识仓实例名称。
71
+ **参数解释:** 知识仓实例名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
72
72
 
73
- :param store_name: The store_name of this GetIndexProgressResponseData.
73
+ :param store_name: The store_name of this GetProgressData.
74
74
  :type store_name: str
75
75
  """
76
76
  self._store_name = store_name
77
77
 
78
78
  @property
79
79
  def collection_name(self):
80
- r"""Gets the collection_name of this GetIndexProgressResponseData.
80
+ r"""Gets the collection_name of this GetProgressData.
81
81
 
82
- Collection 名称。
82
+ **参数解释:** Collection 名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
83
83
 
84
- :return: The collection_name of this GetIndexProgressResponseData.
84
+ :return: The collection_name of this GetProgressData.
85
85
  :rtype: str
86
86
  """
87
87
  return self._collection_name
88
88
 
89
89
  @collection_name.setter
90
90
  def collection_name(self, collection_name):
91
- r"""Sets the collection_name of this GetIndexProgressResponseData.
91
+ r"""Sets the collection_name of this GetProgressData.
92
92
 
93
- Collection 名称。
93
+ **参数解释:** Collection 名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
94
94
 
95
- :param collection_name: The collection_name of this GetIndexProgressResponseData.
95
+ :param collection_name: The collection_name of this GetProgressData.
96
96
  :type collection_name: str
97
97
  """
98
98
  self._collection_name = collection_name
99
99
 
100
100
  @property
101
101
  def build_progress(self):
102
- r"""Gets the build_progress of this GetIndexProgressResponseData.
102
+ r"""Gets the build_progress of this GetProgressData.
103
103
 
104
- :return: The build_progress of this GetIndexProgressResponseData.
104
+ :return: The build_progress of this GetProgressData.
105
105
  :rtype: :class:`huaweicloudsdkdwr.v1.BuildProgress`
106
106
  """
107
107
  return self._build_progress
108
108
 
109
109
  @build_progress.setter
110
110
  def build_progress(self, build_progress):
111
- r"""Sets the build_progress of this GetIndexProgressResponseData.
111
+ r"""Sets the build_progress of this GetProgressData.
112
112
 
113
- :param build_progress: The build_progress of this GetIndexProgressResponseData.
113
+ :param build_progress: The build_progress of this GetProgressData.
114
114
  :type build_progress: :class:`huaweicloudsdkdwr.v1.BuildProgress`
115
115
  """
116
116
  self._build_progress = build_progress
@@ -157,7 +157,7 @@ class GetIndexProgressResponseData:
157
157
 
158
158
  def __eq__(self, other):
159
159
  """Returns true if both objects are equal"""
160
- if not isinstance(other, GetIndexProgressResponseData):
160
+ if not isinstance(other, GetProgressData):
161
161
  return False
162
162
 
163
163
  return self.__dict__ == other.__dict__
@@ -20,7 +20,7 @@ class GetProgressResponse(SdkResponse):
20
20
  openapi_types = {
21
21
  'code': 'str',
22
22
  'message': 'str',
23
- 'data': 'GetIndexProgressResponseData'
23
+ 'data': 'GetProgressData'
24
24
  }
25
25
 
26
26
  attribute_map = {
@@ -34,12 +34,12 @@ class GetProgressResponse(SdkResponse):
34
34
 
35
35
  The model defined in huaweicloud sdk
36
36
 
37
- :param code: 返回码
37
+ :param code: **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
38
38
  :type code: str
39
- :param message: 描述信息
39
+ :param message: **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
40
40
  :type message: str
41
41
  :param data:
42
- :type data: :class:`huaweicloudsdkdwr.v1.GetIndexProgressResponseData`
42
+ :type data: :class:`huaweicloudsdkdwr.v1.GetProgressData`
43
43
  """
44
44
 
45
45
  super(GetProgressResponse, self).__init__()
@@ -60,7 +60,7 @@ class GetProgressResponse(SdkResponse):
60
60
  def code(self):
61
61
  r"""Gets the code of this GetProgressResponse.
62
62
 
63
- 返回码
63
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
64
64
 
65
65
  :return: The code of this GetProgressResponse.
66
66
  :rtype: str
@@ -71,7 +71,7 @@ class GetProgressResponse(SdkResponse):
71
71
  def code(self, code):
72
72
  r"""Sets the code of this GetProgressResponse.
73
73
 
74
- 返回码
74
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :param code: The code of this GetProgressResponse.
77
77
  :type code: str
@@ -82,7 +82,7 @@ class GetProgressResponse(SdkResponse):
82
82
  def message(self):
83
83
  r"""Gets the message of this GetProgressResponse.
84
84
 
85
- 描述信息
85
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :return: The message of this GetProgressResponse.
88
88
  :rtype: str
@@ -93,7 +93,7 @@ class GetProgressResponse(SdkResponse):
93
93
  def message(self, message):
94
94
  r"""Sets the message of this GetProgressResponse.
95
95
 
96
- 描述信息
96
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
97
97
 
98
98
  :param message: The message of this GetProgressResponse.
99
99
  :type message: str
@@ -105,7 +105,7 @@ class GetProgressResponse(SdkResponse):
105
105
  r"""Gets the data of this GetProgressResponse.
106
106
 
107
107
  :return: The data of this GetProgressResponse.
108
- :rtype: :class:`huaweicloudsdkdwr.v1.GetIndexProgressResponseData`
108
+ :rtype: :class:`huaweicloudsdkdwr.v1.GetProgressData`
109
109
  """
110
110
  return self._data
111
111
 
@@ -114,7 +114,7 @@ class GetProgressResponse(SdkResponse):
114
114
  r"""Sets the data of this GetProgressResponse.
115
115
 
116
116
  :param data: The data of this GetProgressResponse.
117
- :type data: :class:`huaweicloudsdkdwr.v1.GetIndexProgressResponseData`
117
+ :type data: :class:`huaweicloudsdkdwr.v1.GetProgressData`
118
118
  """
119
119
  self._data = data
120
120
 
@@ -41,17 +41,17 @@ class HybridSearchBody:
41
41
 
42
42
  The model defined in huaweicloud sdk
43
43
 
44
- :param store_name: 知识仓实例名称
44
+ :param store_name: **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
45
45
  :type store_name: str
46
- :param collection_name: collection名称
46
+ :param collection_name: **参数解释:** collection名称,知识仓内唯一。 约束限制: 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
47
47
  :type collection_name: str
48
- :param output_fields: 配置需返回的字段。
48
+ :param output_fields: **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** `[ ]`,不返回任何额外的字段数据。
49
49
  :type output_fields: list[str]
50
- :param top_k: 返回个数限制
50
+ :param top_k: **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 1.与offset取值的总和应小于16384。 2.当sub_search数量为1时,以sub_search中的top_k和offset为准。 **取值范围:** `[1, 16384]` **默认取值:** 10
51
51
  :type top_k: int
52
- :param offset: 搜索结果中要跳过的entity数。
52
+ :param offset: **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 1.与top_k取值的总和应小于16384。 2.当sub_search数量为1时,以sub_search中的top_k和offset为准。 **取值范围:** 大于等于0 **默认取值:** 0
53
53
  :type offset: int
54
- :param sub_search:
54
+ :param sub_search: **参数解释:** rerank策略。 **约束限制:** 不涉及 **取值范围:** 不涉及。 **默认取值:** 默认使用rrf算法。
55
55
  :type sub_search: list[:class:`huaweicloudsdkdwr.v1.SubSearch`]
56
56
  :param rerank:
57
57
  :type rerank: :class:`huaweicloudsdkdwr.v1.Rerank`
@@ -84,7 +84,7 @@ class HybridSearchBody:
84
84
  def store_name(self):
85
85
  r"""Gets the store_name of this HybridSearchBody.
86
86
 
87
- 知识仓实例名称
87
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
88
88
 
89
89
  :return: The store_name of this HybridSearchBody.
90
90
  :rtype: str
@@ -95,7 +95,7 @@ class HybridSearchBody:
95
95
  def store_name(self, store_name):
96
96
  r"""Sets the store_name of this HybridSearchBody.
97
97
 
98
- 知识仓实例名称
98
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
99
99
 
100
100
  :param store_name: The store_name of this HybridSearchBody.
101
101
  :type store_name: str
@@ -106,7 +106,7 @@ class HybridSearchBody:
106
106
  def collection_name(self):
107
107
  r"""Gets the collection_name of this HybridSearchBody.
108
108
 
109
- collection名称
109
+ **参数解释:** collection名称,知识仓内唯一。 约束限制: 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
110
110
 
111
111
  :return: The collection_name of this HybridSearchBody.
112
112
  :rtype: str
@@ -117,7 +117,7 @@ class HybridSearchBody:
117
117
  def collection_name(self, collection_name):
118
118
  r"""Sets the collection_name of this HybridSearchBody.
119
119
 
120
- collection名称
120
+ **参数解释:** collection名称,知识仓内唯一。 约束限制: 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
121
121
 
122
122
  :param collection_name: The collection_name of this HybridSearchBody.
123
123
  :type collection_name: str
@@ -128,7 +128,7 @@ class HybridSearchBody:
128
128
  def output_fields(self):
129
129
  r"""Gets the output_fields of this HybridSearchBody.
130
130
 
131
- 配置需返回的字段。
131
+ **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** `[ ]`,不返回任何额外的字段数据。
132
132
 
133
133
  :return: The output_fields of this HybridSearchBody.
134
134
  :rtype: list[str]
@@ -139,7 +139,7 @@ class HybridSearchBody:
139
139
  def output_fields(self, output_fields):
140
140
  r"""Sets the output_fields of this HybridSearchBody.
141
141
 
142
- 配置需返回的字段。
142
+ **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** `[ ]`,不返回任何额外的字段数据。
143
143
 
144
144
  :param output_fields: The output_fields of this HybridSearchBody.
145
145
  :type output_fields: list[str]
@@ -150,7 +150,7 @@ class HybridSearchBody:
150
150
  def top_k(self):
151
151
  r"""Gets the top_k of this HybridSearchBody.
152
152
 
153
- 返回个数限制
153
+ **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 1.与offset取值的总和应小于16384。 2.当sub_search数量为1时,以sub_search中的top_k和offset为准。 **取值范围:** `[1, 16384]` **默认取值:** 10
154
154
 
155
155
  :return: The top_k of this HybridSearchBody.
156
156
  :rtype: int
@@ -161,7 +161,7 @@ class HybridSearchBody:
161
161
  def top_k(self, top_k):
162
162
  r"""Sets the top_k of this HybridSearchBody.
163
163
 
164
- 返回个数限制
164
+ **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 1.与offset取值的总和应小于16384。 2.当sub_search数量为1时,以sub_search中的top_k和offset为准。 **取值范围:** `[1, 16384]` **默认取值:** 10
165
165
 
166
166
  :param top_k: The top_k of this HybridSearchBody.
167
167
  :type top_k: int
@@ -172,7 +172,7 @@ class HybridSearchBody:
172
172
  def offset(self):
173
173
  r"""Gets the offset of this HybridSearchBody.
174
174
 
175
- 搜索结果中要跳过的entity数。
175
+ **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 1.与top_k取值的总和应小于16384。 2.当sub_search数量为1时,以sub_search中的top_k和offset为准。 **取值范围:** 大于等于0 **默认取值:** 0
176
176
 
177
177
  :return: The offset of this HybridSearchBody.
178
178
  :rtype: int
@@ -183,7 +183,7 @@ class HybridSearchBody:
183
183
  def offset(self, offset):
184
184
  r"""Sets the offset of this HybridSearchBody.
185
185
 
186
- 搜索结果中要跳过的entity数。
186
+ **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 1.与top_k取值的总和应小于16384。 2.当sub_search数量为1时,以sub_search中的top_k和offset为准。 **取值范围:** 大于等于0 **默认取值:** 0
187
187
 
188
188
  :param offset: The offset of this HybridSearchBody.
189
189
  :type offset: int
@@ -194,6 +194,8 @@ class HybridSearchBody:
194
194
  def sub_search(self):
195
195
  r"""Gets the sub_search of this HybridSearchBody.
196
196
 
197
+ **参数解释:** rerank策略。 **约束限制:** 不涉及 **取值范围:** 不涉及。 **默认取值:** 默认使用rrf算法。
198
+
197
199
  :return: The sub_search of this HybridSearchBody.
198
200
  :rtype: list[:class:`huaweicloudsdkdwr.v1.SubSearch`]
199
201
  """
@@ -203,6 +205,8 @@ class HybridSearchBody:
203
205
  def sub_search(self, sub_search):
204
206
  r"""Sets the sub_search of this HybridSearchBody.
205
207
 
208
+ **参数解释:** rerank策略。 **约束限制:** 不涉及 **取值范围:** 不涉及。 **默认取值:** 默认使用rrf算法。
209
+
206
210
  :param sub_search: The sub_search of this HybridSearchBody.
207
211
  :type sub_search: list[:class:`huaweicloudsdkdwr.v1.SubSearch`]
208
212
  """