Create a comparative experiment on the LangSmith API.
These experiments compare 2 or more experiment results over a shared dataset.
create_comparative_experiment(
self,
name: str,
experiments: Sequence[ID_TYPE],
*,
reference_dataset: Optional[ID_TYPE] = None,
description: Optional[str] = None,
created_at: Optional[datetime.datetime] = None,
metadata: Optional[dict[str, Any]] = None,
id: Optional[ID_TYPE] = None
) -> ls_schemas.ComparativeExperiment| Name | Type | Description |
|---|---|---|
name* | str | The name of the comparative experiment. |
experiments* | Sequence[Union[UUID, str]] | The IDs of the experiments to compare. |
reference_dataset | Optional[Union[UUID, str]] | Default: NoneThe ID of the dataset these experiments are compared on. |
description | Optional[str] | Default: NoneThe description of the comparative experiment. |
created_at | Optional[datetime.datetime] | Default: NoneThe creation time of the comparative experiment. |
metadata | Optional[Dict[str, Any]] | Default: NoneAdditional metadata for the comparative experiment. |
id | Optional[Union[UUID, str]] | Default: NoneThe ID of the comparative experiment. |