Skip to content

[X-0] Update export v2 docs to include batch_id #1157

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 5, 2023
Merged

[X-0] Update export v2 docs to include batch_id #1157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions examples/basics/export_data.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@
"- `last_activity_at`\n",
"- `label_created_at`\n",
"- `data_row_ids`\n",
"- `batch_ids`\n",
"\n",
"#### Filter details\n",
"You can set the range for `last_activity_at` and `label_created_at` in the following formats: \n",
Expand All @@ -107,7 +108,9 @@
"\n",
"The `last_activity_at` filter captures the creation and modification of labels, metadata, workflow status, comments, and reviews.\n",
"\n",
"If you wish to specify data rows to export, uncomment the `data_row_ids` filter and provide a list of applicable IDs. The data rows must be part of a batch attached to the project in question. You can provide up to 2,000 data row IDs."
"If you wish to specify data rows to export, uncomment the `data_row_ids` filter and provide a list of applicable IDs. The data rows must be part of a batch attached to the project in question. You can provide up to 2,000 data row IDs.\n",
"\n",
"The `batch_ids` filter allows you to specify data rows for export based on their associated batch ID. This is particularly useful when `data_row_ids` is not sufficient due to 2,000 data row IDs limit. "
],
"cell_type": "markdown"
},
Expand Down Expand Up @@ -140,7 +143,8 @@
"filters= {\n",
" \"last_activity_at\": [\"2000-01-01 00:00:00\", \"2050-01-01 00:00:00\"],\n",
" \"label_created_at\": [\"2000-01-01 00:00:00\", \"2050-01-01 00:00:00\"],\n",
" # \"data_row_ids\": [\"<data_row_id>\", \"<data_row_id>\"] \n",
" # \"data_row_ids\": [\"<data_row_id>\", \"<data_row_id>\"],\n",
" # \"batch_ids\": [\"<batch_id>\", \"<batch_id>\"],\n",
"}\n",
"\n",
"export_task = project.export_v2(params=export_params, filters=filters)\n",
Expand Down