huaweicloudsdkdwr 3.1.160__py3-none-any.whl

huaweicloudsdkdwr/v1/model/search_entities_body.py

@@ -0,0 +1,343 @@
+# coding: utf-8
+
+import six
+
+from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
+
+
+class SearchEntitiesBody:
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    sensitive_list = []
+
+    openapi_types = {
+        'store_name': 'str',
+        'collection_name': 'str',
+        'output_fields': 'list[str]',
+        'top_k': 'int',
+        'offset': 'int',
+        'filter': 'str',
+        'vector': 'list[float]',
+        'vector_field': 'str',
+        'params': 'dict(str, object)'
+    }
+
+    attribute_map = {
+        'store_name': 'store_name',
+        'collection_name': 'collection_name',
+        'output_fields': 'output_fields',
+        'top_k': 'top_k',
+        'offset': 'offset',
+        'filter': 'filter',
+        'vector': 'vector',
+        'vector_field': 'vector_field',
+        'params': 'params'
+    }
+
+    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):
+        r"""SearchEntitiesBody
+
+        The model defined in huaweicloud sdk
+
+        :param store_name: **参数解释：** 知识仓实例名称，region内唯一。 **约束限制：** 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及 **默认取值：** 不涉及
+        :type store_name: str
+        :param collection_name: **参数解释：** collection名称，知识仓内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
+        :type collection_name: str
+        :param output_fields: **参数解释：** field名称列表，配置需与搜索结果一起返回的字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** [ ]，不返回任何额外的字段数据。
+        :type output_fields: list[str]
+        :param top_k: **参数解释：** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制：** 与offset取值的总和应小于16384。 **取值范围：** `[1, 16384]` **默认取值:** 10
+        :type top_k: int
+        :param offset: **参数解释：** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制：** 与top_k取值的总和应小于16384。 **取值范围：** 大于等于0 **默认取值：** 0
+        :type offset: int
+        :param filter: **参数解释：** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制：** 要构建标量过滤条件，请参阅filter表达式规则。 **取值范围：** 不涉及。 **默认取值：** 空字符串，不进行标量过滤。
+        :type filter: str
+        :param vector: **参数解释：** 要搜索的向量字段数据。 **约束限制：** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+        :type vector: list[float]
+        :param vector_field: **参数解释：** 要搜索的向量字段名称。 **约束限制：** 必须是collection field schema中存在的向量字段名称。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+        :type vector_field: str
+        :param params: **参数解释：** 额外的搜索参数配置。 可以配置的参数： - ef: 每个查询的邻居候选集大小。候选集越大，搜索的精度越高，但是搜索时间也会随之增加。（仅对HNSW索引类型生效） - search_list: 候选列表的大小，越大召回率越高，但性能会下降。（仅对HANNS索引类型生效） - radius：查询范围的半径，若指定则进行range查询。  **约束限制：** 不涉及。 **取值范围：**   ef: [top_k + offset, int32_max]  search_list: [top_k + offset, int32_max]  radius: [0, 1.0] **默认取值:**  ef: top_k + offset  search_list: topk_k + offset
+        :type params: dict(str, object)
+        """
+        
+        
+
+        self._store_name = None
+        self._collection_name = None
+        self._output_fields = None
+        self._top_k = None
+        self._offset = None
+        self._filter = None
+        self._vector = None
+        self._vector_field = None
+        self._params = None
+        self.discriminator = None
+
+        self.store_name = store_name
+        self.collection_name = collection_name
+        if output_fields is not None:
+            self.output_fields = output_fields
+        if top_k is not None:
+            self.top_k = top_k
+        if offset is not None:
+            self.offset = offset
+        if filter is not None:
+            self.filter = filter
+        self.vector = vector
+        self.vector_field = vector_field
+        if params is not None:
+            self.params = params
+
+    @property
+    def store_name(self):
+        r"""Gets the store_name of this SearchEntitiesBody.
+
+        **参数解释：** 知识仓实例名称，region内唯一。 **约束限制：** 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及 **默认取值：** 不涉及
+
+        :return: The store_name of this SearchEntitiesBody.
+        :rtype: str
+        """
+        return self._store_name
+
+    @store_name.setter
+    def store_name(self, store_name):
+        r"""Sets the store_name of this SearchEntitiesBody.
+
+        **参数解释：** 知识仓实例名称，region内唯一。 **约束限制：** 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及 **默认取值：** 不涉及
+
+        :param store_name: The store_name of this SearchEntitiesBody.
+        :type store_name: str
+        """
+        self._store_name = store_name
+
+    @property
+    def collection_name(self):
+        r"""Gets the collection_name of this SearchEntitiesBody.
+
+        **参数解释：** collection名称，知识仓内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
+
+        :return: The collection_name of this SearchEntitiesBody.
+        :rtype: str
+        """
+        return self._collection_name
+
+    @collection_name.setter
+    def collection_name(self, collection_name):
+        r"""Sets the collection_name of this SearchEntitiesBody.
+
+        **参数解释：** collection名称，知识仓内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。
+
+        :param collection_name: The collection_name of this SearchEntitiesBody.
+        :type collection_name: str
+        """
+        self._collection_name = collection_name
+
+    @property
+    def output_fields(self):
+        r"""Gets the output_fields of this SearchEntitiesBody.
+
+        **参数解释：** field名称列表，配置需与搜索结果一起返回的字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** [ ]，不返回任何额外的字段数据。
+
+        :return: The output_fields of this SearchEntitiesBody.
+        :rtype: list[str]
+        """
+        return self._output_fields
+
+    @output_fields.setter
+    def output_fields(self, output_fields):
+        r"""Sets the output_fields of this SearchEntitiesBody.
+
+        **参数解释：** field名称列表，配置需与搜索结果一起返回的字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** [ ]，不返回任何额外的字段数据。
+
+        :param output_fields: The output_fields of this SearchEntitiesBody.
+        :type output_fields: list[str]
+        """
+        self._output_fields = output_fields
+
+    @property
+    def top_k(self):
+        r"""Gets the top_k of this SearchEntitiesBody.
+
+        **参数解释：** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制：** 与offset取值的总和应小于16384。 **取值范围：** `[1, 16384]` **默认取值:** 10
+
+        :return: The top_k of this SearchEntitiesBody.
+        :rtype: int
+        """
+        return self._top_k
+
+    @top_k.setter
+    def top_k(self, top_k):
+        r"""Sets the top_k of this SearchEntitiesBody.
+
+        **参数解释：** 返回的entity个数限制。可以将此参数与offset结合使用以启用分页。 **约束限制：** 与offset取值的总和应小于16384。 **取值范围：** `[1, 16384]` **默认取值:** 10
+
+        :param top_k: The top_k of this SearchEntitiesBody.
+        :type top_k: int
+        """
+        self._top_k = top_k
+
+    @property
+    def offset(self):
+        r"""Gets the offset of this SearchEntitiesBody.
+
+        **参数解释：** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制：** 与top_k取值的总和应小于16384。 **取值范围：** 大于等于0 **默认取值：** 0
+
+        :return: The offset of this SearchEntitiesBody.
+        :rtype: int
+        """
+        return self._offset
+
+    @offset.setter
+    def offset(self, offset):
+        r"""Sets the offset of this SearchEntitiesBody.
+
+        **参数解释：** 在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。 **约束限制：** 与top_k取值的总和应小于16384。 **取值范围：** 大于等于0 **默认取值：** 0
+
+        :param offset: The offset of this SearchEntitiesBody.
+        :type offset: int
+        """
+        self._offset = offset
+
+    @property
+    def filter(self):
+        r"""Gets the filter of this SearchEntitiesBody.
+
+        **参数解释：** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制：** 要构建标量过滤条件，请参阅filter表达式规则。 **取值范围：** 不涉及。 **默认取值：** 空字符串，不进行标量过滤。
+
+        :return: The filter of this SearchEntitiesBody.
+        :rtype: str
+        """
+        return self._filter
+
+    @filter.setter
+    def filter(self, filter):
+        r"""Sets the filter of this SearchEntitiesBody.
+
+        **参数解释：** 用于过滤匹配entity的标量过滤条件。可以将此设置为空字符串以跳过标量过滤。 **约束限制：** 要构建标量过滤条件，请参阅filter表达式规则。 **取值范围：** 不涉及。 **默认取值：** 空字符串，不进行标量过滤。
+
+        :param filter: The filter of this SearchEntitiesBody.
+        :type filter: str
+        """
+        self._filter = filter
+
+    @property
+    def vector(self):
+        r"""Gets the vector of this SearchEntitiesBody.
+
+        **参数解释：** 要搜索的向量字段数据。 **约束限制：** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+
+        :return: The vector of this SearchEntitiesBody.
+        :rtype: list[float]
+        """
+        return self._vector
+
+    @vector.setter
+    def vector(self, vector):
+        r"""Sets the vector of this SearchEntitiesBody.
+
+        **参数解释：** 要搜索的向量字段数据。 **约束限制：** 与collection field schema中定义的对应向量字段的类型和维度一致。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+
+        :param vector: The vector of this SearchEntitiesBody.
+        :type vector: list[float]
+        """
+        self._vector = vector
+
+    @property
+    def vector_field(self):
+        r"""Gets the vector_field of this SearchEntitiesBody.
+
+        **参数解释：** 要搜索的向量字段名称。 **约束限制：** 必须是collection field schema中存在的向量字段名称。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+
+        :return: The vector_field of this SearchEntitiesBody.
+        :rtype: str
+        """
+        return self._vector_field
+
+    @vector_field.setter
+    def vector_field(self, vector_field):
+        r"""Sets the vector_field of this SearchEntitiesBody.
+
+        **参数解释：** 要搜索的向量字段名称。 **约束限制：** 必须是collection field schema中存在的向量字段名称。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+
+        :param vector_field: The vector_field of this SearchEntitiesBody.
+        :type vector_field: str
+        """
+        self._vector_field = vector_field
+
+    @property
+    def params(self):
+        r"""Gets the params of this SearchEntitiesBody.
+
+        **参数解释：** 额外的搜索参数配置。 可以配置的参数： - ef: 每个查询的邻居候选集大小。候选集越大，搜索的精度越高，但是搜索时间也会随之增加。（仅对HNSW索引类型生效） - search_list: 候选列表的大小，越大召回率越高，但性能会下降。（仅对HANNS索引类型生效） - radius：查询范围的半径，若指定则进行range查询。  **约束限制：** 不涉及。 **取值范围：**   ef: [top_k + offset, int32_max]  search_list: [top_k + offset, int32_max]  radius: [0, 1.0] **默认取值:**  ef: top_k + offset  search_list: topk_k + offset
+
+        :return: The params of this SearchEntitiesBody.
+        :rtype: dict(str, object)
+        """
+        return self._params
+
+    @params.setter
+    def params(self, params):
+        r"""Sets the params of this SearchEntitiesBody.
+
+        **参数解释：** 额外的搜索参数配置。 可以配置的参数： - ef: 每个查询的邻居候选集大小。候选集越大，搜索的精度越高，但是搜索时间也会随之增加。（仅对HNSW索引类型生效） - search_list: 候选列表的大小，越大召回率越高，但性能会下降。（仅对HANNS索引类型生效） - radius：查询范围的半径，若指定则进行range查询。  **约束限制：** 不涉及。 **取值范围：**   ef: [top_k + offset, int32_max]  search_list: [top_k + offset, int32_max]  radius: [0, 1.0] **默认取值:**  ef: top_k + offset  search_list: topk_k + offset
+
+        :param params: The params of this SearchEntitiesBody.
+        :type params: dict(str, object)
+        """
+        self._params = params
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                if attr in self.sensitive_list:
+                    result[attr] = "****"
+                else:
+                    result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        import simplejson as json
+        if six.PY2:
+            import sys
+            reload(sys)
+            sys.setdefaultencoding("utf-8")
+        return json.dumps(sanitize_for_serialization(self), ensure_ascii=False)
+
+    def __repr__(self):
+        """For `print`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, SearchEntitiesBody):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other

huaweicloudsdkdwr/v1/model/search_entities_request.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+import six
+
+from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
+
+
+class SearchEntitiesRequest:
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    sensitive_list = []
+
+    openapi_types = {
+        'body': 'SearchEntitiesBody'
+    }
+
+    attribute_map = {
+        'body': 'body'
+    }
+
+    def __init__(self, body=None):
+        r"""SearchEntitiesRequest
+
+        The model defined in huaweicloud sdk
+
+        :param body: Body of the SearchEntitiesRequest
+        :type body: :class:`huaweicloudsdkdwr.v1.SearchEntitiesBody`
+        """
+        
+        
+
+        self._body = None
+        self.discriminator = None
+
+        if body is not None:
+            self.body = body
+
+    @property
+    def body(self):
+        r"""Gets the body of this SearchEntitiesRequest.
+
+        :return: The body of this SearchEntitiesRequest.
+        :rtype: :class:`huaweicloudsdkdwr.v1.SearchEntitiesBody`
+        """
+        return self._body
+
+    @body.setter
+    def body(self, body):
+        r"""Sets the body of this SearchEntitiesRequest.
+
+        :param body: The body of this SearchEntitiesRequest.
+        :type body: :class:`huaweicloudsdkdwr.v1.SearchEntitiesBody`
+        """
+        self._body = body
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                if attr in self.sensitive_list:
+                    result[attr] = "****"
+                else:
+                    result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        import simplejson as json
+        if six.PY2:
+            import sys
+            reload(sys)
+            sys.setdefaultencoding("utf-8")
+        return json.dumps(sanitize_for_serialization(self), ensure_ascii=False)
+
+    def __repr__(self):
+        """For `print`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, SearchEntitiesRequest):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other

