Maxim

View module source on GitHub

​

ConfigDict

class ConfigDict(TypedDict)

A class representing the configuration for the Maxim SDK.

Attributes:

​

Config

@deprecated(
    "This class will be removed in a future version. Use {} which is TypedDict."
)

@dataclass
class Config()

A class representing the configuration for the Maxim SDK.

Attributes:

​

get_config_dict

def get_config_dict(config: Union[Config, ConfigDict]) -> dict[str, Any]

Converts a Config or ConfigDict to a dictionary with default values.

Arguments:

Returns:

dict[str, Any]: A dictionary containing the configuration parameters with defaults applied.

​

Maxim

class Maxim()

​

__init__

def __init__(config: Union[Config, ConfigDict, None] = None)

Initializes a new instance of the Maxim class.

Arguments:

​

enable_prompt_management

def enable_prompt_management(cache: Optional[MaximCache] = None) -> "Maxim"

Enables prompt management functionality with optional cache configuration.

Arguments:

Defaults to None (uses existing cache).

Returns:

​

enable_exceptions

def enable_exceptions(val: bool) -> "Maxim"

Enables or disables exception raising during logging operations.

Arguments:

Returns:

​

get_prompt

def get_prompt(id: str, rule: QueryRule) -> Optional[RunnablePrompt]

Retrieves a prompt based on the provided id and rule.

Arguments:

Returns:

​

get_prompts

def get_prompts(rule: QueryRule) -> List[RunnablePrompt]

Retrieves all prompts that match the given rule.

Arguments:

Returns:

​

get_prompt_chain

def get_prompt_chain(id: str,
                     rule: QueryRule) -> Optional[RunnablePromptChain]

Retrieves a prompt chain based on the provided id and rule.

Arguments:

Returns:

​

get_folder_by_id

def get_folder_by_id(id: str) -> Optional[Folder]

Retrieves a folder based on the provided id.

Arguments:

Returns:

​

get_folders

def get_folders(rule: QueryRule) -> List[Folder]

Retrieves all folders that match the given rule.

Arguments:

Returns:

​

logger

def logger(
        config: Optional[Union[LoggerConfig,
                               LoggerConfigDict]] = None) -> Logger

Creates a logger based on the provided configuration.

Arguments:

Returns:

​

create_test_run

def create_test_run(name: str, in_workspace_id: str) -> TestRunBuilder

Creates a test run builder based on the provided name and workspace id.

Arguments:

Returns:

​

chat_completion

def chat_completion(model: str,
                    messages: List[ChatCompletionMessage],
                    tools: Optional[List[Tool]] = None,
                    **kwargs) -> Optional[PromptResponse]

Performs a chat completion request using the specified model and messages.

Arguments:

Returns:

​

cleanup

def cleanup()

Cleans up the Maxim sync thread.