j~tddlZddlmZmZddlmZddlmZddlm Z ddl m Z ddl m Z dd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1ddl2m3Z3m4Z4ddl5m6Z6ddl7m8Z8ddl9m:Z:ejvejxd Z=Gd!d"Z>Gd#d$Z?y)%N)AsyncClientWrapperSyncClientWrapper)RequestOptions)DatasetExpansionResponse)DatasetExportJobPublic)DatasetItemChangesPublic)DatasetItemFilter)DatasetItemPageCompare)DatasetItemPagePublic)DatasetItemPublic)DatasetItemUpdate)DatasetItemWrite)DatasetItemWriteSource)DatasetPagePublic) DatasetPublic)DatasetVersionDiff)DatasetVersionPagePublic)DatasetVersionPublic)EvaluatorItemWrite)ExecutionPolicyWrite)JsonNode) PageColumns)ProjectStatsPublic)SpanEnrichmentOptions)TraceEnrichmentOptions)AsyncRawDatasetsClientRawDatasetsClient)DatasetUpdateVisibility)DatasetWriteType)DatasetWriteVisibility.ceZdZdefdZedefdZddddede d e je d e je def d Zeeeedd d ede je j$ede je j$ede jede je d e je ddfdZddddddddddd de jede jede je de je de jede jede jede jede jed e je defdZeeeeeeedddede jede jede jede jed e jed!e je j$ed"e jed e je ddfd#Zeeedd$d%e j$ed&e jede jed'e jed e je ddf d(Zdd)d*e j:ee je j<fded e je ddfd+Zdd)ded,e j$ed-e d e je ddf d.Z!dd)ded/e j$ed-e"d e je ddf d0Z#dd)ded e je de$fd1Z%eeedd2deded"e jed e je&d!e je j$ed e je ddfd3Z'dd)ded e je ddfd4Z(edd5d&ede jed e je ddfd6Z)eeeedd7d8e je j$ede jede je j$ed'e jed e je ddf d9Z*dd)de j$ed e je ddfd:Z+dd)d;ed e je de jXe-fd<Z.eeeedd=ded>ed?e jed@e je j$edAe jedBe jed e je de/fdCZ0ddddddddDdedEede jede jede jede jedFe jedGe je d e je de1fdHZ2edd5d&ede jed e je de$fdIZ3dddJdedEede jed e je de4f dKZ5dd)d;ed e je de6fdLZ7dd)d e je de jpe6fdMZ9dd)dNed e je de:fdOZ;eeeeeeeddPdNedQedVe je?d e je ddfdWZ@dddddddXdede jede jedYe jede jedGe je d e je deAfdZZBddd[dedEe jed e je deCfd\ZDdd)d;ed e je ddfd]ZEdd)ded e je de6fd^ZFeeeeedd_d&ed`e jedae jedbe jede jede jed e je de jXe-fdcZGdd)ded e je deHfddZIdd)dedeedfed e je ddf dgZJdd)dedeedfed e je ddf dhZKddddidede jede jed e je deLf djZMdd)dedked e je defdlZNdd)dedmed e je defdnZOeeddodedeedpe jedqe je j$ed e je def drZPy)sDatasetsClientclient_wrapperc&t||_yN)r%)r _raw_clientselfr%s v/Users/manta/Documents/Projects/TheRoad-I1/backend/.venv/lib/python3.12/site-packages/opik/rest_api/datasets/client.py__init__zDatasetsClient.__init__'s,NKreturnc|jS)z Retrieves a raw implementation of this client that returns raw responses. Returns ------- RawDatasetsClient r(r*s r+with_raw_responsez DatasetsClient.with_raw_response*r-Noverriderequest_optionsidrequestr5r6cX|jj||||}|jS)a Apply delta changes (add, edit, delete) to a dataset version with conflict detection. This endpoint: - Creates a new version with the applied changes - Validates that baseVersion matches the latest version (unless override=true) - Returns 409 Conflict if baseVersion is stale and override is not set Use `override=true` query parameter to force version creation even with stale baseVersion. Parameters ---------- id : str request : DatasetItemChangesPublic override : typing.Optional[bool] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPublic Version created successfully Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.apply_dataset_item_changes(id='id', request={'key': 'value' }, ) r8r5r6r(apply_dataset_item_changesdatar*r7r8r5r6 _responses r+r<z)DatasetsClient.apply_dataset_item_changes5s6R$$?? (O@ ~~r-idsfilters dataset_id merge_tagsr6updaterArBrCrDc\|jj||||||}|jS)aA Update multiple dataset items Parameters ---------- update : DatasetItemUpdate ids : typing.Optional[typing.Sequence[str]] List of dataset item IDs to update (max 1000). Mutually exclusive with 'filters'. filters : typing.Optional[typing.Sequence[DatasetItemFilter]] dataset_id : typing.Optional[str] Dataset ID. Required when using 'filters', optional when using 'ids'. merge_tags : typing.Optional[bool] If true, merge tags with existing tags instead of replacing them. Default: false. When using 'filters', this is automatically set to true. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi from Opik import DatasetItemUpdate client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.batch_update_dataset_items(update=DatasetItemUpdate(), ) rErArBrCrDr6r(batch_update_dataset_itemsr=r*rErArBrCrDr6r?s r+rIz)DatasetsClient.batch_update_dataset_itemscs?T$$??!!+ @ ~~r- pagesizewith_experiments_onlywith_optimizations_only prompt_id project_idnamesortingrBr6rLrMrNrOrPrQrRrSc d|jj||||||||| |  } | jS)aM Find datasets Parameters ---------- page : typing.Optional[int] size : typing.Optional[int] with_experiments_only : typing.Optional[bool] with_optimizations_only : typing.Optional[bool] prompt_id : typing.Optional[str] project_id : typing.Optional[str] name : typing.Optional[str] sorting : typing.Optional[str] filters : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetPagePublic Dataset resource Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.find_datasets() rKr( find_datasetsr= r*rLrMrNrOrPrQrRrSrBr6r?s r+rVzDatasetsClient.find_datasetssJf$$22"7$;!+3  ~~r-r7rQ project_nametype visibilitytags descriptionr6rYrZr[r\r]c b|jj|||||||||  } | jS)ad Create dataset Parameters ---------- name : str id : typing.Optional[str] project_id : typing.Optional[str] Project ID. Takes precedence over project_name when both are provided. project_name : typing.Optional[str] For project scope, specify either project_id or project_name. If project_name is provided and the project does not exist, it will be created. Ignored when project_id is provided. If neither is provided, the dataset is created at workspace level. type : typing.Optional[DatasetWriteType] visibility : typing.Optional[DatasetWriteVisibility] tags : typing.Optional[typing.Sequence[str]] description : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.create_dataset(name='name', ) rRr7rQrYrZr[r\r]r6r(create_datasetr= r*rRr7rQrYrZr[r\r]r6r?s r+razDatasetsClient.create_datasetsGb$$33!%!#+4  ~~r- dataset_namerCbatch_group_idr6itemsrdrecZ|jj|||||}|jS)a  Create/update dataset items based on dataset item id Parameters ---------- items : typing.Sequence[DatasetItemWrite] dataset_name : typing.Optional[str] If null, dataset_id must be provided dataset_id : typing.Optional[str] If null, dataset_name must be provided batch_group_id : typing.Optional[str] Optional batch group ID to group multiple batches into a single dataset version. If null, mutates the latest version instead of creating a new one. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi from Opik import DatasetItemWrite client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.create_or_update_dataset_items(items=[DatasetItemWrite(source="manual", data={'key': 'value' }, )], ) rfrdrCrer6r(create_or_update_dataset_itemsr=r*rfrdrCrer6r?s r+rjz-DatasetsClient.create_or_update_dataset_itemss<P$$CC%!)+ D ~~r-r6filecV|jj|||}|jS)a Create dataset items from uploaded CSV file. CSV should have headers in the first row. Processing happens asynchronously in batches. Parameters ---------- file : typing.Dict[str, typing.Optional[typing.Any]] dataset_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.create_dataset_items_from_csv(file={'key': 'value' }, dataset_id='dataset_id', ) rmrCr6r(create_dataset_items_from_csvr=r*rmrCr6r?s r+rqz,DatasetsClient.create_dataset_items_from_csvGs3<$$BB*oC ~~r-span_idsenrichment_optionscX|jj||||}|jS)a Create dataset items from spans with enriched metadata Parameters ---------- dataset_id : str span_ids : typing.Sequence[str] Set of span IDs to add to the dataset enrichment_options : SpanEnrichmentOptions request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi from Opik import SpanEnrichmentOptions client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.create_dataset_items_from_spans(dataset_id='dataset_id', span_ids=['span_ids'], enrichment_options=SpanEnrichmentOptions(), ) rsrtr6r(create_dataset_items_from_spansr=r*rCrsrtr6r?s r+rxz.DatasetsClient.create_dataset_items_from_spansjs8D$$DD >PbqE ~~r- trace_idscX|jj||||}|jS)a Create dataset items from traces with enriched metadata Parameters ---------- dataset_id : str trace_ids : typing.Sequence[str] Set of trace IDs to add to the dataset enrichment_options : TraceEnrichmentOptions request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi from Opik import TraceEnrichmentOptions client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.create_dataset_items_from_traces(dataset_id='dataset_id', trace_ids=['trace_ids'], enrichment_options=TraceEnrichmentOptions(), ) rzrtr6r( create_dataset_items_from_tracesr=r*rCrzrtr6r?s r+r~z/DatasetsClient.create_dataset_items_from_tracess8D$$EE )@RdsF ~~r-cT|jj||}|jS)a Get dataset by id Parameters ---------- id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetPublic Dataset resource Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.get_dataset_by_id(id='id', ) rlr(get_dataset_by_idr=r*r7r6r?s r+rz DatasetsClient.get_dataset_by_ids),$$66r?6[ ~~r-r]r[r\r6c\|jj||||||}|jS)a Update dataset by id Parameters ---------- id : str name : str description : typing.Optional[str] visibility : typing.Optional[DatasetUpdateVisibility] tags : typing.Optional[typing.Sequence[str]] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.update_dataset(id='id', name='name', ) rRr]r[r\r6r(update_datasetr=r*r7rRr]r[r\r6r?s r+rzDatasetsClient.update_datasets;L$$33 T{zPTfu4 ~~r-cT|jj||}|jS)a Delete dataset by id Parameters ---------- id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.delete_dataset(id='id', ) rlr(delete_datasetr=rs r+rzDatasetsClient.delete_datasets)*$$33B3X ~~r-rYr6cV|jj|||}|jS)a Delete dataset by name Parameters ---------- dataset_name : str project_name : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.delete_dataset_by_name(dataset_name='dataset_name', ) rdrYr6r(delete_dataset_by_namer=r*rdrYr6r?s r+rz%DatasetsClient.delete_dataset_by_names3:$$;;%LRa< ~~r-item_idsrCrBrer6rcZ|jj|||||}|jS)aU Delete dataset items using one of two modes: 1. **Delete by IDs**: Provide 'item_ids' to delete specific items by their IDs 2. **Delete by filters**: Provide 'dataset_id' with optional 'filters' to delete items matching criteria When using filters, an empty 'filters' array will delete all items in the specified dataset. Parameters ---------- item_ids : typing.Optional[typing.Sequence[str]] List of dataset item IDs to delete (max 1000). Use this to delete specific items by their IDs. Mutually exclusive with 'dataset_id' and 'filters'. dataset_id : typing.Optional[str] Dataset ID to scope the deletion. Required when using 'filters'. Mutually exclusive with 'item_ids'. filters : typing.Optional[typing.Sequence[DatasetItemFilter]] Filters to select dataset items to delete within the specified dataset. Must be used with 'dataset_id'. Mutually exclusive with 'item_ids'. Empty array means 'delete all items in the dataset'. batch_group_id : typing.Optional[str] Optional batch group ID to group multiple delete operations into a single dataset version. If null, mutates the latest version instead of creating a new one. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.delete_dataset_items() rr(delete_dataset_itemsr=r*rrCrBrer6r?s r+rz#DatasetsClient.delete_dataset_items6s;V$$99!)+ : ~~r-cT|jj||}|jS)a Delete datasets batch Parameters ---------- ids : typing.Sequence[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.delete_datasets_batch(ids=['ids'], ) rAr6r(delete_datasets_batchr=r*rAr6r?s r+rz$DatasetsClient.delete_datasets_batchjs*.$$::sTc:d ~~r-job_idc#K|jj||5}|jEd{dddy7 #1swYyxYww)a Downloads the exported CSV file for a completed export job. This endpoint proxies the file download to avoid exposing internal storage URLs. Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. Returns ------- typing.Iterator[bytes] CSV file content Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.download_dataset_export(job_id='jobId', ) rlNr(download_dataset_exportr=)r*rr6rs r+rz&DatasetsClient.download_dataset_exportsG0   5 5fo 5 ^bcvv  _ ^ _ ^s)A A>A A AA A  sample_countpreserve_fieldsvariation_instructions custom_promptr6modelrrrrc ^|jj|||||||}|jS)a\ Generate synthetic dataset samples using LLM based on existing data patterns Parameters ---------- id : str model : str The model to use for synthetic data generation sample_count : typing.Optional[int] Number of synthetic samples to generate preserve_fields : typing.Optional[typing.Sequence[str]] Fields to preserve patterns from original data variation_instructions : typing.Optional[str] Additional instructions for data variation custom_prompt : typing.Optional[str] Custom prompt to use for generation instead of auto-generated one request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetExpansionResponse Generated synthetic samples Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.expand_dataset(id='id', model='gpt-4', ) rrrrrr6r(expand_datasetr= r*r7rrrrrr6r?s r+rzDatasetsClient.expand_datasetsA^$$33 %+#9'+4 ~~r-rLrMrBrSsearchtruncater6experiment_idsrrc b|jj|||||||||  } | jS)aN Find dataset items with experiment items Parameters ---------- id : str experiment_ids : str page : typing.Optional[int] size : typing.Optional[int] filters : typing.Optional[str] sorting : typing.Optional[str] search : typing.Optional[str] truncate : typing.Optional[bool] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetItemPageCompare Dataset item resource Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.find_dataset_items_with_experiment_items(id='id', experiment_ids='experiment_ids', ) rrLrMrBrSrrr6r((find_dataset_items_with_experiment_itemsr= r*r7rrLrMrBrSrrr6r?s r+rz7DatasetsClient.find_dataset_items_with_experiment_itemssH`$$MM )+N  ~~r-cV|jj|||}|jS)a= Get dataset by name Parameters ---------- dataset_name : str project_name : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetPublic Dataset resource Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.get_dataset_by_identifier(dataset_name='dataset_name', ) rr(get_dataset_by_identifierr=rs r+rz(DatasetsClient.get_dataset_by_identifiers3<$$>>%LRa? ~~r-rBr6cX|jj||||}|jS)a Get experiment items stats for dataset Parameters ---------- id : str experiment_ids : str filters : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- ProjectStatsPublic Experiment items stats resource Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.get_dataset_experiment_items_stats(id='id', experiment_ids='experiment_ids', ) rrBr6r("get_dataset_experiment_items_statsr=r*r7rrBr6r?s r+rz1DatasetsClient.get_dataset_experiment_items_stats9s7B$$GG ~wP_H ~~r-cT|jj||}|jS)a& Retrieves the current status of a dataset export job Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetExportJobPublic Export job details Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.get_dataset_export_job(job_id='jobId', ) rlr(get_dataset_export_jobr=r*rr6r?s r+rz%DatasetsClient.get_dataset_export_job_s*0$$;;FTc;d ~~r-cR|jj|}|jS)aJ Retrieves all export jobs for the workspace. This is used to restore the export panel state after page refresh. Parameters ---------- request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.List[DatasetExportJobPublic] List of export jobs Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.get_dataset_export_jobs() rlr(get_dataset_export_jobsr=r*r6r?s r+rz&DatasetsClient.get_dataset_export_jobszs',$$<<_<] ~~r-item_idcT|jj||}|jS)a  Get dataset item by id Parameters ---------- item_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetItemPublic Dataset item resource Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.get_dataset_item_by_id(item_id='itemId', ) rlr(get_dataset_item_by_idr=r*rr6r?s r+rz%DatasetsClient.get_dataset_item_by_ids*0$$;;GUd;e ~~r-r7trace_idspan_idr]r\ evaluatorsexecution_policyr6sourcer=rrrrc f|jj||||||||| | |  } | jS)a Partially update dataset item by id. Only provided fields will be updated. Parameters ---------- item_id : str source : DatasetItemWriteSource data : JsonNode id : typing.Optional[str] trace_id : typing.Optional[str] span_id : typing.Optional[str] description : typing.Optional[str] tags : typing.Optional[typing.Sequence[str]] evaluators : typing.Optional[typing.Sequence[EvaluatorItemWrite]] execution_policy : typing.Optional[ExecutionPolicyWrite] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.patch_dataset_item(item_id='itemId', source="manual", data={'key': 'value' }, ) rr=r7rrr]r\rrr6r(patch_dataset_itemr= r*rrr=r7rrr]r\rrr6r?s r+rz!DatasetsClient.patch_dataset_itemsMl$$77 #!-+8  ~~r-rLrMversionrBrr6rc ^|jj|||||||}|jS)a Get dataset items Parameters ---------- id : str page : typing.Optional[int] size : typing.Optional[int] version : typing.Optional[str] filters : typing.Optional[str] truncate : typing.Optional[bool] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetItemPagePublic Dataset items resource Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.get_dataset_items(id='id', ) rr(get_dataset_itemsr= r*r7rLrMrrBrr6r?s r+rz DatasetsClient.get_dataset_itemssAT$$66 +7 ~~r-rr6cV|jj|||}|jS)a> Get dataset items output columns Parameters ---------- id : str experiment_ids : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- PageColumns Dataset item output columns Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.get_dataset_items_output_columns(id='id', ) rr( get_dataset_items_output_columnsr=r*r7rr6r?s r+rz/DatasetsClient.get_dataset_items_output_columns(s3<$$EE ~F ~~r-cT|jj||}|jS)ax Marks a dataset export job as viewed by setting the viewed_at timestamp. This is used to track that a user has seen a failed job's error message. This operation is idempotent. Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.mark_dataset_export_job_viewed(job_id='jobId', ) rlr(mark_dataset_export_job_viewedr=rs r+rz-DatasetsClient.mark_dataset_export_job_viewedKs*.$$CCF\kCl ~~r-cT|jj||}|jS)a] Initiates an asynchronous CSV export job for the dataset. Returns immediately with job details for polling. Parameters ---------- id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetExportJobPublic Existing export job in progress Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.start_dataset_export(id='id', ) rlr(start_dataset_exportr=rs r+rz#DatasetsClient.start_dataset_exportes)0$$99"o9^ ~~r-last_retrieved_id steam_limitdataset_versionrYrBr6rrrc #K|jj|||||||5}|jEd{dddy7 #1swYyxYww)a Stream dataset items Parameters ---------- dataset_name : str last_retrieved_id : typing.Optional[str] steam_limit : typing.Optional[int] dataset_version : typing.Optional[str] project_name : typing.Optional[str] filters : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. Returns ------- typing.Iterator[bytes] Dataset items stream or error during process rdrrrrYrBr6Nr(stream_dataset_itemsr=) r*rdrrrrYrBr6rs r+rz#DatasetsClient.stream_dataset_itemsscH   2 2%/#+%+3 vv       s+#AAAA AAA AcT|jj||}|jS)a Compare the latest committed dataset version with the current draft state. This endpoint provides insights into changes made since the last version was committed. The comparison calculates additions, modifications, deletions, and unchanged items between the latest version snapshot and current draft. Parameters ---------- id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionDiff Diff computed successfully Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.compare_dataset_versions(id='id', ) rlr(compare_dataset_versionsr=rs r+rz'DatasetsClient.compare_dataset_versionss*0$$==bRa=b ~~r- version_hashtagcX|jj||||}|jS)ak Add a tag to a specific dataset version for easy reference (e.g., 'baseline', 'v1.0', 'production') Parameters ---------- id : str version_hash : str tag : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.create_version_tag(id='id', version_hash='versionHash', tag='tag', ) rr6r(create_version_tagr=r*r7rrr6r?s r+rz!DatasetsClient.create_version_tags.6$$77Lccr7s ~~r-cX|jj||||}|jS)ag Remove a tag from a dataset version. The version itself is not deleted, only the tag reference. Parameters ---------- id : str version_hash : str tag : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.delete_version_tag(id='id', version_hash='versionHash', tag='tag', ) rlr(delete_version_tagr=rs r+rz!DatasetsClient.delete_version_tags.6$$77L#_n7o ~~r-rLrMr6cX|jj||||}|jS)a Get paginated list of versions for a dataset, ordered by creation time (newest first) Parameters ---------- id : str page : typing.Optional[int] size : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPagePublic Dataset versions Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.list_dataset_versions(id='id', ) rr(list_dataset_versionsr=r*r7rLrMr6r?s r+rz$DatasetsClient.list_dataset_versionss/B$$::2Dtet:u ~~r- version_refcV|jj|||}|jS)a Restores the dataset to a previous version state by creating a new version with items copied from the specified version. If the version is already the latest, returns it as-is (no-op). Parameters ---------- id : str version_ref : str Version hash or tag to restore from request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPublic Version restored successfully Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.restore_dataset_version(id='id', version_ref='version_ref', ) rr6r(restore_dataset_versionr=r*r7rr6r?s r+rz&DatasetsClient.restore_dataset_version*s26$$<< K= ~~r- version_namecV|jj|||}|jS)a Get a specific version by its version name (e.g., 'v1', 'v373'). This is more efficient than paginating through all versions for large datasets. Parameters ---------- id : str version_name : str Version name in format 'vN' (e.g., 'v1', 'v373') request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPublic Dataset version Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.retrieve_dataset_version(id='id', version_name='v1', ) r r6r(retrieve_dataset_versionr=r*r7r r6r?s r+r z'DatasetsClient.retrieve_dataset_versionJs26$$== \?> ~~r-change_description tags_to_addr6rrcZ|jj|||||}|jS)aM Update a dataset version's change_description and/or add new tags Parameters ---------- id : str version_hash : str change_description : typing.Optional[str] Optional description of changes in this version tags_to_add : typing.Optional[typing.Sequence[str]] Optional list of tags to add to this version request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPublic Version updated successfully Examples -------- from Opik import OpikApi client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) client.datasets.update_dataset_version(id='id', version_hash='versionHash', ) rr(update_dataset_versionr=r*r7rrrr6r?s r+rz%DatasetsClient.update_dataset_versionjs;L$$;;  1#+ < ~~r-)Q__name__ __module__ __qualname__rr,propertyrr2strr typingOptionalboolrrr<OMITrSequencer rIintrrVr!r"rarrjDictAnyrqrrxrr~rrr rrrrrIteratorbytesrrrr rrrrrrListrr rrrrrrr rrrrrrrrrrrrrr rr-r+r$r$&s L*;L #4  +/;? , ,* , //$' ,  8 , ,d6:GK+/,0;?2"2__V__S1 2 2 1B!CD 2 OOC( 2OOD)2 82 2n&*%)7;9=*.+/%)(,(,;??ooc"?ooc" ? &t4 ? "(!6 ???3'?OOC(?ooc"?%?%? 8? ?J$(+/-126>B6:,0;?<< OOC < OOC( < ooc* <oo./<OO$:;<oofooc23<__S)< 8< <D.2+//3;?//0/ooc* / OOC( / , / 8/ /l<@ !kk#vvzz::;! !  8 !  !R<@ %%//#& % 2 %  8 % %Z<@ %%??3' % 3 %  8 % %N`dCV__^=\hu<-1?C6:;?) ) ) __S) ) OO$;< )oofooc23) 8) )V]a&//.:Yei8.2;?  ooc*   8   J;?+/GK/3;?2//&//#"672OOC( 2 1B!CD 2 , 2 82 2j`dooc*=C__^=\ 6RV/5~/N  @.2AE7;.2;?8 8 8 ooc* 8  )=> 8!' 48s+8 88 "8~&*%)(,(,'+*.;?; ; ; ooc" ; ooc" ;%;%;$;//$'; 8; ;B.2;? !!ooc* !  8 !  !P)-;? $ $ $ % $  8 $ $NRV/5~/N 8EI"(//."A + ,4SW060O B$()-(,,06:KOBF;?CC' C  C OOC C//#&C%C__S)Coofooc23COOFOO4F$GHC!//*>?C 8C CR&*%)(,(,*.;?3 3ooc" 3 ooc" 3 % 3%3//$'3 83 3r04;? ! !, !  8 !  !HRV/5~/N 6NR+1??>+J >37,004-1(,;?--"??3/ - __S) -  - -ooc*-%- 8-  -`NR+1??>+J 8ko%(25HNXfHg >ko%(/2HNXfHg D&*%);? " "ooc" " ooc" "  8 " ""J`d'*=C__^=\ Bae(+>Doon>] J48=A;?- -- #OOC0 - __V__S%9: - 8- -r-r$ceZdZdefdZedefdZddddede d e je d e je def d Zeeeedd d ede je j$ede je j$ede jede je d e je ddfdZddddddddddd de jede jede je de je de jede jede jede jede jed e je defdZeeeeeeedddede jede jede jede jed e jed!e je j$ed"e jed e je ddfd#Zeeedd$d%e j$ed&e jede jed'e jed e je ddf d(Zdd)d*e j:ee je j<fded e je ddfd+Zdd)ded,e j$ed-e d e je ddf d.Z!dd)ded/e j$ed-e"d e je ddf d0Z#dd)ded e je de$fd1Z%eeedd2deded"e jed e je&d!e je j$ed e je ddfd3Z'dd)ded e je ddfd4Z(edd5d&ede jed e je ddfd6Z)eeeedd7d8e je j$ede jede je j$ed'e jed e je ddf d9Z*dd)de j$ed e je ddfd:Z+dd)d;ed e je de jXe-fd<Z.eeeedd=ded>ed?e jed@e je j$edAe jedBe jed e je de/fdCZ0ddddddddDdedEede jede jede jede jedFe jedGe je d e je de1fdHZ2edd5d&ede jed e je de$fdIZ3dddJdedEede jed e je de4f dKZ5dd)d;ed e je de6fdLZ7dd)d e je de jpe6fdMZ9dd)dNed e je de:fdOZ;eeeeeeeddPdNedQedVe je?d e je ddfdWZ@dddddddXdede jede jedYe jede jedGe je d e je deAfdZZBddd[dedEe jed e je deCfd\ZDdd)d;ed e je ddfd]ZEdd)ded e je de6fd^ZFeeeeedd_d&ed`e jedae jedbe jede jede jed e je de jXe-fdcZGdd)ded e je deHfddZIdd)dedeedfed e je ddf dgZJdd)dedeedfed e je ddf dhZKddddidede jede jed e je deLf djZMdd)dedked e je defdlZNdd)dedmed e je defdnZOeeddodedeedpe jedqe je j$ed e je def drZPy)sAsyncDatasetsClientr%c&t||_yr')rr(r)s r+r,zAsyncDatasetsClient.__init__s1Pr-r.c|jS)z Retrieves a raw implementation of this client that returns raw responses. Returns ------- AsyncRawDatasetsClient r0r1s r+r2z%AsyncDatasetsClient.with_raw_responser3r-Nr4r7r8r5r6ctK|jj||||d{}|jS7w)a Apply delta changes (add, edit, delete) to a dataset version with conflict detection. This endpoint: - Creates a new version with the applied changes - Validates that baseVersion matches the latest version (unless override=true) - Returns 409 Conflict if baseVersion is stale and override is not set Use `override=true` query parameter to force version creation even with stale baseVersion. Parameters ---------- id : str request : DatasetItemChangesPublic override : typing.Optional[bool] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPublic Version created successfully Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.apply_dataset_item_changes(id='id', request={'key': 'value' }, ) asyncio.run(main()) r:Nr;r>s r+r<z.AsyncDatasetsClient.apply_dataset_item_changessDX**EE (OF  ~~ #868r@rErArBrCrDcxK|jj||||||d{}|jS7w)a Update multiple dataset items Parameters ---------- update : DatasetItemUpdate ids : typing.Optional[typing.Sequence[str]] List of dataset item IDs to update (max 1000). Mutually exclusive with 'filters'. filters : typing.Optional[typing.Sequence[DatasetItemFilter]] dataset_id : typing.Optional[str] Dataset ID. Required when using 'filters', optional when using 'ids'. merge_tags : typing.Optional[bool] If true, merge tags with existing tags instead of replacing them. Default: false. When using 'filters', this is automatically set to true. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi from Opik import DatasetItemUpdate import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.batch_update_dataset_items(update=DatasetItemUpdate(), ) asyncio.run(main()) rGNrHrJs r+rIz.AsyncDatasetsClient.batch_update_dataset_itemssMZ**EE!!+ F  ~~ %:8:rKrLrMrNrOrPrQrRrSc K|jj||||||||| |  d{} | jS7w)a Find datasets Parameters ---------- page : typing.Optional[int] size : typing.Optional[int] with_experiments_only : typing.Optional[bool] with_optimizations_only : typing.Optional[bool] prompt_id : typing.Optional[str] project_id : typing.Optional[str] name : typing.Optional[str] sorting : typing.Optional[str] filters : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetPagePublic Dataset resource Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.find_datasets() asyncio.run(main()) rKNrUrWs r+rVz!AsyncDatasetsClient.find_datasetssXl**88"7$;!+9   ~~  s )><>rXrYrZr[r\r]c ~K|jj|||||||||  d{} | jS7w)a Create dataset Parameters ---------- name : str id : typing.Optional[str] project_id : typing.Optional[str] Project ID. Takes precedence over project_name when both are provided. project_name : typing.Optional[str] For project scope, specify either project_id or project_name. If project_name is provided and the project does not exist, it will be created. Ignored when project_id is provided. If neither is provided, the dataset is created at workspace level. type : typing.Optional[DatasetWriteType] visibility : typing.Optional[DatasetWriteVisibility] tags : typing.Optional[typing.Sequence[str]] description : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.create_dataset(name='name', ) asyncio.run(main()) r_Nr`rbs r+raz"AsyncDatasetsClient.create_datasetUsUh**99!%!#+:   ~~  (=;=rcrfrdrecvK|jj|||||d{}|jS7w)ay Create/update dataset items based on dataset item id Parameters ---------- items : typing.Sequence[DatasetItemWrite] dataset_name : typing.Optional[str] If null, dataset_id must be provided dataset_id : typing.Optional[str] If null, dataset_name must be provided batch_group_id : typing.Optional[str] Optional batch group ID to group multiple batches into a single dataset version. If null, mutates the latest version instead of creating a new one. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi from Opik import DatasetItemWrite import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.create_or_update_dataset_items(items=[DatasetItemWrite(source="manual", data={'key': 'value' }, )], ) asyncio.run(main()) rhNrirks r+rjz2AsyncDatasetsClient.create_or_update_dataset_itemssJV**II%!)+ J  ~~ $979rlrmcrK|jj|||d{}|jS7w)a$ Create dataset items from uploaded CSV file. CSV should have headers in the first row. Processing happens asynchronously in batches. Parameters ---------- file : typing.Dict[str, typing.Optional[typing.Any]] dataset_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.create_dataset_items_from_csv(file={'key': 'value' }, dataset_id='dataset_id', ) asyncio.run(main()) roNrprrs r+rqz1AsyncDatasetsClient.create_dataset_items_from_csvsBB**HH*oI  ~~ "757rsrtctK|jj||||d{}|jS7w)aw Create dataset items from spans with enriched metadata Parameters ---------- dataset_id : str span_ids : typing.Sequence[str] Set of span IDs to add to the dataset enrichment_options : SpanEnrichmentOptions request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi from Opik import SpanEnrichmentOptions import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.create_dataset_items_from_spans(dataset_id='dataset_id', span_ids=['span_ids'], enrichment_options=SpanEnrichmentOptions(), ) asyncio.run(main()) rvNrwrys r+rxz3AsyncDatasetsClient.create_dataset_items_from_spanssFJ**JJ >PbqK  ~~ r,rzctK|jj||||d{}|jS7w)a Create dataset items from traces with enriched metadata Parameters ---------- dataset_id : str trace_ids : typing.Sequence[str] Set of trace IDs to add to the dataset enrichment_options : TraceEnrichmentOptions request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi from Opik import TraceEnrichmentOptions import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.create_dataset_items_from_traces(dataset_id='dataset_id', trace_ids=['trace_ids'], enrichment_options=TraceEnrichmentOptions(), ) asyncio.run(main()) r|Nr}rs r+r~z4AsyncDatasetsClient.create_dataset_items_from_tracessFJ**KK )@RdsL  ~~ r,cpK|jj||d{}|jS7w)aQ Get dataset by id Parameters ---------- id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetPublic Dataset resource Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.get_dataset_by_id(id='id', ) asyncio.run(main()) rlNrrs r+rz%AsyncDatasetsClient.get_dataset_by_idDs76**< None: await client.datasets.update_dataset(id='id', name='name', ) asyncio.run(main()) rNrrs r+rz"AsyncDatasetsClient.update_datasetbsIR**99 T{zPTfu:  ~~ r.cpK|jj||d{}|jS7w)a+ Delete dataset by id Parameters ---------- id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.delete_dataset(id='id', ) asyncio.run(main()) rlNrrs r+rz"AsyncDatasetsClient.delete_datasets60**99"o9^^ ~~_r9rcrK|jj|||d{}|jS7w)a Delete dataset by name Parameters ---------- dataset_name : str project_name : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.delete_dataset_by_name(dataset_name='dataset_name', ) asyncio.run(main()) rNrrs r+rz*AsyncDatasetsClient.delete_dataset_by_namesC@**AA%LRaB  ~~ r5rrcvK|jj|||||d{}|jS7w)a Delete dataset items using one of two modes: 1. **Delete by IDs**: Provide 'item_ids' to delete specific items by their IDs 2. **Delete by filters**: Provide 'dataset_id' with optional 'filters' to delete items matching criteria When using filters, an empty 'filters' array will delete all items in the specified dataset. Parameters ---------- item_ids : typing.Optional[typing.Sequence[str]] List of dataset item IDs to delete (max 1000). Use this to delete specific items by their IDs. Mutually exclusive with 'dataset_id' and 'filters'. dataset_id : typing.Optional[str] Dataset ID to scope the deletion. Required when using 'filters'. Mutually exclusive with 'item_ids'. filters : typing.Optional[typing.Sequence[DatasetItemFilter]] Filters to select dataset items to delete within the specified dataset. Must be used with 'dataset_id'. Mutually exclusive with 'item_ids'. Empty array means 'delete all items in the dataset'. batch_group_id : typing.Optional[str] Optional batch group ID to group multiple delete operations into a single dataset version. If null, mutates the latest version instead of creating a new one. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.delete_dataset_items() asyncio.run(main()) rNrrs r+rz(AsyncDatasetsClient.delete_dataset_itemssJ\**??!)+ @  ~~ r3cpK|jj||d{}|jS7w)aI Delete datasets batch Parameters ---------- ids : typing.Sequence[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.delete_datasets_batch(ids=['ids'], ) asyncio.run(main()) rNrrs r+rz)AsyncDatasetsClient.delete_datasets_batchs74**@@SZi@jj ~~kr9rcK|jj||4d{}|j23d{}|77 6dddd{7y#1d{7swYyxYww)aO Downloads the exported CSV file for a completed export job. This endpoint proxies the file download to avoid exposing internal storage URLs. Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. Returns ------- typing.AsyncIterator[bytes] CSV file content Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.download_dataset_export(job_id='jobId', ) asyncio.run(main()) rlNr)r*rr6rr=s r+rz+AsyncDatasetsClient.download_dataset_export$s\6##;;FTc;ddhiff d e feddddsd"A0AA0 AAAAAA0AA A0AA0A-!A$ "A-)A0rrrrrrc zK|jj|||||||d{}|jS7w)a Generate synthetic dataset samples using LLM based on existing data patterns Parameters ---------- id : str model : str The model to use for synthetic data generation sample_count : typing.Optional[int] Number of synthetic samples to generate preserve_fields : typing.Optional[typing.Sequence[str]] Fields to preserve patterns from original data variation_instructions : typing.Optional[str] Additional instructions for data variation custom_prompt : typing.Optional[str] Custom prompt to use for generation instead of auto-generated one request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetExpansionResponse Generated synthetic samples Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.expand_dataset(id='id', model='gpt-4', ) asyncio.run(main()) rNrrs r+rz"AsyncDatasetsClient.expand_datasetCsOd**99 %+#9'+:  ~~ &;9;rrrrc ~K|jj|||||||||  d{} | jS7w)a Find dataset items with experiment items Parameters ---------- id : str experiment_ids : str page : typing.Optional[int] size : typing.Optional[int] filters : typing.Optional[str] sorting : typing.Optional[str] search : typing.Optional[str] truncate : typing.Optional[bool] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetItemPageCompare Dataset item resource Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.find_dataset_items_with_experiment_items(id='id', experiment_ids='experiment_ids', ) asyncio.run(main()) rNrrs r+rz None: await client.datasets.get_dataset_by_identifier(dataset_name='dataset_name', ) asyncio.run(main()) rNrrs r+rz-AsyncDatasetsClient.get_dataset_by_identifiersCB**DD%LRaE  ~~ r5rctK|jj||||d{}|jS7w)a Get experiment items stats for dataset Parameters ---------- id : str experiment_ids : str filters : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- ProjectStatsPublic Experiment items stats resource Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.get_dataset_experiment_items_stats(id='id', experiment_ids='experiment_ids', ) asyncio.run(main()) rNrrs r+rz6AsyncDatasetsClient.get_dataset_experiment_items_statssEH**MM ~wP_N  ~~ r,cpK|jj||d{}|jS7w)a Retrieves the current status of a dataset export job Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetExportJobPublic Export job details Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.get_dataset_export_job(job_id='jobId', ) asyncio.run(main()) rlNrrs r+rz*AsyncDatasetsClient.get_dataset_export_job s76**AA&ZiAjj ~~kr9cnK|jj|d{}|jS7w)a Retrieves all export jobs for the workspace. This is used to restore the export panel state after page refresh. Parameters ---------- request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.List[DatasetExportJobPublic] List of export jobs Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.get_dataset_export_jobs() asyncio.run(main()) rlNrrs r+rz+AsyncDatasetsClient.get_dataset_export_jobs- s52**BBSbBcc ~~ds 535rcpK|jj||d{}|jS7w)ar Get dataset item by id Parameters ---------- item_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetItemPublic Dataset item resource Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.get_dataset_item_by_id(item_id='itemId', ) asyncio.run(main()) rlNrrs r+rz*AsyncDatasetsClient.get_dataset_item_by_idI s76**AA'[jAkk ~~lr9rrr=rrrrc K|jj||||||||| | |  d{} | jS7w)aM Partially update dataset item by id. Only provided fields will be updated. Parameters ---------- item_id : str source : DatasetItemWriteSource data : JsonNode id : typing.Optional[str] trace_id : typing.Optional[str] span_id : typing.Optional[str] description : typing.Optional[str] tags : typing.Optional[typing.Sequence[str]] evaluators : typing.Optional[typing.Sequence[EvaluatorItemWrite]] execution_policy : typing.Optional[ExecutionPolicyWrite] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.patch_dataset_item(item_id='itemId', source="manual", data={'key': 'value' }, ) asyncio.run(main()) rNrrs r+rz&AsyncDatasetsClient.patch_dataset_itemg s[r**== #!-+>   ~~  s *?=?rrc zK|jj|||||||d{}|jS7w)a# Get dataset items Parameters ---------- id : str page : typing.Optional[int] size : typing.Optional[int] version : typing.Optional[str] filters : typing.Optional[str] truncate : typing.Optional[bool] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetItemPagePublic Dataset items resource Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.get_dataset_items(id='id', ) asyncio.run(main()) rNrrs r+rz%AsyncDatasetsClient.get_dataset_items sOZ**<< +=  ~~ rArcrK|jj|||d{}|jS7w)a Get dataset items output columns Parameters ---------- id : str experiment_ids : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- PageColumns Dataset item output columns Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.get_dataset_items_output_columns(id='id', ) asyncio.run(main()) rNrrs r+rz4AsyncDatasetsClient.get_dataset_items_output_columns sBB**KK ~L  ~~ r5cpK|jj||d{}|jS7w)a Marks a dataset export job as viewed by setting the viewed_at timestamp. This is used to track that a user has seen a failed job's error message. This operation is idempotent. Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.mark_dataset_export_job_viewed(job_id='jobId', ) asyncio.run(main()) rlNrrs r+rz2AsyncDatasetsClient.mark_dataset_export_job_viewed s74**II&bqIrr ~~sr9cpK|jj||d{}|jS7w)a Initiates an asynchronous CSV export job for the dataset. Returns immediately with job details for polling. Parameters ---------- id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetExportJobPublic Existing export job in progress Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.start_dataset_export(id='id', ) asyncio.run(main()) rlNrrs r+rz(AsyncDatasetsClient.start_dataset_export* s76**??Tc?dd ~~er9rrrrc K|jj|||||||4d{}|j23d{} | 77 6dddd{7y#1d{7swYyxYww)a Stream dataset items Parameters ---------- dataset_name : str last_retrieved_id : typing.Optional[str] steam_limit : typing.Optional[int] dataset_version : typing.Optional[str] project_name : typing.Optional[str] filters : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. Returns ------- typing.AsyncIterator[bytes] Dataset items stream or error during process rNr) r*rdrrrrYrBr6rr=s r+rz(AsyncDatasetsClient.stream_dataset_itemsH s{H##88%/#+%+9  ff d   f     se'A5A A5 A A A A A  A5 A  A  A5AA5 A2&A) 'A2.A5cpK|jj||d{}|jS7w)a Compare the latest committed dataset version with the current draft state. This endpoint provides insights into changes made since the last version was committed. The comparison calculates additions, modifications, deletions, and unchanged items between the latest version snapshot and current draft. Parameters ---------- id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionDiff Diff computed successfully Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.compare_dataset_versions(id='id', ) asyncio.run(main()) rlNrrs r+rz,AsyncDatasetsClient.compare_dataset_versionsx s76**CCBXgChh ~~ir9rrctK|jj||||d{}|jS7w)a Add a tag to a specific dataset version for easy reference (e.g., 'baseline', 'v1.0', 'production') Parameters ---------- id : str version_hash : str tag : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.create_version_tag(id='id', version_hash='versionHash', tag='tag', ) asyncio.run(main()) rNrrs r+rz&AsyncDatasetsClient.create_version_tag sB<**==  #>  ~~ r,ctK|jj||||d{}|jS7w)a Remove a tag from a dataset version. The version itself is not deleted, only the tag reference. Parameters ---------- id : str version_hash : str tag : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- None Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.delete_version_tag(id='id', version_hash='versionHash', tag='tag', ) asyncio.run(main()) rlNrrs r+rz&AsyncDatasetsClient.delete_version_tag s<<**==b,PSet=uu ~~vr,rctK|jj||||d{}|jS7w)a Get paginated list of versions for a dataset, ordered by creation time (newest first) Parameters ---------- id : str page : typing.Optional[int] size : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPagePublic Dataset versions Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.list_dataset_versions(id='id', ) asyncio.run(main()) rNrrs r+rz)AsyncDatasetsClient.list_dataset_versions sDH**@@ ToA  ~~ r,rcrK|jj|||d{}|jS7w)ax Restores the dataset to a previous version state by creating a new version with items copied from the specified version. If the version is already the latest, returns it as-is (no-op). Parameters ---------- id : str version_ref : str Version hash or tag to restore from request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPublic Version restored successfully Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.restore_dataset_version(id='id', version_ref='version_ref', ) asyncio.run(main()) rNrrs r+rz+AsyncDatasetsClient.restore_dataset_version sA<**BB KC  ~~ r5r crK|jj|||d{}|jS7w)aI Get a specific version by its version name (e.g., 'v1', 'v373'). This is more efficient than paginating through all versions for large datasets. Parameters ---------- id : str version_name : str Version name in format 'vN' (e.g., 'v1', 'v373') request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPublic Dataset version Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.retrieve_dataset_version(id='id', version_name='v1', ) asyncio.run(main()) r Nr rs r+r z,AsyncDatasetsClient.retrieve_dataset_version& sA<**CC \?D  ~~ r5rrrcvK|jj|||||d{}|jS7w)a Update a dataset version's change_description and/or add new tags Parameters ---------- id : str version_hash : str change_description : typing.Optional[str] Optional description of changes in this version tags_to_add : typing.Optional[typing.Sequence[str]] Optional list of tags to add to this version request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DatasetVersionPublic Version updated successfully Examples -------- from Opik import AsyncOpikApi import asyncio client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", ) async def main() -> None: await client.datasets.update_dataset_version(id='id', version_hash='versionHash', ) asyncio.run(main()) rNrrs r+rz*AsyncDatasetsClient.update_dataset_versionI sJR**AA  1#+ B  ~~ r3)Qrrrrr,rrr2rr rrrrrr<rrrr rIr rrVr!r"rarrjr!r"rqrrxrr~rrr rrrrr AsyncIteratorr$rrrr rrrrrrr%rr rrrrrrr rrrrrrrrrrrrrr rr&r-r+r(r(s Q*<Q #9  +/;? / /* / //$' /  8 / /j6:GK+/,0;?5"5__V__S1 2 5 1B!CD 5 OOC( 5OOD)5 85 5t&*%)7;9=*.+/%)(,(,;?Booc"Booc" B &t4 B "(!6 B??3'BOOC(Booc"B%B%B 8B BP$(+/-126>B6:,0;??? OOC ? OOC( ? ooc* ?oo./?OO$:;?oofooc23?__S)? 8? ?J.2+//3;?2/02ooc* 2 OOC( 2 , 2 82 2r<@ $kk#vvzz::;$ $  8 $  $X<@ ((//#& ( 2 (  8 ( (`<@ ((??3' ( 3 (  8 ( (VNR+1??>+J F-1?C6:;?, , , __S) , OO$;< ,oofooc23, 8, ,\cgsP^@_ko>.2;? ##ooc* #  8 #  #P;?+/GK/3;?5//&//#"675OOC( 5 1B!CD 5 , 5 85 5p`dooc*=C__^=\ <RV/5~/N   e $H.2AE7;.2;?; ; ; ooc* ;  )=> ;!' 4;s+; 8; ";D&*%)(,(,'+*.;?> > > ooc" > ooc" >%>%>$>//$'> 8> >H.2;? $$ooc* $  8 $  $V)-;? ' ' ' % '  8 ' 'TRV/5~/N >EI"(//."A + ,:SW060O H$()-(,,06:KOBF;?FF' F  F OOC F//#&F%F__S)Foofooc23FOOFOO4F$GHF!//*>?F 8F FX&*%)(,(,*.;?6 6ooc" 6 ooc" 6 % 6%6//$'6 86 6x04;? $ $, $  8 $  $NRV/5~/N <NR+1??>+J D37,004-1(,;?.."??3/ . __S) .  - .ooc*.%. 8.   e $.bNR+1??>+J >ko!!%(!25!HNXfHg! !Hko%(/2HNXfHg J&*%);? ' 'ooc" ' ooc" '  8 ' "'T`d!!'*!=C__^=\! !Hae!!(+!>Doon>]! !P48=A;?0 00 #OOC0 0 __V__S%9: 0 80 0r-r()@rcore.client_wrapperrrcore.request_optionsr types.dataset_expansion_responsertypes.dataset_export_job_publicr!types.dataset_item_changes_publicr types.dataset_item_filterr types.dataset_item_page_comparer types.dataset_item_page_publicr types.dataset_item_publicr types.dataset_item_updatertypes.dataset_item_writertypes.dataset_item_write_sourcertypes.dataset_page_publicrtypes.dataset_publicrtypes.dataset_version_diffr!types.dataset_version_page_publicrtypes.dataset_version_publicrtypes.evaluator_item_writertypes.execution_policy_writertypes.json_nodertypes.page_columnsrtypes.project_stats_publicrtypes.span_enrichment_optionsrtypes.trace_enrichment_optionsr raw_clientrrtypes.dataset_update_visibilityr types.dataset_write_typer!types.dataset_write_visibilityr"castr"rr$r(r&r-r+rssG1GDH9DB997D90;H?;?&,;ACAD6Bv{{6::s#qqh+__r-