huaweicloudsdkdwr/v1/model/search_entities_response.py

@@ -0,0 +1,170 @@
+# coding: utf-8
+
+import six
+
+from huaweicloudsdkcore.sdk_response import SdkResponse
+from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
+
+
+class SearchEntitiesResponse(SdkResponse):
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    sensitive_list = []
+
+    openapi_types = {
+        'code': 'str',
+        'message': 'str',
+        'data': 'EntitiesData'
+    }
+
+    attribute_map = {
+        'code': 'code',
+        'message': 'message',
+        'data': 'data'
+    }
+
+    def __init__(self, code=None, message=None, data=None):
+        r"""SearchEntitiesResponse
+
+        The model defined in huaweicloud sdk
+
+        :param code: **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+        :type code: str
+        :param message: **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+        :type message: str
+        :param data: 
+        :type data: :class:`huaweicloudsdkdwr.v1.EntitiesData`
+        """
+        
+        super(SearchEntitiesResponse, self).__init__()
+
+        self._code = None
+        self._message = None
+        self._data = None
+        self.discriminator = None
+
+        if code is not None:
+            self.code = code
+        if message is not None:
+            self.message = message
+        if data is not None:
+            self.data = data
+
+    @property
+    def code(self):
+        r"""Gets the code of this SearchEntitiesResponse.
+
+        **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+
+        :return: The code of this SearchEntitiesResponse.
+        :rtype: str
+        """
+        return self._code
+
+    @code.setter
+    def code(self, code):
+        r"""Sets the code of this SearchEntitiesResponse.
+
+        **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+
+        :param code: The code of this SearchEntitiesResponse.
+        :type code: str
+        """
+        self._code = code
+
+    @property
+    def message(self):
+        r"""Gets the message of this SearchEntitiesResponse.
+
+        **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+
+        :return: The message of this SearchEntitiesResponse.
+        :rtype: str
+        """
+        return self._message
+
+    @message.setter
+    def message(self, message):
+        r"""Sets the message of this SearchEntitiesResponse.
+
+        **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。
+
+        :param message: The message of this SearchEntitiesResponse.
+        :type message: str
+        """
+        self._message = message
+
+    @property
+    def data(self):
+        r"""Gets the data of this SearchEntitiesResponse.
+
+        :return: The data of this SearchEntitiesResponse.
+        :rtype: :class:`huaweicloudsdkdwr.v1.EntitiesData`
+        """
+        return self._data
+
+    @data.setter
+    def data(self, data):
+        r"""Sets the data of this SearchEntitiesResponse.
+
+        :param data: The data of this SearchEntitiesResponse.
+        :type data: :class:`huaweicloudsdkdwr.v1.EntitiesData`
+        """
+        self._data = data
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                if attr in self.sensitive_list:
+                    result[attr] = "****"
+                else:
+                    result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        import simplejson as json
+        if six.PY2:
+            import sys
+            reload(sys)
+            sys.setdefaultencoding("utf-8")
+        return json.dumps(sanitize_for_serialization(self), ensure_ascii=False)
+
+    def __repr__(self):
+        """For `print`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, SearchEntitiesResponse):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other