huaweicloudsdkdwr 3.1.181__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.
Files changed (174) hide show
  1. huaweicloudsdkdwr/__init__.py +0 -0
  2. huaweicloudsdkdwr/v1/__init__.py +97 -0
  3. huaweicloudsdkdwr/v1/dwr_async_client.py +1584 -0
  4. huaweicloudsdkdwr/v1/dwr_client.py +1581 -0
  5. huaweicloudsdkdwr/v1/model/__init__.py +94 -0
  6. huaweicloudsdkdwr/v1/model/build_progress.py +224 -0
  7. huaweicloudsdkdwr/v1/model/charge_info.py +223 -0
  8. huaweicloudsdkdwr/v1/model/collection_base_info.py +135 -0
  9. huaweicloudsdkdwr/v1/model/create_collection_body.py +274 -0
  10. huaweicloudsdkdwr/v1/model/create_collection_request.py +104 -0
  11. huaweicloudsdkdwr/v1/model/create_collection_response.py +141 -0
  12. huaweicloudsdkdwr/v1/model/create_index_body.py +159 -0
  13. huaweicloudsdkdwr/v1/model/create_index_request.py +104 -0
  14. huaweicloudsdkdwr/v1/model/create_index_response.py +141 -0
  15. huaweicloudsdkdwr/v1/model/create_store_body.py +241 -0
  16. huaweicloudsdkdwr/v1/model/create_store_data.py +328 -0
  17. huaweicloudsdkdwr/v1/model/create_store_request.py +104 -0
  18. huaweicloudsdkdwr/v1/model/create_store_response.py +166 -0
  19. huaweicloudsdkdwr/v1/model/decribe_collection_data.py +337 -0
  20. huaweicloudsdkdwr/v1/model/delete_collection_request.py +104 -0
  21. huaweicloudsdkdwr/v1/model/delete_collection_response.py +141 -0
  22. huaweicloudsdkdwr/v1/model/delete_entities_body.py +163 -0
  23. huaweicloudsdkdwr/v1/model/delete_entities_request.py +104 -0
  24. huaweicloudsdkdwr/v1/model/delete_entities_response.py +141 -0
  25. huaweicloudsdkdwr/v1/model/delete_index_body.py +163 -0
  26. huaweicloudsdkdwr/v1/model/delete_index_request.py +104 -0
  27. huaweicloudsdkdwr/v1/model/delete_index_response.py +141 -0
  28. huaweicloudsdkdwr/v1/model/delete_store_data.py +107 -0
  29. huaweicloudsdkdwr/v1/model/delete_store_request.py +104 -0
  30. huaweicloudsdkdwr/v1/model/delete_store_response.py +166 -0
  31. huaweicloudsdkdwr/v1/model/describe_collection_request.py +104 -0
  32. huaweicloudsdkdwr/v1/model/describe_collection_response.py +166 -0
  33. huaweicloudsdkdwr/v1/model/describe_index_body.py +163 -0
  34. huaweicloudsdkdwr/v1/model/describe_index_data.py +159 -0
  35. huaweicloudsdkdwr/v1/model/describe_index_request.py +104 -0
  36. huaweicloudsdkdwr/v1/model/describe_index_response.py +166 -0
  37. huaweicloudsdkdwr/v1/model/describe_job_body.py +107 -0
  38. huaweicloudsdkdwr/v1/model/describe_job_request.py +104 -0
  39. huaweicloudsdkdwr/v1/model/describe_job_response.py +166 -0
  40. huaweicloudsdkdwr/v1/model/describe_store_request.py +104 -0
  41. huaweicloudsdkdwr/v1/model/describe_store_response.py +166 -0
  42. huaweicloudsdkdwr/v1/model/entities_data.py +107 -0
  43. huaweicloudsdkdwr/v1/model/field.py +222 -0
  44. huaweicloudsdkdwr/v1/model/field_data.py +278 -0
  45. huaweicloudsdkdwr/v1/model/flavor.py +135 -0
  46. huaweicloudsdkdwr/v1/model/get_index_progress_body.py +163 -0
  47. huaweicloudsdkdwr/v1/model/get_progress_data.py +160 -0
  48. huaweicloudsdkdwr/v1/model/get_progress_request.py +104 -0
  49. huaweicloudsdkdwr/v1/model/get_progress_response.py +166 -0
  50. huaweicloudsdkdwr/v1/model/hybrid_search_body.py +275 -0
  51. huaweicloudsdkdwr/v1/model/hybrid_search_request.py +104 -0
  52. huaweicloudsdkdwr/v1/model/hybrid_search_response.py +166 -0
  53. huaweicloudsdkdwr/v1/model/index_desc.py +191 -0
  54. huaweicloudsdkdwr/v1/model/index_params.py +164 -0
  55. huaweicloudsdkdwr/v1/model/insert_entities_body.py +163 -0
  56. huaweicloudsdkdwr/v1/model/insert_entities_data.py +136 -0
  57. huaweicloudsdkdwr/v1/model/insert_entities_request.py +104 -0
  58. huaweicloudsdkdwr/v1/model/insert_entities_response.py +166 -0
  59. huaweicloudsdkdwr/v1/model/job_data.py +309 -0
  60. huaweicloudsdkdwr/v1/model/list_collection_data.py +136 -0
  61. huaweicloudsdkdwr/v1/model/list_collection_details.py +253 -0
  62. huaweicloudsdkdwr/v1/model/list_collections_body.py +136 -0
  63. huaweicloudsdkdwr/v1/model/list_collections_request.py +104 -0
  64. huaweicloudsdkdwr/v1/model/list_collections_response.py +166 -0
  65. huaweicloudsdkdwr/v1/model/list_jobs_data.py +108 -0
  66. huaweicloudsdkdwr/v1/model/list_jobs_request.py +224 -0
  67. huaweicloudsdkdwr/v1/model/list_jobs_response.py +166 -0
  68. huaweicloudsdkdwr/v1/model/list_store_data.py +107 -0
  69. huaweicloudsdkdwr/v1/model/list_stores_request.py +77 -0
  70. huaweicloudsdkdwr/v1/model/list_stores_response.py +166 -0
  71. huaweicloudsdkdwr/v1/model/load_collection_body.py +135 -0
  72. huaweicloudsdkdwr/v1/model/load_collection_request.py +104 -0
  73. huaweicloudsdkdwr/v1/model/load_collection_response.py +141 -0
  74. huaweicloudsdkdwr/v1/model/primary_field.py +135 -0
  75. huaweicloudsdkdwr/v1/model/query_entities_body.py +250 -0
  76. huaweicloudsdkdwr/v1/model/query_entities_request.py +104 -0
  77. huaweicloudsdkdwr/v1/model/query_entities_response.py +166 -0
  78. huaweicloudsdkdwr/v1/model/release_collection_request.py +104 -0
  79. huaweicloudsdkdwr/v1/model/release_collection_response.py +141 -0
  80. huaweicloudsdkdwr/v1/model/rerank.py +136 -0
  81. huaweicloudsdkdwr/v1/model/scale_store_body.py +135 -0
  82. huaweicloudsdkdwr/v1/model/scale_store_data.py +220 -0
  83. huaweicloudsdkdwr/v1/model/scale_store_request.py +104 -0
  84. huaweicloudsdkdwr/v1/model/scale_store_response.py +166 -0
  85. huaweicloudsdkdwr/v1/model/search_entities_body.py +336 -0
  86. huaweicloudsdkdwr/v1/model/search_entities_request.py +104 -0
  87. huaweicloudsdkdwr/v1/model/search_entities_response.py +166 -0
  88. huaweicloudsdkdwr/v1/model/store_data.py +357 -0
  89. huaweicloudsdkdwr/v1/model/store_info.py +107 -0
  90. huaweicloudsdkdwr/v1/model/sub_search.py +251 -0
  91. huaweicloudsdkdwr/v1/model/upsert_entities_body.py +163 -0
  92. huaweicloudsdkdwr/v1/model/upsert_entities_data.py +135 -0
  93. huaweicloudsdkdwr/v1/model/upsert_entities_request.py +104 -0
  94. huaweicloudsdkdwr/v1/model/upsert_entities_response.py +166 -0
  95. huaweicloudsdkdwr/v1/region/__init__.py +0 -0
  96. huaweicloudsdkdwr/v1/region/dwr_region.py +43 -0
  97. huaweicloudsdkdwr/v3/__init__.py +76 -0
  98. huaweicloudsdkdwr/v3/dwr_async_client.py +1622 -0
  99. huaweicloudsdkdwr/v3/dwr_client.py +1619 -0
  100. huaweicloudsdkdwr/v3/model/__init__.py +73 -0
  101. huaweicloudsdkdwr/v3/model/accept_service_contract_request.py +107 -0
  102. huaweicloudsdkdwr/v3/model/accept_service_contract_response.py +133 -0
  103. huaweicloudsdkdwr/v3/model/action.py +420 -0
  104. huaweicloudsdkdwr/v3/model/action_result.py +221 -0
  105. huaweicloudsdkdwr/v3/model/action_template_item.py +137 -0
  106. huaweicloudsdkdwr/v3/model/async_invoke_api_start_workflow_request.py +132 -0
  107. huaweicloudsdkdwr/v3/model/async_invoke_api_start_workflow_response.py +270 -0
  108. huaweicloudsdkdwr/v3/model/check_workflow_authentication_request.py +77 -0
  109. huaweicloudsdkdwr/v3/model/check_workflow_authentication_response.py +473 -0
  110. huaweicloudsdkdwr/v3/model/create_my_action_template_request.py +132 -0
  111. huaweicloudsdkdwr/v3/model/create_my_action_template_response.py +415 -0
  112. huaweicloudsdkdwr/v3/model/create_workflow_authentication_request.py +77 -0
  113. huaweicloudsdkdwr/v3/model/create_workflow_authentication_response.py +133 -0
  114. huaweicloudsdkdwr/v3/model/create_workflow_request.py +132 -0
  115. huaweicloudsdkdwr/v3/model/create_workflow_request_body.py +274 -0
  116. huaweicloudsdkdwr/v3/model/create_workflow_response.py +270 -0
  117. huaweicloudsdkdwr/v3/model/delete_my_action_template_request.py +107 -0
  118. huaweicloudsdkdwr/v3/model/delete_my_action_template_response.py +133 -0
  119. huaweicloudsdkdwr/v3/model/delete_workflow_request.py +107 -0
  120. huaweicloudsdkdwr/v3/model/delete_workflow_response.py +133 -0
  121. huaweicloudsdkdwr/v3/model/execute_workflow_body.py +160 -0
  122. huaweicloudsdkdwr/v3/model/execution.py +282 -0
  123. huaweicloudsdkdwr/v3/model/express_config.py +137 -0
  124. huaweicloudsdkdwr/v3/model/func_vpc.py +253 -0
  125. huaweicloudsdkdwr/v3/model/graph_item.py +195 -0
  126. huaweicloudsdkdwr/v3/model/input.py +367 -0
  127. huaweicloudsdkdwr/v3/model/input_para_type.py +77 -0
  128. huaweicloudsdkdwr/v3/model/input_para_value_type.py +77 -0
  129. huaweicloudsdkdwr/v3/model/list_my_action_template_request.py +224 -0
  130. huaweicloudsdkdwr/v3/model/list_my_action_template_response.py +299 -0
  131. huaweicloudsdkdwr/v3/model/list_system_templates_request.py +195 -0
  132. huaweicloudsdkdwr/v3/model/list_system_templates_response.py +328 -0
  133. huaweicloudsdkdwr/v3/model/list_workflow_instance_request.py +252 -0
  134. huaweicloudsdkdwr/v3/model/list_workflow_instance_response.py +299 -0
  135. huaweicloudsdkdwr/v3/model/list_workflows_request.py +166 -0
  136. huaweicloudsdkdwr/v3/model/list_workflows_response.py +299 -0
  137. huaweicloudsdkdwr/v3/model/node_execution.py +282 -0
  138. huaweicloudsdkdwr/v3/model/policy.py +137 -0
  139. huaweicloudsdkdwr/v3/model/provided_action.py +561 -0
  140. huaweicloudsdkdwr/v3/model/public_template_item.py +282 -0
  141. huaweicloudsdkdwr/v3/model/public_template_register_type.py +77 -0
  142. huaweicloudsdkdwr/v3/model/restore_workflow_execution_request.py +135 -0
  143. huaweicloudsdkdwr/v3/model/restore_workflow_execution_response.py +270 -0
  144. huaweicloudsdkdwr/v3/model/show_public_action_list_request.py +195 -0
  145. huaweicloudsdkdwr/v3/model/show_public_action_list_response.py +328 -0
  146. huaweicloudsdkdwr/v3/model/show_public_template_info_request.py +107 -0
  147. huaweicloudsdkdwr/v3/model/show_public_template_info_response.py +208 -0
  148. huaweicloudsdkdwr/v3/model/show_service_contract_request.py +107 -0
  149. huaweicloudsdkdwr/v3/model/show_service_contract_response.py +241 -0
  150. huaweicloudsdkdwr/v3/model/show_system_template_detail_request.py +107 -0
  151. huaweicloudsdkdwr/v3/model/show_system_template_detail_response.py +208 -0
  152. huaweicloudsdkdwr/v3/model/show_third_template_info_request.py +107 -0
  153. huaweicloudsdkdwr/v3/model/show_third_template_info_response.py +208 -0
  154. huaweicloudsdkdwr/v3/model/show_workflow_info_request.py +107 -0
  155. huaweicloudsdkdwr/v3/model/show_workflow_info_response.py +328 -0
  156. huaweicloudsdkdwr/v3/model/show_workflow_instance_request.py +135 -0
  157. huaweicloudsdkdwr/v3/model/show_workflow_instance_response.py +531 -0
  158. huaweicloudsdkdwr/v3/model/state.py +338 -0
  159. huaweicloudsdkdwr/v3/model/statement.py +137 -0
  160. huaweicloudsdkdwr/v3/model/third_action_template_item.py +282 -0
  161. huaweicloudsdkdwr/v3/model/third_template_request_body.py +423 -0
  162. huaweicloudsdkdwr/v3/model/update_my_action_template_request.py +132 -0
  163. huaweicloudsdkdwr/v3/model/update_my_action_template_response.py +270 -0
  164. huaweicloudsdkdwr/v3/model/update_my_action_template_to_deprecated_request.py +107 -0
  165. huaweicloudsdkdwr/v3/model/update_my_action_template_to_deprecated_response.py +133 -0
  166. huaweicloudsdkdwr/v3/model/update_workflow_body.py +108 -0
  167. huaweicloudsdkdwr/v3/model/update_workflow_request.py +132 -0
  168. huaweicloudsdkdwr/v3/model/update_workflow_response.py +270 -0
  169. huaweicloudsdkdwr/v3/region/__init__.py +0 -0
  170. huaweicloudsdkdwr/v3/region/dwr_region.py +43 -0
  171. huaweicloudsdkdwr-3.1.181.dist-info/METADATA +25 -0
  172. huaweicloudsdkdwr-3.1.181.dist-info/RECORD +174 -0
  173. huaweicloudsdkdwr-3.1.181.dist-info/WHEEL +4 -0
  174. huaweicloudsdkdwr-3.1.181.dist-info/licenses/LICENSE +13 -0
