[Feat] support xunfei api (#547)

opencompass/models/__init__.py

@@ -7,4 +7,5 @@ from .huggingface import HuggingFaceCausalLM  # noqa: F401, F403
 from .intern_model import InternLM  # noqa: F401, F403
 from .llama2 import Llama2, Llama2Chat  # noqa: F401, F403
 from .openai_api import OpenAI  # noqa: F401
+from .xunfei_api import XunFei  # noqa: F401
 from .zhipuai import ZhiPuAI  # noqa: F401

opencompass/models/xunfei_api.py

@@ -0,0 +1,255 @@
+import json
+import sys
+from concurrent.futures import ThreadPoolExecutor
+from typing import Dict, List, Optional, Union
+
+from opencompass.registry import MODELS
+from opencompass.utils.prompt import PromptList
+
+from .base_api import BaseAPIModel
+
+PromptType = Union[PromptList, str]
+
+
+@MODELS.register_module(name=['XunFei'])
+class XunFei(BaseAPIModel):
+    """Model wrapper around XunFei.
+
+    Args:
+        path (str): Provided URL.
+        appid (str): Provided APPID.
+        api_secret (str): Provided APISecret.
+        api_key (str): Provided APIKey.
+        domain (str): Target version domain. Defaults to `general`.
+        query_per_second (int): The maximum queries allowed per second
+            between two consecutive calls of the API. Defaults to 2.
+        max_seq_len (int): Unused here.
+        meta_template (Dict, optional): The model's meta prompt
+            template if needed, in case the requirement of injecting or
+            wrapping of any meta instructions.
+        retry (int): Number of retires if the API call fails. Defaults to 2.
+    """
+
+    def __init__(self,
+                 path: str,
+                 appid: str,
+                 api_secret: str,
+                 api_key: str,
+                 domain: str = 'general',
+                 query_per_second: int = 2,
+                 max_seq_len: int = 2048,
+                 meta_template: Optional[Dict] = None,
+                 retry: int = 2):
+        super().__init__(path=path,
+                         max_seq_len=max_seq_len,
+                         query_per_second=query_per_second,
+                         meta_template=meta_template,
+                         retry=retry)
+        import ssl
+        import threading
+        from urllib.parse import urlencode, urlparse
+
+        import websocket
+        self.urlencode = urlencode
+        self.websocket = websocket
+        self.websocket.enableTrace(False)
+        self.threading = threading
+        self.ssl = ssl
+
+        # weird auth keys
+        self.APISecret = api_secret
+        self.APIKey = api_key
+        self.domain = domain
+        self.appid = appid
+        self.hostname = urlparse(path).netloc
+        self.hostpath = urlparse(path).path
+
+        self.headers = {
+            'content-type': 'application/json',
+        }
+
+    def get_url(self):
+        from datetime import datetime
+        from time import mktime
+        from wsgiref.handlers import format_date_time
+
+        cur_time = datetime.now()
+        date = format_date_time(mktime(cur_time.timetuple()))
+        tmp = f'host: {self.hostname}\n'
+        tmp += 'date: ' + date + '\n'
+        tmp += 'GET ' + self.hostpath + ' HTTP/1.1'
+        import hashlib
+        import hmac
+        tmp_sha = hmac.new(self.APISecret.encode('utf-8'),
+                           tmp.encode('utf-8'),
+                           digestmod=hashlib.sha256).digest()
+        import base64
+        signature = base64.b64encode(tmp_sha).decode(encoding='utf-8')
+        authorization_origin = (f'api_key="{self.APIKey}", '
+                                'algorithm="hmac-sha256", '
+                                'headers="host date request-line", '
+                                f'signature="{signature}"')
+        authorization = base64.b64encode(
+            authorization_origin.encode('utf-8')).decode(encoding='utf-8')
+        v = {
+            'authorization': authorization,
+            'date': date,
+            'host': self.hostname
+        }
+        url = self.path + '?' + self.urlencode(v)
+        return url
+
+    def generate(
+        self,
+        inputs: List[str or PromptList],
+        max_out_len: int = 512,
+    ) -> List[str]:
+        """Generate results given a list of inputs.
+
+        Args:
+            inputs (List[str or PromptList]): A list of strings or PromptDicts.
+                The PromptDict should be organized in OpenCompass'
+                API format.
+            max_out_len (int): The maximum length of the output.
+
+        Returns:
+            List[str]: A list of generated strings.
+        """
+        with ThreadPoolExecutor() as executor:
+            results = list(
+                executor.map(self._generate, inputs,
+                             [max_out_len] * len(inputs)))
+        self.flush()
+        return results
+
+    def flush(self):
+        """Flush stdout and stderr when concurrent resources exists.
+
+        When use multiproessing with standard io rediected to files, need to
+        flush internal information for examination or log loss when system
+        breaks.
+        """
+        if hasattr(self, 'tokens'):
+            sys.stdout.flush()
+            sys.stderr.flush()
+
+    def acquire(self):
+        """Acquire concurrent resources if exists.
+
+        This behavior will fall back to wait with query_per_second if there are
+        no concurrent resources.
+        """
+        if hasattr(self, 'tokens'):
+            self.tokens.acquire()
+        else:
+            self.wait()
+
+    def release(self):
+        """Release concurrent resources if acquired.
+
+        This behavior will fall back to do nothing if there are no concurrent
+        resources.
+        """
+        if hasattr(self, 'tokens'):
+            self.tokens.release()
+
+    def _generate(
+        self,
+        input: str or PromptList,
+        max_out_len: int = 512,
+    ) -> List[str]:
+        """Generate results given an input.
+
+        Args:
+            inputs (str or PromptList): A string or PromptDict.
+                The PromptDict should be organized in OpenCompass'
+                API format.
+            max_out_len (int): The maximum length of the output.
+
+        Returns:
+            str: The generated string.
+        """
+        assert isinstance(input, (str, PromptList))
+
+        # FIXME: messages only contains the last input
+        if isinstance(input, str):
+            messages = [{'role': 'user', 'content': input}]
+        else:
+            messages = []
+            # word_ctr = 0
+            # TODO: Implement truncation in PromptList
+            for item in input:
+                msg = {'content': item['prompt']}
+                # if word_ctr >= self.max_seq_len:
+                #     break
+                # if len(msg['content']) + word_ctr > self.max_seq_len:
+                #     msg['content'] = msg['content'][word_ctr -
+                #                                     self.max_seq_len:]
+                # word_ctr += len(msg['content'])
+                if item['role'] == 'HUMAN':
+                    msg['role'] = 'user'
+                elif item['role'] == 'BOT':
+                    msg['role'] = 'assistant'
+                messages.append(msg)
+            # in case the word break results in even number of messages
+            # if len(messages) > 0 and len(messages) % 2 == 0:
+            #     messages = messages[:-1]
+
+        data = {
+            'header': {
+                'app_id': self.appid,
+            },
+            'parameter': {
+                'chat': {
+                    'domain': self.domain,
+                    'max_tokens': max_out_len,
+                }
+            },
+            'payload': {
+                'message': {
+                    'text': messages
+                }
+            }
+        }
+
+        msg = ''
+        err_code = None
+        err_data = None
+        content_received = self.threading.Event()
+
+        def on_open(ws):
+            nonlocal data
+            ws.send(json.dumps(data))
+
+        def on_message(ws, message):
+            nonlocal msg, err_code, err_data, content_received
+            err_data = json.loads(message)
+            err_code = err_data['header']['code']
+            if err_code != 0:
+                content_received.set()
+                ws.close()
+            else:
+                choices = err_data['payload']['choices']
+                status = choices['status']
+                msg += choices['text'][0]['content']
+                if status == 2:
+                    content_received.set()
+                    ws.close()
+
+        ws = self.websocket.WebSocketApp(self.get_url(),
+                                         on_message=on_message,
+                                         on_open=on_open)
+        ws.appid = self.appid
+        ws.question = messages[-1]['content']
+
+        for _ in range(self.retry):
+            self.acquire()
+            ws.run_forever(sslopt={'cert_reqs': self.ssl.CERT_NONE})
+            content_received.wait()
+            self.release()
+            if err_code == 0:
+                return msg.strip()
+
+        if err_code == 10013:
+            return err_data['header']['message']
+        raise RuntimeError(f'Code: {err_code}, data: {err_data}')