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 Evaluator()
@dataclass
class LocalEvaluatorReturn()
__init__
def __init__(score: Union[int, bool, str], reasoning: Optional[str] = None)
| Name | Description |
|---|
score | The score of the evaluator. |
reasoning | The reasoning of the evaluator. |
@dataclass
class PassFailCriteriaOnEachEntry()
__init__
def __init__(score_should_be: OperatorType, value: Union[bool, int, float,
None])
| Name | Description |
|---|
score_should_be | The score should be. |
value | The value of the pass fail criteria. |
@dataclass
class PassFailCriteriaForTestrunOverall()
__init__
def __init__(overall_should_be: OperatorType, value: int,
for_result: Literal["average", "percentageOfPassedResults"])
| Name | Description |
|---|
overall_should_be | The overall should be. |
value | The value of the pass fail criteria. |
for_result | The for result. |
@dataclass
class PassFailCriteria()
__init__
def __init__(on_each_entry_pass_if: PassFailCriteriaOnEachEntry,
for_testrun_overall_pass_if: PassFailCriteriaForTestrunOverall)
| Name | Description |
|---|
on_each_entry_pass_if | The pass fail criteria on each entry. |
for_testrun_overall_pass_if | The pass fail criteria for the overall testrun. |
@dataclass
class LocalEvaluatorResultParameter()
__init__
def __init__(output: str, context_to_evaluate: Optional[Union[str,
List[str]]])
| Name | Description |
|---|
output | The output of the local evaluator. |
context_to_evaluate | The context to evaluate. |
@dataclass
class LocalEvaluationResult()
__init__
def __init__(result: LocalEvaluatorReturn, name: str,
pass_fail_criteria: PassFailCriteria)
| Name | Description |
|---|
result | The result of the local evaluation. |
name | The name of the local evaluation. |
pass_fail_criteria | The pass fail criteria of the local evaluation. |
@dataclass
class LocalEvaluationResultWithId(LocalEvaluationResult)
__init__
def __init__(result: LocalEvaluatorReturn, name: str,
pass_fail_criteria: PassFailCriteria, id: str)
| Name | Description |
|---|
result | The result of the local evaluation. |
name | The name of the local evaluation. |
pass_fail_criteria | The pass fail criteria of the local evaluation. |
id | The id of the local evaluation. |
