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
@@ -0,0 +1,114 @@
1
+ # coding: utf-8
2
+
3
+ import six
4
+
5
+ from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
6
+
7
+
8
+ class ListStoreData:
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
+ 'stores': 'list[StoreData]'
21
+ }
22
+
23
+ attribute_map = {
24
+ 'stores': 'stores'
25
+ }
26
+
27
+ def __init__(self, stores=None):
28
+ r"""ListStoreData
29
+
30
+ The model defined in huaweicloud sdk
31
+
32
+ :param stores: **参数解释:** 列举store列表。 **约束限制:** 不涉及。
33
+ :type stores: list[:class:`huaweicloudsdkdwr.v1.StoreData`]
34
+ """
35
+
36
+
37
+
38
+ self._stores = None
39
+ self.discriminator = None
40
+
41
+ self.stores = stores
42
+
43
+ @property
44
+ def stores(self):
45
+ r"""Gets the stores of this ListStoreData.
46
+
47
+ **参数解释:** 列举store列表。 **约束限制:** 不涉及。
48
+
49
+ :return: The stores of this ListStoreData.
50
+ :rtype: list[:class:`huaweicloudsdkdwr.v1.StoreData`]
51
+ """
52
+ return self._stores
53
+
54
+ @stores.setter
55
+ def stores(self, stores):
56
+ r"""Sets the stores of this ListStoreData.
57
+
58
+ **参数解释:** 列举store列表。 **约束限制:** 不涉及。
59
+
60
+ :param stores: The stores of this ListStoreData.
61
+ :type stores: list[:class:`huaweicloudsdkdwr.v1.StoreData`]
62
+ """
63
+ self._stores = stores
64
+
65
+ def to_dict(self):
66
+ """Returns the model properties as a dict"""
67
+ result = {}
68
+
69
+ for attr, _ in six.iteritems(self.openapi_types):
70
+ value = getattr(self, attr)
71
+ if isinstance(value, list):
72
+ result[attr] = list(map(
73
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
74
+ value
75
+ ))
76
+ elif hasattr(value, "to_dict"):
77
+ result[attr] = value.to_dict()
78
+ elif isinstance(value, dict):
79
+ result[attr] = dict(map(
80
+ lambda item: (item[0], item[1].to_dict())
81
+ if hasattr(item[1], "to_dict") else item,
82
+ value.items()
83
+ ))
84
+ else:
85
+ if attr in self.sensitive_list:
86
+ result[attr] = "****"
87
+ else:
88
+ result[attr] = value
89
+
90
+ return result
91
+
92
+ def to_str(self):
93
+ """Returns the string representation of the model"""
94
+ import simplejson as json
95
+ if six.PY2:
96
+ import sys
97
+ reload(sys)
98
+ sys.setdefaultencoding("utf-8")
99
+ return json.dumps(sanitize_for_serialization(self), ensure_ascii=False)
100
+
101
+ def __repr__(self):
102
+ """For `print`"""
103
+ return self.to_str()
104
+
105
+ def __eq__(self, other):
106
+ """Returns true if both objects are equal"""
107
+ if not isinstance(other, ListStoreData):
108
+ return False
109
+
110
+ return self.__dict__ == other.__dict__
111
+
112
+ def __ne__(self, other):
113
+ """Returns true if both objects are not equal"""
114
+ return not self == other
@@ -20,7 +20,7 @@ class ListStoresResponse(SdkResponse):
20
20
  openapi_types = {
21
21
  'code': 'str',
22
22
  'message': 'str',
23
- 'data': 'list[DescribeStoreData]'
23
+ 'data': 'ListStoreData'
24
24
  }
25
25
 
