huaweicloudsdkversatile 3.1.184__py3-none-any.whl

huaweicloudsdkversatile/v1/model/workflow_run_stream_rsp.py

@@ -0,0 +1,195 @@
+# coding: utf-8
+
+from huaweicloudsdkcore.utils.http_utils import sanitize_for_serialization
+
+
+class WorkflowRunStreamRsp:
+
+    """
+    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 = {
+        'event': 'str',
+        'conversation_id': 'str',
+        'data': 'object',
+        'created_time': 'int'
+    }
+
+    attribute_map = {
+        'event': 'event',
+        'conversation_id': 'conversation_id',
+        'data': 'data',
+        'created_time': 'createdTime'
+    }
+
+    def __init__(self, event=None, conversation_id=None, data=None, created_time=None):
+        r"""WorkflowRunStreamRsp
+
+        The model defined in huaweicloud sdk
+
+        :param event: 事件类型：1、workflow_started 2、node_started 3、node_wait 4、node_finished 5、workflow_finished 6、text_chunk ：流式输出到对话框的信息
+        :type event: str
+        :param conversation_id: 执行的conversation_id
+        :type conversation_id: str
+        :param data: 类型说明：1. node_started，node_finished，node_wait data使用NodeInfo对象 2. workflow_started, workflow_finished  data使用 WorkflowInfo对象 3. text_chunk使用对象TextChunk
+        :type data: object
+        :param created_time: 事件发生时间
+        :type created_time: int
+        """
+        
+        
+
+        self._event = None
+        self._conversation_id = None
+        self._data = None
+        self._created_time = None
+        self.discriminator = None
+
+        if event is not None:
+            self.event = event
+        if conversation_id is not None:
+            self.conversation_id = conversation_id
+        if data is not None:
+            self.data = data
+        if created_time is not None:
+            self.created_time = created_time
+
+    @property
+    def event(self):
+        r"""Gets the event of this WorkflowRunStreamRsp.
+
+        事件类型：1、workflow_started 2、node_started 3、node_wait 4、node_finished 5、workflow_finished 6、text_chunk ：流式输出到对话框的信息
+
+        :return: The event of this WorkflowRunStreamRsp.
+        :rtype: str
+        """
+        return self._event
+
+    @event.setter
+    def event(self, event):
+        r"""Sets the event of this WorkflowRunStreamRsp.
+
+        事件类型：1、workflow_started 2、node_started 3、node_wait 4、node_finished 5、workflow_finished 6、text_chunk ：流式输出到对话框的信息
+
+        :param event: The event of this WorkflowRunStreamRsp.
+        :type event: str
+        """
+        self._event = event
+
+    @property
+    def conversation_id(self):
+        r"""Gets the conversation_id of this WorkflowRunStreamRsp.
+
+        执行的conversation_id
+
+        :return: The conversation_id of this WorkflowRunStreamRsp.
+        :rtype: str
+        """
+        return self._conversation_id
+
+    @conversation_id.setter
+    def conversation_id(self, conversation_id):
+        r"""Sets the conversation_id of this WorkflowRunStreamRsp.
+
+        执行的conversation_id
+
+        :param conversation_id: The conversation_id of this WorkflowRunStreamRsp.
+        :type conversation_id: str
+        """
+        self._conversation_id = conversation_id
+
+    @property
+    def data(self):
+        r"""Gets the data of this WorkflowRunStreamRsp.
+
+        类型说明：1. node_started，node_finished，node_wait data使用NodeInfo对象 2. workflow_started, workflow_finished  data使用 WorkflowInfo对象 3. text_chunk使用对象TextChunk
+
+        :return: The data of this WorkflowRunStreamRsp.
+        :rtype: object
+        """
+        return self._data
+
+    @data.setter
+    def data(self, data):
+        r"""Sets the data of this WorkflowRunStreamRsp.
+
+        类型说明：1. node_started，node_finished，node_wait data使用NodeInfo对象 2. workflow_started, workflow_finished  data使用 WorkflowInfo对象 3. text_chunk使用对象TextChunk
+
+        :param data: The data of this WorkflowRunStreamRsp.
+        :type data: object
+        """
+        self._data = data
+
+    @property
+    def created_time(self):
+        r"""Gets the created_time of this WorkflowRunStreamRsp.
+
+        事件发生时间
+
+        :return: The created_time of this WorkflowRunStreamRsp.
+        :rtype: int
+        """
+        return self._created_time
+
+    @created_time.setter
+    def created_time(self, created_time):
+        r"""Sets the created_time of this WorkflowRunStreamRsp.
+
+        事件发生时间
+
+        :param created_time: The created_time of this WorkflowRunStreamRsp.
+        :type created_time: int
+        """
+        self._created_time = created_time
+
+    def to_dict(self):
+        result = {}
+
+        for attr, _ in self.openapi_types.items():
+            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
+        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, WorkflowRunStreamRsp):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other

huaweicloudsdkversatile/v1/region/versatile_region.py

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+from huaweicloudsdkcore.region.region import Region
+from huaweicloudsdkcore.region.provider import RegionProviderChain
+
+class VersatileRegion:
+    _PROVIDER = RegionProviderChain.get_default_region_provider_chain("VERSATILE")
+
+    CN_NORTH_4 = Region("cn-north-4",
+                        "https://versatile.cn-north-4.myhuaweicloud.com")
+
+    static_fields = {
+        "cn-north-4": CN_NORTH_4,
+    }
+
+    @classmethod
+    def value_of(cls, region_id, static_fields=None):
+        if not region_id:
+            raise KeyError("Unexpected empty parameter: region_id")
+
+        fields = static_fields or cls.static_fields
+
+        region = cls._PROVIDER.get_region(region_id)
+        if region:
+            return region
+
+        if region_id in fields:
+            return fields.get(region_id)
+
+        raise KeyError("region_id '%s' is not in the following supported regions of service 'Versatile': [%s]" % (
+            region_id, ", ".join(sorted(fields.keys()))))

huaweicloudsdkversatile/v1/versatile_async_client.py

@@ -0,0 +1,378 @@
+# coding: utf-8
+
+from __future__ import absolute_import
+
+import importlib
+import warnings
+
+from huaweicloudsdkcore.client import Client, ClientBuilder
+from huaweicloudsdkcore.utils import http_utils
+from huaweicloudsdkcore.sdk_stream_request import SdkStreamRequest
+
+try:
+    from huaweicloudsdkcore.invoker.invoker import AsyncInvoker
+except ImportError as e:
+    warnings.warn(str(e) + ", please check if you are using the same versions of 'huaweicloudsdkcore' and 'huaweicloudsdkversatile'")
+
+
+class VersatileAsyncClient(Client):
+    def __init__(self):
+        super().__init__()
+        self.model_package = importlib.import_module("huaweicloudsdkversatile.v1.model")
+
+    @classmethod
+    def new_builder(cls, clazz=None):
+        if not clazz:
+            client_builder = ClientBuilder(cls)
+        else:
+            if clazz.__name__ != "VersatileAsyncClient":
+                raise TypeError("client type error, support client type is VersatileAsyncClient")
+            client_builder = ClientBuilder(clazz)
+
+        
+
+        return client_builder
+
+    def search_knowledge_base_async(self, request):
+        r"""知识库检索
+
+        提供多知识库并行检索能力，支持语义、关键词、混合及FAQ四种检索模式，并允许自定义相似度阈值与返回结果数量，实现精准高效的信息匹配。
+        
+        **适用场景**：
+        - 同时从多个知识库或文档集合中搜索相关内容。
+        - 在预设的问答列表中快速定位最相关的答案（FAQ检索）。
+        - 通过混合模式或调整阈值，兼顾搜索结果的准确性和全面性。
+        
+        Please refer to HUAWEI cloud API Explorer for details.
+
+
+        :param request: Request instance for SearchKnowledgeBase
+        :type request: :class:`huaweicloudsdkversatile.v1.SearchKnowledgeBaseRequest`
+        :rtype: :class:`huaweicloudsdkversatile.v1.SearchKnowledgeBaseResponse`
+        """
+        http_info = self._search_knowledge_base_http_info(request)
+        return self._call_api(**http_info)
+
+    def search_knowledge_base_async_invoker(self, request):
+        http_info = self._search_knowledge_base_http_info(request)
+        return AsyncInvoker(self, http_info)
+
+    def _search_knowledge_base_http_info(self, request):
+        http_info = {
+            "method": "POST",
+            "resource_path": "/v2/{project_id}/knowledge-bases/retrieve",
+            "request_type": request.__class__.__name__,
+            "response_type": "SearchKnowledgeBaseResponse"
+            }
+
+        local_var_params = {attr: getattr(request, attr) for attr in request.attribute_map if hasattr(request, attr)}
+
+        cname = None
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = {}
+
+        body = None
+        if 'body' in local_var_params:
+            body = local_var_params['body']
+        if isinstance(request, SdkStreamRequest):
+            body = request.get_file_stream()
+
+        response_headers = []
+
+        header_params['Content-Type'] = http_utils.select_header_content_type(
+            ['application/json'])
+
+        auth_settings = []
+
+        http_info["cname"] = cname
+        http_info["collection_formats"] = collection_formats
+        http_info["path_params"] = path_params
+        http_info["query_params"] = query_params
+        http_info["header_params"] = header_params
+        http_info["post_params"] = form_params
+        http_info["body"] = body
+        http_info["response_headers"] = response_headers
+
+        return http_info
+
+    def run_agent_async(self, request):
+        r"""运行一个智能体
+
+        运行一个智能体，支持流式和非流式
+        
+        Please refer to HUAWEI cloud API Explorer for details.
+
+
+        :param request: Request instance for RunAgent
+        :type request: :class:`huaweicloudsdkversatile.v1.RunAgentRequest`
+        :rtype: :class:`huaweicloudsdkversatile.v1.RunAgentResponse`
+        """
+        http_info = self._run_agent_http_info(request)
+        return self._call_api(**http_info)
+
+    def run_agent_async_invoker(self, request):
+        http_info = self._run_agent_http_info(request)
+        return AsyncInvoker(self, http_info)
+
+    def _run_agent_http_info(self, request):
+        http_info = {
+            "method": "POST",
+            "resource_path": "/v1/{project_id}/agents/{agent_id}/conversations/{conversation_id}",
+            "request_type": request.__class__.__name__,
+            "response_type": "RunAgentResponse"
+            }
+
+        local_var_params = {attr: getattr(request, attr) for attr in request.attribute_map if hasattr(request, attr)}
+
+        cname = None
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'agent_id' in local_var_params:
+            path_params['agent_id'] = local_var_params['agent_id']
+        if 'conversation_id' in local_var_params:
+            path_params['conversation_id'] = local_var_params['conversation_id']
+
+        query_params = []
+        if 'workspace_id' in local_var_params:
+            query_params.append(('workspace_id', local_var_params['workspace_id']))
+        if 'version' in local_var_params:
+            query_params.append(('version', local_var_params['version']))
+        if 'type' in local_var_params:
+            query_params.append(('type', local_var_params['type']))
+
+        header_params = {}
+        if 'stream' in local_var_params:
+            header_params['stream'] = local_var_params['stream']
+
+        form_params = {}
+
+        body = None
+        if 'body' in local_var_params:
+            body = local_var_params['body']
+        if isinstance(request, SdkStreamRequest):
+            body = request.get_file_stream()
+
+        response_headers = []
+
+        header_params['Content-Type'] = http_utils.select_header_content_type(
+            ['application/json'])
+
+        auth_settings = []
+
+        http_info["cname"] = cname
+        http_info["collection_formats"] = collection_formats
+        http_info["path_params"] = path_params
+        http_info["query_params"] = query_params
+        http_info["header_params"] = header_params
+        http_info["post_params"] = form_params
+        http_info["body"] = body
+        http_info["response_headers"] = response_headers
+
+        return http_info
+
+    def run_workflow_async(self, request):
+        r"""运行一个工作流
+
+        运行一个工作流，支持流式和非流式
+        
+        Please refer to HUAWEI cloud API Explorer for details.
+
+
+        :param request: Request instance for RunWorkflow
+        :type request: :class:`huaweicloudsdkversatile.v1.RunWorkflowRequest`
+        :rtype: :class:`huaweicloudsdkversatile.v1.RunWorkflowResponse`
+        """
+        http_info = self._run_workflow_http_info(request)
+        return self._call_api(**http_info)
+
+    def run_workflow_async_invoker(self, request):
+        http_info = self._run_workflow_http_info(request)
+        return AsyncInvoker(self, http_info)
+
+    def _run_workflow_http_info(self, request):
+        http_info = {
+            "method": "POST",
+            "resource_path": "/v1/{project_id}/workflows/{workflow_id}/conversations/{conversation_id}",
+            "request_type": request.__class__.__name__,
+            "response_type": "RunWorkflowResponse"
+            }
+
+        local_var_params = {attr: getattr(request, attr) for attr in request.attribute_map if hasattr(request, attr)}
+
+        cname = None
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'workflow_id' in local_var_params:
+            path_params['workflow_id'] = local_var_params['workflow_id']
+        if 'conversation_id' in local_var_params:
+            path_params['conversation_id'] = local_var_params['conversation_id']
+
+        query_params = []
+        if 'workspace_id' in local_var_params:
+            query_params.append(('workspace_id', local_var_params['workspace_id']))
+        if 'version' in local_var_params:
+            query_params.append(('version', local_var_params['version']))
+
+        header_params = {}
+        if 'stream' in local_var_params:
+            header_params['stream'] = local_var_params['stream']
+
+        form_params = {}
+
+        body = None
+        if 'body' in local_var_params:
+            body = local_var_params['body']
+        if isinstance(request, SdkStreamRequest):
+            body = request.get_file_stream()
+
+        response_headers = []
+
+        header_params['Content-Type'] = http_utils.select_header_content_type(
+            ['application/json'])
+
+        auth_settings = []
+
+        http_info["cname"] = cname
+        http_info["collection_formats"] = collection_formats
+        http_info["path_params"] = path_params
+        http_info["query_params"] = query_params
+        http_info["header_params"] = header_params
+        http_info["post_params"] = form_params
+        http_info["body"] = body
+        http_info["response_headers"] = response_headers
+
+        return http_info
+
+    def upload_agent_file_async(self, request):
+        r"""上传文件
+
+        上传文件，以供agent或者工作流使用
+        
+        Please refer to HUAWEI cloud API Explorer for details.
+
+
+        :param request: Request instance for UploadAgentFile
+        :type request: :class:`huaweicloudsdkversatile.v1.UploadAgentFileRequest`
+        :rtype: :class:`huaweicloudsdkversatile.v1.UploadAgentFileResponse`
+        """
+        http_info = self._upload_agent_file_http_info(request)
+        return self._call_api(**http_info)
+
+    def upload_agent_file_async_invoker(self, request):
+        http_info = self._upload_agent_file_http_info(request)
+        return AsyncInvoker(self, http_info)
+
+    def _upload_agent_file_http_info(self, request):
+        http_info = {
+            "method": "POST",
+            "resource_path": "/v1/{project_id}/agent-runtime/upload-file",
+            "request_type": request.__class__.__name__,
+            "response_type": "UploadAgentFileResponse"
+            }
+
+        local_var_params = {attr: getattr(request, attr) for attr in request.attribute_map if hasattr(request, attr)}
+
+        cname = None
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'workspace_id' in local_var_params:
+            query_params.append(('workspace_id', local_var_params['workspace_id']))
+        if 'expires' in local_var_params:
+            query_params.append(('expires', local_var_params['expires']))
+        if 'is_image' in local_var_params:
+            query_params.append(('is_image', local_var_params['is_image']))
+
+        header_params = {}
+
+        form_params = {}
+        if 'file' in local_var_params:
+            form_params['file'] = local_var_params['file']
+
+        body = None
+        if 'body' in local_var_params:
+            body = local_var_params['body']
+        if isinstance(request, SdkStreamRequest):
+            body = request.get_file_stream()
+
+        response_headers = []
+
+        header_params['Content-Type'] = http_utils.select_header_content_type(
+            ['multipart/form-data'])
+
+        auth_settings = []
+
+        http_info["cname"] = cname
+        http_info["collection_formats"] = collection_formats
+        http_info["path_params"] = path_params
+        http_info["query_params"] = query_params
+        http_info["header_params"] = header_params
+        http_info["post_params"] = form_params
+        http_info["body"] = body
+        http_info["response_headers"] = response_headers
+
+        return http_info
+
+    def _call_api(self, **kwargs):
+        try:
+            kwargs["async_request"] = True
+            return self.do_http_request(**kwargs)
+        except TypeError:
+            import inspect
+            params = inspect.signature(self.do_http_request).parameters
+            http_info = {param_name: kwargs.get(param_name) for param_name in params if param_name in kwargs}
+            return self.do_http_request(**http_info)
+
+    def call_api(self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None,
+                 post_params=None, cname=None, response_type=None, response_headers=None, auth_settings=None,
+                 collection_formats=None, request_type=None):
+        """Makes the HTTP request and returns deserialized data.
+
+        :param resource_path: Path to method endpoint.
+        :param method: Method to call.
+        :param path_params: Path parameters in the url.
+        :param query_params: Query parameters in the url.
+        :param header_params: Header parameters to be
+            placed in the request header.
+        :param body: Request body.
+        :param post_params: Request post form parameters,
+            for `application/x-www-form-urlencoded`, `multipart/form-data`.
+        :param cname: Used for obs endpoint.
+        :param auth_settings: Auth Settings names for the request.
+        :param response_type: Response data type.
+        :param response_headers: Header should be added to response data.
+        :param collection_formats: dict of collection formats for path, query,
+            header, and post parameters.
+        :param request_type: Request data type.
+        :return:
+            Return the response directly.
+        """
+        return self.do_http_request(
+            method=method,
+            resource_path=resource_path,
+            path_params=path_params,
+            query_params=query_params,
+            header_params=header_params,
+            body=body,
+            post_params=post_params,
+            cname=cname,
+            response_type=response_type,
+            response_headers=response_headers,
+            collection_formats=collection_formats,
+            request_type=request_type,
+	        async_request=True)