huaweicloudsdkdwr 3.1.154__py2.py3-none-any.whl → 3.1.156__py2.py3-none-any.whl

huaweicloudsdkdwr/v1/model/{get_index_progress_response_data.py → get_progress_data.py}

@@ -5,7 +5,7 @@ import six
 from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
 
 
-class GetIndexProgressResponseData:
+class GetProgressData:
 
     """
     Attributes:
@@ -29,13 +29,13 @@ class GetIndexProgressResponseData:
     }
 
     def __init__(self, store_name=None, collection_name=None, build_progress=None):
-        r"""GetIndexProgressResponseData
+        r"""GetProgressData
 
         The model defined in huaweicloud sdk
 
-        :param store_name: 知识仓实例名称。
+        :param store_name: **参数解释：** 知识仓实例名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
         :type store_name: str
-        :param collection_name: Collection 名称。
+        :param collection_name: **参数解释：** Collection 名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
         :type collection_name: str
         :param build_progress: 
         :type build_progress: :class:`huaweicloudsdkdwr.v1.BuildProgress`
@@ -55,62 +55,62 @@ class GetIndexProgressResponseData:
 
     @property
     def store_name(self):
-        r"""Gets the store_name of this GetIndexProgressResponseData.
+        r"""Gets the store_name of this GetProgressData.
 
-        知识仓实例名称。
+        **参数解释：** 知识仓实例名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
-        :return: The store_name of this GetIndexProgressResponseData.
+        :return: The store_name of this GetProgressData.
         :rtype: str
         """
         return self._store_name
 
     @store_name.setter
     def store_name(self, store_name):
-        r"""Sets the store_name of this GetIndexProgressResponseData.
+        r"""Sets the store_name of this GetProgressData.
 
-        知识仓实例名称。
+        **参数解释：** 知识仓实例名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
-        :param store_name: The store_name of this GetIndexProgressResponseData.
+        :param store_name: The store_name of this GetProgressData.
         :type store_name: str
         """
         self._store_name = store_name
 
     @property
     def collection_name(self):
-        r"""Gets the collection_name of this GetIndexProgressResponseData.
+        r"""Gets the collection_name of this GetProgressData.
 
-        Collection 名称。
+        **参数解释：** Collection 名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
-        :return: The collection_name of this GetIndexProgressResponseData.
+        :return: The collection_name of this GetProgressData.
         :rtype: str
         """
         return self._collection_name
 
     @collection_name.setter
     def collection_name(self, collection_name):
-        r"""Sets the collection_name of this GetIndexProgressResponseData.
+        r"""Sets the collection_name of this GetProgressData.
 
-        Collection 名称。
+        **参数解释：** Collection 名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
-        :param collection_name: The collection_name of this GetIndexProgressResponseData.
+        :param collection_name: The collection_name of this GetProgressData.
         :type collection_name: str
         """
         self._collection_name = collection_name
 
     @property
     def build_progress(self):
-        r"""Gets the build_progress of this GetIndexProgressResponseData.
+        r"""Gets the build_progress of this GetProgressData.
 
-        :return: The build_progress of this GetIndexProgressResponseData.
+        :return: The build_progress of this GetProgressData.
         :rtype: :class:`huaweicloudsdkdwr.v1.BuildProgress`
         """
         return self._build_progress
 
     @build_progress.setter
     def build_progress(self, build_progress):
-        r"""Sets the build_progress of this GetIndexProgressResponseData.
+        r"""Sets the build_progress of this GetProgressData.
 
-        :param build_progress: The build_progress of this GetIndexProgressResponseData.
+        :param build_progress: The build_progress of this GetProgressData.
         :type build_progress: :class:`huaweicloudsdkdwr.v1.BuildProgress`
         """
         self._build_progress = build_progress
@@ -157,7 +157,7 @@ class GetIndexProgressResponseData:
 
     def __eq__(self, other):
         """Returns true if both objects are equal"""
-        if not isinstance(other, GetIndexProgressResponseData):
+        if not isinstance(other, GetProgressData):
             return False
 
         return self.__dict__ == other.__dict__

huaweicloudsdkdwr/v1/model/get_progress_response.py

@@ -20,7 +20,7 @@ class GetProgressResponse(SdkResponse):
     openapi_types = {
         'code': 'str',
         'message': 'str',
-        'data': 'GetIndexProgressResponseData'
+        'data': 'GetProgressData'
     }
 
     attribute_map = {
@@ -34,12 +34,12 @@ class GetProgressResponse(SdkResponse):
 
         The model defined in huaweicloud sdk
 
-        :param code: 返回码
+        :param code: **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
         :type code: str
-        :param message: 描述信息
+        :param message: **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
         :type message: str
         :param data: 
-        :type data: :class:`huaweicloudsdkdwr.v1.GetIndexProgressResponseData`
+        :type data: :class:`huaweicloudsdkdwr.v1.GetProgressData`
         """
         
         super(GetProgressResponse, self).__init__()
