Experiment

class opik.api_objects.experiment.experiment.Experiment(id: str, name: str | None, dataset_name: str, rest_client: OpikApi, streamer: Streamer, experiments_client: ExperimentsClient, prompts: List[BasePrompt] | None = None, tags: List[str] | None = None, project_name: str | None = None)

Bases: object

__init__(id: str, name: str | None, dataset_name: str, rest_client: OpikApi, streamer: Streamer, experiments_client: ExperimentsClient, prompts: List[BasePrompt] | None = None, tags: List[str] | None = None, project_name: str | None = None) → None

property project_name: str | None

property id: str

property dataset_name: str

property name: str

property tags: List[str] | None

property prompts: List[BasePrompt] | None

property dataset_id: str

property experiments_rest_client: ExperimentsClient

get_experiment_data() → ExperimentPublic

insert(experiment_items_references: List[ExperimentItemReferences]) → None

Creates a new experiment item by linking the existing trace and dataset item.

Parameters:

experiment_items_references – The list of ExperimentItemReferences objects, containing trace id and dataset item id to link together into experiment item.

Returns:

None

get_items(max_results: int | None = 10000, truncate: bool = False) → List[ExperimentItemContent]

Retrieves and returns a list of experiment items for this experiment.

Parameters:

• max_results – Maximum number of experiment items to retrieve. Defaults to 10000 if not specified.

• truncate – Whether to truncate the items returned by the backend. Defaults to False.

Returns:

List of ExperimentItemContent objects for this experiment.

log_experiment_scores(score_results: List[score_result.ScoreResult]) → None

Log experiment-level scores to the backend.