beamlit 0.0.52__tar.gz → 0.0.53rc99__tar.gz

{beamlit-0.0.52 → beamlit-0.0.53rc99}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beamlit
-Version: 0.0.52
+Version: 0.0.53rc99
 Summary: Add your description here
 Author-email: cploujoux <ch.ploujoux@gmail.com>
 License-File: LICENSE

beamlit-0.0.53rc99/doc.sh

@@ -0,0 +1 @@
+uv run beamlit-docs src/beamlit -o docs --force --skip-errors

beamlit-0.0.53rc99/docs/beamlit/agents/chain.md

@@ -0,0 +1,93 @@
+Module beamlit.agents.chain
+===========================
+
+Classes
+-------
+
+`ChainInput(**data: Any)`
+:   A Pydantic model representing the input structure for a chain.
+    
+    Create a new model by parsing and validating input data from keyword arguments.
+    
+    Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
+    validated to form a valid model.
+    
+    `self` is explicitly positional-only to allow `self` as a field name.
+
+    ### Ancestors (in MRO)
+
+    * pydantic.main.BaseModel
+
+    ### Class variables
+
+    `inputs: str`
+    :
+
+    `model_config`
+    :
+
+`ChainTool(**kwargs: Any)`
+:   A tool that allows chaining of agent actions. Extends LangChain's BaseTool.
+    
+    Initialize the tool.
+
+    ### Ancestors (in MRO)
+
+    * langchain_core.tools.base.BaseTool
+    * langchain_core.runnables.base.RunnableSerializable[Union[str, dict, ToolCall], Any]
+    * langchain_core.runnables.base.RunnableSerializable
+    * langchain_core.load.serializable.Serializable
+    * pydantic.main.BaseModel
+    * langchain_core.runnables.base.Runnable
+    * typing.Generic
+    * abc.ABC
+
+    ### Class variables
+
+    `client: beamlit.run.RunClient`
+    :
+
+    `handle_tool_error: bool | str | Callable[[langchain_core.tools.base.ToolException], str] | None`
+    :
+
+    `model_config`
+    :
+
+    ### Instance variables
+
+    `tool_call_schema: type[pydantic.main.BaseModel]`
+    :   Defines the schema for tool calls based on the provided argument schema.
+        
+        Returns:
+            type[pydantic.BaseModel]: The Pydantic model representing the tool call schema.
+
+`ChainToolkit(client: beamlit.client.AuthenticatedClient, chain: list[beamlit.models.agent_chain.AgentChain])`
+:   A toolkit for managing and initializing a chain of agents.
+
+    ### Class variables
+
+    `chain: list[beamlit.models.agent_chain.AgentChain]`
+    :
+
+    `client: beamlit.client.AuthenticatedClient`
+    :
+
+    `model_config`
+    :
+
+    ### Methods
+
+    `get_tools(self) ‑> list[langchain_core.tools.base.BaseTool]`
+    :   Retrieves a list of tools corresponding to the initialized agents.
+        
+        Returns:
+            list[BaseTool]: A list of initialized `ChainTool` instances.
+        
+        Raises:
+            RuntimeError: If the toolkit has not been initialized.
+
+    `initialize(self) ‑> None`
+    :   Initializes the toolkit by retrieving and configuring the list of agents based on the provided chains.
+        
+        Raises:
+            RuntimeError: If initialization fails due to missing agents.

beamlit-0.0.53rc99/docs/beamlit/agents/chat.md

