Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 9 additions & 33 deletions py/src/braintrust/framework.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@

from tqdm.asyncio import tqdm as async_tqdm
from tqdm.auto import tqdm as std_tqdm
from typing_extensions import NotRequired, Protocol, TypedDict
from typing_extensions import Protocol, TypedDict

from .generated_types import FunctionFormat, FunctionOutputType, ObjectReference
from .git_fields import GitMetadataSettings, RepoInfo
Expand All@@ -36,7 +36,6 @@
Metadata,
ScoreSummary,
Span,
_ExperimentDatasetEvent,
parent_context,
start_span,
stringify_exception,
Expand All@@ -53,6 +52,7 @@
from .score import Score, is_score, is_scorer
from .serializable_data_class import SerializableDataClass
from .span_types import SpanTypeAttribute
from .types._eval import EvalCaseDict, EvalCaseDictNoOutput, ExperimentDatasetEvent
from .util import bt_iscoroutinefunction, eprint, merge_dicts


Expand DownExpand Up@@ -91,30 +91,6 @@ class EvalCase(SerializableDataClass, Generic[Input, Output]):
created: str | None = None


class _EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy `_EvalCaseDict[Input, Output]` for any
`Output` type.
"""

input: Input
metadata: NotRequired[Metadata | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class _EvalCaseDict(Generic[Input, Output], _EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


# Inheritance doesn't quite work for dataclasses, so we redefine the fields
# from EvalCase here.
@dataclasses.dataclass
Expand DownExpand Up@@ -292,9 +268,9 @@ class BaseExperiment:

_AnyEvalCase = Union[
EvalCase[Input, Output],
_EvalCaseDict[Input, Output],
_EvalCaseDictNoOutput[Input],
_ExperimentDatasetEvent,
EvalCaseDict[Input, Output],
EvalCaseDictNoOutput[Input],
ExperimentDatasetEvent,
]

_EvalDataObject = Union[
Expand DownExpand Up@@ -429,7 +405,7 @@ class Evaluator(Generic[Input, Output]):
takes precedence over `git_metadata_settings` if specified.
"""

error_score_handler: ErrorScoreHandler | None = None
error_score_handler: ErrorScoreHandler[Input, Output] | None = None
"""
Optionally supply a custom function to specifically handle score values when tasks or scoring functions have errored.
A default implementation is exported as `default_error_score_handler` which will log a 0 score to the root span for any scorer that was not run.
Expand DownExpand Up@@ -682,7 +658,7 @@ def _EvalCommon(
description: str | None,
summarize_scores: bool,
no_send_logs: bool,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
parameters: EvalParameters | RemoteEvalParameters | None = None,
on_start: Callable[[ExperimentSummary], None] | None = None,
stream: Callable[[SSEProgressEvent], None] | None = None,
Expand DownExpand Up@@ -815,7 +791,7 @@ async def EvalAsync(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand DownExpand Up@@ -942,7 +918,7 @@ def Eval(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand Down
21 changes: 4 additions & 17 deletions py/src/braintrust/logger.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@
from .span_identifier_v4 import SpanComponentsV4
from .span_types import SpanTypeAttribute
from .types import Metadata
from .types._eval import ExperimentDatasetEvent
from .util import (
GLOBAL_PROJECT,
AugmentedHTTPError,
Expand DownExpand Up@@ -3716,35 +3717,21 @@ class ExperimentIdentifier:
name: str


class _ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with `framework._EvalCaseDict` like we do in the
TypeScript SDK, or generated from OpenAPI spec. For now, marking as internal
to exclude it from the docs.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None


class ExperimentDatasetIterator:
def __init__(self, iterator: Iterator[ExperimentEvent]):
self.iterator = iterator

def __iter__(self):
return self

def __next__(self) -> _ExperimentDatasetEvent:
def __next__(self) -> ExperimentDatasetEvent:
while True:
value = next(self.iterator)
if value["root_span_id"] != value["span_id"]:
continue

output, expected = value.get("output"), value.get("expected")
ret: _ExperimentDatasetEvent = {
ret: ExperimentDatasetEvent = {
"input": value.get("input"),
"expected": expected if expected is not None else output,
"tags": value.get("tags"),
Expand DownExpand Up@@ -4133,7 +4120,7 @@ def _get_state(self) -> BraintrustState:
self._lazy_metadata.get()
return self.state

def as_dataset(self, batch_size: int | None = None) -> Iterator[_ExperimentDatasetEvent]:
def as_dataset(self, batch_size: int | None = None) -> Iterator[ExperimentDatasetEvent]:
"""
Return the experiment's data as a dataset iterator.

Expand Down
File renamed without changes.
51 changes: 51 additions & 0 deletions py/src/braintrust/types/_eval.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
"""Internal TypedDict types used in Eval/EvalAsync signatures.

These live in an underscore-prefixed module so they don't appear in
generated documentation, while the class names themselves are *not*
underscore-prefixed so pyright strict mode doesn't flag them as private.
"""

from typing import Any, Generic, Sequence, TypeVar

from typing_extensions import NotRequired, TypedDict


Input = TypeVar("Input")
Output = TypeVar("Output")


class EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy ``EvalCaseDict[Input, Output]`` for any
``Output`` type.
"""

input: Input
metadata: NotRequired[dict[str, Any] | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class EvalCaseDict(Generic[Input, Output], EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


class ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with ``EvalCaseDict`` like we do in the
TypeScript SDK, or generated from OpenAPI spec.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 9 additions & 33 deletions py/src/braintrust/framework.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@

from tqdm.asyncio import tqdm as async_tqdm
from tqdm.auto import tqdm as std_tqdm
from typing_extensions import NotRequired, Protocol, TypedDict
from typing_extensions import Protocol, TypedDict

from .generated_types import FunctionFormat, FunctionOutputType, ObjectReference
from .git_fields import GitMetadataSettings, RepoInfo
Expand All@@ -36,7 +36,6 @@
Metadata,
ScoreSummary,
Span,
_ExperimentDatasetEvent,
parent_context,
start_span,
stringify_exception,
Expand All@@ -53,6 +52,7 @@
from .score import Score, is_score, is_scorer
from .serializable_data_class import SerializableDataClass
from .span_types import SpanTypeAttribute
from .types._eval import EvalCaseDict, EvalCaseDictNoOutput, ExperimentDatasetEvent
from .util import bt_iscoroutinefunction, eprint, merge_dicts


Expand DownExpand Up@@ -91,30 +91,6 @@ class EvalCase(SerializableDataClass, Generic[Input, Output]):
created: str | None = None


class _EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy `_EvalCaseDict[Input, Output]` for any
`Output` type.
"""

