Documentation Index
Fetch the complete documentation index at: https://www.getmaxim.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
View module source on GitHub
@dataclass
class YieldedOutputTokenUsage()
yieldsOutput function.
@dataclass
class YieldedOutputCost()
yieldsOutput function.
@dataclass
class YieldedOutputMeta()
yieldsOutput function.
@dataclass
class YieldedOutput()
yieldsOutput function.
@dataclass
class EvaluatorArgs()
@dataclass
class EvaluatorConfig()
@dataclass
class TestRun()
@dataclass
class TestRunEntry()
@dataclass
class TestRunWithDatasetEntry(TestRun)
@dataclass
class TestRunStatus()
@dataclass
class EvaluatorMeanScore()
@dataclass
class TestRunTokenUsage()
@dataclass
class TestRunCost()
@dataclass
class TestRunLatency()
@dataclass
class TestRunResultObj()
@dataclass
class TestRunResult()
@dataclass
class RunResult()
info
@abstractmethod
def info(message: str) -> None
| Name | Type | Description |
|---|
message | str | The message to be logged. |
error
@abstractmethod
def error(message: str, e: Optional[Exception] = None) -> None
| Name | Type | Description |
|---|
message | str | The error message to be logged. |
@dataclass
class TestRunConfig(Generic[T])
| Name | Type | Description |
|---|
base_url | str | The base URL for the API. |
api_key | str | The API key for authentication. |
in_workspace_id | str | The ID of the workspace. |
workflow_id | Optional[str] | The ID of the workflow. |
prompt_version_id | Optional[str] | The ID of the prompt version. |
prompt_chain_version_id | Optional[str] | The ID of the prompt chain version. |
name | str | The name of the test run. |
data_structure | Optional[T] | The structure of the test data. |
data | Optional[Union[str, DataValue[T], Callable[[int], Optional[DataValue[T]]]]] | The test data or a function to retrieve it. |
test_config_id | Optional[str] | The ID of the test configuration. |
platform_evaluators | List[PlatformEvaluatorType[T]] | List of platform evaluators to use. |