@@ -0,0 +1,93 @@
+Module beamlit.agents.chat
+==========================
+
+Functions
+---------
+
+`get_anthropic_chat_model(**kwargs) ‑> langchain_core.language_models.chat_models.BaseChatModel`
+:   Initializes and returns an Anthropic chat model with the provided keyword arguments.
+    
+    Parameters:
+        **kwargs: Arbitrary keyword arguments for configuring the `ChatAnthropic` model.
+    
+    Returns:
+        ChatAnthropic: An instance of the Anthropic chat model.
+
+`get_azure_ai_inference_chat_model(**kwargs)`
+:   
+
+`get_azure_marketplace_chat_model(**kwargs)`
+:   
+
+`get_base_url(name: str) ‑> str`
+:   Constructs the base URL for a given model name based on the current settings.
+    
+    Parameters:
+        name (str): The name of the model.
+    
+    Returns:
+        str: The constructed base URL.
+
+`get_chat_model(name: str, agent_model: beamlit.models.model.Model | None = None) ‑> langchain_core.language_models.chat_models.BaseChatModel`
+:   Gets a chat model instance for the specified model name.
+    
+    Parameters:
+        name (str): The name of the model to retrieve.
+        agent_model (Union[Model, None], optional): A pre-fetched model instance.
+            If None, the model will be fetched from the API. Defaults to None.
+    
+    Returns:
+        BaseChatModel: An instance of the appropriate chat model.
+
+`get_chat_model_full(name: str, agent_model: beamlit.models.model.Model | None = None) ‑> Tuple[langchain_core.language_models.chat_models.BaseChatModel, str, str]`
+:   Gets a chat model instance along with provider and model information.
+    
+    Parameters:
+        name (str): The name of the model to retrieve.
+        agent_model (Union[Model, None], optional): A pre-fetched model instance.
+            If None, the model will be fetched from the API. Defaults to None.
+    
+    Returns:
+        Tuple[BaseChatModel, str, str]: A tuple containing:
+            - The chat model instance
+            - The provider name (e.g., 'openai', 'anthropic', etc.)
+            - The specific model name (e.g., 'gpt-4o-mini')
+
+`get_cohere_chat_model(**kwargs) ‑> langchain_core.language_models.chat_models.BaseChatModel`
+:   Initializes and returns a Cohere chat model with the provided keyword arguments.
+    
+    Parameters:
+        **kwargs: Arbitrary keyword arguments for configuring the `ChatCohere` model.
+    
+    Returns:
+        ChatCohere: An instance of the Cohere chat model.
+
+`get_deepseek_chat_model(**kwargs)`
+:   
+
+`get_mistral_chat_model(**kwargs) ‑> langchain_core.language_models.chat_models.BaseChatModel`
+:   Initializes and returns a MistralAI chat model with the provided keyword arguments.
+    
+    Parameters:
+        **kwargs: Arbitrary keyword arguments for configuring the `ChatMistralAI` model.
+    
+    Returns:
+        ChatMistralAI: An instance of the MistralAI chat model.
+
+`get_openai_chat_model(**kwargs) ‑> langchain_core.language_models.chat_models.BaseChatModel`
+:   Initializes and returns an OpenAI chat model with the provided keyword arguments.
+    
+    Parameters:
+        **kwargs: Arbitrary keyword arguments for configuring the `ChatOpenAI` model.
+    
+    Returns:
+        ChatOpenAI: An instance of the OpenAI chat model.
+
+`get_xai_chat_model(**kwargs) ‑> langchain_core.language_models.chat_models.BaseChatModel`
+:   Initializes and returns an XAI chat model with the provided keyword arguments.
+    
+    Parameters:
+        **kwargs: Arbitrary keyword arguments for configuring the `ChatXAI` model.
+    
+    Returns:
+        ChatXAI: An instance of the XAI chat model.

beamlit-0.0.53rc99/docs/beamlit/agents/decorator.md

@@ -0,0 +1,33 @@
+Module beamlit.agents.decorator
+===============================
+Module: decorator
+
+Defines decorators for agent functionalities.
+
+Functions
+---------
+
+`agent(agent: beamlit.models.agent.Agent | dict = None, override_model=None, override_agent=None, override_functions=None, remote_functions=None) ‑> Callable`
+:   A decorator factory that configures and wraps functions to integrate with Beamlit agents.
+    Handles model initialization, function retrieval, and agent setup.
+    
+    Parameters:
+        agent (Agent | dict, optional): An `Agent` instance or a dictionary containing agent metadata and specifications.
+        override_model (Any, optional): An optional model to override the default agent model.
+        override_agent (Any, optional): An optional agent instance to override the default agent.
+        mcp_hub (Any, optional): An optional MCP hub configuration.
+        remote_functions (Any, optional): An optional list of remote functions to be integrated.
+    
+    Returns:
+        Callable: A decorator that wraps the target function, injecting agent-related configurations and dependencies.
+    
+    Behavior:
+        - Validates and initializes the agent configuration.
+        - Retrieves and sets up the appropriate chat model based on the agent's specifications.
+        - Retrieves functions from the specified directories or remote sources.
+        - Wraps the target function, injecting agent, model, and function dependencies as needed.
+        - Logs relevant information and handles exceptions during the setup process.
+    
+    Raises:
+        ValueError: If required configurations such as the model are missing.
+        Re-raises exceptions encountered during model retrieval and agent setup.

