langsmith.client.Client.create_comparative_experiment#

Client.create_comparative_experiment(name: str, experiments: Sequence[UUID | str], *, reference_dataset: UUID | str | None = None, description: str | None = None, created_at: datetime | None = None, metadata: Dict[str, Any] | None = None, id: UUID | str | None = None) → ComparativeExperiment[source]#

Create a comparative experiment on the LangSmith API.

These experiments compare 2 or more experiment results over a shared dataset.

Parameters:

  • name (str) – The name of the comparative experiment.

  • experiments (Sequence[UUID | str]) – The IDs of the experiments to compare.

  • reference_dataset (UUID | str | None) – The ID of the dataset these experiments are compared on.

  • description (str | None) – The description of the comparative experiment.

  • created_at (datetime | None) – The creation time of the comparative experiment.

  • metadata (Dict[str, Any] | None) – Additional metadata for the comparative experiment.

  • id (UUID | str | None) –

Returns:

The created comparative experiment object.

Return type:

ComparativeExperiment