@@ -60,7 +60,7 @@ class GetProgressResponse(SdkResponse):
     def code(self):
         r"""Gets the code of this GetProgressResponse.
 
-        返回码
+        **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :return: The code of this GetProgressResponse.
         :rtype: str
@@ -71,7 +71,7 @@ class GetProgressResponse(SdkResponse):
     def code(self, code):
         r"""Sets the code of this GetProgressResponse.
 
-        返回码
+        **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :param code: The code of this GetProgressResponse.
         :type code: str
@@ -82,7 +82,7 @@ class GetProgressResponse(SdkResponse):
     def message(self):
         r"""Gets the message of this GetProgressResponse.
 
-        描述信息
+        **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :return: The message of this GetProgressResponse.
         :rtype: str
@@ -93,7 +93,7 @@ class GetProgressResponse(SdkResponse):
     def message(self, message):
         r"""Sets the message of this GetProgressResponse.
 
-        描述信息
+        **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :param message: The message of this GetProgressResponse.
         :type message: str
@@ -105,7 +105,7 @@ class GetProgressResponse(SdkResponse):
         r"""Gets the data of this GetProgressResponse.
 
         :return: The data of this GetProgressResponse.
-        :rtype: :class:`huaweicloudsdkdwr.v1.GetIndexProgressResponseData`
+        :rtype: :class:`huaweicloudsdkdwr.v1.GetProgressData`
         """
         return self._data
 
@@ -114,7 +114,7 @@ class GetProgressResponse(SdkResponse):
         r"""Sets the data of this GetProgressResponse.
 
         :param data: The data of this GetProgressResponse.
-        :type data: :class:`huaweicloudsdkdwr.v1.GetIndexProgressResponseData`
+        :type data: :class:`huaweicloudsdkdwr.v1.GetProgressData`
         """
         self._data = data
 

huaweicloudsdkdwr/v1/model/hybrid_search_body.py

@@ -41,17 +41,17 @@ class HybridSearchBody:
 
         The model defined in huaweicloud sdk
 
-        :param store_name: 知识仓实例名称
+        :param store_name: **参数解释：** 知识仓实例名称，region内唯一。 **约束限制：** 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
         :type store_name: str
-        :param collection_name: collection名称
+        :param collection_name: **参数解释：** collection名称，知识仓内唯一。 约束限制： 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
         :type collection_name: str
-        :param output_fields: 配置需返回的字段。
+        :param output_fields: **参数解释：** field名称列表，配置需与搜索结果一起返回的字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** `[ ]`，不返回任何额外的字段数据。
         :type output_fields: list[str]
-        :param top_k: 返回个数限制
+        :param top_k: **参数解释：** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制：** 与offset取值的总和应小于16384。 **取值范围：** `[1, 16384]` **默认取值:** 10
         :type top_k: int
-        :param offset: 搜索结果中要跳过的entity数。
+        :param offset: **参数解释：** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制：** 与top_k取值的总和应小于16384。 **取值范围：** 大于等于0 **默认取值：** 0
         :type offset: int
-        :param sub_search: 
+        :param sub_search: **参数解释：** rerank策略。 **约束限制：** 不涉及 **取值范围：** 不涉及。 **默认取值：** 默认使用rrf算法。
         :type sub_search: list[:class:`huaweicloudsdkdwr.v1.SubSearch`]
         :param rerank: 
         :type rerank: :class:`huaweicloudsdkdwr.v1.Rerank`
@@ -84,7 +84,7 @@ class HybridSearchBody:
     def store_name(self):
         r"""Gets the store_name of this HybridSearchBody.
 
-        知识仓实例名称
+        **参数解释：** 知识仓实例名称，region内唯一。 **约束限制：** 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :return: The store_name of this HybridSearchBody.
         :rtype: str
@@ -95,7 +95,7 @@ class HybridSearchBody:
     def store_name(self, store_name):
         r"""Sets the store_name of this HybridSearchBody.
 
-        知识仓实例名称
+        **参数解释：** 知识仓实例名称，region内唯一。 **约束限制：** 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :param store_name: The store_name of this HybridSearchBody.
         :type store_name: str