beamlit-0.0.53rc99/docs/beamlit/agents/index.md

@@ -0,0 +1,74 @@
+Module beamlit.agents
+=====================
+
+Sub-modules
+-----------
+* beamlit.agents.chain
+* beamlit.agents.chat
+* beamlit.agents.decorator
+* beamlit.agents.thread
+* beamlit.agents.voice
+
+Functions
+---------
+
+`agent(agent: beamlit.models.agent.Agent | dict = None, override_model=None, override_agent=None, override_functions=None, remote_functions=None) ‑> Callable`
+:   A decorator factory that configures and wraps functions to integrate with Beamlit agents.
+    Handles model initialization, function retrieval, and agent setup.
+    
+    Parameters:
+        agent (Agent | dict, optional): An `Agent` instance or a dictionary containing agent metadata and specifications.
+        override_model (Any, optional): An optional model to override the default agent model.
+        override_agent (Any, optional): An optional agent instance to override the default agent.
+        mcp_hub (Any, optional): An optional MCP hub configuration.
+        remote_functions (Any, optional): An optional list of remote functions to be integrated.
+    
+    Returns:
+        Callable: A decorator that wraps the target function, injecting agent-related configurations and dependencies.
+    
+    Behavior:
+        - Validates and initializes the agent configuration.
+        - Retrieves and sets up the appropriate chat model based on the agent's specifications.
+        - Retrieves functions from the specified directories or remote sources.
+        - Wraps the target function, injecting agent, model, and function dependencies as needed.
+        - Logs relevant information and handles exceptions during the setup process.
+    
+    Raises:
+        ValueError: If required configurations such as the model are missing.
+        Re-raises exceptions encountered during model retrieval and agent setup.
+
+`get_chat_model(name: str, agent_model: beamlit.models.model.Model | None = None) ‑> langchain_core.language_models.chat_models.BaseChatModel`
+:   Gets a chat model instance for the specified model name.
+    
+    Parameters:
+        name (str): The name of the model to retrieve.
+        agent_model (Union[Model, None], optional): A pre-fetched model instance.
+            If None, the model will be fetched from the API. Defaults to None.
+    
+    Returns:
+        BaseChatModel: An instance of the appropriate chat model.
+
+`get_chat_model_full(name: str, agent_model: beamlit.models.model.Model | None = None) ‑> Tuple[langchain_core.language_models.chat_models.BaseChatModel, str, str]`
+:   Gets a chat model instance along with provider and model information.
+    
+    Parameters:
+        name (str): The name of the model to retrieve.
+        agent_model (Union[Model, None], optional): A pre-fetched model instance.
+            If None, the model will be fetched from the API. Defaults to None.
+    
+    Returns:
+        Tuple[BaseChatModel, str, str]: A tuple containing:
+            - The chat model instance
+            - The provider name (e.g., 'openai', 'anthropic', etc.)
+            - The specific model name (e.g., 'gpt-4o-mini')
+
+`get_default_thread(request: starlette.requests.Request) ‑> str`
+:   Extracts the default thread identifier from an incoming HTTP request.
+    Prioritizes the `X-Beamlit-Sub` header and falls back to decoding the JWT
+    from the `Authorization` or `X-Beamlit-Authorization` headers.
+    
+    Parameters:
+        request (Request): The incoming HTTP request object.
+    
+    Returns:
+        str: The extracted thread identifier. Returns an empty string if no valid identifier is found.

beamlit-0.0.53rc99/docs/beamlit/agents/thread.md