@@ -0,0 +1,336 @@
1
+ # coding: utf-8
2
+
3
+ from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
4
+
5
+
6
+ class SearchEntitiesBody:
7
+
8
+ """
9
+ Attributes:
10
+ openapi_types (dict): The key is attribute name
11
+ and the value is attribute type.
12
+ attribute_map (dict): The key is attribute name
13
+ and the value is json key in definition.
14
+ """
15
+ sensitive_list = []
16
+
17
+ openapi_types = {
18
+ 'store_name': 'str',
19
+ 'collection_name': 'str',
20
+ 'output_fields': 'list[str]',
21
+ 'top_k': 'int',
22
+ 'offset': 'int',
23
+ 'filter': 'str',
24
+ 'vector': 'list[float]',
25
+ 'vector_field': 'str',
26
+ 'params': 'dict(str, object)'
27
+ }
28
+
29
+ attribute_map = {
30
+ 'store_name': 'store_name',
31
+ 'collection_name': 'collection_name',
32
+ 'output_fields': 'output_fields',
33
+ 'top_k': 'top_k',
34
+ 'offset': 'offset',
35
+ 'filter': 'filter',
36
+ 'vector': 'vector',
37
+ 'vector_field': 'vector_field',
38
+ 'params': 'params'
39
+ }
40
+
41
+ def __init__(self, store_name=None, collection_name=None, output_fields=None, top_k=None, offset=None, filter=None, vector=None, vector_field=None, params=None):
42
+ r"""SearchEntitiesBody
43
+
44
+ The model defined in huaweicloud sdk
45
+
46
+ :param store_name: **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
47
+ :type store_name: str
48
+ :param collection_name: **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线( _ ),大小写敏感。第一个字符只能够是下划线( _ )和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
49
+ :type collection_name: str
50
+ :param output_fields: **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** [ ],不返回任何额外的字段数据。
51
+ :type output_fields: list[str]
52
+ :param top_k: **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 与offset取值的总和应小于16384。 **取值范围:** `[1, 16384]` **默认取值:** 10
53
+ :type top_k: int
54
+ :param offset: **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
55
+ :type offset: int
56
+ :param filter: **参数解释:** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 空字符串,不进行标量过滤。
57
+ :type filter: str
58
+ :param vector: **参数解释:** 要搜索的向量字段数据。 **约束限制:** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
59
+ :type vector: list[float]
60
+ :param vector_field: **参数解释:** 要搜索的向量字段名称。 **约束限制:** 必须是collection field schema中存在的向量字段名称。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
61
+ :type vector_field: str
62
+ :param params: **参数解释:** 额外的搜索参数配置。 可以配置的参数: - ef: 每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。(仅对HNSW索引类型生效) - search_list: 候选列表的大小,越大召回率越高,但性能会下降。(仅对HANNS索引类型生效) - radius:向量相似度范围查询的外圈半径,若指定则进行相似度范围查询。 - range_filter: 向量相似度范围查询的内圈半径,向量相似度查询将过滤与查询相似度或距离在radius和range_filter参数范围内的所有向量。仅当指定radius时,该参数才生效,进行相似度范围查询时,建议根据metric_type指定该参数。 对于距离metric,如L2,范围搜索将搜索距离在[range_filter, radius)范围内的向量,如果range_filter未指定则搜索距离在[0, radius)范围内的向量。 对于相似度metric,如IP和COSINE,范围搜索将搜索相似度在(radius, range_filter]范围内的向量,如果range_filter未指定则分别搜索相似度在(radius, +∞]和(radius, 1.0]范围内的向量。 **约束限制:** 不涉及。 **取值范围:** ef: [top_k + offset, int32_max] search_list: [top_k + offset, int32_max] **默认取值:** ef: top_k + offset search_list: topk_k + offset
63
+ :type params: dict(str, object)
64
+ """
65
+
66
+
67
+
68
+ self._store_name = None
69
+ self._collection_name = None
70
+ self._output_fields = None
71
+ self._top_k = None
72
+ self._offset = None
73
+ self._filter = None
74
+ self._vector = None
75
+ self._vector_field = None
76
+ self._params = None
77
+ self.discriminator = None
78
+
79
+ self.store_name = store_name
80
+ self.collection_name = collection_name
81
+ if output_fields is not None:
82
+ self.output_fields = output_fields
83
+ if top_k is not None:
84
+ self.top_k = top_k
85
+ if offset is not None:
86
+ self.offset = offset
87
+ if filter is not None:
88
+ self.filter = filter
89
+ self.vector = vector
90
+ self.vector_field = vector_field
91
+ if params is not None:
92
+ self.params = params
93
+
94
+ @property
95
+ def store_name(self):
96
+ r"""Gets the store_name of this SearchEntitiesBody.
97
+
98
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
99
+
100
+ :return: The store_name of this SearchEntitiesBody.
101
+ :rtype: str
102
+ """
103
+ return self._store_name
104
+
105
+ @store_name.setter
106
+ def store_name(self, store_name):
107
+ r"""Sets the store_name of this SearchEntitiesBody.
108
+
109
+ **参数解释:** 知识仓实例名称,region内唯一。 **约束限制:** 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
110
+
111
+ :param store_name: The store_name of this SearchEntitiesBody.
112
+ :type store_name: str
113
+ """
114
+ self._store_name = store_name
115
+
116
+ @property
117
+ def collection_name(self):
118
+ r"""Gets the collection_name of this SearchEntitiesBody.
119
+
120
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线( _ ),大小写敏感。第一个字符只能够是下划线( _ )和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
121
+
122
+ :return: The collection_name of this SearchEntitiesBody.
123
+ :rtype: str
124
+ """
125
+ return self._collection_name
126
+
127
+ @collection_name.setter
128
+ def collection_name(self, collection_name):
129
+ r"""Sets the collection_name of this SearchEntitiesBody.
130
+
131
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线( _ ),大小写敏感。第一个字符只能够是下划线( _ )和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
132
+
133
+ :param collection_name: The collection_name of this SearchEntitiesBody.
134
+ :type collection_name: str
135
+ """
136
+ self._collection_name = collection_name
137
+
138
+ @property
139
+ def output_fields(self):
140
+ r"""Gets the output_fields of this SearchEntitiesBody.
141
+
142
+ **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** [ ],不返回任何额外的字段数据。
143
+
144
+ :return: The output_fields of this SearchEntitiesBody.
145
+ :rtype: list[str]
146
+ """
147
+ return self._output_fields
148
+
149
+ @output_fields.setter
150
+ def output_fields(self, output_fields):
151
+ r"""Sets the output_fields of this SearchEntitiesBody.
152
+
153
+ **参数解释:** field名称列表,配置需与搜索结果一起返回的字段。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** [ ],不返回任何额外的字段数据。
154
+
155
+ :param output_fields: The output_fields of this SearchEntitiesBody.
156
+ :type output_fields: list[str]
157
+ """
158
+ self._output_fields = output_fields
159
+
160
+ @property
161
+ def top_k(self):
162
+ r"""Gets the top_k of this SearchEntitiesBody.
163
+
164
+ **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 与offset取值的总和应小于16384。 **取值范围:** `[1, 16384]` **默认取值:** 10
165
+
166
+ :return: The top_k of this SearchEntitiesBody.
167
+ :rtype: int
168
+ """
169
+ return self._top_k
170
+
171
+ @top_k.setter
172
+ def top_k(self, top_k):
173
+ r"""Sets the top_k of this SearchEntitiesBody.
174
+
175
+ **参数解释:** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制:** 与offset取值的总和应小于16384。 **取值范围:** `[1, 16384]` **默认取值:** 10
176
+
177
+ :param top_k: The top_k of this SearchEntitiesBody.
178
+ :type top_k: int
179
+ """
180
+ self._top_k = top_k
181
+
182
+ @property
183
+ def offset(self):
184
+ r"""Gets the offset of this SearchEntitiesBody.
185
+
186
+ **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
187
+
188
+ :return: The offset of this SearchEntitiesBody.
189
+ :rtype: int
190
+ """
191
+ return self._offset
192
+
193
+ @offset.setter
194
+ def offset(self, offset):
195
+ r"""Sets the offset of this SearchEntitiesBody.
196
+
197
+ **参数解释:** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制:** 与top_k取值的总和应小于16384。 **取值范围:** 大于等于0 **默认取值:** 0
198
+
199
+ :param offset: The offset of this SearchEntitiesBody.
200
+ :type offset: int
201
+ """
202
+ self._offset = offset
203
+
204
+ @property
205
+ def filter(self):
206
+ r"""Gets the filter of this SearchEntitiesBody.
207
+
208
+ **参数解释:** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 空字符串,不进行标量过滤。
209
+
210
+ :return: The filter of this SearchEntitiesBody.
211
+ :rtype: str
212
+ """
213
+ return self._filter
214
+
215
+ @filter.setter
216
+ def filter(self, filter):
217
+ r"""Sets the filter of this SearchEntitiesBody.
218
+
219
+ **参数解释:** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制:** 要构建标量过滤条件,请参阅filter表达式规则。 **取值范围:** 不涉及。 **默认取值:** 空字符串,不进行标量过滤。
220
+
221
+ :param filter: The filter of this SearchEntitiesBody.
222
+ :type filter: str
223
+ """
224
+ self._filter = filter
225
+
226
+ @property
227
+ def vector(self):
228
+ r"""Gets the vector of this SearchEntitiesBody.
229
+
230
+ **参数解释:** 要搜索的向量字段数据。 **约束限制:** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
231
+
232
+ :return: The vector of this SearchEntitiesBody.
233
+ :rtype: list[float]
234
+ """
235
+ return self._vector
236
+
237
+ @vector.setter
238
+ def vector(self, vector):
239
+ r"""Sets the vector of this SearchEntitiesBody.
240
+
241
+ **参数解释:** 要搜索的向量字段数据。 **约束限制:** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
242
+
243
+ :param vector: The vector of this SearchEntitiesBody.
244
+ :type vector: list[float]
245
+ """
246
+ self._vector = vector
247
+
248
+ @property
249
+ def vector_field(self):
250
+ r"""Gets the vector_field of this SearchEntitiesBody.
251
+
252
+ **参数解释:** 要搜索的向量字段名称。 **约束限制:** 必须是collection field schema中存在的向量字段名称。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
253
+
254
+ :return: The vector_field of this SearchEntitiesBody.
255
+ :rtype: str
256
+ """
257
+ return self._vector_field
258
+
259
+ @vector_field.setter
260
+ def vector_field(self, vector_field):
261
+ r"""Sets the vector_field of this SearchEntitiesBody.
262
+
263
+ **参数解释:** 要搜索的向量字段名称。 **约束限制:** 必须是collection field schema中存在的向量字段名称。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
264
+
265
+ :param vector_field: The vector_field of this SearchEntitiesBody.
266
+ :type vector_field: str
267
+ """
268
+ self._vector_field = vector_field
269
+
270
+ @property
271
+ def params(self):
272
+ r"""Gets the params of this SearchEntitiesBody.
273
+
274
+ **参数解释:** 额外的搜索参数配置。 可以配置的参数: - ef: 每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。(仅对HNSW索引类型生效) - search_list: 候选列表的大小,越大召回率越高,但性能会下降。(仅对HANNS索引类型生效) - radius:向量相似度范围查询的外圈半径,若指定则进行相似度范围查询。 - range_filter: 向量相似度范围查询的内圈半径,向量相似度查询将过滤与查询相似度或距离在radius和range_filter参数范围内的所有向量。仅当指定radius时,该参数才生效,进行相似度范围查询时,建议根据metric_type指定该参数。 对于距离metric,如L2,范围搜索将搜索距离在[range_filter, radius)范围内的向量,如果range_filter未指定则搜索距离在[0, radius)范围内的向量。 对于相似度metric,如IP和COSINE,范围搜索将搜索相似度在(radius, range_filter]范围内的向量,如果range_filter未指定则分别搜索相似度在(radius, +∞]和(radius, 1.0]范围内的向量。 **约束限制:** 不涉及。 **取值范围:** ef: [top_k + offset, int32_max] search_list: [top_k + offset, int32_max] **默认取值:** ef: top_k + offset search_list: topk_k + offset
275
+
276
+ :return: The params of this SearchEntitiesBody.
277
+ :rtype: dict(str, object)
278
+ """
279
+ return self._params
280
+
281
+ @params.setter
282
+ def params(self, params):
283
+ r"""Sets the params of this SearchEntitiesBody.
284
+
285
+ **参数解释:** 额外的搜索参数配置。 可以配置的参数: - ef: 每个查询的邻居候选集大小。候选集越大,搜索的精度越高,但是搜索时间也会随之增加。(仅对HNSW索引类型生效) - search_list: 候选列表的大小,越大召回率越高,但性能会下降。(仅对HANNS索引类型生效) - radius:向量相似度范围查询的外圈半径,若指定则进行相似度范围查询。 - range_filter: 向量相似度范围查询的内圈半径,向量相似度查询将过滤与查询相似度或距离在radius和range_filter参数范围内的所有向量。仅当指定radius时,该参数才生效,进行相似度范围查询时,建议根据metric_type指定该参数。 对于距离metric,如L2,范围搜索将搜索距离在[range_filter, radius)范围内的向量,如果range_filter未指定则搜索距离在[0, radius)范围内的向量。 对于相似度metric,如IP和COSINE,范围搜索将搜索相似度在(radius, range_filter]范围内的向量,如果range_filter未指定则分别搜索相似度在(radius, +∞]和(radius, 1.0]范围内的向量。 **约束限制:** 不涉及。 **取值范围:** ef: [top_k + offset, int32_max] search_list: [top_k + offset, int32_max] **默认取值:** ef: top_k + offset search_list: topk_k + offset
286
+
287
+ :param params: The params of this SearchEntitiesBody.
288
+ :type params: dict(str, object)
289
+ """
290
+ self._params = params
291
+
292
+ def to_dict(self):
293
+ result = {}
294
+
295
+ for attr, _ in self.openapi_types.items():
296
+ value = getattr(self, attr)
297
+ if isinstance(value, list):
298
+ result[attr] = list(map(
299
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
300
+ value
301
+ ))
302
+ elif hasattr(value, "to_dict"):
303
+ result[attr] = value.to_dict()
304
+ elif isinstance(value, dict):
305
+ result[attr] = dict(map(
306
+ lambda item: (item[0], item[1].to_dict())
307
+ if hasattr(item[1], "to_dict") else item,
308
+ value.items()
309
+ ))
310
+ else:
311
+ if attr in self.sensitive_list:
312
+ result[attr] = "****"
313
+ else:
314
+ result[attr] = value
315
+
316
+ return result
317
+
318
+ def to_str(self):
319
+ """Returns the string representation of the model"""
320
+ import simplejson as json
321
+ return json.dumps(sanitize_for_serialization(self), ensure_ascii=False)
322
+
323
+ def __repr__(self):
324
+ """For `print`"""
325
+ return self.to_str()
326
+
327
+ def __eq__(self, other):
328
+ """Returns true if both objects are equal"""
329
+ if not isinstance(other, SearchEntitiesBody):
330
+ return False
331
+
332
+ return self.__dict__ == other.__dict__
333
+
334
+ def __ne__(self, other):
335
+ """Returns true if both objects are not equal"""
336
+ return not self == other
@@ -0,0 +1,104 @@
1
+ # coding: utf-8
2
+
3
+ from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
4
+
5
+
6
+ class SearchEntitiesRequest:
7
+
8
+ """
9
+ Attributes:
10
+ openapi_types (dict): The key is attribute name
11
+ and the value is attribute type.
12
+ attribute_map (dict): The key is attribute name
13
+ and the value is json key in definition.
14
+ """
15
+ sensitive_list = []
16
+
17
+ openapi_types = {
18
+ 'body': 'SearchEntitiesBody'
19
+ }
20
+
21
+ attribute_map = {
22
+ 'body': 'body'
23
+ }
24
+
25
+ def __init__(self, body=None):
26
+ r"""SearchEntitiesRequest
27
+
28
+ The model defined in huaweicloud sdk
29
+
30
+ :param body: Body of the SearchEntitiesRequest
31
+ :type body: :class:`huaweicloudsdkdwr.v1.SearchEntitiesBody`
32
+ """
33
+
34
+
35
+
36
+ self._body = None
37
+ self.discriminator = None
38
+
39
+ if body is not None:
40
+ self.body = body
41
+
42
+ @property
43
+ def body(self):
44
+ r"""Gets the body of this SearchEntitiesRequest.
45
+
46
+ :return: The body of this SearchEntitiesRequest.
47
+ :rtype: :class:`huaweicloudsdkdwr.v1.SearchEntitiesBody`
48
+ """
49
+ return self._body
50
+
51
+ @body.setter
52
+ def body(self, body):
53
+ r"""Sets the body of this SearchEntitiesRequest.
54
+
55
+ :param body: The body of this SearchEntitiesRequest.
56
+ :type body: :class:`huaweicloudsdkdwr.v1.SearchEntitiesBody`
57
+ """
58
+ self._body = body
59
+
60
+ def to_dict(self):
61
+ result = {}
62
+
63
+ for attr, _ in self.openapi_types.items():
64
+ value = getattr(self, attr)
65
+ if isinstance(value, list):
66
+ result[attr] = list(map(
67
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
68
+ value
69
+ ))
70
+ elif hasattr(value, "to_dict"):
71
+ result[attr] = value.to_dict()
72
+ elif isinstance(value, dict):
73
+ result[attr] = dict(map(
74
+ lambda item: (item[0], item[1].to_dict())
75
+ if hasattr(item[1], "to_dict") else item,
76
+ value.items()
77
+ ))
78
+ else:
79
+ if attr in self.sensitive_list:
80
+ result[attr] = "****"
81
+ else:
82
+ result[attr] = value
83
+
84
+ return result
85
+
86
+ def to_str(self):
87
+ """Returns the string representation of the model"""
88
+ import simplejson as json
89
+ return json.dumps(sanitize_for_serialization(self), ensure_ascii=False)
90
+
91
+ def __repr__(self):
92
+ """For `print`"""
93
+ return self.to_str()
94
+
95
+ def __eq__(self, other):
96
+ """Returns true if both objects are equal"""
97
+ if not isinstance(other, SearchEntitiesRequest):
98
+ return False
99
+
100
+ return self.__dict__ == other.__dict__
101
+
102
+ def __ne__(self, other):
103
+ """Returns true if both objects are not equal"""
104
+ return not self == other
@@ -0,0 +1,166 @@
1
+ # coding: utf-8
2
+
3
+ from huaweicloudsdkcore.sdk_response import SdkResponse
4
+ from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
5
+
6
+
7
+ class SearchEntitiesResponse(SdkResponse):
8
+
9
+ """
10
+ Attributes:
11
+ openapi_types (dict): The key is attribute name
12
+ and the value is attribute type.
13
+ attribute_map (dict): The key is attribute name
14
+ and the value is json key in definition.
15
+ """
16
+ sensitive_list = []
17
+
18
+ openapi_types = {
19
+ 'code': 'str',
20
+ 'message': 'str',
21
+ 'data': 'EntitiesData'
22
+ }
23
+
24
+ attribute_map = {
25
+ 'code': 'code',
26
+ 'message': 'message',
27
+ 'data': 'data'
28
+ }
29
+
30
+ def __init__(self, code=None, message=None, data=None):
31
+ r"""SearchEntitiesResponse
32
+
33
+ The model defined in huaweicloud sdk
34
+
35
+ :param code: **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
36
+ :type code: str
37
+ :param message: **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
38
+ :type message: str
39
+ :param data:
40
+ :type data: :class:`huaweicloudsdkdwr.v1.EntitiesData`
41
+ """
42
+
43
+ super().__init__()
44
+
45
+ self._code = None
46
+ self._message = None
47
+ self._data = None
48
+ self.discriminator = None
49
+
50
+ if code is not None:
51
+ self.code = code
52
+ if message is not None:
53
+ self.message = message
54
+ if data is not None:
55
+ self.data = data
56
+
57
+ @property
58
+ def code(self):
59
+ r"""Gets the code of this SearchEntitiesResponse.
60
+
61
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
62
+
63
+ :return: The code of this SearchEntitiesResponse.
64
+ :rtype: str
65
+ """
66
+ return self._code
67
+
68
+ @code.setter
69
+ def code(self, code):
70
+ r"""Sets the code of this SearchEntitiesResponse.
71
+
72
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
73
+
74
+ :param code: The code of this SearchEntitiesResponse.
75
+ :type code: str
76
+ """
77
+ self._code = code
78
+
79
+ @property
80
+ def message(self):
81
+ r"""Gets the message of this SearchEntitiesResponse.
82
+
83
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
84
+
85
+ :return: The message of this SearchEntitiesResponse.
86
+ :rtype: str
87
+ """
88
+ return self._message
89
+
90
+ @message.setter
91
+ def message(self, message):
92
+ r"""Sets the message of this SearchEntitiesResponse.
93
+
94
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
95
+
96
+ :param message: The message of this SearchEntitiesResponse.
97
+ :type message: str
98
+ """
99
+ self._message = message
100
+
101
+ @property
102
+ def data(self):
103
+ r"""Gets the data of this SearchEntitiesResponse.
104
+
105
+ :return: The data of this SearchEntitiesResponse.
106
+ :rtype: :class:`huaweicloudsdkdwr.v1.EntitiesData`
107
+ """
108
+ return self._data
109
+
110
+ @data.setter
111
+ def data(self, data):
112
+ r"""Sets the data of this SearchEntitiesResponse.
113
+
114
+ :param data: The data of this SearchEntitiesResponse.
115
+ :type data: :class:`huaweicloudsdkdwr.v1.EntitiesData`
116
+ """
117
+ self._data = data
118
+
119
+ def to_dict(self):
120
+ import warnings
121
+ warnings.warn("SearchEntitiesResponse.to_dict() is deprecated and no longer maintained, "
122
+ "use to_json_object() to get the response content.", DeprecationWarning)
123
+ result = {}
124
+
125
+ for attr, _ in self.openapi_types.items():
126
+ value = getattr(self, attr)
127
+ if isinstance(value, list):
128
+ result[attr] = list(map(
129
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
130
+ value
131
+ ))
132
+ elif hasattr(value, "to_dict"):
133
+ result[attr] = value.to_dict()
134
+ elif isinstance(value, dict):
135
+ result[attr] = dict(map(
136
+ lambda item: (item[0], item[1].to_dict())
137
+ if hasattr(item[1], "to_dict") else item,
138
+ value.items()
139
+ ))
140
+ else:
141
+ if attr in self.sensitive_list:
142
+ result[attr] = "****"
143
+ else:
144
+ result[attr] = value
145
+
146
+ return result
147
+
148
+ def to_str(self):
149
+ """Returns the string representation of the model"""
150
+ import simplejson as json
151
+ return json.dumps(sanitize_for_serialization(self), ensure_ascii=False)
152
+
153
+ def __repr__(self):
154
+ """For `print`"""
155
+ return self.to_str()
156
+
157
+ def __eq__(self, other):
158
+ """Returns true if both objects are equal"""
159
+ if not isinstance(other, SearchEntitiesResponse):
160
+ return False
161
+
162
+ return self.__dict__ == other.__dict__
163
+
164
+ def __ne__(self, other):
165
+ """Returns true if both objects are not equal"""
166
+ return not self == other