@@ -106,7 +106,7 @@ class HybridSearchBody:
     def collection_name(self):
         r"""Gets the collection_name of this HybridSearchBody.
 
-        collection名称
+        **参数解释：** collection名称，知识仓内唯一。 约束限制： 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :return: The collection_name of this HybridSearchBody.
         :rtype: str
@@ -117,7 +117,7 @@ class HybridSearchBody:
     def collection_name(self, collection_name):
         r"""Sets the collection_name of this HybridSearchBody.
 
-        collection名称
+        **参数解释：** collection名称，知识仓内唯一。 约束限制： 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :param collection_name: The collection_name of this HybridSearchBody.
         :type collection_name: str
@@ -128,7 +128,7 @@ class HybridSearchBody:
     def output_fields(self):
         r"""Gets the output_fields of this HybridSearchBody.
 
-        配置需返回的字段。
+        **参数解释：** field名称列表，配置需与搜索结果一起返回的字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** `[ ]`，不返回任何额外的字段数据。
 
         :return: The output_fields of this HybridSearchBody.
         :rtype: list[str]
@@ -139,7 +139,7 @@ class HybridSearchBody:
     def output_fields(self, output_fields):
         r"""Sets the output_fields of this HybridSearchBody.
 
-        配置需返回的字段。
+        **参数解释：** field名称列表，配置需与搜索结果一起返回的字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** `[ ]`，不返回任何额外的字段数据。
 
         :param output_fields: The output_fields of this HybridSearchBody.
         :type output_fields: list[str]
@@ -150,7 +150,7 @@ class HybridSearchBody:
     def top_k(self):
         r"""Gets the top_k of this HybridSearchBody.
 
-        返回个数限制
+        **参数解释：** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制：** 与offset取值的总和应小于16384。 **取值范围：** `[1, 16384]` **默认取值:** 10
 
         :return: The top_k of this HybridSearchBody.
         :rtype: int
@@ -161,7 +161,7 @@ class HybridSearchBody:
     def top_k(self, top_k):
         r"""Sets the top_k of this HybridSearchBody.
 
-        返回个数限制
+        **参数解释：** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制：** 与offset取值的总和应小于16384。 **取值范围：** `[1, 16384]` **默认取值:** 10
 
         :param top_k: The top_k of this HybridSearchBody.
         :type top_k: int
@@ -172,7 +172,7 @@ class HybridSearchBody:
     def offset(self):
         r"""Gets the offset of this HybridSearchBody.
 
-        搜索结果中要跳过的entity数。
+        **参数解释：** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制：** 与top_k取值的总和应小于16384。 **取值范围：** 大于等于0 **默认取值：** 0
 
         :return: The offset of this HybridSearchBody.
         :rtype: int
@@ -183,7 +183,7 @@ class HybridSearchBody:
     def offset(self, offset):
         r"""Sets the offset of this HybridSearchBody.
 
-        搜索结果中要跳过的entity数。
+        **参数解释：** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制：** 与top_k取值的总和应小于16384。 **取值范围：** 大于等于0 **默认取值：** 0
 
         :param offset: The offset of this HybridSearchBody.
         :type offset: int
@@ -194,6 +194,8 @@ class HybridSearchBody:
     def sub_search(self):
         r"""Gets the sub_search of this HybridSearchBody.
 
+        **参数解释：** rerank策略。 **约束限制：** 不涉及 **取值范围：** 不涉及。 **默认取值：** 默认使用rrf算法。
+
         :return: The sub_search of this HybridSearchBody.
         :rtype: list[:class:`huaweicloudsdkdwr.v1.SubSearch`]
         """
@@ -203,6 +205,8 @@ class HybridSearchBody:
     def sub_search(self, sub_search):
         r"""Sets the sub_search of this HybridSearchBody.
 
+        **参数解释：** rerank策略。 **约束限制：** 不涉及 **取值范围：** 不涉及。 **默认取值：** 默认使用rrf算法。
+
         :param sub_search: The sub_search of this HybridSearchBody.
         :type sub_search: list[:class:`huaweicloudsdkdwr.v1.SubSearch`]
         """

huaweicloudsdkdwr/v1/model/hybrid_search_response.py