@@ -0,0 +1,19 @@
+Module beamlit.agents.thread
+============================
+Module: thread
+
+Defines threading capabilities for agents.
+
+Functions
+---------
+
+`get_default_thread(request: starlette.requests.Request) ‑> str`
+:   Extracts the default thread identifier from an incoming HTTP request.
+    Prioritizes the `X-Beamlit-Sub` header and falls back to decoding the JWT
+    from the `Authorization` or `X-Beamlit-Authorization` headers.
+    
+    Parameters:
+        request (Request): The incoming HTTP request object.
+    
+    Returns:
+        str: The extracted thread identifier. Returns an empty string if no valid identifier is found.

beamlit-0.0.53rc99/docs/beamlit/agents/voice/index.md

@@ -0,0 +1,7 @@
+Namespace beamlit.agents.voice
+==============================
+
+Sub-modules
+-----------
+* beamlit.agents.voice.openai
+* beamlit.agents.voice.utils

beamlit-0.0.53rc99/docs/beamlit/agents/voice/openai.md

@@ -0,0 +1,53 @@
+Module beamlit.agents.voice.openai
+==================================
+
+Classes
+-------
+
+`OpenAIVoiceReactAgent(**data: Any)`
+:   .. beta::
+       
+    
+    Create a new model by parsing and validating input data from keyword arguments.
+    
+    Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
+    validated to form a valid model.
+    
+    `self` is explicitly positional-only to allow `self` as a field name.
+
+    ### Ancestors (in MRO)
+
+    * pydantic.main.BaseModel
+
+    ### Class variables
+
+    `headers: dict[str, typing.Any]`
+    :
+
+    `instructions: str | None`
+    :
+
+    `model: str`
+    :
+
+    `model_config`
+    :
+
+    `tools: list[langchain_core.tools.base.BaseTool] | None`
+    :
+
+    `url: str`
+    :
+
+    ### Methods
+
+    `aconnect(self, input_stream: AsyncIterator[str], send_output_chunk: Callable[[str], Coroutine[Any, Any, None]]) ‑> None`
+    :   Connect to the OpenAI API and send and receive messages.
+        
+        input_stream: AsyncIterator[str]
+            Stream of input events to send to the model. Usually transports input_audio_buffer.append events from the microphone.
+        output: Callable[[str], None]
+            Callback to receive output events from the model. Usually sends response.audio.delta events to the speaker.
+
+    `bind_tools(self, tools: list[langchain_core.tools.base.BaseTool]) ‑> None`
+    :

beamlit-0.0.53rc99/docs/beamlit/agents/voice/utils.md

@@ -0,0 +1,8 @@
+Module beamlit.agents.voice.utils
+=================================
+
+Functions
+---------
+
+`amerge(**streams: AsyncIterator[~T]) ‑> AsyncIterator[tuple[str, ~T]]`
+:   Merge multiple streams into one stream.

beamlit-0.0.53rc99/docs/beamlit/api/accounts/delete_account.md

@@ -0,0 +1,65 @@
+Module beamlit.api.accounts.delete_account
+==========================================
+
+Functions
+---------
+
+`asyncio(account_id: str, *, client: beamlit.client.AuthenticatedClient) ‑> beamlit.models.account.Account | Any | None`
+:   Delete account
+    
+     Deletes an account by name.
+    
+    Args:
+        account_id (str):
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Union[Account, Any]
+
+`asyncio_detailed(account_id: str, *, client: beamlit.client.AuthenticatedClient) ‑> beamlit.types.Response[beamlit.models.account.Account | Any]`
+:   Delete account
+    
+     Deletes an account by name.
+    
+    Args:
+        account_id (str):
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Response[Union[Account, Any]]
+
+`sync(account_id: str, *, client: beamlit.client.AuthenticatedClient) ‑> beamlit.models.account.Account | Any | None`
+:   Delete account
+    
+     Deletes an account by name.
+    
+    Args:
+        account_id (str):
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Union[Account, Any]
+
+`sync_detailed(account_id: str, *, client: beamlit.client.AuthenticatedClient) ‑> beamlit.types.Response[beamlit.models.account.Account | Any]`
+:   Delete account
+    
+     Deletes an account by name.
+    
+    Args:
+        account_id (str):
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Response[Union[Account, Any]]

beamlit-0.0.53rc99/docs/beamlit/api/accounts/get_account.md

