Implementation:Openai Openai python Eval Update Params
| Knowledge Sources | |
|---|---|
| Domains | API_Types, Python |
| Last Updated | 2026-02-15 00:00 GMT |
Overview
Concrete type for evaluation update parameters provided by the openai-python SDK.
Description
The EvalUpdateParams TypedDict defines the parameters for updating an existing evaluation via client.evals.update(). It is a simple type with two optional fields: metadata (up to 16 key-value pairs for structured information) and name (to rename the evaluation). Both fields are optional since the TypedDict uses total=False.
Usage
Import this type when constructing or type-hinting parameters for client.evals.update() to modify an existing evaluation's name or metadata.
Code Reference
Source Location
- Repository: openai-python
- File: src/openai/types/eval_update_params.py
Signature
class EvalUpdateParams(TypedDict, total=False):
metadata: Optional[Metadata]
name: str
Import
from openai.types import EvalUpdateParams
I/O Contract
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| metadata | Optional[Metadata] | No | Up to 16 key-value pairs for additional information (keys max 64 chars, values max 512 chars) |
| name | str | No | New name for the evaluation |
Usage Examples
from openai import OpenAI
client = OpenAI()
# Rename an evaluation and update its metadata
updated = client.evals.update(
"eval_abc123",
name="Chatbot Quality v2",
metadata={"version": "2", "team": "ml-ops"},
)
print(updated.name) # "Chatbot Quality v2"