declarai

Main interface for declarai.

Decorates the package functionalities and serve as the main interface for the user.

Classes:

Name	Description
Declarai	Context manager for the Declarai root interface.

Functions:

Name	Description
azure_openai	Sets up a Declarai context for the Azure OpenAI provider.
magic	This is an empty method used as a potential replacement for using the docstring for passing
openai	Sets up a Declarai context for the OpenAI provider.
register_llm	Registers an LLM.
register_operator	Registers an operator.

Declarai

Declarai(provider: str, model: str, **kwargs: str)

Context manager for the Declarai root interface. This class is responsible for setting up tasks and initializing experimental features provided by Declarai.

Parameters:

Name	Type	Description	Default
provider	str	The provider name.	required
model	str	The model name.	required
**kwargs		Additional keyword arguments passed to the LLM resolver.	{}

Attributes:

Name	Type	Description
llm	LLM	Resolved LLM.
task	Callable	A decorator for task creation.
experimental		A namespace for experimental features.
experimental.chat	Callable	A decorator for chat operators.

Source code in src/declarai/declarai.py

def __init__(self, provider: str, model: str, **kwargs):
    self.llm = resolve_llm(provider, model, **kwargs)
    self.task = TaskDecorator(self.llm).task

    class Experimental:
        chat = ChatDecorator(self.llm).chat

    self.experimental = Experimental

azure_openai

azure_openai(
    deployment_name: str,
    azure_openai_key: str = None,
    azure_openai_api_base: str = None,
    api_version: str = None,
    headers: dict = None,
    timeout: int = None,
    stream: bool = None,
    request_timeout: int = None,
) -> Declarai

Sets up a Declarai context for the Azure OpenAI provider.

Parameters:

Name	Type	Description	Default
deployment_name	str	Name of the deployment.	required
azure_openai_key	str	Azure OpenAI key.	None
azure_openai_api_base	str	Base API URL for Azure OpenAI.	None
api_version	str	API version.	None
headers	dict	Additional headers for the request.	None
timeout	int	Timeout for the request.	None
stream	bool	Whether to stream the response.	None
request_timeout	int	Request timeout duration.	None

Returns:

Name	Type	Description
DeclaraiContext	Declarai	Initialized Declarai context.

Source code in src/declarai/declarai.py

def azure_openai(
    deployment_name: str,
    azure_openai_key: str = None,
    azure_openai_api_base: str = None,
    api_version: str = None,
    headers: dict = None,
    timeout: int = None,
    stream: bool = None,
    request_timeout: int = None,
) -> Declarai:
    """
    Sets up a Declarai context for the Azure OpenAI provider.

    Args:
        deployment_name (str): Name of the deployment.
        azure_openai_key (str, optional): Azure OpenAI key.
        azure_openai_api_base (str, optional): Base API URL for Azure OpenAI.
        api_version (str, optional): API version.
        headers (dict, optional): Additional headers for the request.
        timeout (int, optional): Timeout for the request.
        stream (bool, optional): Whether to stream the response.
        request_timeout (int, optional): Request timeout duration.

    Returns:
        DeclaraiContext: Initialized Declarai context.
    """
    return Declarai(
        provider=ProviderAzureOpenai,
        model=deployment_name,
        azure_openai_key=azure_openai_key,
        azure_openai_api_base=azure_openai_api_base,
        api_version=api_version,
        headers=headers,
        timeout=timeout,
        stream=stream,
        request_timeout=request_timeout,
    )

magic

magic(
    return_name: Optional[str] = None,
    *,
    task_desc: Optional[str] = None,
    input_desc: Optional[Dict[str, str]] = None,
    output_desc: Optional[str] = None,
    **kwargs: Optional[str]
) -> Any

This is an empty method used as a potential replacement for using the docstring for passing parameters to the LLM builder. It can also serve as a fake use of arguments in the defined functions as to simplify handling of lint rules for llms functions.

Example

@openai.task
def add(a: int, b: int) -> int:
    return magic(a, b)

Source code in src/declarai/declarai.py

def magic(
    return_name: Optional[str] = None,
    *,
    task_desc: Optional[str] = None,
    input_desc: Optional[Dict[str, str]] = None,
    output_desc: Optional[str] = None,
    **kwargs
) -> Any:
    """
    This is an empty method used as a potential replacement for using the docstring for passing
    parameters to the LLM builder. It can also serve as a fake use of arguments in the defined
    functions as to simplify handling of lint rules for llms functions.

    Example:
        ```py
        @openai.task
        def add(a: int, b: int) -> int:
            return magic(a, b)
        ```
    """
    pass

openai

openai(
    model: ModelsOpenai,
    version: str = None,
    openai_token: str = None,
    headers: dict = None,
    timeout: int = None,
    stream: bool = None,
    request_timeout: int = None,
) -> Declarai

Sets up a Declarai context for the OpenAI provider.

Parameters:

Name	Type	Description	Default
model	ModelsOpenai	The model to be used.	required
version	str	Model version.	None
openai_token	str	OpenAI authentication token.	None
headers	dict	Additional headers for the request.	None
timeout	int	Timeout for the request.	None
stream	bool	Whether to stream the response.	None
request_timeout	int	Request timeout duration.	None

Returns:

Name	Type	Description
Declarai	Declarai	Initialized Declarai context.

Source code in src/declarai/declarai.py

def openai(
    model: ModelsOpenai,
    version: str = None,
    openai_token: str = None,
    headers: dict = None,
    timeout: int = None,
    stream: bool = None,
    request_timeout: int = None,
) -> Declarai:
    """
    Sets up a Declarai context for the OpenAI provider.

    Args:
        model (ModelsOpenai): The model to be used.
        version (str, optional): Model version.
        openai_token (str, optional): OpenAI authentication token.
        headers (dict, optional): Additional headers for the request.
        timeout (int, optional): Timeout for the request.
        stream (bool, optional): Whether to stream the response.
        request_timeout (int, optional): Request timeout duration.

    Returns:
        Declarai: Initialized Declarai context.
    """
    return Declarai(
        provider=ProviderOpenai,
        model=model,
        version=version,
        openai_token=openai_token,
        headers=headers,
        timeout=timeout,
        stream=stream,
        request_timeout=request_timeout,
    )

register_llm

register_llm(
    provider: str, llm_cls: Type[LLM], model: str = None
)

Registers an LLM. Args: provider: Name of the LLM provider. model: Specific model name (optional). llm_cls: The LLM class to register.

Source code in src/declarai/declarai.py

def register_llm(provider: str, llm_cls: Type[LLM], model: str = None):
    """
    Registers an LLM.
    Args:
        provider: Name of the LLM provider.
        model: Specific model name (optional).
        llm_cls: The LLM class to register.
    """
    llm_registry.register(provider=provider, llm_cls=llm_cls, model=model)

register_operator

register_operator(
    provider: str,
    operator_type: str,
    operator_cls: Type[BaseOperator],
    model: str = None,
)

Registers an operator. Args: provider: Name of the LLM provider. operator_type: The type of operator (e.g., "chat", "task"). operator_cls: The operator class to register. model: Specific model name

Source code in src/declarai/declarai.py

def register_operator(
    provider: str,
    operator_type: str,
    operator_cls: Type[BaseOperator],
    model: str = None,
):
    """
    Registers an operator.
    Args:
        provider: Name of the LLM provider.
        operator_type: The type of operator (e.g., "chat", "task").
        operator_cls: The operator class to register.
        model: Specific model name
    """
    operator_registry.register(
        provider=provider,
        operator_type=operator_type,
        model=model,
        operator_cls=operator_cls,
    )