Overview
Retrieve a paginated list of evaluators with optional filtering and sorting.
Method Signature
# Synchronous
client.evaluators.list(
limit: Optional[int] = 50,
offset: Optional[int] = 0,
evaluator_type: Optional[str] = None,
sort_by: Optional[str] = "created_at",
sort_order: Optional[str] = "desc"
) -> Dict[str, Any]
# Asynchronous
await client.evaluators.list(
limit: Optional[int] = 50,
offset: Optional[int] = 0,
evaluator_type: Optional[str] = None,
sort_by: Optional[str] = "created_at",
sort_order: Optional[str] = "desc"
) -> Dict[str, Any]
Parameters
Maximum number of evaluators to return (default: 50)
Number of evaluators to skip (default: 0)
Field to sort by (default: “created_at”)
Sort order: “asc” or “desc” (default: “desc”)
Returns
Returns a dictionary containing the list of evaluators and pagination information.
Example
from keywordsai import KeywordsAI
client = KeywordsAI(api_key="your-api-key")
# List all evaluators
evaluators = client.evaluators.list()
print(f"Found {evaluators['total']} evaluators")
for evaluator in evaluators['data']:
print(f"- {evaluator['name']} ({evaluator['type']})")
# List evaluators with filtering
accuracy_evaluators = client.evaluators.list(
evaluator_type="accuracy",
limit=10
)
Error Handling
try:
evaluators = client.evaluators.list()
except Exception as e:
print(f"Error listing evaluators: {e}")