@@ -20,7 +20,7 @@ class HybridSearchResponse(SdkResponse):
     openapi_types = {
         'code': 'str',
         'message': 'str',
-        'data': 'dict(str, list[dict(str, object)])'
+        'data': 'EntitiesData'
     }
 
     attribute_map = {
@@ -34,12 +34,12 @@ class HybridSearchResponse(SdkResponse):
 
         The model defined in huaweicloud sdk
 
-        :param code: 返回码
+        :param code: **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
         :type code: str
-        :param message: 描述信息
+        :param message: **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
         :type message: str
-        :param data: 响应数据
-        :type data: dict(str, list[dict(str, object)])
+        :param data: 
+        :type data: :class:`huaweicloudsdkdwr.v1.EntitiesData`
         """
         
         super(HybridSearchResponse, self).__init__()
@@ -60,7 +60,7 @@ class HybridSearchResponse(SdkResponse):
     def code(self):
         r"""Gets the code of this HybridSearchResponse.
 
-        返回码
+        **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :return: The code of this HybridSearchResponse.
         :rtype: str
@@ -71,7 +71,7 @@ class HybridSearchResponse(SdkResponse):
     def code(self, code):
         r"""Sets the code of this HybridSearchResponse.
 
-        返回码
+        **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :param code: The code of this HybridSearchResponse.
         :type code: str
@@ -82,7 +82,7 @@ class HybridSearchResponse(SdkResponse):
     def message(self):
         r"""Gets the message of this HybridSearchResponse.
 
-        描述信息
+        **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :return: The message of this HybridSearchResponse.
         :rtype: str
@@ -93,7 +93,7 @@ class HybridSearchResponse(SdkResponse):
     def message(self, message):
         r"""Sets the message of this HybridSearchResponse.
 
-        描述信息
+        **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :param message: The message of this HybridSearchResponse.
         :type message: str
@@ -104,10 +104,8 @@ class HybridSearchResponse(SdkResponse):
     def data(self):
         r"""Gets the data of this HybridSearchResponse.
 
-        响应数据
-
         :return: The data of this HybridSearchResponse.
-        :rtype: dict(str, list[dict(str, object)])
+        :rtype: :class:`huaweicloudsdkdwr.v1.EntitiesData`
         """
         return self._data
 
@@ -115,10 +113,8 @@ class HybridSearchResponse(SdkResponse):
     def data(self, data):
         r"""Sets the data of this HybridSearchResponse.
 
-        响应数据
-
         :param data: The data of this HybridSearchResponse.
-        :type data: dict(str, list[dict(str, object)])
+        :type data: :class:`huaweicloudsdkdwr.v1.EntitiesData`
         """
         self._data = data
 

huaweicloudsdkdwr/v1/model/index_desc.py

@@ -35,13 +35,13 @@ class IndexDesc:
 
         The model defined in huaweicloud sdk
 
-        :param index_name: 索引名
+        :param index_name: **参数解释：** 描述的索引名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
         :type index_name: str
-        :param field_name: 索引对应的列
+        :param field_name: **参数解释：** 索引对应的字段名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
         :type field_name: str
-        :param index_params: 索引的参数信息
+        :param index_params: **参数解释：** 索引的参数信息。详情请查阅IndexParam。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
         :type index_params: dict(str, object)
-        :param index_state: 索引状态：  -\"InProgress\"：索引正在构建中或还未开始构建 -\"Finished\"：索引构建完成 -\"Failed\"：索引构建失败
+        :param index_state: **参数解释：** 索引状态。 **约束限制：** 不涉及。 **取值范围：** -\"InProgress\"：索引正在构建中或还未开始构建。 -\"Finished\"：索引构建完成。 -\"Failed\"：索引构建失败。 **默认取值:** 不涉及。
         :type index_state: str
         """
         
@@ -55,16 +55,14 @@ class IndexDesc:
 
         self.index_name = index_name
         self.field_name = field_name
-        if index_params is not None:
-            self.index_params = index_params
-        if index_state is not None:
-            self.index_state = index_state
+        self.index_params = index_params
+        self.index_state = index_state
 
     @property
     def index_name(self):
         r"""Gets the index_name of this IndexDesc.
 
-        索引名
+        **参数解释：** 描述的索引名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :return: The index_name of this IndexDesc.
         :rtype: str
@@ -75,7 +73,7 @@ class IndexDesc:
     def index_name(self, index_name):
         r"""Sets the index_name of this IndexDesc.
 
-        索引名
+        **参数解释：** 描述的索引名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :param index_name: The index_name of this IndexDesc.
         :type index_name: str
@@ -86,7 +84,7 @@ class IndexDesc:
     def field_name(self):
         r"""Gets the field_name of this IndexDesc.
 
-        索引对应的列
+        **参数解释：** 索引对应的字段名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :return: The field_name of this IndexDesc.
         :rtype: str
@@ -97,7 +95,7 @@ class IndexDesc:
     def field_name(self, field_name):
         r"""Sets the field_name of this IndexDesc.
 
-        索引对应的列
+        **参数解释：** 索引对应的字段名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :param field_name: The field_name of this IndexDesc.
         :type field_name: str
@@ -108,7 +106,7 @@ class IndexDesc:
     def index_params(self):
         r"""Gets the index_params of this IndexDesc.
 
-        索引的参数信息
+        **参数解释：** 索引的参数信息。详情请查阅IndexParam。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :return: The index_params of this IndexDesc.
         :rtype: dict(str, object)
@@ -119,7 +117,7 @@ class IndexDesc:
     def index_params(self, index_params):
         r"""Sets the index_params of this IndexDesc.
 
-        索引的参数信息
+        **参数解释：** 索引的参数信息。详情请查阅IndexParam。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
 
         :param index_params: The index_params of this IndexDesc.
         :type index_params: dict(str, object)
@@ -130,7 +128,7 @@ class IndexDesc:
     def index_state(self):
         r"""Gets the index_state of this IndexDesc.
 
-        索引状态：  -\"InProgress\"：索引正在构建中或还未开始构建 -\"Finished\"：索引构建完成 -\"Failed\"：索引构建失败
+        **参数解释：** 索引状态。 **约束限制：** 不涉及。 **取值范围：** -\"InProgress\"：索引正在构建中或还未开始构建。 -\"Finished\"：索引构建完成。 -\"Failed\"：索引构建失败。 **默认取值:** 不涉及。
 
         :return: The index_state of this IndexDesc.
         :rtype: str
@@ -141,7 +139,7 @@ class IndexDesc:
     def index_state(self, index_state):
         r"""Sets the index_state of this IndexDesc.
 
-        索引状态：  -\"InProgress\"：索引正在构建中或还未开始构建 -\"Finished\"：索引构建完成 -\"Failed\"：索引构建失败
+        **参数解释：** 索引状态。 **约束限制：** 不涉及。 **取值范围：** -\"InProgress\"：索引正在构建中或还未开始构建。 -\"Finished\"：索引构建完成。 -\"Failed\"：索引构建失败。 **默认取值:** 不涉及。
 
         :param index_state: The index_state of this IndexDesc.
         :type index_state: str

huaweicloudsdkdwr/v1/model/index_params.py

@@ -33,11 +33,11 @@ class IndexParams:
 
         The model defined in huaweicloud sdk
 
-        :param index_name: 索引名
+        :param index_name: **参数解释：** 创建的索引名称，collection内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
         :type index_name: str
-        :param field_name: 索引对应的列
+        :param field_name: **参数解释：** 要创建索引的目标字段名称。 **约束限制：** - 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 - field_name必须是collection field schema中存在的字段。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
         :type field_name: str
-        :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:查询聚类的数量
+        :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
         :type params: dict(str, object)
         """
         
@@ -57,7 +57,7 @@ class IndexParams:
     def index_name(self):
         r"""Gets the index_name of this IndexParams.
 
-        索引名
+        **参数解释：** 创建的索引名称，collection内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :return: The index_name of this IndexParams.
         :rtype: str
@@ -68,7 +68,7 @@ class IndexParams:
     def index_name(self, index_name):
         r"""Sets the index_name of this IndexParams.
 
-        索引名
+        **参数解释：** 创建的索引名称，collection内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :param index_name: The index_name of this IndexParams.
         :type index_name: str
@@ -79,7 +79,7 @@ class IndexParams:
     def field_name(self):
         r"""Gets the field_name of this IndexParams.
 
-        索引对应的列
+        **参数解释：** 要创建索引的目标字段名称。 **约束限制：** - 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 - field_name必须是collection field schema中存在的字段。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :return: The field_name of this IndexParams.
         :rtype: str
@@ -90,7 +90,7 @@ class IndexParams:
     def field_name(self, field_name):
         r"""Sets the field_name of this IndexParams.
 
-        索引对应的列
+        **参数解释：** 要创建索引的目标字段名称。 **约束限制：** - 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 - field_name必须是collection field schema中存在的字段。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
 
         :param field_name: The field_name of this IndexParams.
         :type field_name: str
@@ -101,7 +101,7 @@ class IndexParams:
     def params(self):
         r"""Gets the params of this IndexParams.
 
-        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:查询聚类的数量
+        **参数解释：** 创建的索引的参数配置。 可以设置的参数： -  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
 
         :return: The params of this IndexParams.
         :rtype: dict(str, object)
@@ -112,7 +112,7 @@ class IndexParams:
     def params(self, params):
         r"""Sets the params of this IndexParams.
 
-        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:查询聚类的数量
+        **参数解释：** 创建的索引的参数配置。 可以设置的参数： -  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
 
         :param params: The params of this IndexParams.
         :type params: dict(str, object)