mirror of
https://github.com/eigent-ai/eigent.git
synced 2026-05-24 13:43:45 +00:00
90 lines
3.7 KiB
Python
90 lines
3.7 KiB
Python
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# 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.
|
|
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
|
|
|
|
import os
|
|
from typing import Any, Dict, Optional, Union
|
|
|
|
from camel.configs import ModelScopeConfig
|
|
from camel.models.openai_compatible_model import OpenAICompatibleModel
|
|
from camel.types import ModelType
|
|
from camel.utils import (
|
|
BaseTokenCounter,
|
|
api_keys_required,
|
|
)
|
|
|
|
|
|
class ModelScopeModel(OpenAICompatibleModel):
|
|
r"""ModelScope API in a unified OpenAICompatibleModel interface.
|
|
|
|
Args:
|
|
model_type (Union[ModelType, str]): Model for which a backend is
|
|
created, one of ModelScope series.
|
|
model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
|
|
that will be fed into:obj:`openai.ChatCompletion.create()`. If
|
|
:obj:`None`, :obj:`ModelScopeConfig().as_dict()` will be used.
|
|
(default: :obj:`None`)
|
|
api_key (Optional[str], optional): The MODELSCOPE_SDK_TOKEN for
|
|
authenticating with the ModelScope service. (default: :obj:`None`)
|
|
refer to the following link for more details:
|
|
https://modelscope.cn/my/myaccesstoken
|
|
url (Optional[str], optional): The url to the ModelScope service.
|
|
(default: :obj:`https://api-inference.modelscope.cn/v1/`)
|
|
token_counter (Optional[BaseTokenCounter], optional): Token counter to
|
|
use for the model. If not provided, :obj:`OpenAITokenCounter(
|
|
ModelType.GPT_4O_MINI)` will be used.
|
|
(default: :obj:`None`)
|
|
timeout (Optional[float], optional): The timeout value in seconds for
|
|
API calls. If not provided, will fall back to the MODEL_TIMEOUT
|
|
environment variable or default to 180 seconds.
|
|
(default: :obj:`None`)
|
|
max_retries (int, optional): Maximum number of retries for API calls.
|
|
(default: :obj:`3`)
|
|
**kwargs (Any): Additional arguments to pass to the client
|
|
initialization.
|
|
"""
|
|
|
|
@api_keys_required(
|
|
[
|
|
("api_key", 'MODELSCOPE_SDK_TOKEN'),
|
|
]
|
|
)
|
|
def __init__(
|
|
self,
|
|
model_type: Union[ModelType, str],
|
|
model_config_dict: Optional[Dict[str, Any]] = None,
|
|
api_key: Optional[str] = None,
|
|
url: Optional[str] = None,
|
|
token_counter: Optional[BaseTokenCounter] = None,
|
|
timeout: Optional[float] = None,
|
|
max_retries: int = 3,
|
|
**kwargs: Any,
|
|
) -> None:
|
|
if model_config_dict is None:
|
|
model_config_dict = ModelScopeConfig().as_dict()
|
|
api_key = api_key or os.environ.get("MODELSCOPE_SDK_TOKEN")
|
|
url = url or os.environ.get(
|
|
"MODELSCOPE_API_BASE_URL",
|
|
"https://api-inference.modelscope.cn/v1/",
|
|
)
|
|
timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
|
|
super().__init__(
|
|
model_type=model_type,
|
|
model_config_dict=model_config_dict,
|
|
api_key=api_key,
|
|
url=url,
|
|
token_counter=token_counter,
|
|
timeout=timeout,
|
|
max_retries=max_retries,
|
|
**kwargs,
|
|
)
|