Camel.models.sglang model

​

SGLangModel

class SGLangModel(BaseModelBackend):

• model_type (Union[ModelType, str]): Model for which a backend is created.
• model_config_dict (Optional[Dict[str, Any]], optional): A dictionary that will be fed into:obj:openai.ChatCompletion.create(). If :obj:None, :obj:SGLangConfig().as_dict() will be used. (default: :obj:None)
• api_key (Optional[str], optional): The API key for authenticating with the model service. SGLang doesn’t need API key, it would be ignored if set. (default: :obj:None)
• url (Optional[str], optional): The url to the model service. If not provided, :obj:"http://127.0.0.1:30000/v1" will be used. (default: :obj:None)
• 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)
• client (Optional[Any], optional): A custom synchronous OpenAI-compatible client instance. If provided, this client will be used instead of creating a new one. Note: When using custom clients with SGLang, server auto-start features will be disabled. (default: :obj:None)
• async_client (Optional[Any], optional): A custom asynchronous OpenAI-compatible client instance. If provided, this client will be used instead of creating a new one. (default: :obj:None) **kwargs (Any): Additional arguments to pass to the client initialization. Ignored if custom clients are provided.
• Reference: https://sgl-project.github.io/backend/openai_api_completions. html

​

init

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,
    client: Optional[Any] = None,
    async_client: Optional[Any] = None,
    **kwargs: Any
):

​

_start_server

def _start_server(self):

​

_ensure_server_running

def _ensure_server_running(self):

​

_monitor_inactivity

def _monitor_inactivity(self):

​

token_counter

def token_counter(self):

​

_run

def _run(
    self,
    messages: List[OpenAIMessage],
    response_format: Optional[Type[BaseModel]] = None,
    tools: Optional[List[Dict[str, Any]]] = None
):

• messages (List[OpenAIMessage]): Message list with the chat history in OpenAI API format.

​

stream

def stream(self):

​

del

def __del__(self):

​

cleanup

def cleanup(self):

​

_terminate_process

def _terminate_process(process):

​

_kill_process_tree

def _kill_process_tree(
    parent_pid,
    include_parent: bool = True,
    skip_pid: Optional[int] = None
):

​

_execute_shell_command

def _execute_shell_command(command: str):

• command: Shell command as a string (can include \ line continuations)

​

_wait_for_server

def _wait_for_server(base_url: str, timeout: Optional[float] = 30):

• base_url (str): The base URL of the server
• timeout (Optional[float]): Maximum time to wait in seconds. (default: :obj:30)