Skip to main content

​
Overview

Update the properties of an existing evaluator, including its name, description, and configuration.

​
Method Signature

# Synchronous
client.evaluators.update(
    evaluator_id: str,
    name: Optional[str] = None,
    description: Optional[str] = None,
    config: Optional[Dict[str, Any]] = None
) -> Dict[str, Any]

# Asynchronous
await client.evaluators.update(
    evaluator_id: str,
    name: Optional[str] = None,
    description: Optional[str] = None,
    config: Optional[Dict[str, Any]] = None
) -> Dict[str, Any]

​
Parameters

​
evaluator_id
string
required
The unique identifier of the evaluator to update
​
name
string
New name for the evaluator
​
description
string
New description for the evaluator
​
config
Dict[str, Any]
New configuration parameters for the evaluator

​
Returns

Returns a dictionary containing the updated evaluator information.

​
Example

from keywordsai import KeywordsAI

client = KeywordsAI(api_key="your-api-key")

# Update evaluator properties
updated_evaluator = client.evaluators.update(
    evaluator_id="eval_123",
    name="Enhanced Accuracy Evaluator",
    description="Improved accuracy measurement with better thresholds",
    config={
        "threshold": 0.9,
        "metric": "semantic_similarity",
        "model": "sentence-transformers"
    }
)

print(f"Updated evaluator: {updated_evaluator['name']}")

​
Error Handling

try:
    updated_evaluator = client.evaluators.update(
        evaluator_id="eval_123",
        name="New Name"
    )
except Exception as e:
    print(f"Error updating evaluator: {e}")
⌘I