-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Document all_experiments option for bulk exports
#4180
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
Open
langsmith-fleet
wants to merge
3
commits into
main
Choose a base branch
from
docs/add-all-experiments-bulk-export-option
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -59,10 +59,10 @@ Refer to [Manage bulk export destinations](/langsmith/data-export-destinations) | |
|
|
||
| ## 2. Create an export job | ||
|
|
||
| An export job targets a specific project and date range. You will need: | ||
| An export job targets a project (or all experiments in a workspace) and a date range. You will need: | ||
|
|
||
| - The destination `id` from the [previous step](#1-create-a-destination). | ||
| - The project ID (`session_id`)—copy this from the individual project view in the [**Tracing Projects** list](https://smith.langchain.com). | ||
| - Either a project ID (`session_id`) or `"all_experiments": true`—copy the project ID from the individual project view in the [**Tracing Projects** list](https://smith.langchain.com). | ||
| - A `start_time` and `end_time` in UTC ISO 8601 format. | ||
|
|
||
| ```bash | ||
|
|
@@ -86,6 +86,29 @@ Save the `id` from the response to monitor the export's progress. | |
|
|
||
| You can optionally add a `filter` expression to narrow the set of runs exported. Refer to our [filter query language](/langsmith/trace-query-syntax#filter-query-language) and [examples](/langsmith/export-traces#use-filter-query-language) for syntax. Not setting the `filter` field will export all runs. | ||
|
|
||
| ### Export all experiments | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this will also need a note on which self-hosted version it's available from (not available yet, likely later today) |
||
|
|
||
| To export every experiment in the workspace instead of targeting a single project with `session_id`, set `all_experiments: true`. LangSmith creates an experiment whenever you run an evaluation against a dataset, any tracing project with `reference_dataset_id` set qualifies. | ||
|
|
||
| `all_experiments` and `session_id` are mutually exclusive—set exactly one. | ||
|
|
||
| ```bash | ||
| curl --request POST \ | ||
| --url 'https://api.smith.langchain.com/api/v1/bulk-exports' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --header 'X-API-Key: YOUR_API_KEY' \ | ||
| --header 'X-Tenant-Id: YOUR_WORKSPACE_ID' \ | ||
| --data '{ | ||
| "bulk_export_destination_id": "your_destination_id", | ||
| "all_experiments": true, | ||
| "start_time": "2024-01-01T00:00:00Z", | ||
| "end_time": "2024-02-01T00:00:00Z", | ||
| "format_version": "v2_beta" | ||
| }' | ||
| ``` | ||
|
|
||
| LangSmith resolves the set of experiment sessions at run time, so the export picks up any experiments you create after submitting the job but before the orchestrator starts processing. | ||
|
|
||
| ### Schedule recurring exports | ||
|
|
||
| <Note> | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all_experimentsbulk export to see which tracing projects (i.e. experiments) have been exported, then create standard bulk exports for the remaining. alternatively, request for this limit to be increased for your workspace by reaching out to supportThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is no limit for self-hosted though