Camel.models.base model

​

_StreamLogger

class _StreamLogger:

​

init

def __init__(self, log_path: Optional[str], log_enabled: bool):

​

_collect

def _collect(self, chunk: ChatCompletionChunk):

​

_log

def _log(self):

​

_SyncStreamWrapper

class _SyncStreamWrapper(_StreamLogger):

​

init

def __init__(
    self,
    stream: Union[Stream[ChatCompletionChunk], Generator[ChatCompletionChunk, None, None]],
    log_path: Optional[str],
    log_enabled: bool
):

​

iter

def __iter__(self):

​

next

def __next__(self):

​

enter

def __enter__(self):

​

exit

def __exit__(self, *_):

​

del

def __del__(self):

​

_AsyncStreamWrapper

class _AsyncStreamWrapper(_StreamLogger):

​

init

def __init__(
    self,
    stream: Union[AsyncStream[ChatCompletionChunk], AsyncGenerator[ChatCompletionChunk, None]],
    log_path: Optional[str],
    log_enabled: bool
):

​

aiter

def __aiter__(self):

​

del

def __del__(self):

​

ModelBackendMeta

class ModelBackendMeta(ABCMeta):

​

new

def __new__(
    mcs,
    name,
    bases,
    namespace
):

​

BaseModelBackend

class BaseModelBackend(ABC):

• model_type (Union[ModelType, str]): Model for which a backend is created.
• model_config_dict (Optional[Dict[str, Any]], optional): A config dictionary. (default: :obj:{})
• api_key (Optional[str], optional): The API key for authenticating with the model service. (default: :obj:None)
• url (Optional[str], optional): The url to the model service. (default: :obj:None)
• token_counter (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:OpenAITokenCounter will be used. (default: :obj:None)
• timeout (Optional[float], optional): The timeout value in seconds for API calls. (default: :obj:None)
• max_retries (int, optional): Maximum number of retries for API calls. (default: :obj:3)

​

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] = Constants.TIMEOUT_THRESHOLD,
    max_retries: int = 3
):

​

token_counter

def token_counter(self):

​

_prepare_request_config

def _prepare_request_config(self, tools: Optional[List[Dict[str, Any]]] = None):

• tools (Optional[List[Dict[str, Any]]]): The tools to include in the request. (default: :obj:None)

​

preprocess_messages

def preprocess_messages(self, messages: List[OpenAIMessage]):

• messages (List[OpenAIMessage]): Original messages.

​

_log_request

def _log_request(self, messages: List[OpenAIMessage]):

• messages (List[OpenAIMessage]): The messages to log.

​

_log_response

def _log_response(self, log_path: str, response: Any):

• log_path (str): The path to the log file.
• response (Any): The response to log.

​

_log_and_trace

def _log_and_trace(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.
• response_format (Optional[Type[BaseModel]]): The format of the response.
• tools (Optional[List[Dict[str, Any]]]): The schema of the tools to use for the request.

​

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.
• response_format (Optional[Type[BaseModel]]): The response format to use for the model. (default: :obj:None)
• tools (Optional[List[Tool]]): The schema of tools to use for the model for this request. Will override the tools specified in the model configuration (but not change the configuration). (default: :obj:None)

​

count_tokens_from_messages

def count_tokens_from_messages(self, messages: List[OpenAIMessage]):

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

​

_to_chat_completion

def _to_chat_completion(self, response: ParsedChatCompletion):

​

token_limit

def token_limit(self):

​

stream

def stream(self):