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 DescribeIndexResponse(SdkResponse):
20
20
  openapi_types = {
21
21
  'code': 'str',
22
22
  'message': 'str',
23
- 'data': 'DescribeIndexResposeData'
23
+ 'data': 'DescribeIndexData'
24
24
  }
25
25
 
26
26
  attribute_map = {
@@ -34,12 +34,12 @@ class DescribeIndexResponse(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.DescribeIndexResposeData`
42
+ :type data: :class:`huaweicloudsdkdwr.v1.DescribeIndexData`
43
43
  """
44
44
 
45
45
  super(DescribeIndexResponse, self).__init__()
@@ -60,7 +60,7 @@ class DescribeIndexResponse(SdkResponse):
60
60
  def code(self):
61
61
  r"""Gets the code of this DescribeIndexResponse.
62
62
 
63
- 返回码
63
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
64
64
 
65
65
  :return: The code of this DescribeIndexResponse.
66
66
  :rtype: str
@@ -71,7 +71,7 @@ class DescribeIndexResponse(SdkResponse):
71
71
  def code(self, code):
72
72
  r"""Sets the code of this DescribeIndexResponse.
73
73
 
74
- 返回码
74
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :param code: The code of this DescribeIndexResponse.
77
77
  :type code: str
@@ -82,7 +82,7 @@ class DescribeIndexResponse(SdkResponse):
82
82
  def message(self):
83
83
  r"""Gets the message of this DescribeIndexResponse.
84
84
 
85
- 描述信息
85
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :return: The message of this DescribeIndexResponse.
88
88
  :rtype: str
@@ -93,7 +93,7 @@ class DescribeIndexResponse(SdkResponse):
93
93
  def message(self, message):
94
94
  r"""Sets the message of this DescribeIndexResponse.
95
95
 
96
- 描述信息
96
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
97
97
 
98
98
  :param message: The message of this DescribeIndexResponse.
99
99
  :type message: str
@@ -105,7 +105,7 @@ class DescribeIndexResponse(SdkResponse):
105
105
  r"""Gets the data of this DescribeIndexResponse.
106
106
 
107
107
  :return: The data of this DescribeIndexResponse.
108
- :rtype: :class:`huaweicloudsdkdwr.v1.DescribeIndexResposeData`
108
+ :rtype: :class:`huaweicloudsdkdwr.v1.DescribeIndexData`
109
109
  """
110
110
  return self._data
111
111
 
@@ -114,7 +114,7 @@ class DescribeIndexResponse(SdkResponse):
114
114
  r"""Sets the data of this DescribeIndexResponse.
115
115
 
116
116
  :param data: The data of this DescribeIndexResponse.
117
- :type data: :class:`huaweicloudsdkdwr.v1.DescribeIndexResposeData`
117
+ :type data: :class:`huaweicloudsdkdwr.v1.DescribeIndexData`
118
118
  """
119
119
  self._data = data
120
120
 
@@ -29,7 +29,7 @@ class DescribeJobBody:
29
29
 
30
30
  The model defined in huaweicloud sdk
31
31
 
32
- :param job_id: 任务ID
32
+ :param job_id: **参数解释:** 创建知识仓实例的任务id **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
33
33
  :type job_id: str
34
34
  """
35
35
 
@@ -44,7 +44,7 @@ class DescribeJobBody:
44
44
  def job_id(self):
45
45
  r"""Gets the job_id of this DescribeJobBody.
46
46
 
47
- 任务ID
47
+ **参数解释:** 创建知识仓实例的任务id **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
48
48
 
49
49
  :return: The job_id of this DescribeJobBody.
50
50
  :rtype: str
@@ -55,7 +55,7 @@ class DescribeJobBody:
55
55
  def job_id(self, job_id):
56
56
  r"""Sets the job_id of this DescribeJobBody.
57
57
 
58
- 任务ID
58
+ **参数解释:** 创建知识仓实例的任务id **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
59
59
 
60
60
  :param job_id: The job_id of this DescribeJobBody.
61
61
  :type job_id: str
@@ -34,9 +34,9 @@ class DescribeJobResponse(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
42
  :type data: :class:`huaweicloudsdkdwr.v1.JobData`
@@ -60,7 +60,7 @@ class DescribeJobResponse(SdkResponse):
60
60
  def code(self):
61
61
  r"""Gets the code of this DescribeJobResponse.
62
62
 
63
- 返回码
63
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
64
64
 
65
65
  :return: The code of this DescribeJobResponse.
66
66
  :rtype: str
@@ -71,7 +71,7 @@ class DescribeJobResponse(SdkResponse):
71
71
  def code(self, code):
72
72
  r"""Sets the code of this DescribeJobResponse.
73
73
 
74
- 返回码
74
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :param code: The code of this DescribeJobResponse.
77
77
  :type code: str
@@ -82,7 +82,7 @@ class DescribeJobResponse(SdkResponse):
82
82
  def message(self):
83
83
  r"""Gets the message of this DescribeJobResponse.
84
84
 
85
- 描述信息
85
+ **参数解释:** 描述信息。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :return: The message of this DescribeJobResponse.
88
88
  :rtype: str
@@ -93,7 +93,7 @@ class DescribeJobResponse(SdkResponse):
93
93
  def message(self, message):
94
94
  r"""Sets the message of this DescribeJobResponse.
95
95
 
96
- 描述信息
96
+ **参数解释:** 描述信息。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
97
97
 
98
98
  :param message: The message of this DescribeJobResponse.
99
99
  :type message: str
@@ -20,7 +20,7 @@ class DescribeStoreResponse(SdkResponse):
20
20
  openapi_types = {
21
21
  'code': 'str',
22
22
  'message': 'str',
23
- 'data': 'DescribeStoreData'
23
+ 'data': 'StoreData'
24
24
  }
25
25
 
26
26
  attribute_map = {
@@ -34,12 +34,12 @@ class DescribeStoreResponse(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.DescribeStoreData`
42
+ :type data: :class:`huaweicloudsdkdwr.v1.StoreData`
43
43
  """
44
44
 
45
45
  super(DescribeStoreResponse, self).__init__()
@@ -60,7 +60,7 @@ class DescribeStoreResponse(SdkResponse):
60
60
  def code(self):
61
61
  r"""Gets the code of this DescribeStoreResponse.
62
62
 
63
- 返回码
63
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
64
64
 
65
65
  :return: The code of this DescribeStoreResponse.
66
66
  :rtype: str
@@ -71,7 +71,7 @@ class DescribeStoreResponse(SdkResponse):
71
71
  def code(self, code):
72
72
  r"""Sets the code of this DescribeStoreResponse.
73
73
 
74
- 返回码
74
+ **参数解释:** 返回码。参见错误码章节。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :param code: The code of this DescribeStoreResponse.
77
77
  :type code: str
@@ -82,7 +82,7 @@ class DescribeStoreResponse(SdkResponse):
82
82
  def message(self):
83
83
  r"""Gets the message of this DescribeStoreResponse.
84
84
 
85
- 描述信息
85
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :return: The message of this DescribeStoreResponse.
88
88
  :rtype: str
@@ -93,7 +93,7 @@ class DescribeStoreResponse(SdkResponse):
93
93
  def message(self, message):
94
94
  r"""Sets the message of this DescribeStoreResponse.
95
95
 
96
- 描述信息
96
+ **参数解释:** 描述信息 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
97
97
 
98
98
  :param message: The message of this DescribeStoreResponse.
99
99
  :type message: str
@@ -105,7 +105,7 @@ class DescribeStoreResponse(SdkResponse):
105
105
  r"""Gets the data of this DescribeStoreResponse.
106
106
 
107
107
  :return: The data of this DescribeStoreResponse.
108
- :rtype: :class:`huaweicloudsdkdwr.v1.DescribeStoreData`
108
+ :rtype: :class:`huaweicloudsdkdwr.v1.StoreData`
109
109
  """
110
110
  return self._data
111
111
 
@@ -114,7 +114,7 @@ class DescribeStoreResponse(SdkResponse):
114
114
  r"""Sets the data of this DescribeStoreResponse.
115
115
 
116
116
  :param data: The data of this DescribeStoreResponse.
117
- :type data: :class:`huaweicloudsdkdwr.v1.DescribeStoreData`
117
+ :type data: :class:`huaweicloudsdkdwr.v1.StoreData`
118
118
  """
119
119
  self._data = data
120
120
 
@@ -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 EntitiesData:
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
+ 'entities': 'list[dict(str, object)]'
21
+ }
22
+
23
+ attribute_map = {
24
+ 'entities': 'entities'
25
+ }
26
+
27
+ def __init__(self, entities=None):
28
+ r"""EntitiesData
29
+
30
+ The model defined in huaweicloud sdk
31
+
32
+ :param entities: **参数解释:** 查询到的信息。 **约束限制:** 不涉及。
33
+ :type entities: list[dict(str, object)]
34
+ """
35
+
36
+
37
+
38
+ self._entities = None
39
+ self.discriminator = None
40
+
41
+ self.entities = entities
42
+
43
+ @property
44
+ def entities(self):
45
+ r"""Gets the entities of this EntitiesData.
46
+
47
+ **参数解释:** 查询到的信息。 **约束限制:** 不涉及。
48
+
49
+ :return: The entities of this EntitiesData.
50
+ :rtype: list[dict(str, object)]
51
+ """
52
+ return self._entities
53
+
54
+ @entities.setter
55
+ def entities(self, entities):
56
+ r"""Sets the entities of this EntitiesData.
57
+
58
+ **参数解释:** 查询到的信息。 **约束限制:** 不涉及。
59
+
60
+ :param entities: The entities of this EntitiesData.
61
+ :type entities: list[dict(str, object)]
62
+ """
63
+ self._entities = entities
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, EntitiesData):
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
@@ -37,15 +37,15 @@ class Field:
37
37
 
38
38
  The model defined in huaweicloud sdk
39
39
 
40
- :param field_name: 要在集合中创建的字段名称
40
+ :param field_name: **参数解释:** 要在集合中创建的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
41
41
  :type field_name: str
42
- :param data_type: 字段的数据类型;“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"
42
+ :param data_type: **参数解释:** 字段的数据类型。 **约束限制:** 不涉及。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"。 **默认取值:** 不涉及。
43
43
  :type data_type: str
44
- :param element_data_type: 数组内部的数据类型,当前支持“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String
44
+ :param element_data_type: **参数解释:** 数组内部的数据类型。 **约束限制:** 在data_type是Array时生效。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”。 **默认取值:** 不涉及。
45
45
  :type element_data_type: str
46
- :param element_type_params: 如果field为FloatVector类型向量字段,则必须设定维度参数dim: 向量字段的维度,最大支持32,768维 如果field为String类型字段或Array 元素类型为String类型,则可设定字段值最大长度max_length,默认为256 如果field为Array类型字段,则可设定数组最大容量max_capacity,默认为32
46
+ :param element_type_params: **参数解释:** 每个field列的参数。 **约束限制:** 如果field为FloatVector类型向量字段,则必须设定维度参数dim 如果field为String类型字段或Array 元素类型为String类型,则可设定字段值最大长度max_length如果field为Array类型字段,则可设定数组最大容量max_capacity。 **取值范围:** 如果field为FloatVector类型向量字段时,参数dim的有效取值范围是[2-32768]; 如果field为String类型字段或Array 元素类型为String类型, 参数max_length的有效取值范围是[1-65535]; 如果field为Array类型字段,参数max_capacity的有效取值范围是[1-32768] **默认取值:** 如果field为String类型字段或Array 元素类型为String类型, 参数max_length的默认值是256 如果field为Array类型字段,参数max_capacity的默认值是32
47
47
  :type element_type_params: dict(str, object)
48
- :param partition_key: 该字段是否为partition_key,默认false。(如果partition_key为true,data_type仅支持String与Int64);最多只有一个field的partition_key设置为true
48
+ :param partition_key: **参数解释:** 是否将这个filed列设置为分区键。 **约束限制:** 1.只能在数据类型为String与Int64field列上设置分区键; 2.最多只能设置1个field为分区键。 **取值范围:** true,false。 **默认取值:** false。
49
49
  :type partition_key: bool
50
50
  """
51
51
 
@@ -71,7 +71,7 @@ class Field:
71
71
  def field_name(self):
72
72
  r"""Gets the field_name of this Field.
73
73
 
74
- 要在集合中创建的字段名称
74
+ **参数解释:** 要在集合中创建的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
75
75
 
76
76
  :return: The field_name of this Field.
77
77
  :rtype: str
@@ -82,7 +82,7 @@ class Field:
82
82
  def field_name(self, field_name):
83
83
  r"""Sets the field_name of this Field.
84
84
 
85
- 要在集合中创建的字段名称
85
+ **参数解释:** 要在集合中创建的字段名称。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值:** 不涉及。
86
86
 
87
87
  :param field_name: The field_name of this Field.
88
88
  :type field_name: str
@@ -93,7 +93,7 @@ class Field:
93
93
  def data_type(self):
94
94
  r"""Gets the data_type of this Field.
95
95
 
96
- 字段的数据类型;“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"
96
+ **参数解释:** 字段的数据类型。 **约束限制:** 不涉及。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"。 **默认取值:** 不涉及。
97
97
 
98
98
  :return: The data_type of this Field.
99
99
  :rtype: str
@@ -104,7 +104,7 @@ class Field:
104
104
  def data_type(self, data_type):
105
105
  r"""Sets the data_type of this Field.
106
106
 
107
- 字段的数据类型;“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"
107
+ **参数解释:** 字段的数据类型。 **约束限制:** 不涉及。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”,“Array”,“JSON”,\"FloatVector\", \"SparseFloatVector\"。 **默认取值:** 不涉及。
108
108
 
109
109
  :param data_type: The data_type of this Field.
110
110
  :type data_type: str
@@ -115,7 +115,7 @@ class Field:
115
115
  def element_data_type(self):
116
116
  r"""Gets the element_data_type of this Field.
117
117
 
118
- 数组内部的数据类型,当前支持“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String
118
+ **参数解释:** 数组内部的数据类型。 **约束限制:** 在data_type是Array时生效。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”。 **默认取值:** 不涉及。
119
119
 
120
120
  :return: The element_data_type of this Field.
121
121
  :rtype: str
@@ -126,7 +126,7 @@ class Field:
126
126
  def element_data_type(self, element_data_type):
127
127
  r"""Sets the element_data_type of this Field.
128
128
 
129
- 数组内部的数据类型,当前支持“Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String
129
+ **参数解释:** 数组内部的数据类型。 **约束限制:** 在data_type是Array时生效。 **取值范围:** “Bool”,“Int8”,“Int16”,“Int32”,“Int64”,“Float”,“String”。 **默认取值:** 不涉及。
130
130
 
131
131
  :param element_data_type: The element_data_type of this Field.
132
132
  :type element_data_type: str
@@ -137,7 +137,7 @@ class Field:
137
137
  def element_type_params(self):
138
138
  r"""Gets the element_type_params of this Field.
139
139
 
140
- 如果field为FloatVector类型向量字段,则必须设定维度参数dim: 向量字段的维度,最大支持32,768维 如果field为String类型字段或Array 元素类型为String类型,则可设定字段值最大长度max_length,默认为256 如果field为Array类型字段,则可设定数组最大容量max_capacity,默认为32
140
+ **参数解释:** 每个field列的参数。 **约束限制:** 如果field为FloatVector类型向量字段,则必须设定维度参数dim 如果field为String类型字段或Array 元素类型为String类型,则可设定字段值最大长度max_length如果field为Array类型字段,则可设定数组最大容量max_capacity。 **取值范围:** 如果field为FloatVector类型向量字段时,参数dim的有效取值范围是[2-32768]; 如果field为String类型字段或Array 元素类型为String类型, 参数max_length的有效取值范围是[1-65535]; 如果field为Array类型字段,参数max_capacity的有效取值范围是[1-32768] **默认取值:** 如果field为String类型字段或Array 元素类型为String类型, 参数max_length的默认值是256 如果field为Array类型字段,参数max_capacity的默认值是32
141
141
 
142
142
  :return: The element_type_params of this Field.
143
143
  :rtype: dict(str, object)
@@ -148,7 +148,7 @@ class Field:
148
148
  def element_type_params(self, element_type_params):
149
149
  r"""Sets the element_type_params of this Field.
150
150
 
151
- 如果field为FloatVector类型向量字段,则必须设定维度参数dim: 向量字段的维度,最大支持32,768维 如果field为String类型字段或Array 元素类型为String类型,则可设定字段值最大长度max_length,默认为256 如果field为Array类型字段,则可设定数组最大容量max_capacity,默认为32
151
+ **参数解释:** 每个field列的参数。 **约束限制:** 如果field为FloatVector类型向量字段,则必须设定维度参数dim 如果field为String类型字段或Array 元素类型为String类型,则可设定字段值最大长度max_length如果field为Array类型字段,则可设定数组最大容量max_capacity。 **取值范围:** 如果field为FloatVector类型向量字段时,参数dim的有效取值范围是[2-32768]; 如果field为String类型字段或Array 元素类型为String类型, 参数max_length的有效取值范围是[1-65535]; 如果field为Array类型字段,参数max_capacity的有效取值范围是[1-32768] **默认取值:** 如果field为String类型字段或Array 元素类型为String类型, 参数max_length的默认值是256 如果field为Array类型字段,参数max_capacity的默认值是32
152
152
 
153
153
  :param element_type_params: The element_type_params of this Field.
154
154
  :type element_type_params: dict(str, object)
@@ -159,7 +159,7 @@ class Field:
159
159
  def partition_key(self):
160
160
  r"""Gets the partition_key of this Field.
161
161
 
162
- 该字段是否为partition_key,默认false。(如果partition_key为true,data_type仅支持String与Int64);最多只有一个field的partition_key设置为true
162
+ **参数解释:** 是否将这个filed列设置为分区键。 **约束限制:** 1.只能在数据类型为String与Int64field列上设置分区键; 2.最多只能设置1个field为分区键。 **取值范围:** true,false。 **默认取值:** false。
163
163
 
164
164
  :return: The partition_key of this Field.
165
165
  :rtype: bool
@@ -170,7 +170,7 @@ class Field:
170
170
  def partition_key(self, partition_key):
171
171
  r"""Sets the partition_key of this Field.
172
172
 
173
- 该字段是否为partition_key,默认false。(如果partition_key为true,data_type仅支持String与Int64);最多只有一个field的partition_key设置为true
173
+ **参数解释:** 是否将这个filed列设置为分区键。 **约束限制:** 1.只能在数据类型为String与Int64field列上设置分区键; 2.最多只能设置1个field为分区键。 **取值范围:** true,false。 **默认取值:** false。
174
174
 
175
175
  :param partition_key: The partition_key of this Field.
176
176
  :type partition_key: bool