Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

增加模型列表获取的SDK #29

Merged
merged 8 commits into from
Jan 4, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions appbuilder/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ def check_version(self):

from appbuilder.utils.logger_util import logger

from appbuilder.core.utils import get_model_list


from .core._exception import (
BadRequestException,
ForbiddenException,
Expand Down
7 changes: 4 additions & 3 deletions appbuilder/core/components/asr/component.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ def run(self, message: Message, audio_format: str = "pcm", rate: int = 16000,
request.cuid = str(uuid.uuid4())
request.dev_pid = "80001"
request.speech = inp.raw_audio
response = self._recognize(request)
response = self._recognize(request, timeout, retry)
out = ASROutMsg(result=list(response.result))
return Message(content=dict(out))

def _recognize(self, request: ShortSpeechRecognitionRequest, timeout: float = None,
retry: int = 0) -> ShortSpeechRecognitionResponse:
retry: int = 0) -> ShortSpeechRecognitionResponse:
"""
使用给定的输入并返回语音识别的结果。
Expand All @@ -89,7 +89,8 @@ def _recognize(self, request: ShortSpeechRecognitionRequest, timeout: float = No
}
if retry != self.http_client.retry.total:
self.http_client.retry.total = retry
response = self.http_client.session.post(self.http_client.service_url("/v1/bce/aip_speech/asrpro"), params=params, headers=headers, data=request.speech, timeout=timeout)
response = self.http_client.session.post(self.http_client.service_url("/v1/bce/aip_speech/asrpro"),
params=params, headers=headers, data=request.speech, timeout=timeout)
self.http_client.check_response_header(response)
data = response.json()
self.http_client.check_response_json(data)
Expand Down
41 changes: 40 additions & 1 deletion appbuilder/core/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,49 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import List


from appbuilder.utils.model_util import GetModelListRequest, Models, map_model_name


def utils_get_user_agent():
return 'appbuilder-sdk-python/{}'.format("__version__")


def get_model_list(secret_key: str = "", apiTypefilter: List[str] = [], is_available: bool = False):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

get_model_list函数的返回类型是不是也可以说明下

Copy link
Contributor

@ide-rea ide-rea Jan 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

函数入参apiTypefilter,可以统一写成下划线

"""
返回用户的模型列表。

参数:
secret_key(str,可选): 用户鉴权token, 默认从环境变量中获取: os.getenv("APPBUILDER_TOKEN", "")。
apiTypefilter(List[str], 可选): 根据apiType过滤,["chat", "completions", "embeddings", "text2image"],不填包括所有的。
is_available(bool, 可选): 返回可用模型列表, 默认返回所有模型。

返回:
List[str]: 模型列表。
"""
request = GetModelListRequest()
request.apiTypefilter = apiTypefilter
model = Models(secret_key=secret_key)
response = model.list(request)
models = []
if is_available:
for common_model in response.result.common:
if common_model.chargeStatus in ["OPENED", "FREE"]:
mapped_name = map_model_name(common_model.name)
models.append(mapped_name)

for custom_model in response.result.custom:
if custom_model.chargeStatus in ["OPENED", "FREE"]:
mapped_name = map_model_name(custom_model.name)
models.append(mapped_name)
return models
else:
for common_model in response.result.common:
mapped_name = map_model_name(common_model.name)
models.append(mapped_name)

for custom_model in response.result.custom:
mapped_name = map_model_name(custom_model.name)
models.append(mapped_name)
return models
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

可以使用一个迭代器,将通用模型与定制化模型连接起来,再进行遍历

import itertools
for  model in itertools.chain(response.result.common, response.result.custom):
    if is_available and common_model.chargeStatus not in ["OPENED", "FREE"]:
        continue
    mapped_name = map_model_name(common_model.name)
    models.append(mapped_name)

71 changes: 71 additions & 0 deletions appbuilder/tests/test_get_model_list.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import unittest

import appbuilder
from appbuilder.utils.model_util import GetModelListRequest, Models, GetModelListResponse


class TestModels(unittest.TestCase):
def setUp(self):
"""
设置环境变量。

Args:
None

Returns:
None.
"""
self.model = Models()

def get_model_list(self):
"""
get_model_list方法单测

Args:
None

Returns:
None

"""
response = appbuilder.get_model_list(apiTypefilter=["chat"])
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 函数命名是 小写, 参数是 驼峰, 需要统一
  2. apiTypefilter 缩短一下变量定义?

self.assertIsNotNone(response)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

只验证 返回是否为空, 需要进一步校验返回值的正确性

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apiTypefilter=["chat"], filter的chat是什么含义

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

就是只返回千帆的对话Chat模型


def test_list(self):
"""
list方法单测

Args:
None

Returns:
None

"""

request = GetModelListRequest()
response = self.model.list(request)
self.assertIsNotNone(response)
self.assertIsInstance(response, GetModelListResponse)

def test_check_service_error(self):
"""
check_service_error方法单测

Args:
None

Returns:
None

"""
data = {'error_msg': 'Error', 'error_code': 1}
request_id = "request_id"
with self.assertRaises(appbuilder.AppBuilderServerException):
self.model._check_service_error(request_id, data)
data = {'error_msg': 'No Error', 'error_code': 0}
self.assertIsNone(self.model._check_service_error(request_id, data))


if __name__ == '__main__':
unittest.main()
Loading
Loading