ComparativeExperiment

class langsmith.schemas.ComparativeExperiment

Bases: BaseModel

Represents a comparative experiment.

This information summarizes evaluation results comparing two or more models on a given dataset.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param created_at: datetime [Required]

The timestamp when the comparative experiment was created.

param description: str | None = None

An optional description of the comparative experiment.

param experiments_info: List[dict] | None = None

Optional list of dictionaries containing information about individual experiments.

param extra: Dict[str, Any] | None = None

Optional additional information about the experiment.

param feedback_stats: Dict[str, Any] | None = None

Optional dictionary containing feedback statistics for the experiment.

param id: UUID [Required]

The unique identifier for the comparative experiment.

param modified_at: datetime [Required]

The timestamp when the comparative experiment was last modified.

param name: str | None = None

The optional name of the comparative experiment.

param reference_dataset_id: UUID [Required]

The identifier of the reference dataset used in this experiment.

param tenant_id: UUID [Required]

The identifier of the tenant associated with this experiment.

property metadata: dict[str, Any]

Retrieve the metadata (if any).