@@ -0,0 +1,65 @@
+Module beamlit.api.accounts.get_account
+=======================================
+
+Functions
+---------
+
+`asyncio(account_id: str, *, client: beamlit.client.AuthenticatedClient) ‑> beamlit.models.account.Account | None`
+:   Get account by name
+    
+     Returns an account by name.
+    
+    Args:
+        account_id (str):
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Account
+
+`asyncio_detailed(account_id: str, *, client: beamlit.client.AuthenticatedClient) ‑> beamlit.types.Response[beamlit.models.account.Account]`
+:   Get account by name
+    
+     Returns an account by name.
+    
+    Args:
+        account_id (str):
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Response[Account]
+
+`sync(account_id: str, *, client: beamlit.client.AuthenticatedClient) ‑> beamlit.models.account.Account | None`
+:   Get account by name
+    
+     Returns an account by name.
+    
+    Args:
+        account_id (str):
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Account
+
+`sync_detailed(account_id: str, *, client: beamlit.client.AuthenticatedClient) ‑> beamlit.types.Response[beamlit.models.account.Account]`
+:   Get account by name
+    
+     Returns an account by name.
+    
+    Args:
+        account_id (str):
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Response[Account]

beamlit-0.0.53rc99/docs/beamlit/api/accounts/index.md

@@ -0,0 +1,9 @@
+Module beamlit.api.accounts
+===========================
+
+Sub-modules
+-----------
+* beamlit.api.accounts.delete_account
+* beamlit.api.accounts.get_account
+* beamlit.api.accounts.list_accounts
+* beamlit.api.accounts.update_account

beamlit-0.0.53rc99/docs/beamlit/api/accounts/list_accounts.md

@@ -0,0 +1,53 @@
+Module beamlit.api.accounts.list_accounts
+=========================================
+
+Functions
+---------
+
+`asyncio(*, client: beamlit.client.AuthenticatedClient) ‑> list[beamlit.models.account.Account] | None`
+:   List accounts
+    
+     Returns a list of all accounts.
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        list['Account']
+
+`asyncio_detailed(*, client: beamlit.client.AuthenticatedClient) ‑> beamlit.types.Response[list[beamlit.models.account.Account]]`
+:   List accounts
+    
+     Returns a list of all accounts.
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Response[list['Account']]
+
+`sync(*, client: beamlit.client.AuthenticatedClient) ‑> list[beamlit.models.account.Account] | None`
+:   List accounts
+    
+     Returns a list of all accounts.
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        list['Account']
+
+`sync_detailed(*, client: beamlit.client.AuthenticatedClient) ‑> beamlit.types.Response[list[beamlit.models.account.Account]]`
+:   List accounts
+    
+     Returns a list of all accounts.
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Response[list['Account']]

beamlit-0.0.53rc99/docs/beamlit/api/accounts/update_account.md

@@ -0,0 +1,69 @@
+Module beamlit.api.accounts.update_account
+==========================================
+
+Functions
+---------
+
+`asyncio(account_id: str, *, client: beamlit.client.AuthenticatedClient, body: beamlit.models.account.Account) ‑> beamlit.models.account.Account | None`
+:   Update account
+    
+     Updates an account by name.
+    
+    Args:
+        account_id (str):
+        body (Account): Account
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Account
+
+`asyncio_detailed(account_id: str, *, client: beamlit.client.AuthenticatedClient, body: beamlit.models.account.Account) ‑> beamlit.types.Response[beamlit.models.account.Account]`
+:   Update account
+    
+     Updates an account by name.
+    
+    Args:
+        account_id (str):
+        body (Account): Account
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Response[Account]
+
+`sync(account_id: str, *, client: beamlit.client.AuthenticatedClient, body: beamlit.models.account.Account) ‑> beamlit.models.account.Account | None`
+:   Update account
+    
+     Updates an account by name.
+    
+    Args:
+        account_id (str):
+        body (Account): Account
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Account
+
+`sync_detailed(account_id: str, *, client: beamlit.client.AuthenticatedClient, body: beamlit.models.account.Account) ‑> beamlit.types.Response[beamlit.models.account.Account]`
+:   Update account
+    
+     Updates an account by name.
+    
+    Args:
+        account_id (str):
+        body (Account): Account
+    
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+    
+    Returns:
+        Response[Account]