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,7 +20,7 @@ class HybridSearchResponse(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 HybridSearchResponse(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(HybridSearchResponse, self).__init__()
@@ -60,7 +60,7 @@ class HybridSearchResponse(SdkResponse):
60
60
  def code(self):
61
61
  r"""Gets the code of this HybridSearchResponse.
62
62
 
63
- 返回码
63
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
64
64
 
65
65
  :return: The code of this HybridSearchResponse.
66
66
  :rtype: str
@@ -71,7 +71,7 @@ class HybridSearchResponse(SdkResponse):
71
71
  def code(self, code):
72
72
  r"""Sets the code of this HybridSearchResponse.
73
73
 
74
- 返回码
74
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :param code: The code of this HybridSearchResponse.
77
77
  :type code: str
@@ -82,7 +82,7 @@ class HybridSearchResponse(SdkResponse):
82
82
  def message(self):
83
83
  r"""Gets the message of this HybridSearchResponse.
84
84
 
85
- 描述信息
85
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :return: The message of this HybridSearchResponse.
88
88
  :rtype: str
@@ -93,7 +93,7 @@ class HybridSearchResponse(SdkResponse):
93
93
  def message(self, message):
94
94
  r"""Sets the message of this HybridSearchResponse.
95
95
 
96
- 描述信息
96
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
97
97
 
98
98
  :param message: The message of this HybridSearchResponse.
99
99
  :type message: str
@@ -104,10 +104,8 @@ class HybridSearchResponse(SdkResponse):
104
104
  def data(self):
105
105
  r"""Gets the data of this HybridSearchResponse.
106
106
 
107
- 响应数据
108
-
109
107
  :return: The data of this HybridSearchResponse.
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 HybridSearchResponse(SdkResponse):
115
113
  def data(self, data):
116
114
  r"""Sets the data of this HybridSearchResponse.
117
115
 
118
- 响应数据
119
-
120
116
  :param data: The data of this HybridSearchResponse.
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
 
@@ -35,13 +35,13 @@ class IndexDesc:
35
35
 
36
36
  The model defined in huaweicloud sdk
37
37
 
38
- :param index_name: 索引名
38
+ :param index_name: **参数解释:** 描述的索引名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
39
39
  :type index_name: str
40
- :param field_name: 索引对应的列
40
+ :param field_name: **参数解释:** 索引对应的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
41
41
  :type field_name: str
42
- :param index_params: 索引的参数信息
42
+ :param index_params: **参数解释:** 索引的参数信息。详情请查阅CreateIndex接口中 index_params结构中params字段的描述。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
43
43
  :type index_params: dict(str, object)
44
- :param index_state: 索引状态: -\"InProgress\":索引正在构建中或还未开始构建 -\"Finished\":索引构建完成 -\"Failed\":索引构建失败
44
+ :param index_state: **参数解释:** 索引状态。 **约束限制:** 不涉及。 **取值范围:** -\"InProgress\":索引正在构建中或还未开始构建。 -\"Finished\":索引构建完成。 -\"Failed\":索引构建失败。 **默认取值:** 不涉及。
45
45
  :type index_state: str
46
46
  """
47
47
 
@@ -55,16 +55,14 @@ class IndexDesc:
55
55
 
56
56
  self.index_name = index_name
57
57
  self.field_name = field_name
58
- if index_params is not None:
59
- self.index_params = index_params
60
- if index_state is not None:
61
- self.index_state = index_state
58
+ self.index_params = index_params
59
+ self.index_state = index_state
62
60
 
63
61
  @property
64
62
  def index_name(self):
65
63
  r"""Gets the index_name of this IndexDesc.
66
64
 
67
- 索引名
65
+ **参数解释:** 描述的索引名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
68
66
 
69
67
  :return: The index_name of this IndexDesc.
70
68
  :rtype: str
@@ -75,7 +73,7 @@ class IndexDesc:
75
73
  def index_name(self, index_name):
76
74
  r"""Sets the index_name of this IndexDesc.
77
75
 
78
- 索引名
76
+ **参数解释:** 描述的索引名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
79
77
 
80
78
  :param index_name: The index_name of this IndexDesc.
81
79
  :type index_name: str
@@ -86,7 +84,7 @@ class IndexDesc:
86
84
  def field_name(self):
87
85
  r"""Gets the field_name of this IndexDesc.
88
86
 
89
- 索引对应的列
87
+ **参数解释:** 索引对应的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
90
88
 
91
89
  :return: The field_name of this IndexDesc.
92
90
  :rtype: str
@@ -97,7 +95,7 @@ class IndexDesc:
97
95
  def field_name(self, field_name):
98
96
  r"""Sets the field_name of this IndexDesc.
99
97
 
100
- 索引对应的列
98
+ **参数解释:** 索引对应的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
101
99
 
102
100
  :param field_name: The field_name of this IndexDesc.
103
101
  :type field_name: str
@@ -108,7 +106,7 @@ class IndexDesc:
108
106
  def index_params(self):
109
107
  r"""Gets the index_params of this IndexDesc.
110
108
 
111
- 索引的参数信息
109
+ **参数解释:** 索引的参数信息。详情请查阅CreateIndex接口中 index_params结构中params字段的描述。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
112
110
 
113
111
  :return: The index_params of this IndexDesc.
114
112
  :rtype: dict(str, object)
@@ -119,7 +117,7 @@ class IndexDesc:
119
117
  def index_params(self, index_params):
120
118
  r"""Sets the index_params of this IndexDesc.
121
119
 
122
- 索引的参数信息
120
+ **参数解释:** 索引的参数信息。详情请查阅CreateIndex接口中 index_params结构中params字段的描述。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
123
121
 
124
122
  :param index_params: The index_params of this IndexDesc.
125
123
  :type index_params: dict(str, object)
@@ -130,7 +128,7 @@ class IndexDesc:
130
128
  def index_state(self):
131
129
  r"""Gets the index_state of this IndexDesc.
132
130
 
133
- 索引状态: -\"InProgress\":索引正在构建中或还未开始构建 -\"Finished\":索引构建完成 -\"Failed\":索引构建失败
131
+ **参数解释:** 索引状态。 **约束限制:** 不涉及。 **取值范围:** -\"InProgress\":索引正在构建中或还未开始构建。 -\"Finished\":索引构建完成。 -\"Failed\":索引构建失败。 **默认取值:** 不涉及。
134
132
 
135
133
  :return: The index_state of this IndexDesc.
136
134
  :rtype: str
@@ -141,7 +139,7 @@ class IndexDesc:
141
139
  def index_state(self, index_state):
142
140
  r"""Sets the index_state of this IndexDesc.
143
141
 
144
- 索引状态: -\"InProgress\":索引正在构建中或还未开始构建 -\"Finished\":索引构建完成 -\"Failed\":索引构建失败
142
+ **参数解释:** 索引状态。 **约束限制:** 不涉及。 **取值范围:** -\"InProgress\":索引正在构建中或还未开始构建。 -\"Finished\":索引构建完成。 -\"Failed\":索引构建失败。 **默认取值:** 不涉及。
145
143
 
146
144
  :param index_state: The index_state of this IndexDesc.
147
145
  :type index_state: str
@@ -33,11 +33,11 @@ class IndexParams:
33
33
 
34
34
  The model defined in huaweicloud sdk
35
35
 
36
- :param index_name: 索引名
36
+ :param index_name: **参数解释:** 创建的索引名称,collection内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
37
37
  :type index_name: str
38
- :param field_name: 索引对应的列
38
+ :param field_name: **参数解释:** 要创建索引的目标字段名称。 **约束限制:** - 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 - field_name必须是collection field schema中存在的字段。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
39
39
  :type field_name: str
40
- :param params: 1、距离度量方式: \"metric_type\": (非必选,默认值:稠密向量L2,稀疏向量IP)(稀疏向量仅支持IP,标量不支持距离度量) - \"L2\" - \"IP\" - \"COSINE\" 2、支持的索引类型: (非必选,默认值:稠密向量HANNS,标量INVERTED,稀疏向量SPARSE_INVERTED_INDEX,其中Array和JSON字段不支持建立索引) \"index_type\": 向量索引: - \"HNSW\" - \"HANNS\" - \"IVF_FLAT\" 稀疏向量索引: - \"SPARSE_INVERTED_INDEX\" - \"SPARSE_WAND\" 标量索引: - \"INVERTED\"(标量字段推荐)倒排索引 3、索引的参数 (非必选) HNSW相关参数: - M:节点的最大度 - efConstruction:构建索引时每个节点邻居数 HANNS相关参数: - max_degree:节点的最大度数。较大的值提供更高的召回率但增加索引的大小和构建时间。 - search_list_size:候选列表的大小。较大的值增加构建索引的时间但提供更高的召回率。 - encoding_type: SQ/PQ,,默认SQ - pq_code_budget_gb_ratio:PQ 码的大小限制。较大的值提供更高的召回率但增加内存使用量,仅当encoding_type为 PQ时生效。 - beamwidth:每个搜索迭代的最大 IO 请求数与 CPU 数之间的比率,可用于提升索引性能。 IVF_FLAT相关参数 - nlist:聚类的数量 - nprobe:查询聚类的数量
40
+ :param params: **参数解释:** 创建的索引的参数配置。 可以设置的参数: - metric_type:向量度量方式,只有向量索引需要配置。 - index_type:创建的索引类型。 - params:对应索引类型的配置参数。 1. HNSW索引类型参数: - M:节点的最大度。 - efConstruction:构建索引时每个节点邻居数。 2. HANNS索引相关参数: - max_degree:节点的最大度数。较大的值提供更高的召回率但增加索引的大小和构建时间。 - search_list_size:候选列表的大小。较大的值增加构建索引的时间但提供更高的召回率。 - encoding_type: SQ/PQ,默认SQ。 - pq_code_budget_gb_ratio:PQ 码的大小限制。较大的值提供更高的召回率但增加内存使用量,仅当encoding_type为PQ时生效。 - beamwidth:每个搜索迭代的最大 IO 请求数与 CPU 数之间的比率,可用于提升索引性能。 3. IVF_FLAT索引相关参数: - nlist:聚类的数量。 - nprobe:查询聚类的数量。 **约束限制:** 不涉及。 **取值范围:** - metric_type: 1. 稠密向量支持度量方式:\"L2\"和\"COSINE\"。 2. 稀疏向量支持度量方式:\"IP\"。 - index_type: 1. 稠密向量支持索引类型:\"HNSW\"、\"HANNS\"和\"IVF_FLAT\"。 2. 稀疏向量支持索引类型:\"SPARSE_INVERTED_INDEX\"和\"SPARSE_WAND\"。 3. 标量字段支持索引类型:\"IVF_FLAT\"。 - params: 1. HNSW索引类型参数: - M:[2, 2048] - efConstruction:[1, int32_max] 2. HANNS索引相关参数: - max_degree:[1, 512] - search_list_size:[1, int32_max] - encoding_type: SQ/PQ - pq_code_budget_gb_ratio:[0.0, 0.25] - beamwidth:[1, 16] 3. IVF_FLAT索引相关参数: - nlist:[1, 65536] - nprobe:[1, nlist] **默认值:** - metric_type: 1. 稠密向量:\"L2\"。 2. 稀疏向量:\"IP\"。 3. 标量:无须配置 - index_type: 1. 稠密向量:\"HANNS\"。 2. 稀疏向量:\"SPARSE_INVERTED_INDEX\"。 3. 标量:\"IVF_FLAT\"。 - params:对应索引类型的配置参数。 1. HNSW索引类型参数: - M:16。 - efConstruction:200。 2. HANNS索引相关参数: - max_degree:56。 - search_list_size:100。 - encoding_type: 默认SQ。 - pq_code_budget_gb_ratio:0.125。 - beamwidth:0.0 3. IVF_FLAT索引相关参数: - nlist:128 - nprobe:8
41
41
  :type params: dict(str, object)
42
42
  """
43
43
 
@@ -57,7 +57,7 @@ class IndexParams:
57
57
  def index_name(self):
58
58
  r"""Gets the index_name of this IndexParams.
59
59
 
60
- 索引名
60
+ **参数解释:** 创建的索引名称,collection内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
61
61
 
62
62
  :return: The index_name of this IndexParams.
63
63
  :rtype: str
@@ -68,7 +68,7 @@ class IndexParams:
68
68
  def index_name(self, index_name):
69
69
  r"""Sets the index_name of this IndexParams.
70
70
 
71
- 索引名
71
+ **参数解释:** 创建的索引名称,collection内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
72
72
 
73
73
  :param index_name: The index_name of this IndexParams.
74
74
  :type index_name: str
@@ -79,7 +79,7 @@ class IndexParams:
79
79
  def field_name(self):
80
80
  r"""Gets the field_name of this IndexParams.
81
81
 
82
- 索引对应的列
82
+ **参数解释:** 要创建索引的目标字段名称。 **约束限制:** - 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 - field_name必须是collection field schema中存在的字段。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
83
83
 
84
84
  :return: The field_name of this IndexParams.
85
85
  :rtype: str
@@ -90,7 +90,7 @@ class IndexParams:
90
90
  def field_name(self, field_name):
91
91
  r"""Sets the field_name of this IndexParams.
92
92
 
93
- 索引对应的列
93
+ **参数解释:** 要创建索引的目标字段名称。 **约束限制:** - 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 - field_name必须是collection field schema中存在的字段。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
94
94
 
95
95
  :param field_name: The field_name of this IndexParams.
96
96
  :type field_name: str
@@ -101,7 +101,7 @@ class IndexParams:
101
101
  def params(self):
102
102
  r"""Gets the params of this IndexParams.
103
103
 
104
- 1、距离度量方式: \"metric_type\": (非必选,默认值:稠密向量L2,稀疏向量IP)(稀疏向量仅支持IP,标量不支持距离度量) - \"L2\" - \"IP\" - \"COSINE\" 2、支持的索引类型: (非必选,默认值:稠密向量HANNS,标量INVERTED,稀疏向量SPARSE_INVERTED_INDEX,其中Array和JSON字段不支持建立索引) \"index_type\": 向量索引: - \"HNSW\" - \"HANNS\" - \"IVF_FLAT\" 稀疏向量索引: - \"SPARSE_INVERTED_INDEX\" - \"SPARSE_WAND\" 标量索引: - \"INVERTED\"(标量字段推荐)倒排索引 3、索引的参数 (非必选) HNSW相关参数: - M:节点的最大度 - efConstruction:构建索引时每个节点邻居数 HANNS相关参数: - max_degree:节点的最大度数。较大的值提供更高的召回率但增加索引的大小和构建时间。 - search_list_size:候选列表的大小。较大的值增加构建索引的时间但提供更高的召回率。 - encoding_type: SQ/PQ,,默认SQ。 - pq_code_budget_gb_ratio:PQ 码的大小限制。较大的值提供更高的召回率但增加内存使用量,仅当encoding_type为 PQ时生效。 - beamwidth:每个搜索迭代的最大 IO 请求数与 CPU 数之间的比率,可用于提升索引性能。 IVF_FLAT相关参数 - nlist:聚类的数量 - nprobe:查询聚类的数量
104
+ **参数解释:** 创建的索引的参数配置。 可以设置的参数: - metric_type:向量度量方式,只有向量索引需要配置。 - index_type:创建的索引类型。 - params:对应索引类型的配置参数。 1. HNSW索引类型参数: - M:节点的最大度。 - efConstruction:构建索引时每个节点邻居数。 2. HANNS索引相关参数: - max_degree:节点的最大度数。较大的值提供更高的召回率但增加索引的大小和构建时间。 - search_list_size:候选列表的大小。较大的值增加构建索引的时间但提供更高的召回率。 - encoding_type: SQ/PQ,默认SQ。 - pq_code_budget_gb_ratio:PQ 码的大小限制。较大的值提供更高的召回率但增加内存使用量,仅当encoding_type为PQ时生效。 - beamwidth:每个搜索迭代的最大 IO 请求数与 CPU 数之间的比率,可用于提升索引性能。 3. IVF_FLAT索引相关参数: - nlist:聚类的数量。 - nprobe:查询聚类的数量。 **约束限制:** 不涉及。 **取值范围:** - metric_type: 1. 稠密向量支持度量方式:\"L2\"和\"COSINE\" 2. 稀疏向量支持度量方式:\"IP\" - index_type: 1. 稠密向量支持索引类型:\"HNSW\"、\"HANNS\"和\"IVF_FLAT\" 2. 稀疏向量支持索引类型:\"SPARSE_INVERTED_INDEX\"和\"SPARSE_WAND\" 3. 标量字段支持索引类型:\"IVF_FLAT\"。 - params: 1. HNSW索引类型参数: - M:[2, 2048] - efConstruction:[1, int32_max] 2. HANNS索引相关参数: - max_degree:[1, 512] - search_list_size:[1, int32_max] - encoding_type: SQ/PQ - pq_code_budget_gb_ratio:[0.0, 0.25] - beamwidth:[1, 16] 3. IVF_FLAT索引相关参数: - nlist:[1, 65536] - nprobe:[1, nlist] **默认值:** - metric_type: 1. 稠密向量:\"L2\" 2. 稀疏向量:\"IP\"。 3. 标量:无须配置 - index_type: 1. 稠密向量:\"HANNS\"。 2. 稀疏向量:\"SPARSE_INVERTED_INDEX\"。 3. 标量:\"IVF_FLAT\"。 - params:对应索引类型的配置参数。 1. HNSW索引类型参数: - M:16。 - efConstruction:200。 2. HANNS索引相关参数: - max_degree:56。 - search_list_size:100。 - encoding_type: 默认SQ。 - pq_code_budget_gb_ratio:0.125。 - beamwidth:0.0 3. IVF_FLAT索引相关参数: - nlist:128 - nprobe:8
105
105
 
106
106
  :return: The params of this IndexParams.
107
107
  :rtype: dict(str, object)
@@ -112,7 +112,7 @@ class IndexParams:
112
112
  def params(self, params):
113
113
  r"""Sets the params of this IndexParams.
114
114
 
115
- 1、距离度量方式: \"metric_type\": (非必选,默认值:稠密向量L2,稀疏向量IP)(稀疏向量仅支持IP,标量不支持距离度量) - \"L2\" - \"IP\" - \"COSINE\" 2、支持的索引类型: (非必选,默认值:稠密向量HANNS,标量INVERTED,稀疏向量SPARSE_INVERTED_INDEX,其中Array和JSON字段不支持建立索引) \"index_type\": 向量索引: - \"HNSW\" - \"HANNS\" - \"IVF_FLAT\" 稀疏向量索引: - \"SPARSE_INVERTED_INDEX\" - \"SPARSE_WAND\" 标量索引: - \"INVERTED\"(标量字段推荐)倒排索引 3、索引的参数 (非必选) HNSW相关参数: - M:节点的最大度 - efConstruction:构建索引时每个节点邻居数 HANNS相关参数: - max_degree:节点的最大度数。较大的值提供更高的召回率但增加索引的大小和构建时间。 - search_list_size:候选列表的大小。较大的值增加构建索引的时间但提供更高的召回率。 - encoding_type: SQ/PQ,,默认SQ。 - pq_code_budget_gb_ratio:PQ 码的大小限制。较大的值提供更高的召回率但增加内存使用量,仅当encoding_type为 PQ时生效。 - beamwidth:每个搜索迭代的最大 IO 请求数与 CPU 数之间的比率,可用于提升索引性能。 IVF_FLAT相关参数 - nlist:聚类的数量 - nprobe:查询聚类的数量
115
+ **参数解释:** 创建的索引的参数配置。 可以设置的参数: - metric_type:向量度量方式,只有向量索引需要配置。 - index_type:创建的索引类型。 - params:对应索引类型的配置参数。 1. HNSW索引类型参数: - M:节点的最大度。 - efConstruction:构建索引时每个节点邻居数。 2. HANNS索引相关参数: - max_degree:节点的最大度数。较大的值提供更高的召回率但增加索引的大小和构建时间。 - search_list_size:候选列表的大小。较大的值增加构建索引的时间但提供更高的召回率。 - encoding_type: SQ/PQ,默认SQ。 - pq_code_budget_gb_ratio:PQ 码的大小限制。较大的值提供更高的召回率但增加内存使用量,仅当encoding_type为PQ时生效。 - beamwidth:每个搜索迭代的最大 IO 请求数与 CPU 数之间的比率,可用于提升索引性能。 3. IVF_FLAT索引相关参数: - nlist:聚类的数量。 - nprobe:查询聚类的数量。 **约束限制:** 不涉及。 **取值范围:** - metric_type: 1. 稠密向量支持度量方式:\"L2\"和\"COSINE\" 2. 稀疏向量支持度量方式:\"IP\" - index_type: 1. 稠密向量支持索引类型:\"HNSW\"、\"HANNS\"和\"IVF_FLAT\" 2. 稀疏向量支持索引类型:\"SPARSE_INVERTED_INDEX\"和\"SPARSE_WAND\" 3. 标量字段支持索引类型:\"IVF_FLAT\"。 - params: 1. HNSW索引类型参数: - M:[2, 2048] - efConstruction:[1, int32_max] 2. HANNS索引相关参数: - max_degree:[1, 512] - search_list_size:[1, int32_max] - encoding_type: SQ/PQ - pq_code_budget_gb_ratio:[0.0, 0.25] - beamwidth:[1, 16] 3. IVF_FLAT索引相关参数: - nlist:[1, 65536] - nprobe:[1, nlist] **默认值:** - metric_type: 1. 稠密向量:\"L2\" 2. 稀疏向量:\"IP\"。 3. 标量:无须配置 - index_type: 1. 稠密向量:\"HANNS\"。 2. 稀疏向量:\"SPARSE_INVERTED_INDEX\"。 3. 标量:\"IVF_FLAT\"。 - params:对应索引类型的配置参数。 1. HNSW索引类型参数: - M:16。 - efConstruction:200。 2. HANNS索引相关参数: - max_degree:56。 - search_list_size:100。 - encoding_type: 默认SQ。 - pq_code_budget_gb_ratio:0.125。 - beamwidth:0.0 3. IVF_FLAT索引相关参数: - nlist:128 - nprobe:8
116
116
 
117
117
  :param params: The params of this IndexParams.
118
118
  :type params: dict(str, object)
@@ -33,11 +33,11 @@ class InsertEntitiesBody:
33
33
 
34
34
  The model defined in huaweicloud sdk
35
35
 
36
- :param store_name: 知识仓实例名称
36
+ :param store_name: **参数解释:** 知识仓实例名称,region内唯一。 约束限制: 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
37
37
  :type store_name: str
38
- :param collection_name: collection名称
38
+ :param collection_name: **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
39
39
  :type collection_name: str
40
- :param data: 满足collection的field schema
40
+ :param data: **参数解释:** 插入collection的entity数据。 **约束限制:** 满足插入collection的field schema。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
41
41
  :type data: list[dict(str, object)]
42
42
  """
43
43
 
@@ -56,7 +56,7 @@ class InsertEntitiesBody:
56
56
  def store_name(self):
57
57
  r"""Gets the store_name of this InsertEntitiesBody.
58
58
 
59
- 知识仓实例名称
59
+ **参数解释:** 知识仓实例名称,region内唯一。 约束限制: 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
60
60
 
61
61
  :return: The store_name of this InsertEntitiesBody.
62
62
  :rtype: str
@@ -67,7 +67,7 @@ class InsertEntitiesBody:
67
67
  def store_name(self, store_name):
68
68
  r"""Sets the store_name of this InsertEntitiesBody.
69
69
 
70
- 知识仓实例名称
70
+ **参数解释:** 知识仓实例名称,region内唯一。 约束限制: 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及 **默认取值:** 不涉及
71
71
 
72
72
  :param store_name: The store_name of this InsertEntitiesBody.
73
73
  :type store_name: str
@@ -78,7 +78,7 @@ class InsertEntitiesBody:
78
78
  def collection_name(self):
79
79
  r"""Gets the collection_name of this InsertEntitiesBody.
80
80
 
81
- collection名称
81
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
82
82
 
83
83
  :return: The collection_name of this InsertEntitiesBody.
84
84
  :rtype: str
@@ -89,7 +89,7 @@ class InsertEntitiesBody:
89
89
  def collection_name(self, collection_name):
90
90
  r"""Sets the collection_name of this InsertEntitiesBody.
91
91
 
92
- collection名称
92
+ **参数解释:** collection名称,知识仓内唯一。 **约束限制:** 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
93
93
 
94
94
  :param collection_name: The collection_name of this InsertEntitiesBody.
95
95
  :type collection_name: str
@@ -100,7 +100,7 @@ class InsertEntitiesBody:
100
100
  def data(self):
101
101
  r"""Gets the data of this InsertEntitiesBody.
102
102
 
103
- 满足collection的field schema
103
+ **参数解释:** 插入collection的entity数据。 **约束限制:** 满足插入collection的field schema。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
104
104
 
105
105
  :return: The data of this InsertEntitiesBody.
106
106
  :rtype: list[dict(str, object)]
@@ -111,7 +111,7 @@ class InsertEntitiesBody:
111
111
  def data(self, data):
112
112
  r"""Sets the data of this InsertEntitiesBody.
113
113
 
114
- 满足collection的field schema
114
+ **参数解释:** 插入collection的entity数据。 **约束限制:** 满足插入collection的field schema。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
115
115
 
116
116
  :param data: The data of this InsertEntitiesBody.
117
117
  :type data: list[dict(str, object)]
@@ -5,7 +5,7 @@ import six
5
5
  from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
6
6
 
7
7
 
8
- class InsertEntitiesResponseData:
8
+ class InsertEntitiesData:
9
9
 
10
10
  """
11
11
  Attributes:
@@ -27,13 +27,13 @@ class InsertEntitiesResponseData:
27
27
  }
28
28
 
29
29
  def __init__(self, insert_count=None, insert_ids=None):
30
- r"""InsertEntitiesResponseData
30
+ r"""InsertEntitiesData
31
31
 
32
32
  The model defined in huaweicloud sdk
33
33
 
34
- :param insert_count: 插入的entity数量。
34
+ :param insert_count: **参数解释:** 插入的entity数量。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
35
35
  :type insert_count: int
36
- :param insert_ids: 插入成功的entity的primary_key
36
+ :param insert_ids: **参数解释:** 插入成功的entity的primary_key。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
37
37
  :type insert_ids: list[object]
38
38
  """
39
39
 
@@ -49,44 +49,44 @@ class InsertEntitiesResponseData:
49
49
 
50
50
  @property
51
51
  def insert_count(self):
52
- r"""Gets the insert_count of this InsertEntitiesResponseData.
52
+ r"""Gets the insert_count of this InsertEntitiesData.
53
53
 
54
- 插入的entity数量。
54
+ **参数解释:** 插入的entity数量。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
55
55
 
56
- :return: The insert_count of this InsertEntitiesResponseData.
56
+ :return: The insert_count of this InsertEntitiesData.
57
57
  :rtype: int
58
58
  """
59
59
  return self._insert_count
60
60
 
61
61
  @insert_count.setter
62
62
  def insert_count(self, insert_count):
63
- r"""Sets the insert_count of this InsertEntitiesResponseData.
63
+ r"""Sets the insert_count of this InsertEntitiesData.
64
64
 
65
- 插入的entity数量。
65
+ **参数解释:** 插入的entity数量。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
66
66
 
67
- :param insert_count: The insert_count of this InsertEntitiesResponseData.
67
+ :param insert_count: The insert_count of this InsertEntitiesData.
68
68
  :type insert_count: int
69
69
  """
70
70
  self._insert_count = insert_count
71
71
 
72
72
  @property
73
73
  def insert_ids(self):
74
- r"""Gets the insert_ids of this InsertEntitiesResponseData.
74
+ r"""Gets the insert_ids of this InsertEntitiesData.
75
75
 
76
- 插入成功的entity的primary_key
76
+ **参数解释:** 插入成功的entity的primary_key。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
77
77
 
78
- :return: The insert_ids of this InsertEntitiesResponseData.
78
+ :return: The insert_ids of this InsertEntitiesData.
79
79
  :rtype: list[object]
80
80
  """
81
81
  return self._insert_ids
82
82
 
83
83
  @insert_ids.setter
84
84
  def insert_ids(self, insert_ids):
85
- r"""Sets the insert_ids of this InsertEntitiesResponseData.
85
+ r"""Sets the insert_ids of this InsertEntitiesData.
86
86
 
87
- 插入成功的entity的primary_key
87
+ **参数解释:** 插入成功的entity的primary_key。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
88
88
 
89
- :param insert_ids: The insert_ids of this InsertEntitiesResponseData.
89
+ :param insert_ids: The insert_ids of this InsertEntitiesData.
90
90
  :type insert_ids: list[object]
91
91
  """
92
92
  self._insert_ids = insert_ids
@@ -133,7 +133,7 @@ class InsertEntitiesResponseData:
133
133
 
134
134
  def __eq__(self, other):
135
135
  """Returns true if both objects are equal"""
136
- if not isinstance(other, InsertEntitiesResponseData):
136
+ if not isinstance(other, InsertEntitiesData):
137
137
  return False
138
138
 
139
139
  return self.__dict__ == other.__dict__
@@ -20,7 +20,7 @@ class InsertEntitiesResponse(SdkResponse):
20
20
  openapi_types = {
21
21
  'code': 'str',
22
22
  'message': 'str',
23
- 'data': 'InsertEntitiesResponseData'
23
+ 'data': 'InsertEntitiesData'
24
24
  }
25
25
 
26
26
  attribute_map = {
@@ -34,12 +34,12 @@ class InsertEntitiesResponse(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.InsertEntitiesResponseData`
42
+ :type data: :class:`huaweicloudsdkdwr.v1.InsertEntitiesData`
43
43
  """
44
44
 
45
45
  super(InsertEntitiesResponse, self).__init__()
@@ -60,7 +60,7 @@ class InsertEntitiesResponse(SdkResponse):
60
60
  def code(self):
61
61
  r"""Gets the code of this InsertEntitiesResponse.
62
62
 
63
- 返回码
63
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
64
64
 
65
65
  :return: The code of this InsertEntitiesResponse.
66
66
  :rtype: str
@@ -71,7 +71,7 @@ class InsertEntitiesResponse(SdkResponse):
71
71
  def code(self, code):
72
72
  r"""Sets the code of this InsertEntitiesResponse.
73
73
 
74
- 返回码
74
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :param code: The code of this InsertEntitiesResponse.
77
77
  :type code: str
@@ -82,7 +82,7 @@ class InsertEntitiesResponse(SdkResponse):
82
82
  def message(self):
83
83
  r"""Gets the message of this InsertEntitiesResponse.
84
84
 
85
- 描述信息
85
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :return: The message of this InsertEntitiesResponse.
88
88
  :rtype: str
@@ -93,7 +93,7 @@ class InsertEntitiesResponse(SdkResponse):
93
93
  def message(self, message):
94
94
  r"""Sets the message of this InsertEntitiesResponse.
95
95
 
96
- 描述信息
96
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
97
97
 
98
98
  :param message: The message of this InsertEntitiesResponse.
99
99
  :type message: str
@@ -105,7 +105,7 @@ class InsertEntitiesResponse(SdkResponse):
105
105
  r"""Gets the data of this InsertEntitiesResponse.
106
106
 
107
107
  :return: The data of this InsertEntitiesResponse.
108
- :rtype: :class:`huaweicloudsdkdwr.v1.InsertEntitiesResponseData`
108
+ :rtype: :class:`huaweicloudsdkdwr.v1.InsertEntitiesData`
109
109
  """
110
110
  return self._data
111
111
 
@@ -114,7 +114,7 @@ class InsertEntitiesResponse(SdkResponse):
114
114
  r"""Sets the data of this InsertEntitiesResponse.
115
115
 
116
116
  :param data: The data of this InsertEntitiesResponse.
117
- :type data: :class:`huaweicloudsdkdwr.v1.InsertEntitiesResponseData`
117
+ :type data: :class:`huaweicloudsdkdwr.v1.InsertEntitiesData`
118
118
  """
119
119
  self._data = data
120
120