Files
comet-ml--opik/sdks/python/tests/unit/evaluation/test_evaluate_experiment_name.py
T
wehub-resource-sync 5a558eb09e
TypeScript SDK Compatibility V1.x E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / TypeScript SDK Compatibility V1.x E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
TypeScript SDK E2E Tests / TypeScript SDK E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
Python SDK E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK E2E Tests / Python SDK E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK E2E Tests / build-opik (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Python SDK Compatibility V1.x E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK E2E Tests / build-opik (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer E2E Tests Python ${{matrix.python_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer Integration Smoke Tests (push) Has been cancelled
🐙 Code Quality / detect (push) Has been cancelled
🐙 Code Quality / lint (${{ matrix.leg.name }}) (push) Has been cancelled
🐙 Code Quality / summary (push) Has been cancelled
TypeScript SDK Library Integration Tests / Check Secrets (push) Has been cancelled
TypeScript SDK Library Integration Tests / opik-vercel (Vercel AI SDK / eve) (push) Has been cancelled
SDK Library Integration Tests Runner / Check Secrets (push) Has been cancelled
SDK Library Integration Tests Runner / Missed OpenAI API Key Warning (push) Has been cancelled
SDK Library Integration Tests Runner / Build (push) Has been cancelled
SDK Library Integration Tests Runner / openai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_legacy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / llama_index_tests (push) Has been cancelled
SDK Library Integration Tests Runner / anthropic_tests (push) Has been cancelled
SDK Library Integration Tests Runner / mistral_tests (push) Has been cancelled
SDK Library Integration Tests Runner / groq_tests (push) Has been cancelled
SDK Library Integration Tests Runner / aisuite_tests (push) Has been cancelled
SDK Library Integration Tests Runner / haystack_tests (push) Has been cancelled
SDK Library Integration Tests Runner / dspy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v1_tests (push) Has been cancelled
SDK Library Integration Tests Runner / genai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_legacy_1_3_0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / evaluation_metrics_tests (push) Has been cancelled
SDK Library Integration Tests Runner / bedrock_tests (push) Has been cancelled
SDK Library Integration Tests Runner / litellm_tests (push) Has been cancelled
SDK Library Integration Tests Runner / harbor_tests (push) Has been cancelled
SDK Library Integration Tests Runner / Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / render-equality (push) Has been cancelled
Opik Optimizer - Unit Tests / Opik Optimizer Unit Tests Python ${{matrix.python_version}} (push) Has been cancelled
Python BE E2E Tests / Python BE E2E (push) Has been cancelled
Python Backend Tests / run-python-backend-tests (push) Has been cancelled
Python SDK Unit Tests / Python SDK Unit Tests ${{matrix.python_version}} (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
SDK E2E Libraries Integration Tests / Check Secrets (push) Has been cancelled
SDK E2E Libraries Integration Tests / Missed OpenAI API Key Warning (push) Has been cancelled
SDK E2E Libraries Integration Tests / build-opik (push) Has been cancelled
SDK E2E Libraries Integration Tests / E2E Lib Integration Python ${{matrix.python_version}} (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-gemini) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-langchain) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-openai) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-otel) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-vercel) (push) Has been cancelled
TypeScript SDK Build & Publish / build-and-publish (push) Has been cancelled
TypeScript SDK Unit Tests / Test on Node ${{ matrix.node-version }} (push) Has been cancelled
Backend Tests / discover-tests (push) Has been cancelled
Backend Tests / ${{ matrix.name }} (push) Has been cancelled
Build and Publish SDK / build-and-publish (push) Has been cancelled
Build Opik Docker Images / set-version (push) Has been cancelled
Build Opik Docker Images / build-backend (push) Has been cancelled
Build Opik Docker Images / build-sandbox-executor-python (push) Has been cancelled
Build Opik Docker Images / build-python-backend (push) Has been cancelled
Build Opik Docker Images / build-frontend (push) Has been cancelled
Build Opik Docker Images / create-git-tag (push) Has been cancelled
ClickHouse Migration Cluster Check / validate-clickhouse-migrations (push) Has been cancelled
Docs - Publish / run (push) Has been cancelled
E2E Tests - Post Merge (v2) / 🧪 E2E v2 Tests (${{ github.event.inputs.tier || 't1' }}) (push) Has been cancelled
E2E Tests - Post Merge (v2) / 📢 Slack Notification (push) Has been cancelled
Frontend Unit Tests / Test on Node 20 (push) Has been cancelled
Guardrails E2E Tests / Select Python version matrix (push) Has been cancelled
Guardrails E2E Tests / Guardrails E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Guardrails E2E Tests / 📢 Slack Notification (push) Has been cancelled
Guardrails Backend Unit Tests / Guardrails Backend Unit Tests (push) Has been cancelled
Guardrails Backend Unit Tests / 📢 Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v3.21.0) (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v4.2.0) (push) Has been cancelled
Lint Opik Helm Chart / unittest-helm-chart (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:25:44 +08:00

815 lines
30 KiB
Python

from typing import Any, Dict, Optional
from unittest import mock
from opik import evaluation
from opik import url_helpers
from opik.api_objects import opik_client
from opik.api_objects.dataset import dataset_item
from opik.evaluation.models import models_factory
def _extract_experiment_name_from_call_args(call_args: Any) -> Optional[str]:
"""Extract the experiment name from mock call arguments.
Args:
call_args: A mock.call object containing the call arguments.
Returns:
The experiment name if found in kwargs or args, None otherwise.
"""
if "name" in call_args.kwargs:
return call_args.kwargs["name"]
elif len(call_args.args) > 1:
return call_args.args[1]
else:
return None
def test_evaluate__with_experiment_name_prefix__generates_name_with_prefix(
fake_backend,
):
"""Test that experiment_name_prefix is correctly applied when creating an experiment."""
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[
dataset_item.DatasetItem(
id="dataset-item-id-1",
),
]
)
def say_task(dataset_item: Dict[str, Any]):
return {"output": "hello"}
mock_create_experiment = mock.Mock()
mock_create_experiment.return_value = mock.Mock(prompts=None)
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
# Mock generate_id to return a predictable value
mock_generated_id = "abc123def456"
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
with mock.patch(
"opik.api_objects.experiment.helpers.id_helpers.generate_random_alphanumeric_string"
) as mock_generate_id:
mock_generate_id.return_value = mock_generated_id
evaluation.evaluate(
dataset=mock_dataset,
task=say_task,
experiment_name_prefix="my-prefix",
task_threads=1,
)
# Verify that create_experiment was called with a name that starts with the prefix
mock_create_experiment.assert_called_once()
call_args = mock_create_experiment.call_args
experiment_name = _extract_experiment_name_from_call_args(call_args)
assert experiment_name is not None, "Experiment name should not be None"
assert experiment_name == f"my-prefix-{mock_generated_id}", (
f"Expected experiment name to be 'my-prefix-{mock_generated_id}', "
f"but got '{experiment_name}'"
)
def test_evaluate__with_experiment_name_prefix_and_experiment_name__experiment_name_takes_precedence(
fake_backend,
):
"""Test that when both experiment_name and experiment_name_prefix are provided, experiment_name takes precedence."""
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[
dataset_item.DatasetItem(
id="dataset-item-id-1",
),
]
)
def say_task(dataset_item: Dict[str, Any]):
return {"output": "hello"}
mock_create_experiment = mock.Mock()
mock_create_experiment.return_value = mock.Mock(prompts=None)
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
evaluation.evaluate(
dataset=mock_dataset,
task=say_task,
experiment_name="explicit-experiment-name",
experiment_name_prefix="my-prefix",
task_threads=1,
)
# Verify that create_experiment was called with the explicit experiment_name
mock_create_experiment.assert_called_once_with(
dataset_name="the-dataset-name",
name="explicit-experiment-name",
experiment_config=mock.ANY,
prompts=None,
tags=None,
dataset_version_id=None,
project_name=None,
)
def test_evaluate__with_experiment_name_prefix_only__generates_unique_name(
fake_backend,
):
"""Test that when only experiment_name_prefix is provided, a unique name is generated."""
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[
dataset_item.DatasetItem(
id="dataset-item-id-1",
),
]
)
def say_task(dataset_item: Dict[str, Any]):
return {"output": "hello"}
mock_create_experiment = mock.Mock()
mock_create_experiment.return_value = mock.Mock(prompts=None)
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
# Mock generate_id to return a predictable value
mock_generated_id = "xyz789abc123"
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
with mock.patch(
"opik.api_objects.experiment.helpers.id_helpers.generate_random_alphanumeric_string"
) as mock_generate_id:
mock_generate_id.return_value = mock_generated_id
evaluation.evaluate(
dataset=mock_dataset,
task=say_task,
experiment_name_prefix="test-prefix",
task_threads=1,
)
# Verify that create_experiment was called with a name that starts with the prefix
mock_create_experiment.assert_called_once()
call_args = mock_create_experiment.call_args
experiment_name = _extract_experiment_name_from_call_args(call_args)
assert experiment_name is not None, "Experiment name should not be None"
assert experiment_name.startswith("test-prefix-"), (
f"Experiment name '{experiment_name}' should start with 'test-prefix-'"
)
assert experiment_name == f"test-prefix-{mock_generated_id}", (
f"Expected experiment name to be 'test-prefix-{mock_generated_id}', "
f"but got '{experiment_name}'"
)
def test_evaluate__without_experiment_name_prefix_or_name__generates_default_name(
fake_backend,
):
"""Test that when neither experiment_name nor experiment_name_prefix is provided, None is passed to create_experiment."""
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[
dataset_item.DatasetItem(id="dataset-item-id-1"),
]
)
def say_task(dataset_item: Dict[str, Any]):
return {"output": "hello"}
mock_experiment = mock.Mock()
mock_experiment.prompts = None
mock_experiment.id = "experiment-id"
mock_experiment.name = None
mock_create_experiment = mock.Mock()
mock_create_experiment.return_value = mock_experiment
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
evaluation.evaluate(
dataset=mock_dataset,
task=say_task,
task_threads=1,
)
# Verify that create_experiment was called with name=None
mock_create_experiment.assert_called_once_with(
dataset_name="the-dataset-name",
name=None,
experiment_config=mock.ANY,
prompts=None,
tags=None,
dataset_version_id=None,
project_name=None,
)
def test_evaluate__with_experiment_name_prefix__multiple_calls_generate_unique_names(
fake_backend,
):
"""Test that multiple calls with the same prefix generate different unique names."""
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[dataset_item.DatasetItem(id="dataset-item-id-1")]
)
def say_task(dataset_item: Dict[str, Any]):
return {"output": "hello"}
mock_experiment1 = mock.Mock(prompts=None)
mock_experiment1.id = "experiment-id-1"
mock_experiment2 = mock.Mock(prompts=None)
mock_experiment2.id = "experiment-id-2"
mock_create_experiment = mock.Mock()
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
# Mock generate_id to return different values for each call
mock_generated_ids = ["id1-abc123", "id2-xyz789"]
mock_generate_id_call_count = 0
def mock_generate_random_alphanumeric_string_side_effect(length: int):
nonlocal mock_generate_id_call_count
result = mock_generated_ids[mock_generate_id_call_count]
mock_generate_id_call_count += 1
return result
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
with mock.patch(
"opik.api_objects.experiment.helpers.id_helpers.generate_random_alphanumeric_string"
) as mock_generate_id:
mock_generate_id.side_effect = (
mock_generate_random_alphanumeric_string_side_effect
)
# First call
mock_create_experiment.return_value = mock_experiment1
evaluation.evaluate(
dataset=mock_dataset,
task=say_task,
experiment_name_prefix="shared-prefix",
task_threads=1,
)
# Second call
mock_create_experiment.return_value = mock_experiment2
evaluation.evaluate(
dataset=mock_dataset,
task=say_task,
experiment_name_prefix="shared-prefix",
task_threads=1,
)
# Verify that create_experiment was called twice with different names
assert mock_create_experiment.call_count == 2, (
"create_experiment should be called twice"
)
# Extract name from first call
first_call_args = mock_create_experiment.call_args_list[0]
first_call_name = _extract_experiment_name_from_call_args(first_call_args)
# Extract name from the second call
second_call_args = mock_create_experiment.call_args_list[1]
second_call_name = _extract_experiment_name_from_call_args(second_call_args)
assert first_call_name == f"shared-prefix-{mock_generated_ids[0]}", (
f"First experiment name should be 'shared-prefix-{mock_generated_ids[0]}', "
f"but got '{first_call_name}'"
)
assert second_call_name == f"shared-prefix-{mock_generated_ids[1]}", (
f"Second experiment name should be 'shared-prefix-{mock_generated_ids[1]}', "
f"but got '{second_call_name}'"
)
assert first_call_name != second_call_name, (
"Multiple calls with the same prefix should generate different unique names"
)
def test_evaluate_prompt__with_experiment_name_prefix__generates_name_with_prefix(
fake_backend,
):
"""Test that experiment_name_prefix is correctly applied when creating an experiment via evaluate_prompt."""
MODEL_NAME = "gpt-3.5-turbo"
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[dataset_item.DatasetItem(id="dataset-item-id-1")]
)
mock_create_experiment = mock.Mock()
mock_create_experiment.return_value = mock.Mock(prompts=None)
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
mock_models_factory_get = mock.Mock()
mock_model = mock.Mock()
mock_model.model_name = MODEL_NAME
mock_model.generate_provider_response.return_value = mock.Mock(
choices=[mock.Mock(message=mock.Mock(content="Hello, world!"))]
)
mock_models_factory_get.return_value = mock_model
# Mock generate_id to return a predictable value
mock_generated_id = "prompt-abc123def456"
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
with mock.patch.object(models_factory, "get", mock_models_factory_get):
with mock.patch(
"opik.api_objects.experiment.helpers.id_helpers.generate_random_alphanumeric_string"
) as mock_generate_id:
mock_generate_id.return_value = mock_generated_id
evaluation.evaluate_prompt(
dataset=mock_dataset,
messages=[
{"role": "user", "content": "LLM response: {{input}}"},
],
experiment_name_prefix="prompt-prefix",
model=MODEL_NAME,
task_threads=1,
)
# Verify that create_experiment was called with a name that starts with the prefix
mock_create_experiment.assert_called_once()
call_args = mock_create_experiment.call_args
experiment_name = _extract_experiment_name_from_call_args(call_args)
assert experiment_name is not None, "Experiment name should not be None"
assert experiment_name == f"prompt-prefix-{mock_generated_id}", (
f"Expected experiment name to be 'prompt-prefix-{mock_generated_id}', "
f"but got '{experiment_name}'"
)
def test_evaluate_prompt__with_experiment_name_prefix_and_experiment_name__experiment_name_takes_precedence(
fake_backend,
):
"""Test that when both experiment_name and experiment_name_prefix are provided, experiment_name takes precedence."""
MODEL_NAME = "gpt-3.5-turbo"
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[dataset_item.DatasetItem(id="dataset-item-id-1")]
)
mock_create_experiment = mock.Mock()
mock_create_experiment.return_value = mock.Mock(prompts=None)
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
mock_models_factory_get = mock.Mock()
mock_model = mock.Mock()
mock_model.model_name = MODEL_NAME
mock_model.generate_provider_response.return_value = mock.Mock(
choices=[mock.Mock(message=mock.Mock(content="Hello, world!"))]
)
mock_models_factory_get.return_value = mock_model
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
with mock.patch.object(models_factory, "get", mock_models_factory_get):
evaluation.evaluate_prompt(
dataset=mock_dataset,
messages=[
{"role": "user", "content": "LLM response: {{input}}"},
],
experiment_name="explicit-prompt-experiment-name",
experiment_name_prefix="prompt-prefix",
model=MODEL_NAME,
task_threads=1,
)
# Verify that create_experiment was called with the explicit experiment_name
mock_create_experiment.assert_called_once_with(
dataset_name="the-dataset-name",
name="explicit-prompt-experiment-name",
experiment_config=mock.ANY,
prompts=None,
tags=None,
dataset_version_id=None,
project_name=None,
)
# ``evaluate_prompt`` is contractually required to auto-populate
# ``prompt_template`` and ``model`` into ``experiment_config``. The
# resume blob coexists under a separate key, so we pin the prompt
# contract by drilling in rather than asserting whole-dict equality.
forwarded_config = mock_create_experiment.call_args.kwargs["experiment_config"]
assert forwarded_config["prompt_template"] == [
{"role": "user", "content": "LLM response: {{input}}"}
]
assert forwarded_config["model"] == MODEL_NAME
def test_evaluate_prompt__with_experiment_name_prefix_only__generates_unique_name(
fake_backend,
):
"""Test that when only experiment_name_prefix is provided, a unique name is generated."""
MODEL_NAME = "gpt-3.5-turbo"
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[dataset_item.DatasetItem(id="dataset-item-id-1")]
)
mock_create_experiment = mock.Mock()
mock_create_experiment.return_value = mock.Mock(prompts=None)
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
mock_models_factory_get = mock.Mock()
mock_model = mock.Mock()
mock_model.model_name = MODEL_NAME
mock_model.generate_provider_response.return_value = mock.Mock(
choices=[mock.Mock(message=mock.Mock(content="Hello, world!"))]
)
mock_models_factory_get.return_value = mock_model
# Mock generate_id to return a predictable value
mock_generated_id = "prompt-xyz789abc123"
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
with mock.patch.object(models_factory, "get", mock_models_factory_get):
with mock.patch(
"opik.api_objects.experiment.helpers.id_helpers.generate_random_alphanumeric_string"
) as mock_generate_id:
mock_generate_id.return_value = mock_generated_id
evaluation.evaluate_prompt(
dataset=mock_dataset,
messages=[
{"role": "user", "content": "LLM response: {{input}}"},
],
experiment_name_prefix="test-prompt-prefix",
model=MODEL_NAME,
task_threads=1,
)
# Verify that create_experiment was called with a name that starts with the prefix
mock_create_experiment.assert_called_once()
call_args = mock_create_experiment.call_args
experiment_name = _extract_experiment_name_from_call_args(call_args)
assert experiment_name is not None, "Experiment name should not be None"
assert experiment_name.startswith("test-prompt-prefix-"), (
f"Experiment name '{experiment_name}' should start with 'test-prompt-prefix-'"
)
assert experiment_name == f"test-prompt-prefix-{mock_generated_id}", (
f"Expected experiment name to be 'test-prompt-prefix-{mock_generated_id}', "
f"but got '{experiment_name}'"
)
def test_evaluate_prompt__without_experiment_name_prefix_or_name__generates_default_name(
fake_backend,
):
"""Test that when neither experiment_name nor experiment_name_prefix is provided, None is passed to create_experiment."""
MODEL_NAME = "gpt-3.5-turbo"
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[dataset_item.DatasetItem(id="dataset-item-id-1")]
)
mock_create_experiment = mock.Mock()
mock_create_experiment.return_value = mock.Mock(prompts=None)
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
mock_models_factory_get = mock.Mock()
mock_model = mock.Mock()
mock_model.model_name = MODEL_NAME
mock_model.generate_provider_response.return_value = mock.Mock(
choices=[mock.Mock(message=mock.Mock(content="Hello, world!"))]
)
mock_models_factory_get.return_value = mock_model
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
with mock.patch.object(models_factory, "get", mock_models_factory_get):
evaluation.evaluate_prompt(
dataset=mock_dataset,
messages=[
{"role": "user", "content": "LLM response: {{input}}"},
],
model=MODEL_NAME,
task_threads=1,
)
# Verify that create_experiment was called with name=None
mock_create_experiment.assert_called_once_with(
dataset_name="the-dataset-name",
name=None,
experiment_config=mock.ANY,
prompts=None,
tags=None,
dataset_version_id=None,
project_name=None,
)
# ``evaluate_prompt`` is contractually required to auto-populate
# ``prompt_template`` and ``model`` into ``experiment_config``. The
# resume blob coexists under a separate key, so we pin the prompt
# contract by drilling in rather than asserting whole-dict equality.
forwarded_config = mock_create_experiment.call_args.kwargs["experiment_config"]
assert forwarded_config["prompt_template"] == [
{"role": "user", "content": "LLM response: {{input}}"}
]
assert forwarded_config["model"] == MODEL_NAME
def test_evaluate_prompt__with_experiment_name_prefix__multiple_calls_generate_unique_names(
fake_backend,
):
"""Test that multiple calls with the same prefix generate different unique names."""
MODEL_NAME = "gpt-3.5-turbo"
mock_dataset = mock.MagicMock(
spec=[
"__internal_api__stream_items_as_dataclasses__",
"id",
"name",
"dataset_items_count",
"get_version_info",
"project_name",
]
)
mock_dataset.name = "the-dataset-name"
mock_dataset.get_version_info.return_value = None
mock_dataset.project_name = None
mock_dataset.dataset_items_count = None
mock_dataset.id = "dataset-id"
mock_dataset.__internal_api__stream_items_as_dataclasses__.return_value = iter(
[dataset_item.DatasetItem(id="dataset-item-id-1")]
)
mock_create_experiment = mock.Mock()
mock_get_experiment_url_by_id = mock.Mock()
mock_get_experiment_url_by_id.return_value = "any_url"
mock_models_factory_get = mock.Mock()
mock_model = mock.Mock()
mock_model.model_name = MODEL_NAME
mock_model.generate_provider_response.return_value = mock.Mock(
choices=[mock.Mock(message=mock.Mock(content="Hello, world!"))]
)
mock_models_factory_get.return_value = mock_model
# Mock generate_id to return different values for each call
mock_generated_ids = ["prompt-id1-abc123", "prompt-id2-xyz789"]
mock_generate_id_call_count = 0
def mock_generate_random_alphanumeric_string_side_effect(length: int):
nonlocal mock_generate_id_call_count
result = mock_generated_ids[mock_generate_id_call_count]
mock_generate_id_call_count += 1
return result
with mock.patch.object(
opik_client.Opik, "create_experiment", mock_create_experiment
):
with mock.patch.object(
url_helpers, "get_experiment_url_by_id", mock_get_experiment_url_by_id
):
with mock.patch.object(models_factory, "get", mock_models_factory_get):
with mock.patch(
"opik.api_objects.experiment.helpers.id_helpers.generate_random_alphanumeric_string"
) as mock_generate_id:
mock_generate_id.side_effect = (
mock_generate_random_alphanumeric_string_side_effect
)
# First call
mock_create_experiment.return_value = mock.Mock(prompts=None)
evaluation.evaluate_prompt(
dataset=mock_dataset,
messages=[
{"role": "user", "content": "LLM response: {{input}}"},
],
experiment_name_prefix="shared-prompt-prefix",
model=MODEL_NAME,
task_threads=1,
)
# Second call
mock_create_experiment.return_value = mock.Mock(prompts=None)
evaluation.evaluate_prompt(
dataset=mock_dataset,
messages=[
{"role": "user", "content": "LLM response: {{input}}"},
],
experiment_name_prefix="shared-prompt-prefix",
model=MODEL_NAME,
task_threads=1,
)
# Verify that create_experiment was called twice with different names
assert mock_create_experiment.call_count == 2, (
"create_experiment should be called twice"
)
# Extract name from first call
first_call_args = mock_create_experiment.call_args_list[0]
first_call_name = _extract_experiment_name_from_call_args(first_call_args)
# Extract name from the second call
second_call_args = mock_create_experiment.call_args_list[1]
second_call_name = _extract_experiment_name_from_call_args(second_call_args)
assert first_call_name == f"shared-prompt-prefix-{mock_generated_ids[0]}", (
f"First experiment name should be 'shared-prompt-prefix-{mock_generated_ids[0]}', "
f"but got '{first_call_name}'"
)
assert second_call_name == f"shared-prompt-prefix-{mock_generated_ids[1]}", (
f"Second experiment name should be 'shared-prompt-prefix-{mock_generated_ids[1]}', "
f"but got '{second_call_name}'"
)
assert first_call_name != second_call_name, (
"Multiple calls with the same prefix should generate different unique names"
)