26
26
  attribute_map = {
@@ -34,12 +34,12 @@ class ListStoresResponse(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
- :param data: 响应数据
42
- :type data: list[:class:`huaweicloudsdkdwr.v1.DescribeStoreData`]
41
+ :param data:
42
+ :type data: :class:`huaweicloudsdkdwr.v1.ListStoreData`
43
43
  """
44
44
 
45
45
  super(ListStoresResponse, self).__init__()
@@ -60,7 +60,7 @@ class ListStoresResponse(SdkResponse):
60
60
  def code(self):
61
61
  r"""Gets the code of this ListStoresResponse.
62
62
 
63
- 返回码
63
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
64
64
 
65
65
  :return: The code of this ListStoresResponse.
66
66
  :rtype: str
@@ -71,7 +71,7 @@ class ListStoresResponse(SdkResponse):
71
71
  def code(self, code):
72
72
  r"""Sets the code of this ListStoresResponse.
73
73
 
74
- 返回码
74
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :param code: The code of this ListStoresResponse.
77
77
  :type code: str
@@ -82,7 +82,7 @@ class ListStoresResponse(SdkResponse):
82
82
  def message(self):
83
83
  r"""Gets the message of this ListStoresResponse.
84
84
 
85
- 描述信息
85
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :return: The message of this ListStoresResponse.
88
88
  :rtype: str
@@ -93,7 +93,7 @@ class ListStoresResponse(SdkResponse):
93
93
  def message(self, message):
94
94
  r"""Sets the message of this ListStoresResponse.
95
95
 
96
- 描述信息
96
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
97
97
 
98
98
  :param message: The message of this ListStoresResponse.
99
99
  :type message: str
@@ -104,10 +104,8 @@ class ListStoresResponse(SdkResponse):
104
104
  def data(self):
105
105
  r"""Gets the data of this ListStoresResponse.
106
106
 
107
- 响应数据
108
-
109
107
  :return: The data of this ListStoresResponse.
110
- :rtype: list[:class:`huaweicloudsdkdwr.v1.DescribeStoreData`]
108
+ :rtype: :class:`huaweicloudsdkdwr.v1.ListStoreData`
111
109
  """
112
110
  return self._data
113
111
 
@@ -115,10 +113,8 @@ class ListStoresResponse(SdkResponse):
115
113
  def data(self, data):
116
114
  r"""Sets the data of this ListStoresResponse.
117
115
 
118
- 响应数据
119
-
120
116
  :param data: The data of this ListStoresResponse.
121
- :type data: list[:class:`huaweicloudsdkdwr.v1.DescribeStoreData`]
117
+ :type data: :class:`huaweicloudsdkdwr.v1.ListStoreData`
122
118
  """
123
119
  self._data = data
124
120
 
@@ -31,9 +31,9 @@ class LoadCollectionBody:
31
31
 
32
32
  The model defined in huaweicloud sdk
33
33
 
34
- :param store_name: 知识仓实例名称。
34
+ :param store_name: **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
35
35
  :type store_name: str
36
- :param collection_name: Collection 名称。
36
+ :param collection_name: **参数解释:** collection名称。 **约束限制:** 可包含数字、字母和下划线 (_)。资源名称必须以字母或下划线 (_) 开头。最大长度支持255。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
37
37
  :type collection_name: str
38
38
  """
39
39
 
@@ -50,7 +50,7 @@ class LoadCollectionBody:
50
50
  def store_name(self):
51
51
  r"""Gets the store_name of this LoadCollectionBody.
52
52
 
53
- 知识仓实例名称。
53
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
54
54
 
55
55
  :return: The store_name of this LoadCollectionBody.
56
56
  :rtype: str
@@ -61,7 +61,7 @@ class LoadCollectionBody:
61
61
  def store_name(self, store_name):
62
62
  r"""Sets the store_name of this LoadCollectionBody.
63
63
 
64
- 知识仓实例名称。
64
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
65
65
 
66
66
  :param store_name: The store_name of this LoadCollectionBody.
67
67
  :type store_name: str
@@ -72,7 +72,7 @@ class LoadCollectionBody:
72
72
  def collection_name(self):
73
73
  r"""Gets the collection_name of this LoadCollectionBody.
74
74
 
75
- Collection 名称。
75
+ **参数解释:** collection名称。 **约束限制:** 可包含数字、字母和下划线 (_)。资源名称必须以字母或下划线 (_) 开头。最大长度支持255。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
76
76
 
77
77
  :return: The collection_name of this LoadCollectionBody.
78
78
  :rtype: str
@@ -83,7 +83,7 @@ class LoadCollectionBody:
83
83
  def collection_name(self, collection_name):
84
84
  r"""Sets the collection_name of this LoadCollectionBody.
85
85
 
86
- Collection 名称。
86
+ **参数解释:** collection名称。 **约束限制:** 可包含数字、字母和下划线 (_)。资源名称必须以字母或下划线 (_) 开头。最大长度支持255。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
87
87
 
88
88
  :param collection_name: The collection_name of this LoadCollectionBody.
89
89
  :type collection_name: str
@@ -32,9 +32,9 @@ class LoadCollectionResponse(SdkResponse):
32
32
 
33
33
  The model defined in huaweicloud sdk
34
34
 
35
- :param code: 返回码
35
+ :param code: **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
36
36
  :type code: str
37
- :param message: 描述信息
37
+ :param message: **参数解释:** 描述信息。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
38
38
  :type message: str
39
39
  """
40
40
 
@@ -53,7 +53,7 @@ class LoadCollectionResponse(SdkResponse):
53
53
  def code(self):
54
54
  r"""Gets the code of this LoadCollectionResponse.
55
55
 
56
- 返回码
56
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
57
57
 
58
58
  :return: The code of this LoadCollectionResponse.
59
59
  :rtype: str
@@ -64,7 +64,7 @@ class LoadCollectionResponse(SdkResponse):
64
64
  def code(self, code):
65
65
  r"""Sets the code of this LoadCollectionResponse.
66
66
 
67
- 返回码
67
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
68
68
 
69
69
  :param code: The code of this LoadCollectionResponse.
70
70
  :type code: str
@@ -75,7 +75,7 @@ class LoadCollectionResponse(SdkResponse):
75
75
  def message(self):
76
76
  r"""Gets the message of this LoadCollectionResponse.
77
77
 
78
- 描述信息
78
+ **参数解释:** 描述信息。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
79
79
 
80
80
  :return: The message of this LoadCollectionResponse.
81
81
  :rtype: str
@@ -86,7 +86,7 @@ class LoadCollectionResponse(SdkResponse):
86
86
  def message(self, message):
87
87
  r"""Sets the message of this LoadCollectionResponse.
88
88
 
89
- 描述信息
89
+ **参数解释:** 描述信息。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
90
90
 
91
91
  :param message: The message of this LoadCollectionResponse.
92
92
  :type message: str
@@ -31,9 +31,9 @@ class PrimaryField:
31
31
 
32
32
  The model defined in huaweicloud sdk
33
33
 
34
- :param name: 指定主键名
34
+ :param name: **参数解释:** 指定主键名。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
35
35
  :type name: str
36
- :param type: 该参数为 \"String\",“Int64”。
36
+ :param type: **参数解释:** 主键列的数据类型。 **约束限制:** 不涉及。 **取值范围:** \"String\",“Int64”。 **默认取值:** 不涉及。
37
37
  :type type: str
38
38
  """
39
39
 
@@ -50,7 +50,7 @@ class PrimaryField:
50
50
  def name(self):
51
51
  r"""Gets the name of this PrimaryField.
52
52
 
53
- 指定主键名
53
+ **参数解释:** 指定主键名。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
54
54
 
55
55
  :return: The name of this PrimaryField.
56
56
  :rtype: str
@@ -61,7 +61,7 @@ class PrimaryField:
61
61
  def name(self, name):
62
62
  r"""Sets the name of this PrimaryField.
63
63
 
64
- 指定主键名
64
+ **参数解释:** 指定主键名。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
65
65
 
66
66
  :param name: The name of this PrimaryField.
67
67
  :type name: str
@@ -72,7 +72,7 @@ class PrimaryField:
72
72
  def type(self):
73
73
  r"""Gets the type of this PrimaryField.
74
74
 
75
- 该参数为 \"String\",“Int64”。
75
+ **参数解释:** 主键列的数据类型。 **约束限制:** 不涉及。 **取值范围:** \"String\",“Int64”。 **默认取值:** 不涉及。
76
76
 
77
77
  :return: The type of this PrimaryField.
78
78
  :rtype: str
@@ -83,7 +83,7 @@ class PrimaryField:
83
83
  def type(self, type):
84
84
  r"""Sets the type of this PrimaryField.
85
85
 
86
- 该参数为 \"String\",“Int64”。
86
+ **参数解释:** 主键列的数据类型。 **约束限制:** 不涉及。 **取值范围:** \"String\",“Int64”。 **默认取值:** 不涉及。
87
87
 
88
88
  :param type: The type of this PrimaryField.
89
89
  :type type: str
@@ -39,17 +39,17 @@ class QueryEntitiesBody:
39
39
 
40
40
  The model defined in huaweicloud sdk
41
41
 
42
- :param store_name: 知识仓实例名称
42
+ :param store_name: **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
43
43
  :type store_name: str
44
- :param collection_name: collection名称
44
+ :param collection_name: **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
45
45
  :type collection_name: str
46
- :param output_fields: 配置需返回的字段。
46
+ :param output_fields: **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 当取值为`[\"count(*)\"]`时,top_k必须为负数,表示统计符合条件的entity数量。 **取值范围:** 不涉及。 **默认取值:** `[ ]`,不返回任何额外的字段数据。
47
47
  :type output_fields: list[str]
48
- :param top_k: 返回个数限制
48
+ :param top_k: **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。当取值为负数时,表示返回所有符合条件的数据。 **约束限制:** 与offset取值的总和应小于16384。当output_field为`[\"count(*)\"]`时,top_k必须为负数。 **取值范围:** 小于等于16384 **默认取值:** 10
49
49
  :type top_k: int
50
- :param offset: 搜索结果中要跳过的entity数。
50
+ :param offset: **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
51
51
  :type offset: int
52
- :param filter: 设置过滤表达式。 filter的表达式格式为详见Filter规则
52
+ :param filter: **参数解释:** 用于过滤匹配entity的标量过滤条件。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
53
53
  :type filter: str
54
54
  """
55
55
 
@@ -77,7 +77,7 @@ class QueryEntitiesBody:
77
77
  def store_name(self):
78
78
  r"""Gets the store_name of this QueryEntitiesBody.
79
79
 
80
- 知识仓实例名称
80
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
81
81
 
82
82
  :return: The store_name of this QueryEntitiesBody.
83
83
  :rtype: str
@@ -88,7 +88,7 @@ class QueryEntitiesBody:
88
88
  def store_name(self, store_name):
89
89
  r"""Sets the store_name of this QueryEntitiesBody.
90
90
 
91
- 知识仓实例名称
91
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
92
92
 
93
93
  :param store_name: The store_name of this QueryEntitiesBody.
94
94
  :type store_name: str
@@ -99,7 +99,7 @@ class QueryEntitiesBody:
99
99
  def collection_name(self):
100
100
  r"""Gets the collection_name of this QueryEntitiesBody.
101
101
 
102
- collection名称
102
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
103
103
 
104
104
  :return: The collection_name of this QueryEntitiesBody.
105
105
  :rtype: str
@@ -110,7 +110,7 @@ class QueryEntitiesBody:
110
110
  def collection_name(self, collection_name):
111
111
  r"""Sets the collection_name of this QueryEntitiesBody.
112
112
 
113
- collection名称
113
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
114
114
 
115
115
  :param collection_name: The collection_name of this QueryEntitiesBody.
116
116
  :type collection_name: str
@@ -121,7 +121,7 @@ class QueryEntitiesBody:
121
121
  def output_fields(self):
122
122
  r"""Gets the output_fields of this QueryEntitiesBody.
123
123
 
124
- 配置需返回的字段。
124
+ **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 当取值为`[\"count(*)\"]`时,top_k必须为负数,表示统计符合条件的entity数量。 **取值范围:** 不涉及。 **默认取值:** `[ ]`,不返回任何额外的字段数据。
125
125
 
126
126
  :return: The output_fields of this QueryEntitiesBody.
127
127
  :rtype: list[str]
@@ -132,7 +132,7 @@ class QueryEntitiesBody:
132
132
  def output_fields(self, output_fields):
133
133
  r"""Sets the output_fields of this QueryEntitiesBody.
134
134
 
135
- 配置需返回的字段。
135
+ **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 当取值为`[\"count(*)\"]`时,top_k必须为负数,表示统计符合条件的entity数量。 **取值范围:** 不涉及。 **默认取值:** `[ ]`,不返回任何额外的字段数据。
136
136
 
137
137
  :param output_fields: The output_fields of this QueryEntitiesBody.
138
138
  :type output_fields: list[str]
@@ -143,7 +143,7 @@ class QueryEntitiesBody:
143
143
  def top_k(self):
144
144
  r"""Gets the top_k of this QueryEntitiesBody.
145
145
 
146
- 返回个数限制
146
+ **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。当取值为负数时,表示返回所有符合条件的数据。 **约束限制:** 与offset取值的总和应小于16384。当output_field为`[\"count(*)\"]`时,top_k必须为负数。 **取值范围:** 小于等于16384 **默认取值:** 10
147
147
 
148
148
  :return: The top_k of this QueryEntitiesBody.
149
149
  :rtype: int
@@ -154,7 +154,7 @@ class QueryEntitiesBody:
154
154
  def top_k(self, top_k):
155
155
  r"""Sets the top_k of this QueryEntitiesBody.
156
156
 
157
- 返回个数限制
157
+ **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。当取值为负数时,表示返回所有符合条件的数据。 **约束限制:** 与offset取值的总和应小于16384。当output_field为`[\"count(*)\"]`时,top_k必须为负数。 **取值范围:** 小于等于16384 **默认取值:** 10
158
158
 
159
159
  :param top_k: The top_k of this QueryEntitiesBody.
160
160
  :type top_k: int
@@ -165,7 +165,7 @@ class QueryEntitiesBody:
165
165
  def offset(self):
166
166
  r"""Gets the offset of this QueryEntitiesBody.
167
167
 
168
- 搜索结果中要跳过的entity数。
168
+ **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
169
169
 
170
170
  :return: The offset of this QueryEntitiesBody.
171
171
  :rtype: int
@@ -176,7 +176,7 @@ class QueryEntitiesBody:
176
176
  def offset(self, offset):
177
177
  r"""Sets the offset of this QueryEntitiesBody.
178
178
 
179
- 搜索结果中要跳过的entity数。
179
+ **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
180
180
 
181
181
  :param offset: The offset of this QueryEntitiesBody.
182
182
  :type offset: int
@@ -187,7 +187,7 @@ class QueryEntitiesBody:
187
187
  def filter(self):
188
188
  r"""Gets the filter of this QueryEntitiesBody.
189
189
 
190
- 设置过滤表达式。 filter的表达式格式为详见Filter规则
190
+ **参数解释:** 用于过滤匹配entity的标量过滤条件。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
191
191
 
192
192
  :return: The filter of this QueryEntitiesBody.
193
193
  :rtype: str
@@ -198,7 +198,7 @@ class QueryEntitiesBody:
198
198
  def filter(self, filter):
199
199
  r"""Sets the filter of this QueryEntitiesBody.
200
200
 
201
- 设置过滤表达式。 filter的表达式格式为详见Filter规则
201
+ **参数解释:** 用于过滤匹配entity的标量过滤条件。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
202
202
 
203
203
  :param filter: The filter of this QueryEntitiesBody.
204
204
  :type filter: str
@@ -20,7 +20,7 @@ class QueryEntitiesResponse(SdkResponse):
20
20
  openapi_types = {
21
21
  'code': 'str',
22
22
  'message': 'str',
23
- 'data': 'dict(str, list[dict(str, object)])'
23
+ 'data': 'EntitiesData'
24
24
  }
25
25
 
26
26
  attribute_map = {
@@ -34,12 +34,12 @@ class QueryEntitiesResponse(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
- :param data: 响应数据
42
- :type data: dict(str, list[dict(str, object)])
41
+ :param data:
42
+ :type data: :class:`huaweicloudsdkdwr.v1.EntitiesData`
43
43
  """
44
44
 
45
45
  super(QueryEntitiesResponse, self).__init__()
@@ -60,7 +60,7 @@ class QueryEntitiesResponse(SdkResponse):
60
60
  def code(self):
61
61
  r"""Gets the code of this QueryEntitiesResponse.
62
62
 
63
- 返回码
63
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
64
64
 
65
65
  :return: The code of this QueryEntitiesResponse.
66
66
  :rtype: str
@@ -71,7 +71,7 @@ class QueryEntitiesResponse(SdkResponse):
71
71
  def code(self, code):
72
72
  r"""Sets the code of this QueryEntitiesResponse.
73
73
 
74
- 返回码
74
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :param code: The code of this QueryEntitiesResponse.
77
77
  :type code: str
@@ -82,7 +82,7 @@ class QueryEntitiesResponse(SdkResponse):
82
82
  def message(self):
83
83
  r"""Gets the message of this QueryEntitiesResponse.
84
84
 
85
- 描述信息
85
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :return: The message of this QueryEntitiesResponse.
88
88
  :rtype: str
@@ -93,7 +93,7 @@ class QueryEntitiesResponse(SdkResponse):
93
93
  def message(self, message):
94
94
  r"""Sets the message of this QueryEntitiesResponse.
95
95
 
96
- 描述信息
96
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
97
97
 
98
98
  :param message: The message of this QueryEntitiesResponse.
99
99
  :type message: str
@@ -104,10 +104,8 @@ class QueryEntitiesResponse(SdkResponse):
104
104
  def data(self):
105
105
  r"""Gets the data of this QueryEntitiesResponse.
106
106
 
107
- 响应数据
108
-
109
107
  :return: The data of this QueryEntitiesResponse.
110
- :rtype: dict(str, list[dict(str, object)])
108
+ :rtype: :class:`huaweicloudsdkdwr.v1.EntitiesData`
111
109
  """
112
110
  return self._data
113
111
 
@@ -115,10 +113,8 @@ class QueryEntitiesResponse(SdkResponse):
115
113
  def data(self, data):
116
114
  r"""Sets the data of this QueryEntitiesResponse.
117
115
 
118
- 响应数据
119
-
120
116
  :param data: The data of this QueryEntitiesResponse.
121
- :type data: dict(str, list[dict(str, object)])
117
+ :type data: :class:`huaweicloudsdkdwr.v1.EntitiesData`
122
118
  """
123
119
  self._data = data
124
120
 
@@ -32,9 +32,9 @@ class ReleaseCollectionResponse(SdkResponse):
32
32
 
33
33
  The model defined in huaweicloud sdk
34
34
 
35
- :param code: 返回码
35
+ :param code: **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
36
36
  :type code: str
37
- :param message: 描述信息
37
+ :param message: **参数解释:** 描述信息。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
38
38
  :type message: str
39
39
  """
40
40
 
@@ -53,7 +53,7 @@ class ReleaseCollectionResponse(SdkResponse):
53
53
  def code(self):
54
54
  r"""Gets the code of this ReleaseCollectionResponse.
55
55
 
56
- 返回码
56
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
57
57
 
58
58
  :return: The code of this ReleaseCollectionResponse.
59
59
  :rtype: str
@@ -64,7 +64,7 @@ class ReleaseCollectionResponse(SdkResponse):
64
64
  def code(self, code):
65
65
  r"""Sets the code of this ReleaseCollectionResponse.
66
66
 
67
- 返回码
67
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
68
68
 
69
69
  :param code: The code of this ReleaseCollectionResponse.
70
70
  :type code: str
@@ -75,7 +75,7 @@ class ReleaseCollectionResponse(SdkResponse):
75
75
  def message(self):
76
76
  r"""Gets the message of this ReleaseCollectionResponse.
77
77
 
78
- 描述信息
78
+ **参数解释:** 描述信息。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
79
79
 
80
80
  :return: The message of this ReleaseCollectionResponse.
81
81
  :rtype: str
@@ -86,7 +86,7 @@ class ReleaseCollectionResponse(SdkResponse):
86
86
  def message(self, message):
87
87
  r"""Sets the message of this ReleaseCollectionResponse.
88
88
 
89
- 描述信息
89
+ **参数解释:** 描述信息。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
90
90
 
91
91
  :param message: The message of this ReleaseCollectionResponse.
92
92
  :type message: str
@@ -31,9 +31,9 @@ class Rerank:
31
31
 
32
32
  The model defined in huaweicloud sdk
33
33
 
34
- :param strategy: 重排序的策略选择:1、权重排序weighted;2、rrf 默认:rrf
34
+ :param strategy: **参数解释:** 重排序的策略名称。 **约束限制:** 不涉及 **取值范围:** `[\"weighted\", \"rrf\"]` 默认取值: \"rrf\"
35
35
  :type strategy: str
36
- :param params: 算法参数:1、权重给出各个向量结果权值(0-1);2、rrf给出k值(平滑值),默认60
36
+ :param params: **参数解释:** rerank策略的算法参数。 可以设置的参数: - k:平滑值。(仅对rrf策略生效) - weights:各个向量搜索结果的权值。(仅对weighted策略生效,且当策略为weighted时该参数必填) 重排序的策略名称。 **约束限制:** 不涉及。 **取值范围:** - weights:[0, 1] - k:(0, 16384) **默认取值:** - k60
37
37
  :type params: dict(str, object)
38
38
  """
39
39
 
@@ -51,7 +51,7 @@ class Rerank:
51
51
  def strategy(self):
52
52
  r"""Gets the strategy of this Rerank.
53
53
 
54
- 重排序的策略选择:1、权重排序weighted;2、rrf 默认:rrf
54
+ **参数解释:** 重排序的策略名称。 **约束限制:** 不涉及 **取值范围:** `[\"weighted\", \"rrf\"]` 默认取值: \"rrf\"
55
55
 
56
56
  :return: The strategy of this Rerank.
57
57
  :rtype: str
@@ -62,7 +62,7 @@ class Rerank:
62
62
  def strategy(self, strategy):
63
63
  r"""Sets the strategy of this Rerank.
64
64
 
65
- 重排序的策略选择:1、权重排序weighted;2、rrf 默认:rrf
65
+ **参数解释:** 重排序的策略名称。 **约束限制:** 不涉及 **取值范围:** `[\"weighted\", \"rrf\"]` 默认取值: \"rrf\"
66
66
 
67
67
  :param strategy: The strategy of this Rerank.
68
68
  :type strategy: str
@@ -73,7 +73,7 @@ class Rerank:
73
73
  def params(self):
74
74
  r"""Gets the params of this Rerank.
75
75
 
76
- 算法参数:1、权重给出各个向量结果权值(0-1);2、rrf给出k值(平滑值),默认60
76
+ **参数解释:** rerank策略的算法参数。 可以设置的参数: - k:平滑值。(仅对rrf策略生效) - weights:各个向量搜索结果的权值。(仅对weighted策略生效,且当策略为weighted时该参数必填) 重排序的策略名称。 **约束限制:** 不涉及。 **取值范围:** - weights:[0, 1] - k:(0, 16384) **默认取值:** - k60
77
77
 
78
78
  :return: The params of this Rerank.
79
79
  :rtype: dict(str, object)
@@ -84,7 +84,7 @@ class Rerank:
84
84
  def params(self, params):
85
85
  r"""Sets the params of this Rerank.
86
86
 
87
- 算法参数:1、权重给出各个向量结果权值(0-1);2、rrf给出k值(平滑值),默认60
87
+ **参数解释:** rerank策略的算法参数。 可以设置的参数: - k:平滑值。(仅对rrf策略生效) - weights:各个向量搜索结果的权值。(仅对weighted策略生效,且当策略为weighted时该参数必填) 重排序的策略名称。 **约束限制:** 不涉及。 **取值范围:** - weights:[0, 1] - k:(0, 16384) **默认取值:** - k60
88
88
 
89
89
  :param params: The params of this Rerank.
90
90
  :type params: dict(str, object)