Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[python] support uploading examples with attachments and running evals on examples with attachments #1209

Merged
merged 102 commits into from
Dec 10, 2024
Merged
Changes from 1 commit
Commits
Show all changes
102 commits
Select commit Hold shift + click to select a range
e9e2131
wip
isahers1 Nov 13, 2024
ff30541
unit test
isahers1 Nov 13, 2024
152ec59
integration test skeleton
isahers1 Nov 13, 2024
27b1546
integration test passing
isahers1 Nov 13, 2024
53a0f14
wip
isahers1 Nov 14, 2024
025aa6d
wip
isahers1 Nov 14, 2024
4208b6e
Update python/langsmith/client.py
isahers1 Nov 14, 2024
fd16baa
more edits
isahers1 Nov 14, 2024
28a4677
nit
isahers1 Nov 14, 2024
816302d
nit
isahers1 Nov 14, 2024
aa947a6
remove dev endpoint in test
isahers1 Nov 18, 2024
a82063b
typo
isahers1 Nov 18, 2024
b18df6b
Merge branch 'main' into isaac/multipartstuff
isahers1 Nov 18, 2024
ad19daf
fmt
isahers1 Nov 18, 2024
390ac66
yml changes
isahers1 Nov 18, 2024
523e5d1
fmt
isahers1 Nov 18, 2024
ed3aa1c
example search restoration
isahers1 Nov 18, 2024
ce73afc
fmt
isahers1 Nov 18, 2024
460b16b
list -> List
isahers1 Nov 18, 2024
4e9edf4
dict -> Dict
isahers1 Nov 18, 2024
b6b9d79
fmt
isahers1 Nov 18, 2024
bc9ec6f
undo yml changes
isahers1 Nov 18, 2024
15708dc
unit test fix
isahers1 Nov 18, 2024
527174a
unit test fix
isahers1 Nov 18, 2024
81f5249
unit test fix
isahers1 Nov 18, 2024
0b476e8
Merge branch 'main' into isaac/multipartstuff
isahers1 Nov 19, 2024
f36a0cb
make evaluate function compatible with attachments (#1218)
isahers1 Nov 19, 2024
ddbe2f5
file path update
isahers1 Nov 19, 2024
c1ba615
add benchmarks
jakerachleff Nov 19, 2024
3544171
better error message
jakerachleff Nov 19, 2024
3cc32c5
aevaluate
isahers1 Nov 19, 2024
161e0d1
Merge branch 'isaac/multipartstuff' of https://github.com/langchain-a…
isahers1 Nov 19, 2024
08a6f34
unit test for _include_attachments
isahers1 Nov 20, 2024
8e2e704
test that adding examples without attachments still lets you run evals
isahers1 Nov 20, 2024
cfa0e4c
fmt
isahers1 Nov 20, 2024
de38a37
fmt
isahers1 Nov 20, 2024
2e74735
fmt
isahers1 Nov 20, 2024
f26c996
attempt fix
isahers1 Nov 20, 2024
095aae9
fix test
isahers1 Nov 20, 2024
a99da23
add unit test
isahers1 Nov 20, 2024
ee9d968
Merge branch 'main' into isaac/multipartstuff
agola11 Nov 20, 2024
b9dd0f2
Bump version (rc)
hinthornw Nov 20, 2024
01ef4d0
repetitions
isahers1 Nov 27, 2024
3715c30
nit
isahers1 Nov 27, 2024
49442d7
added upload endpoint
isahers1 Dec 2, 2024
9a70f70
Merge branch 'main' into isaac/multipartstuff
isahers1 Dec 2, 2024
484f2a5
comments
isahers1 Dec 6, 2024
f57b4bd
Merge branch 'main' into isaac/multipartstuff
isahers1 Dec 6, 2024
28fe5d1
fmt
isahers1 Dec 6, 2024
1e5eebf
fmt
isahers1 Dec 6, 2024
e013d72
fmt
isahers1 Dec 6, 2024
bc2d4b6
fmt
isahers1 Dec 6, 2024
96f4246
fix test
isahers1 Dec 6, 2024
887782e
x
isahers1 Dec 6, 2024
66228e8
defaults
isahers1 Dec 9, 2024
a5ee599
refactor
isahers1 Dec 9, 2024
2f1e6be
fmt
isahers1 Dec 9, 2024
c9ade2e
fmt
isahers1 Dec 9, 2024
4576779
fmt
isahers1 Dec 9, 2024
578a715
changes
isahers1 Dec 9, 2024
e4e3068
fmt
isahers1 Dec 9, 2024
6e91e05
x
isahers1 Dec 9, 2024
020d074
fmt
isahers1 Dec 9, 2024
1abe4f9
flag
isahers1 Dec 9, 2024
39be3c7
flags in tests
isahers1 Dec 9, 2024
5c2c74d
attachment_urls -> attachments
isahers1 Dec 9, 2024
2b385b6
x
isahers1 Dec 9, 2024
0daf245
fmt
baskaryan Dec 9, 2024
04a5496
Merge branch 'isaac/multipartstuff' of github.com:langchain-ai/langsm…
baskaryan Dec 9, 2024
c8a2b01
undo
isahers1 Dec 9, 2024
8033b7e
undo
isahers1 Dec 9, 2024
114a79d
fix
isahers1 Dec 9, 2024
b524f72
fix
isahers1 Dec 9, 2024
23187f1
test fix
isahers1 Dec 9, 2024
5471e88
fmt
isahers1 Dec 9, 2024
49246d0
fmt
baskaryan Dec 9, 2024
9b7c36a
Merge branch 'isaac/multipartstuff' of github.com:langchain-ai/langsm…
baskaryan Dec 9, 2024
b0921e0
tests
isahers1 Dec 9, 2024
70c3f3c
tests
isahers1 Dec 10, 2024
8bb0826
update examples multipart (#1310)
isahers1 Dec 10, 2024
c841ec6
add attachments to evaluate (#1237)
isahers1 Dec 10, 2024
eeeb375
Merge branch 'main' into isaac/multipartstuff
agola11 Dec 10, 2024
f3cc56f
update to 0.2.2
agola11 Dec 10, 2024
bf00aa6
fix spelling
agola11 Dec 10, 2024
c63b92c
fix update_examples issue
agola11 Dec 10, 2024
76e003e
fix test
isahers1 Dec 10, 2024
cf9e58c
Merge branch 'isaac/multipartstuff' of https://github.com/langchain-a…
isahers1 Dec 10, 2024
ed73f1a
test fix
isahers1 Dec 10, 2024
4887a99
attempt to fix test_update_examples_multipart
agola11 Dec 10, 2024
87d2a33
Merge branch 'isaac/multipartstuff' of github.com:langchain-ai/langsm…
agola11 Dec 10, 2024
6b9a026
fix tests
isahers1 Dec 10, 2024
1f25f55
x
isahers1 Dec 10, 2024
7573691
x
isahers1 Dec 10, 2024
cf85e56
fix test
isahers1 Dec 10, 2024
5c74829
fix test_bulk_update_examples_with_attachments_operations
agola11 Dec 10, 2024
9795e6e
Merge branch 'isaac/multipartstuff' of github.com:langchain-ai/langsm…
agola11 Dec 10, 2024
266272d
lint and fmt
agola11 Dec 10, 2024
61b28f5
fix tests
isahers1 Dec 10, 2024
ca3ec28
Merge branch 'isaac/multipartstuff' of https://github.com/langchain-a…
isahers1 Dec 10, 2024
34e8bb9
fmt
isahers1 Dec 10, 2024
e043a7d
fmt
isahers1 Dec 10, 2024
d77bd0e
remove blanket try/except
agola11 Dec 10, 2024
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
Prev Previous commit
Next Next commit
more edits
  • Loading branch information
isahers1 committed Nov 14, 2024
commit fd16baa5e721dac218f0e9b282b9f8024f8f4281
18 changes: 7 additions & 11 deletions python/bench/upload_examples_bench.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import statistics

Check notice on line 1 in python/bench/upload_examples_bench.py

GitHub Actions / benchmark

Benchmark results

......................................... create_5_000_run_trees: Mean +- std dev: 620 ms +- 45 ms ......................................... create_10_000_run_trees: Mean +- std dev: 1.18 sec +- 0.05 sec ......................................... create_20_000_run_trees: Mean +- std dev: 1.18 sec +- 0.06 sec ......................................... dumps_class_nested_py_branch_and_leaf_200x400: Mean +- std dev: 709 us +- 17 us ......................................... dumps_class_nested_py_leaf_50x100: Mean +- std dev: 25.8 ms +- 0.3 ms ......................................... dumps_class_nested_py_leaf_100x200: Mean +- std dev: 106 ms +- 3 ms ......................................... dumps_dataclass_nested_50x100: Mean +- std dev: 26.1 ms +- 0.4 ms ......................................... WARNING: the benchmark result may be unstable * the standard deviation (17.8 ms) is 25% of the mean (70.3 ms) * the maximum (106 ms) is 50% greater than the mean (70.3 ms) Try to rerun the benchmark with more runs, values and/or loops. Run 'python -m pyperf system tune' command to reduce the system jitter. Use pyperf stats, pyperf dump and pyperf hist to analyze results. Use --quiet option to hide these warnings. dumps_pydantic_nested_50x100: Mean +- std dev: 70.3 ms +- 17.8 ms ......................................... WARNING: the benchmark result may be unstable * the standard deviation (33.0 ms) is 15% of the mean (223 ms) Try to rerun the benchmark with more runs, values and/or loops. Run 'python -m pyperf system tune' command to reduce the system jitter. Use pyperf stats, pyperf dump and pyperf hist to analyze results. Use --quiet option to hide these warnings. dumps_pydanticv1_nested_50x100: Mean +- std dev: 223 ms +- 33 ms

Check notice on line 1 in python/bench/upload_examples_bench.py

GitHub Actions / benchmark

Comparison against main

+-----------------------------------------------+----------+------------------------+ | Benchmark | main | changes | +===============================================+==========+========================+ | create_10_000_run_trees | 1.21 sec | 1.18 sec: 1.02x faster | +-----------------------------------------------+----------+------------------------+ | create_20_000_run_trees | 1.20 sec | 1.18 sec: 1.02x faster | +-----------------------------------------------+----------+------------------------+ | dumps_class_nested_py_branch_and_leaf_200x400 | 703 us | 709 us: 1.01x slower | +-----------------------------------------------+----------+------------------------+ | dumps_class_nested_py_leaf_100x200 | 105 ms | 106 ms: 1.01x slower | +-----------------------------------------------+----------+------------------------+ | dumps_class_nested_py_leaf_50x100 | 25.1 ms | 25.8 ms: 1.03x slower | +-----------------------------------------------+----------+------------------------+ | dumps_dataclass_nested_50x100 | 25.4 ms | 26.1 ms: 1.03x slower | +-----------------------------------------------+----------+------------------------+ | Geometric mean | (ref) | 1.01x slower | +-----------------------------------------------+----------+------------------------+ Benchmark hidden because not significant (3): create_5_000_run_trees, dumps_pydanticv1_nested_50x100, dumps_pydantic_nested_50x100
import time
from typing import Dict
from uuid import uuid4
from langsmith.schemas import DataType, ExampleCreateWithAttachments
import sys
sys.path.append('./../langsmith')
from client import Client
from langsmith import Client

def create_large_json(length: int) -> Dict:
"""Create a large JSON object for benchmarking purposes."""
@@ -38,7 +37,7 @@
"outputs": create_large_json(json_size),
})

DATASET_NAME = "TEST DATASET"
DATASET_NAME = "upsert_llm_evaluator_benchmark_dataset"
def benchmark_example_uploading(num_examples: int, json_size: int, samples: int = 1) -> Dict:
"""
Benchmark run creation with specified parameters.
@@ -64,13 +63,10 @@
old_start = time.perf_counter()
inputs=[e.inputs for e in examples]
outputs=[e.outputs for e in examples]
# the create_examples endpoint fails above 20mb
try:
client.create_examples(inputs=inputs,
outputs=outputs,dataset_id=dataset.id)
old_elapsed = time.perf_counter() - old_start
except:
old_elapsed = 1000000
# the create_examples endpoint fails above 20mb - so this will crash with json_size > ~100
client.create_examples(inputs=inputs,
outputs=outputs,dataset_id=dataset.id)
old_elapsed = time.perf_counter() - old_start

# New method
multipart_start = time.perf_counter()
@@ -121,4 +117,4 @@


if __name__ == "__main__":
main(json_size, num_examples)
main(json_size, num_examples)
8 changes: 4 additions & 4 deletions python/langsmith/client.py
Original file line number Diff line number Diff line change
@@ -3373,14 +3373,14 @@ def create_example_from_run(
def upsert_examples_multipart(
self,
*,
upserts: List[ls_schemas.ExampleCreateWithAttachments] = None,
) -> dict: # Should we create an object for the return type - like UpsertExamplesResponse?
upserts: List[ls_schemas.ExampleUpsertWithAttachments] = None,
) -> ls_schemas.UpsertExamplesResponse:
"""Upsert examples."""
if not (self.info.instance_flags or {}).get(
""" if not (self.info.instance_flags or {}).get(
"examples_multipart_enabled", False
):
raise ValueError("Your LangSmith version does not allow using the multipart examples endpoint, please update to the latest version.")

"""
if upserts is None:
upserts = []
parts: list[MultipartPart] = []
20 changes: 13 additions & 7 deletions python/langsmith/schemas.py
Original file line number Diff line number Diff line change
@@ -89,7 +89,7 @@ class ExampleCreate(ExampleBase):
split: Optional[Union[str, List[str]]] = None


class ExampleCreateWithAttachments(ExampleCreate):
class ExampleUpsertWithAttachments(ExampleCreate):
"""Example create with attachments."""

attachments: Optional[Attachments] = None
@@ -131,12 +131,6 @@ def url(self) -> Optional[str]:
return None


class ExampleSearch(ExampleBase):
"""Example returned via search."""

id: UUID


class ExampleUpdate(BaseModel):
"""Update class for Example."""

@@ -151,6 +145,10 @@ class Config:

frozen = True

class ExampleUpdateWithAttachments(ExampleUpdate):
"""Example update with attachments."""
id: UUID
attachments: Optional[Attachments] = None

class DataType(str, Enum):
"""Enum for dataset data types."""
@@ -988,3 +986,11 @@ class UsageMetadata(TypedDict):

Does *not* need to sum to full output token count. Does *not* need to have all keys.
"""

class UpsertExamplesResponse(TypedDict):
"""Response object returned from the upsert_examples_multipart method."""

count: int
"""The number of examples that were upserted."""
example_ids: List[str]
"""The ids of the examples that were upserted."""
28 changes: 22 additions & 6 deletions python/tests/integration_tests/test_client.py
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@
from requests_toolbelt import MultipartEncoder, MultipartEncoderMonitor

from langsmith.client import ID_TYPE, Client
from langsmith.schemas import DataType, ExampleCreateWithAttachments
from langsmith.schemas import DataType, ExampleUpsertWithAttachments
from langsmith.utils import (
LangSmithNotFoundError,
LangSmithConnectionError,
@@ -373,7 +373,7 @@ def test_error_surfaced_invalid_uri(uri: str) -> None:
def test_upsert_examples_multipart() -> None:
"""Test upserting examples with attachments via multipart endpoint."""
dataset_name = "__test_upsert_examples_multipart" + uuid4().hex[:4]
langchain_client = Client(api_url="https://dev.api.smith.langchain.com")
langchain_client = Client(api_url="https://dev.api.smith.langchain.com", api_key="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")
if langchain_client.has_dataset(dataset_name=dataset_name):
langchain_client.delete_dataset(dataset_name=dataset_name)

@@ -385,7 +385,7 @@ def test_upsert_examples_multipart() -> None:

# Test example with all fields
example_id = uuid4()
example_1 = ExampleCreateWithAttachments(
example_1 = ExampleUpsertWithAttachments(
id=example_id,
dataset_id=dataset.id,
inputs={"text": "hello world"},
@@ -395,7 +395,7 @@ def test_upsert_examples_multipart() -> None:
},
)
# Test example without id
example_2 = ExampleCreateWithAttachments(
example_2 = ExampleUpsertWithAttachments(
dataset_id=dataset.id,
inputs={"text": "foo bar"},
outputs={"response": "baz"},
@@ -419,8 +419,24 @@ def test_upsert_examples_multipart() -> None:
all_examples_in_dataset = [example for example in langchain_client.list_examples(dataset_id=dataset.id)]
assert len(all_examples_in_dataset) == 2

example_1_update = ExampleUpsertWithAttachments(
id=example_id,
dataset_id=dataset.id,
inputs={"text": "bar baz"},
outputs={"response": "foo"},
attachments={
"my_file": ("text/plain", b"more test content"),
},
)
updated_examples = langchain_client.upsert_examples_multipart(upserts=[example_1_update])
assert updated_examples['count'] == 1
assert updated_examples['example_ids'][0] == str(example_id)
updated_example = langchain_client.read_example(updated_examples['example_ids'][0])
assert updated_example.inputs['text'] == "bar baz"
assert updated_example.outputs['response'] == "foo"

# Test that adding invalid example fails - even if valid examples are added alongside
example_3 = ExampleCreateWithAttachments(
example_3 = ExampleUpsertWithAttachments(
dataset_id=uuid4(), # not a real dataset
inputs={"text": "foo bar"},
outputs={"response": "baz"},
@@ -435,7 +451,7 @@ def test_upsert_examples_multipart() -> None:
all_examples_in_dataset = [example for example in langchain_client.list_examples(dataset_id=dataset.id)]
assert len(all_examples_in_dataset) == 2

# Throw type errors when not passing ExampleCreateWithAttachments
# Throw type errors when not passing ExampleUpsertWithAttachments
with pytest.raises(AttributeError):
langchain_client.upsert_examples_multipart(upserts=[{"foo":"bar"}])

Loading