input: Input
metadata: NotRequired[Metadata | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class _EvalCaseDict(Generic[Input, Output], _EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


# Inheritance doesn't quite work for dataclasses, so we redefine the fields
# from EvalCase here.
@dataclasses.dataclass
Expand DownExpand Up@@ -292,9 +268,9 @@ class BaseExperiment:

_AnyEvalCase = Union[
EvalCase[Input, Output],
_EvalCaseDict[Input, Output],
_EvalCaseDictNoOutput[Input],
_ExperimentDatasetEvent,
EvalCaseDict[Input, Output],
EvalCaseDictNoOutput[Input],
ExperimentDatasetEvent,
]

_EvalDataObject = Union[
Expand DownExpand Up@@ -429,7 +405,7 @@ class Evaluator(Generic[Input, Output]):
takes precedence over `git_metadata_settings` if specified.
"""

error_score_handler: ErrorScoreHandler | None = None
error_score_handler: ErrorScoreHandler[Input, Output] | None = None
"""
Optionally supply a custom function to specifically handle score values when tasks or scoring functions have errored.
A default implementation is exported as `default_error_score_handler` which will log a 0 score to the root span for any scorer that was not run.
Expand DownExpand Up@@ -682,7 +658,7 @@ def _EvalCommon(
description: str | None,
summarize_scores: bool,
no_send_logs: bool,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
parameters: EvalParameters | RemoteEvalParameters | None = None,
on_start: Callable[[ExperimentSummary], None] | None = None,
stream: Callable[[SSEProgressEvent], None] | None = None,
Expand DownExpand Up@@ -815,7 +791,7 @@ async def EvalAsync(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand DownExpand Up@@ -942,7 +918,7 @@ def Eval(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand Down
21 changes: 4 additions & 17 deletions py/src/braintrust/logger.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@
from .span_identifier_v4 import SpanComponentsV4
from .span_types import SpanTypeAttribute
from .types import Metadata
from .types._eval import ExperimentDatasetEvent
from .util import (
GLOBAL_PROJECT,
AugmentedHTTPError,
Expand DownExpand Up@@ -3716,35 +3717,21 @@ class ExperimentIdentifier:
name: str


class _ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with `framework._EvalCaseDict` like we do in the
TypeScript SDK, or generated from OpenAPI spec. For now, marking as internal
to exclude it from the docs.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None


class ExperimentDatasetIterator:
def __init__(self, iterator: Iterator[ExperimentEvent]):
self.iterator = iterator

def __iter__(self):
return self

def __next__(self) -> _ExperimentDatasetEvent:
def __next__(self) -> ExperimentDatasetEvent:
while True:
value = next(self.iterator)
if value["root_span_id"] != value["span_id"]:
continue

output, expected = value.get("output"), value.get("expected")
ret: _ExperimentDatasetEvent = {
ret: ExperimentDatasetEvent = {
"input": value.get("input"),
"expected": expected if expected is not None else output,
"tags": value.get("tags"),
Expand DownExpand Up@@ -4133,7 +4120,7 @@ def _get_state(self) -> BraintrustState:
self._lazy_metadata.get()
return self.state

def as_dataset(self, batch_size: int | None = None) -> Iterator[_ExperimentDatasetEvent]:
def as_dataset(self, batch_size: int | None = None) -> Iterator[ExperimentDatasetEvent]:
"""
Return the experiment's data as a dataset iterator.

Expand Down
File renamed without changes.
51 changes: 51 additions & 0 deletions py/src/braintrust/types/_eval.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
"""Internal TypedDict types used in Eval/EvalAsync signatures.

These live in an underscore-prefixed module so they don't appear in
generated documentation, while the class names themselves are *not*
underscore-prefixed so pyright strict mode doesn't flag them as private.
"""

from typing import Any, Generic, Sequence, TypeVar

from typing_extensions import NotRequired, TypedDict


Input = TypeVar("Input")
Output = TypeVar("Output")


class EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy ``EvalCaseDict[Input, Output]`` for any
``Output`` type.
"""

input: Input
metadata: NotRequired[dict[str, Any] | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class EvalCaseDict(Generic[Input, Output], EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


class ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with ``EvalCaseDict`` like we do in the
TypeScript SDK, or generated from OpenAPI spec.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 9 additions & 33 deletions py/src/braintrust/framework.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@

from tqdm.asyncio import tqdm as async_tqdm
from tqdm.auto import tqdm as std_tqdm
from typing_extensions import NotRequired, Protocol, TypedDict
from typing_extensions import Protocol, TypedDict

from .generated_types import FunctionFormat, FunctionOutputType, ObjectReference
from .git_fields import GitMetadataSettings, RepoInfo
Expand All@@ -36,7 +36,6 @@
Metadata,
ScoreSummary,
Span,
_ExperimentDatasetEvent,
parent_context,
start_span,
stringify_exception,
Expand All@@ -53,6 +52,7 @@
from .score import Score, is_score, is_scorer
from .serializable_data_class import SerializableDataClass
from .span_types import SpanTypeAttribute
from .types._eval import EvalCaseDict, EvalCaseDictNoOutput, ExperimentDatasetEvent
from .util import bt_iscoroutinefunction, eprint, merge_dicts


Expand DownExpand Up@@ -91,30 +91,6 @@ class EvalCase(SerializableDataClass, Generic[Input, Output]):
created: str | None = None


class _EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy `_EvalCaseDict[Input, Output]` for any
`Output` type.
"""

input: Input
metadata: NotRequired[Metadata | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class _EvalCaseDict(Generic[Input, Output], _EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


# Inheritance doesn't quite work for dataclasses, so we redefine the fields
# from EvalCase here.
@dataclasses.dataclass
Expand DownExpand Up@@ -292,9 +268,9 @@ class BaseExperiment:

_AnyEvalCase = Union[
EvalCase[Input, Output],
_EvalCaseDict[Input, Output],
_EvalCaseDictNoOutput[Input],
_ExperimentDatasetEvent,
EvalCaseDict[Input, Output],
EvalCaseDictNoOutput[Input],
ExperimentDatasetEvent,
]

_EvalDataObject = Union[
Expand DownExpand Up@@ -429,7 +405,7 @@ class Evaluator(Generic[Input, Output]):
takes precedence over `git_metadata_settings` if specified.
"""

error_score_handler: ErrorScoreHandler | None = None
error_score_handler: ErrorScoreHandler[Input, Output] | None = None
"""
Optionally supply a custom function to specifically handle score values when tasks or scoring functions have errored.
A default implementation is exported as `default_error_score_handler` which will log a 0 score to the root span for any scorer that was not run.
Expand DownExpand Up@@ -682,7 +658,7 @@ def _EvalCommon(
description: str | None,
summarize_scores: bool,
no_send_logs: bool,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
parameters: EvalParameters | RemoteEvalParameters | None = None,
on_start: Callable[[ExperimentSummary], None] | None = None,
stream: Callable[[SSEProgressEvent], None] | None = None,
Expand DownExpand Up@@ -815,7 +791,7 @@ async def EvalAsync(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand DownExpand Up@@ -942,7 +918,7 @@ def Eval(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand Down
21 changes: 4 additions & 17 deletions py/src/braintrust/logger.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@
from .span_identifier_v4 import SpanComponentsV4
from .span_types import SpanTypeAttribute
from .types import Metadata
from .types._eval import ExperimentDatasetEvent
from .util import (
GLOBAL_PROJECT,
AugmentedHTTPError,
Expand DownExpand Up@@ -3716,35 +3717,21 @@ class ExperimentIdentifier:
name: str


class _ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with `framework._EvalCaseDict` like we do in the
TypeScript SDK, or generated from OpenAPI spec. For now, marking as internal
to exclude it from the docs.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None


class ExperimentDatasetIterator:
def __init__(self, iterator: Iterator[ExperimentEvent]):
self.iterator = iterator

def __iter__(self):
return self

def __next__(self) -> _ExperimentDatasetEvent:
def __next__(self) -> ExperimentDatasetEvent:
while True:
value = next(self.iterator)
if value["root_span_id"] != value["span_id"]:
continue

output, expected = value.get("output"), value.get("expected")
ret: _ExperimentDatasetEvent = {
ret: ExperimentDatasetEvent = {
"input": value.get("input"),
"expected": expected if expected is not None else output,
"tags": value.get("tags"),
Expand DownExpand Up@@ -4133,7 +4120,7 @@ def _get_state(self) -> BraintrustState:
self._lazy_metadata.get()
return self.state

def as_dataset(self, batch_size: int | None = None) -> Iterator[_ExperimentDatasetEvent]:
def as_dataset(self, batch_size: int | None = None) -> Iterator[ExperimentDatasetEvent]:
"""
Return the experiment's data as a dataset iterator.

Expand Down
File renamed without changes.
51 changes: 51 additions & 0 deletions py/src/braintrust/types/_eval.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
"""Internal TypedDict types used in Eval/EvalAsync signatures.

These live in an underscore-prefixed module so they don't appear in
generated documentation, while the class names themselves are *not*
underscore-prefixed so pyright strict mode doesn't flag them as private.
"""

from typing import Any, Generic, Sequence, TypeVar

from typing_extensions import NotRequired, TypedDict


Input = TypeVar("Input")
Output = TypeVar("Output")


class EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy ``EvalCaseDict[Input, Output]`` for any
``Output`` type.
"""

input: Input
metadata: NotRequired[dict[str, Any] | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class EvalCaseDict(Generic[Input, Output], EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


class ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with ``EvalCaseDict`` like we do in the
TypeScript SDK, or generated from OpenAPI spec.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 9 additions & 33 deletions py/src/braintrust/framework.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@

from tqdm.asyncio import tqdm as async_tqdm
from tqdm.auto import tqdm as std_tqdm
from typing_extensions import NotRequired, Protocol, TypedDict
from typing_extensions import Protocol, TypedDict

from .generated_types import FunctionFormat, FunctionOutputType, ObjectReference
from .git_fields import GitMetadataSettings, RepoInfo
Expand All@@ -36,7 +36,6 @@
Metadata,
ScoreSummary,
Span,
_ExperimentDatasetEvent,
parent_context,
start_span,
stringify_exception,
Expand All@@ -53,6 +52,7 @@
from .score import Score, is_score, is_scorer
from .serializable_data_class import SerializableDataClass
from .span_types import SpanTypeAttribute
from .types._eval import EvalCaseDict, EvalCaseDictNoOutput, ExperimentDatasetEvent
from .util import bt_iscoroutinefunction, eprint, merge_dicts


Expand DownExpand Up@@ -91,30 +91,6 @@ class EvalCase(SerializableDataClass, Generic[Input, Output]):
created: str | None = None


class _EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy `_EvalCaseDict[Input, Output]` for any
`Output` type.
"""

input: Input
metadata: NotRequired[Metadata | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class _EvalCaseDict(Generic[Input, Output], _EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


# Inheritance doesn't quite work for dataclasses, so we redefine the fields
# from EvalCase here.
@dataclasses.dataclass
Expand DownExpand Up@@ -292,9 +268,9 @@ class BaseExperiment:

_AnyEvalCase = Union[
EvalCase[Input, Output],
_EvalCaseDict[Input, Output],
_EvalCaseDictNoOutput[Input],
_ExperimentDatasetEvent,
EvalCaseDict[Input, Output],
EvalCaseDictNoOutput[Input],
ExperimentDatasetEvent,
]

_EvalDataObject = Union[
Expand DownExpand Up@@ -429,7 +405,7 @@ class Evaluator(Generic[Input, Output]):
takes precedence over `git_metadata_settings` if specified.
"""

error_score_handler: ErrorScoreHandler | None = None
error_score_handler: ErrorScoreHandler[Input, Output] | None = None
"""
Optionally supply a custom function to specifically handle score values when tasks or scoring functions have errored.
A default implementation is exported as `default_error_score_handler` which will log a 0 score to the root span for any scorer that was not run.
Expand DownExpand Up@@ -682,7 +658,7 @@ def _EvalCommon(
description: str | None,
summarize_scores: bool,
no_send_logs: bool,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
parameters: EvalParameters | RemoteEvalParameters | None = None,
on_start: Callable[[ExperimentSummary], None] | None = None,
stream: Callable[[SSEProgressEvent], None] | None = None,
Expand DownExpand Up@@ -815,7 +791,7 @@ async def EvalAsync(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand DownExpand Up@@ -942,7 +918,7 @@ def Eval(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand Down
21 changes: 4 additions & 17 deletions py/src/braintrust/logger.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@
from .span_identifier_v4 import SpanComponentsV4
from .span_types import SpanTypeAttribute
from .types import Metadata
from .types._eval import ExperimentDatasetEvent
from .util import (
GLOBAL_PROJECT,
AugmentedHTTPError,
Expand DownExpand Up@@ -3716,35 +3717,21 @@ class ExperimentIdentifier:
name: str


class _ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with `framework._EvalCaseDict` like we do in the
TypeScript SDK, or generated from OpenAPI spec. For now, marking as internal
to exclude it from the docs.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None


class ExperimentDatasetIterator:
def __init__(self, iterator: Iterator[ExperimentEvent]):
self.iterator = iterator

def __iter__(self):
return self

def __next__(self) -> _ExperimentDatasetEvent:
def __next__(self) -> ExperimentDatasetEvent:
while True:
value = next(self.iterator)
if value["root_span_id"] != value["span_id"]:
continue

output, expected = value.get("output"), value.get("expected")
ret: _ExperimentDatasetEvent = {
ret: ExperimentDatasetEvent = {
"input": value.get("input"),
"expected": expected if expected is not None else output,
"tags": value.get("tags"),
Expand DownExpand Up@@ -4133,7 +4120,7 @@ def _get_state(self) -> BraintrustState:
self._lazy_metadata.get()
return self.state

def as_dataset(self, batch_size: int | None = None) -> Iterator[_ExperimentDatasetEvent]:
def as_dataset(self, batch_size: int | None = None) -> Iterator[ExperimentDatasetEvent]:
"""
Return the experiment's data as a dataset iterator.

Expand Down
File renamed without changes.
51 changes: 51 additions & 0 deletions py/src/braintrust/types/_eval.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
"""Internal TypedDict types used in Eval/EvalAsync signatures.

These live in an underscore-prefixed module so they don't appear in
generated documentation, while the class names themselves are *not*
underscore-prefixed so pyright strict mode doesn't flag them as private.
"""

from typing import Any, Generic, Sequence, TypeVar

from typing_extensions import NotRequired, TypedDict


Input = TypeVar("Input")
Output = TypeVar("Output")


class EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy ``EvalCaseDict[Input, Output]`` for any
``Output`` type.
"""

input: Input
metadata: NotRequired[dict[str, Any] | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class EvalCaseDict(Generic[Input, Output], EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


class ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with ``EvalCaseDict`` like we do in the
TypeScript SDK, or generated from OpenAPI spec.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 9 additions & 33 deletions py/src/braintrust/framework.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@

from tqdm.asyncio import tqdm as async_tqdm
from tqdm.auto import tqdm as std_tqdm
from typing_extensions import NotRequired, Protocol, TypedDict
from typing_extensions import Protocol, TypedDict

from .generated_types import FunctionFormat, FunctionOutputType, ObjectReference
from .git_fields import GitMetadataSettings, RepoInfo
Expand All@@ -36,7 +36,6 @@
Metadata,
ScoreSummary,
Span,
_ExperimentDatasetEvent,
parent_context,
start_span,
stringify_exception,
Expand All@@ -53,6 +52,7 @@
from .score import Score, is_score, is_scorer
from .serializable_data_class import SerializableDataClass
from .span_types import SpanTypeAttribute
from .types._eval import EvalCaseDict, EvalCaseDictNoOutput, ExperimentDatasetEvent
from .util import bt_iscoroutinefunction, eprint, merge_dicts


Expand DownExpand Up@@ -91,30 +91,6 @@ class EvalCase(SerializableDataClass, Generic[Input, Output]):
created: str | None = None


class _EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy `_EvalCaseDict[Input, Output]` for any
`Output` type.
"""

input: Input
metadata: NotRequired[Metadata | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class _EvalCaseDict(Generic[Input, Output], _EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


# Inheritance doesn't quite work for dataclasses, so we redefine the fields
# from EvalCase here.
@dataclasses.dataclass
Expand DownExpand Up@@ -292,9 +268,9 @@ class BaseExperiment:

_AnyEvalCase = Union[
EvalCase[Input, Output],
_EvalCaseDict[Input, Output],
_EvalCaseDictNoOutput[Input],
_ExperimentDatasetEvent,
EvalCaseDict[Input, Output],
EvalCaseDictNoOutput[Input],
ExperimentDatasetEvent,
]

_EvalDataObject = Union[
Expand DownExpand Up@@ -429,7 +405,7 @@ class Evaluator(Generic[Input, Output]):
takes precedence over `git_metadata_settings` if specified.
"""

error_score_handler: ErrorScoreHandler | None = None
error_score_handler: ErrorScoreHandler[Input, Output] | None = None
"""
Optionally supply a custom function to specifically handle score values when tasks or scoring functions have errored.
A default implementation is exported as `default_error_score_handler` which will log a 0 score to the root span for any scorer that was not run.
Expand DownExpand Up@@ -682,7 +658,7 @@ def _EvalCommon(
description: str | None,
summarize_scores: bool,
no_send_logs: bool,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
parameters: EvalParameters | RemoteEvalParameters | None = None,
on_start: Callable[[ExperimentSummary], None] | None = None,
stream: Callable[[SSEProgressEvent], None] | None = None,
Expand DownExpand Up@@ -815,7 +791,7 @@ async def EvalAsync(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand DownExpand Up@@ -942,7 +918,7 @@ def Eval(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand Down
21 changes: 4 additions & 17 deletions py/src/braintrust/logger.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@
from .span_identifier_v4 import SpanComponentsV4
from .span_types import SpanTypeAttribute
from .types import Metadata
from .types._eval import ExperimentDatasetEvent
from .util import (
GLOBAL_PROJECT,
AugmentedHTTPError,
Expand DownExpand Up@@ -3716,35 +3717,21 @@ class ExperimentIdentifier:
name: str


class _ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with `framework._EvalCaseDict` like we do in the
TypeScript SDK, or generated from OpenAPI spec. For now, marking as internal
to exclude it from the docs.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None


class ExperimentDatasetIterator:
def __init__(self, iterator: Iterator[ExperimentEvent]):
self.iterator = iterator

def __iter__(self):
return self

def __next__(self) -> _ExperimentDatasetEvent:
def __next__(self) -> ExperimentDatasetEvent:
while True:
value = next(self.iterator)
if value["root_span_id"] != value["span_id"]:
continue

output, expected = value.get("output"), value.get("expected")
ret: _ExperimentDatasetEvent = {
ret: ExperimentDatasetEvent = {
"input": value.get("input"),
"expected": expected if expected is not None else output,
"tags": value.get("tags"),
Expand DownExpand Up@@ -4133,7 +4120,7 @@ def _get_state(self) -> BraintrustState:
self._lazy_metadata.get()
return self.state

def as_dataset(self, batch_size: int | None = None) -> Iterator[_ExperimentDatasetEvent]:
def as_dataset(self, batch_size: int | None = None) -> Iterator[ExperimentDatasetEvent]:
"""
Return the experiment's data as a dataset iterator.

Expand Down
File renamed without changes.
51 changes: 51 additions & 0 deletions py/src/braintrust/types/_eval.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
"""Internal TypedDict types used in Eval/EvalAsync signatures.

These live in an underscore-prefixed module so they don't appear in
generated documentation, while the class names themselves are *not*
underscore-prefixed so pyright strict mode doesn't flag them as private.
"""

from typing import Any, Generic, Sequence, TypeVar

from typing_extensions import NotRequired, TypedDict


Input = TypeVar("Input")
Output = TypeVar("Output")


class EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy ``EvalCaseDict[Input, Output]`` for any
``Output`` type.
"""

input: Input
metadata: NotRequired[dict[str, Any] | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class EvalCaseDict(Generic[Input, Output], EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


class ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with ``EvalCaseDict`` like we do in the
TypeScript SDK, or generated from OpenAPI spec.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 9 additions & 33 deletions py/src/braintrust/framework.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@

from tqdm.asyncio import tqdm as async_tqdm
from tqdm.auto import tqdm as std_tqdm
from typing_extensions import NotRequired, Protocol, TypedDict
from typing_extensions import Protocol, TypedDict

from .generated_types import FunctionFormat, FunctionOutputType, ObjectReference
from .git_fields import GitMetadataSettings, RepoInfo
Expand All@@ -36,7 +36,6 @@
Metadata,
ScoreSummary,
Span,
_ExperimentDatasetEvent,
parent_context,
start_span,
stringify_exception,
Expand All@@ -53,6 +52,7 @@
from .score import Score, is_score, is_scorer
from .serializable_data_class import SerializableDataClass
from .span_types import SpanTypeAttribute
from .types._eval import EvalCaseDict, EvalCaseDictNoOutput, ExperimentDatasetEvent
from .util import bt_iscoroutinefunction, eprint, merge_dicts


Expand DownExpand Up@@ -91,30 +91,6 @@ class EvalCase(SerializableDataClass, Generic[Input, Output]):
created: str | None = None


class _EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy `_EvalCaseDict[Input, Output]` for any
`Output` type.
"""

input: Input
metadata: NotRequired[Metadata | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class _EvalCaseDict(Generic[Input, Output], _EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


# Inheritance doesn't quite work for dataclasses, so we redefine the fields
# from EvalCase here.
@dataclasses.dataclass
Expand DownExpand Up@@ -292,9 +268,9 @@ class BaseExperiment:

_AnyEvalCase = Union[
EvalCase[Input, Output],
_EvalCaseDict[Input, Output],
_EvalCaseDictNoOutput[Input],
_ExperimentDatasetEvent,
EvalCaseDict[Input, Output],
EvalCaseDictNoOutput[Input],
ExperimentDatasetEvent,
]

_EvalDataObject = Union[
Expand DownExpand Up@@ -429,7 +405,7 @@ class Evaluator(Generic[Input, Output]):
takes precedence over `git_metadata_settings` if specified.
"""

error_score_handler: ErrorScoreHandler | None = None
error_score_handler: ErrorScoreHandler[Input, Output] | None = None
"""
Optionally supply a custom function to specifically handle score values when tasks or scoring functions have errored.
A default implementation is exported as `default_error_score_handler` which will log a 0 score to the root span for any scorer that was not run.
Expand DownExpand Up@@ -682,7 +658,7 @@ def _EvalCommon(
description: str | None,
summarize_scores: bool,
no_send_logs: bool,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
parameters: EvalParameters | RemoteEvalParameters | None = None,
on_start: Callable[[ExperimentSummary], None] | None = None,
stream: Callable[[SSEProgressEvent], None] | None = None,
Expand DownExpand Up@@ -815,7 +791,7 @@ async def EvalAsync(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand DownExpand Up@@ -942,7 +918,7 @@ def Eval(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand Down
21 changes: 4 additions & 17 deletions py/src/braintrust/logger.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@
from .span_identifier_v4 import SpanComponentsV4
from .span_types import SpanTypeAttribute
from .types import Metadata
from .types._eval import ExperimentDatasetEvent
from .util import (
GLOBAL_PROJECT,
AugmentedHTTPError,
Expand DownExpand Up@@ -3716,35 +3717,21 @@ class ExperimentIdentifier:
name: str


class _ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with `framework._EvalCaseDict` like we do in the
TypeScript SDK, or generated from OpenAPI spec. For now, marking as internal
to exclude it from the docs.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None


class ExperimentDatasetIterator:
def __init__(self, iterator: Iterator[ExperimentEvent]):
self.iterator = iterator

def __iter__(self):
return self

def __next__(self) -> _ExperimentDatasetEvent:
def __next__(self) -> ExperimentDatasetEvent:
while True:
value = next(self.iterator)
if value["root_span_id"] != value["span_id"]:
continue

output, expected = value.get("output"), value.get("expected")
ret: _ExperimentDatasetEvent = {
ret: ExperimentDatasetEvent = {
"input": value.get("input"),
"expected": expected if expected is not None else output,
"tags": value.get("tags"),
Expand DownExpand Up@@ -4133,7 +4120,7 @@ def _get_state(self) -> BraintrustState:
self._lazy_metadata.get()
return self.state

def as_dataset(self, batch_size: int | None = None) -> Iterator[_ExperimentDatasetEvent]:
def as_dataset(self, batch_size: int | None = None) -> Iterator[ExperimentDatasetEvent]:
"""
Return the experiment's data as a dataset iterator.

Expand Down
File renamed without changes.
51 changes: 51 additions & 0 deletions py/src/braintrust/types/_eval.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
"""Internal TypedDict types used in Eval/EvalAsync signatures.

These live in an underscore-prefixed module so they don't appear in
generated documentation, while the class names themselves are *not*
underscore-prefixed so pyright strict mode doesn't flag them as private.
"""

from typing import Any, Generic, Sequence, TypeVar

from typing_extensions import NotRequired, TypedDict


Input = TypeVar("Input")
Output = TypeVar("Output")


class EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy ``EvalCaseDict[Input, Output]`` for any
``Output`` type.
"""

input: Input
metadata: NotRequired[dict[str, Any] | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class EvalCaseDict(Generic[Input, Output], EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


class ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with ``EvalCaseDict`` like we do in the
TypeScript SDK, or generated from OpenAPI spec.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 9 additions & 33 deletions py/src/braintrust/framework.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@

from tqdm.asyncio import tqdm as async_tqdm
from tqdm.auto import tqdm as std_tqdm
from typing_extensions import NotRequired, Protocol, TypedDict
from typing_extensions import Protocol, TypedDict

from .generated_types import FunctionFormat, FunctionOutputType, ObjectReference
from .git_fields import GitMetadataSettings, RepoInfo
Expand All@@ -36,7 +36,6 @@
Metadata,
ScoreSummary,
Span,
_ExperimentDatasetEvent,
parent_context,
start_span,
stringify_exception,
Expand All@@ -53,6 +52,7 @@
from .score import Score, is_score, is_scorer
from .serializable_data_class import SerializableDataClass
from .span_types import SpanTypeAttribute
from .types._eval import EvalCaseDict, EvalCaseDictNoOutput, ExperimentDatasetEvent
from .util import bt_iscoroutinefunction, eprint, merge_dicts


Expand DownExpand Up@@ -91,30 +91,6 @@ class EvalCase(SerializableDataClass, Generic[Input, Output]):
created: str | None = None


class _EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy `_EvalCaseDict[Input, Output]` for any
`Output` type.
"""

input: Input
metadata: NotRequired[Metadata | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class _EvalCaseDict(Generic[Input, Output], _EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


# Inheritance doesn't quite work for dataclasses, so we redefine the fields
# from EvalCase here.
@dataclasses.dataclass
Expand DownExpand Up@@ -292,9 +268,9 @@ class BaseExperiment:

_AnyEvalCase = Union[
EvalCase[Input, Output],
_EvalCaseDict[Input, Output],
_EvalCaseDictNoOutput[Input],
_ExperimentDatasetEvent,
EvalCaseDict[Input, Output],
EvalCaseDictNoOutput[Input],
ExperimentDatasetEvent,
]

_EvalDataObject = Union[
Expand DownExpand Up@@ -429,7 +405,7 @@ class Evaluator(Generic[Input, Output]):
takes precedence over `git_metadata_settings` if specified.
"""

error_score_handler: ErrorScoreHandler | None = None
error_score_handler: ErrorScoreHandler[Input, Output] | None = None
"""
Optionally supply a custom function to specifically handle score values when tasks or scoring functions have errored.
A default implementation is exported as `default_error_score_handler` which will log a 0 score to the root span for any scorer that was not run.
Expand DownExpand Up@@ -682,7 +658,7 @@ def _EvalCommon(
description: str | None,
summarize_scores: bool,
no_send_logs: bool,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
parameters: EvalParameters | RemoteEvalParameters | None = None,
on_start: Callable[[ExperimentSummary], None] | None = None,
stream: Callable[[SSEProgressEvent], None] | None = None,
Expand DownExpand Up@@ -815,7 +791,7 @@ async def EvalAsync(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand DownExpand Up@@ -942,7 +918,7 @@ def Eval(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand Down
21 changes: 4 additions & 17 deletions py/src/braintrust/logger.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@
from .span_identifier_v4 import SpanComponentsV4
from .span_types import SpanTypeAttribute
from .types import Metadata
from .types._eval import ExperimentDatasetEvent
from .util import (
GLOBAL_PROJECT,
AugmentedHTTPError,
Expand DownExpand Up@@ -3716,35 +3717,21 @@ class ExperimentIdentifier:
name: str


class _ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with `framework._EvalCaseDict` like we do in the
TypeScript SDK, or generated from OpenAPI spec. For now, marking as internal
to exclude it from the docs.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None


class ExperimentDatasetIterator:
def __init__(self, iterator: Iterator[ExperimentEvent]):
self.iterator = iterator

def __iter__(self):
return self

def __next__(self) -> _ExperimentDatasetEvent:
def __next__(self) -> ExperimentDatasetEvent:
while True:
value = next(self.iterator)
if value["root_span_id"] != value["span_id"]:
continue

output, expected = value.get("output"), value.get("expected")
ret: _ExperimentDatasetEvent = {
ret: ExperimentDatasetEvent = {
"input": value.get("input"),
"expected": expected if expected is not None else output,
"tags": value.get("tags"),
Expand DownExpand Up@@ -4133,7 +4120,7 @@ def _get_state(self) -> BraintrustState:
self._lazy_metadata.get()
return self.state

def as_dataset(self, batch_size: int | None = None) -> Iterator[_ExperimentDatasetEvent]:
def as_dataset(self, batch_size: int | None = None) -> Iterator[ExperimentDatasetEvent]:
"""
Return the experiment's data as a dataset iterator.

Expand Down
File renamed without changes.
51 changes: 51 additions & 0 deletions py/src/braintrust/types/_eval.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
"""Internal TypedDict types used in Eval/EvalAsync signatures.

These live in an underscore-prefixed module so they don't appear in
generated documentation, while the class names themselves are *not*
underscore-prefixed so pyright strict mode doesn't flag them as private.
"""

from typing import Any, Generic, Sequence, TypeVar

from typing_extensions import NotRequired, TypedDict


Input = TypeVar("Input")
Output = TypeVar("Output")


class EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy ``EvalCaseDict[Input, Output]`` for any
``Output`` type.
"""

input: Input
metadata: NotRequired[dict[str, Any] | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class EvalCaseDict(Generic[Input, Output], EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


class ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with ``EvalCaseDict`` like we do in the
TypeScript SDK, or generated from OpenAPI spec.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 9 additions & 33 deletions py/src/braintrust/framework.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@

from tqdm.asyncio import tqdm as async_tqdm
from tqdm.auto import tqdm as std_tqdm
from typing_extensions import NotRequired, Protocol, TypedDict
from typing_extensions import Protocol, TypedDict

from .generated_types import FunctionFormat, FunctionOutputType, ObjectReference
from .git_fields import GitMetadataSettings, RepoInfo
Expand All@@ -36,7 +36,6 @@
Metadata,
ScoreSummary,
Span,
_ExperimentDatasetEvent,
parent_context,
start_span,
stringify_exception,
Expand All@@ -53,6 +52,7 @@
from .score import Score, is_score, is_scorer
from .serializable_data_class import SerializableDataClass
from .span_types import SpanTypeAttribute
from .types._eval import EvalCaseDict, EvalCaseDictNoOutput, ExperimentDatasetEvent
from .util import bt_iscoroutinefunction, eprint, merge_dicts


Expand DownExpand Up@@ -91,30 +91,6 @@ class EvalCase(SerializableDataClass, Generic[Input, Output]):
created: str | None = None


class _EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy `_EvalCaseDict[Input, Output]` for any
`Output` type.
"""

input: Input
metadata: NotRequired[Metadata | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class _EvalCaseDict(Generic[Input, Output], _EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


# Inheritance doesn't quite work for dataclasses, so we redefine the fields
# from EvalCase here.
@dataclasses.dataclass
Expand DownExpand Up@@ -292,9 +268,9 @@ class BaseExperiment:

_AnyEvalCase = Union[
EvalCase[Input, Output],
_EvalCaseDict[Input, Output],
_EvalCaseDictNoOutput[Input],
_ExperimentDatasetEvent,
EvalCaseDict[Input, Output],
EvalCaseDictNoOutput[Input],
ExperimentDatasetEvent,
]

_EvalDataObject = Union[
Expand DownExpand Up@@ -429,7 +405,7 @@ class Evaluator(Generic[Input, Output]):
takes precedence over `git_metadata_settings` if specified.
"""

error_score_handler: ErrorScoreHandler | None = None
error_score_handler: ErrorScoreHandler[Input, Output] | None = None
"""
Optionally supply a custom function to specifically handle score values when tasks or scoring functions have errored.
A default implementation is exported as `default_error_score_handler` which will log a 0 score to the root span for any scorer that was not run.
Expand DownExpand Up@@ -682,7 +658,7 @@ def _EvalCommon(
description: str | None,
summarize_scores: bool,
no_send_logs: bool,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
parameters: EvalParameters | RemoteEvalParameters | None = None,
on_start: Callable[[ExperimentSummary], None] | None = None,
stream: Callable[[SSEProgressEvent], None] | None = None,
Expand DownExpand Up@@ -815,7 +791,7 @@ async def EvalAsync(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand DownExpand Up@@ -942,7 +918,7 @@ def Eval(
base_experiment_id: str | None = None,
git_metadata_settings: GitMetadataSettings | None = None,
repo_info: RepoInfo | None = None,
error_score_handler: ErrorScoreHandler | None = None,
error_score_handler: ErrorScoreHandler[Input, Output] | None = None,
description: str | None = None,
summarize_scores: bool = True,
no_send_logs: bool = False,
Expand Down
21 changes: 4 additions & 17 deletions py/src/braintrust/logger.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@
from .span_identifier_v4 import SpanComponentsV4
from .span_types import SpanTypeAttribute
from .types import Metadata
from .types._eval import ExperimentDatasetEvent
from .util import (
GLOBAL_PROJECT,
AugmentedHTTPError,
Expand DownExpand Up@@ -3716,35 +3717,21 @@ class ExperimentIdentifier:
name: str


class _ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with `framework._EvalCaseDict` like we do in the
TypeScript SDK, or generated from OpenAPI spec. For now, marking as internal
to exclude it from the docs.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None


class ExperimentDatasetIterator:
def __init__(self, iterator: Iterator[ExperimentEvent]):
self.iterator = iterator

def __iter__(self):
return self

def __next__(self) -> _ExperimentDatasetEvent:
def __next__(self) -> ExperimentDatasetEvent:
while True:
value = next(self.iterator)
if value["root_span_id"] != value["span_id"]:
continue

output, expected = value.get("output"), value.get("expected")
ret: _ExperimentDatasetEvent = {
ret: ExperimentDatasetEvent = {
"input": value.get("input"),
"expected": expected if expected is not None else output,
"tags": value.get("tags"),
Expand DownExpand Up@@ -4133,7 +4120,7 @@ def _get_state(self) -> BraintrustState:
self._lazy_metadata.get()
return self.state

def as_dataset(self, batch_size: int | None = None) -> Iterator[_ExperimentDatasetEvent]:
def as_dataset(self, batch_size: int | None = None) -> Iterator[ExperimentDatasetEvent]:
"""
Return the experiment's data as a dataset iterator.

Expand Down
File renamed without changes.
51 changes: 51 additions & 0 deletions py/src/braintrust/types/_eval.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
"""Internal TypedDict types used in Eval/EvalAsync signatures.

These live in an underscore-prefixed module so they don't appear in
generated documentation, while the class names themselves are *not*
underscore-prefixed so pyright strict mode doesn't flag them as private.
"""

from typing import Any, Generic, Sequence, TypeVar

from typing_extensions import NotRequired, TypedDict


Input = TypeVar("Input")
Output = TypeVar("Output")


class EvalCaseDictNoOutput(Generic[Input], TypedDict):
"""
Workaround for the Pyright type checker handling of generics. Specifically,
the type checker doesn't know that a dict which is missing the key
"expected" can be used to satisfy ``EvalCaseDict[Input, Output]`` for any
``Output`` type.
"""

input: Input
metadata: NotRequired[dict[str, Any] | None]
tags: NotRequired[Sequence[str] | None]

id: NotRequired[str | None]
_xact_id: NotRequired[str | None]


class EvalCaseDict(Generic[Input, Output], EvalCaseDictNoOutput[Input]):
"""
Mirrors EvalCase for callers who pass a dict instead of dataclass.
"""

expected: NotRequired[Output | None]


class ExperimentDatasetEvent(TypedDict):
"""
TODO: This could be unified with ``EvalCaseDict`` like we do in the
TypeScript SDK, or generated from OpenAPI spec.
"""

id: str
_xact_id: str
input: Any | None
expected: Any | None
tags: Sequence[str] | None
Loading