openapi: 3.1.0 info: title: LangSmith access_policies datasets API description: 'The LangSmith API is used to programmatically create and manage LangSmith resources. ## Host https://api.smith.langchain.com ## Authentication To authenticate with the LangSmith API, set the `X-Api-Key` header to a valid [LangSmith API key](https://docs.langchain.com/langsmith/create-account-api-key#create-an-api-key). ' version: 0.1.0 servers: - url: / tags: - name: datasets paths: /api/v1/datasets: get: tags: - datasets summary: Read Datasets description: Get all datasets by query params and owner. operationId: read_datasets_api_v1_datasets_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: id in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Id - name: data_type in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/DataType' - $ref: '#/components/schemas/DataType' - type: 'null' title: Data Type - name: name in: query required: false schema: anyOf: - type: string - type: 'null' title: Name - name: name_contains in: query required: false schema: anyOf: - type: string - type: 'null' title: Name Contains - name: metadata in: query required: false schema: anyOf: - type: string - type: 'null' title: Metadata - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 100 title: Limit - name: sort_by in: query required: false schema: $ref: '#/components/schemas/SortByDatasetColumn' default: last_session_start_time - name: sort_by_desc in: query required: false schema: type: boolean default: true title: Sort By Desc - name: tag_value_id in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Tag Value Id - name: exclude_corrections_datasets in: query required: false schema: type: boolean default: false title: Exclude Corrections Datasets - name: exclude in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/GetDatasetsSelect' - type: 'null' title: Exclude responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Dataset' title: Response Read Datasets Api V1 Datasets Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - datasets summary: Create Dataset description: Create a new dataset. operationId: create_dataset_api_v1_datasets_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatasetCreate' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Dataset' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - datasets summary: Delete Datasets description: Delete multiple datasets. operationId: delete_datasets_api_v1_datasets_delete security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_ids in: query required: true schema: type: array items: type: string format: uuid maxItems: 100 title: Dataset Ids responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/stream: get: tags: - datasets summary: Read Datasets Stream description: Stream all datasets by query params and owner as JSON patches. operationId: read_datasets_stream_api_v1_datasets_stream_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: id in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Id - name: data_type in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/DataType' - $ref: '#/components/schemas/DataType' - type: 'null' title: Data Type - name: name in: query required: false schema: anyOf: - type: string - type: 'null' title: Name - name: name_contains in: query required: false schema: anyOf: - type: string - type: 'null' title: Name Contains - name: metadata in: query required: false schema: anyOf: - type: string - type: 'null' title: Metadata - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 100 title: Limit - name: sort_by in: query required: false schema: $ref: '#/components/schemas/SortByDatasetColumn' default: last_session_start_time - name: sort_by_desc in: query required: false schema: type: boolean default: true title: Sort By Desc - name: tag_value_id in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Tag Value Id - name: exclude_corrections_datasets in: query required: false schema: type: boolean default: false title: Exclude Corrections Datasets responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}: get: tags: - datasets summary: Read Dataset description: Get a specific dataset. operationId: read_dataset_api_v1_datasets__dataset_id__get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Dataset' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - datasets summary: Delete Dataset description: Delete a specific dataset. operationId: delete_dataset_api_v1_datasets__dataset_id__delete security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - datasets summary: Update Dataset description: Update a specific dataset. operationId: update_dataset_api_v1_datasets__dataset_id__patch security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatasetUpdate' responses: '200': description: Dataset updated successfully content: application/json: schema: $ref: '#/components/schemas/DatasetSchemaForUpdate' headers: X-Updated-Examples-Count: description: Number of examples updated schema: type: integer '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/upload: post: tags: - datasets summary: Upload Csv Dataset description: Create a new dataset from a CSV or JSONL file. operationId: upload_csv_dataset_api_v1_datasets_upload_post requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_upload_csv_dataset_api_v1_datasets_upload_post' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Dataset' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] /api/v1/datasets/upload-experiment: post: tags: - datasets summary: Upload Experiment description: Upload an experiment that has already been run. operationId: upload_experiment_api_v1_datasets_upload_experiment_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ExperimentResultsUpload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExperimentResultsUploadResult' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] /api/v1/datasets/{dataset_id}/versions: get: tags: - datasets summary: Get Dataset Versions description: Get dataset versions. operationId: get_dataset_versions_api_v1_datasets__dataset_id__versions_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: search in: query required: false schema: anyOf: - type: string - type: 'null' title: Search - name: example in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Example - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 100 title: Limit - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DatasetVersion' title: Response Get Dataset Versions Api V1 Datasets Dataset Id Versions Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/versions/diff: get: tags: - datasets summary: Diff Dataset Versions description: Get diff between two dataset versions. operationId: diff_dataset_versions_api_v1_datasets__dataset_id__versions_diff_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: from_version in: query required: true schema: anyOf: - type: string format: date-time - type: string title: From Version - name: to_version in: query required: true schema: anyOf: - type: string format: date-time - type: string title: To Version responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetDiffInfo' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/version: get: tags: - datasets summary: Get Dataset Version description: Get dataset version by as_of or exact tag. operationId: get_dataset_version_api_v1_datasets__dataset_id__version_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: as_of in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: As Of - name: tag in: query required: false schema: anyOf: - type: string - type: 'null' title: Tag responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetVersion' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/tags: put: tags: - datasets summary: Update Dataset Version description: Set a tag on a dataset version. operationId: update_dataset_version_api_v1_datasets__dataset_id__tags_put security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutDatasetVersionsSchema' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetVersion' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/openai: get: tags: - datasets summary: Download Dataset Openai description: Download a dataset as OpenAI Evals Jsonl format. operationId: download_dataset_openai_api_v1_datasets__dataset_id__openai_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: as_of in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. title: As Of description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/openai_ft: get: tags: - datasets summary: Download Dataset Openai Ft description: Download a dataset as OpenAI Jsonl format. operationId: download_dataset_openai_ft_api_v1_datasets__dataset_id__openai_ft_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: as_of in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. title: As Of description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/csv: get: tags: - datasets summary: Download Dataset Csv description: Download a dataset as CSV format. operationId: download_dataset_csv_api_v1_datasets__dataset_id__csv_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: as_of in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. title: As Of description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/jsonl: get: tags: - datasets summary: Download Dataset Jsonl description: Download a dataset as CSV format. operationId: download_dataset_jsonl_api_v1_datasets__dataset_id__jsonl_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: as_of in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. title: As Of description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/runs: post: tags: - datasets summary: Read Examples With Runs description: Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids. operationId: read_examples_with_runs_api_v1_datasets__dataset_id__runs_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: format in: query required: false schema: anyOf: - const: csv type: string - type: 'null' description: Response format, e.g., 'csv' title: Format description: Response format, e.g., 'csv' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryExampleSchemaWithRunsRequest' responses: '200': description: Successful Response content: application/json: schema: anyOf: - type: array items: $ref: '#/components/schemas/ExampleWithRunsCH' title: ExamplesWithRuns - type: 'null' title: Response Read Examples With Runs Api V1 Datasets Dataset Id Runs Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/group/runs: post: tags: - datasets summary: Read Examples With Runs Grouped description: Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids. operationId: read_examples_with_runs_grouped_api_v1_datasets__dataset_id__group_runs_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryGroupedExamplesWithRuns' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedExamplesWithRunsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/runs/delta: post: tags: - datasets summary: Read Delta description: Fetch the number of regressions/improvements for each example in a dataset, between sessions[0] and sessions[1]. operationId: read_delta_api_v1_datasets__dataset_id__runs_delta_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryFeedbackDelta' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SessionFeedbackDelta' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/runs/delta/stream: post: tags: - datasets summary: Read Delta Stream description: "Stream feedback deltas for multiple feedback keys.\n\nReturns results in chunks as they become available. Each chunk contains\nresults for one or more feedback keys. Errors for individual chunks are\nincluded in the response rather than failing the entire operation.\n\nResponse format (SSE):\n event: data\n data: {\"feedback_deltas\": {\"key1\": {session_id: {...}}, ...}, \"errors\": null}\n\n event: data\n data: {\"feedback_deltas\": {\"key2\": {...}}, \"errors\": null}\n\n event: end" operationId: read_delta_stream_api_v1_datasets__dataset_id__runs_delta_stream_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryFeedbackDeltaBatch' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/experiments/grouped: post: tags: - datasets summary: Read Grouped Experiments description: Stream grouped and aggregated experiments. operationId: read_grouped_experiments_api_v1_datasets__dataset_id__experiments_grouped_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GroupedExperimentsRequest' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/share: get: tags: - datasets summary: Read Dataset Share State description: Get the state of sharing a dataset operationId: read_dataset_share_state_api_v1_datasets__dataset_id__share_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/DatasetShareSchema' - type: 'null' title: Response Read Dataset Share State Api V1 Datasets Dataset Id Share Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: tags: - datasets summary: Share Dataset description: Share a dataset. operationId: share_dataset_api_v1_datasets__dataset_id__share_put security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: share_projects in: query required: false schema: type: boolean default: false title: Share Projects responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetShareSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - datasets summary: Unshare Dataset description: Unshare a dataset. operationId: unshare_dataset_api_v1_datasets__dataset_id__share_delete security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/comparative: get: tags: - datasets summary: Read Comparative Experiments description: Get all comparative experiments for a given dataset. operationId: read_comparative_experiments_api_v1_datasets__dataset_id__comparative_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: name in: query required: false schema: anyOf: - type: string - type: 'null' title: Name - name: name_contains in: query required: false schema: anyOf: - type: string - type: 'null' title: Name Contains - name: id in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Id - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 100 title: Limit - name: sort_by in: query required: false schema: $ref: '#/components/schemas/SortByComparativeExperimentColumn' default: created_at - name: sort_by_desc in: query required: false schema: type: boolean default: true title: Sort By Desc responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ComparativeExperiment' title: Response Read Comparative Experiments Api V1 Datasets Dataset Id Comparative Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/comparative: post: tags: - datasets summary: Create Comparative Experiment description: Create a comparative experiment. operationId: create_comparative_experiment_api_v1_datasets_comparative_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ComparativeExperimentCreate' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ComparativeExperimentBase' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] /api/v1/datasets/comparative/{comparative_experiment_id}: delete: tags: - datasets summary: Delete Comparative Experiment description: Delete a specific comparative experiment. operationId: delete_comparative_experiment_api_v1_datasets_comparative__comparative_experiment_id__delete security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: comparative_experiment_id in: path required: true schema: type: string format: uuid title: Comparative Experiment Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/clone: post: tags: - datasets summary: Clone Dataset description: Clone a dataset. operationId: clone_dataset_api_v1_datasets_clone_post requestBody: content: application/json: schema: $ref: '#/components/schemas/Body_clone_dataset_api_v1_datasets_clone_post' required: true responses: '200': description: Successful Response content: application/json: schema: items: additionalProperties: true type: object type: array title: Response Clone Dataset Api V1 Datasets Clone Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] /api/v1/datasets/{dataset_id}/splits: get: tags: - datasets summary: Get Dataset Splits operationId: get_dataset_splits_api_v1_datasets__dataset_id__splits_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id - name: as_of in: query required: false schema: anyOf: - type: string format: date-time - type: string description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. default: latest title: As Of description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. responses: '200': description: Successful Response content: application/json: schema: type: array items: type: string title: Response Get Dataset Splits Api V1 Datasets Dataset Id Splits Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: tags: - datasets summary: Update Dataset Splits operationId: update_dataset_splits_api_v1_datasets__dataset_id__splits_put security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Body_update_dataset_splits_api_v1_datasets__dataset_id__splits_put' responses: '200': description: Successful Response content: application/json: schema: type: array items: type: string format: uuid title: Response Update Dataset Splits Api V1 Datasets Dataset Id Splits Put '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/{dataset_id}/generate: post: tags: - datasets summary: Generate description: Generate synthetic examples for a dataset. operationId: generate_api_v1_datasets__dataset_id__generate_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: dataset_id in: path required: true schema: type: string format: uuid title: Dataset Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GenerateSyntheticExamplesBody' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/datasets/playground_experiment/batch: post: tags: - datasets summary: Dataset Handler operationId: dataset_handler_api_v1_datasets_playground_experiment_batch_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PlaygroundRunOverDatasetBatchRequestSchema' required: true responses: '200': description: Successful Response content: application/json: schema: title: Response Dataset Handler Api V1 Datasets Playground Experiment Batch Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] /api/v1/datasets/playground_experiment/stream: post: tags: - datasets summary: Stream Dataset Handler operationId: stream_dataset_handler_api_v1_datasets_playground_experiment_stream_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PlaygroundRunOverDatasetRequestSchema' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] /api/v1/datasets/studio_experiment: post: tags: - datasets summary: Studio Experiment operationId: studio_experiment_api_v1_datasets_studio_experiment_post requestBody: content: application/json: schema: $ref: '#/components/schemas/StudioRunOverDatasetRequestSchema' required: true responses: '200': description: Successful Response content: application/json: schema: title: Response Studio Experiment Api V1 Datasets Studio Experiment Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] components: schemas: SimpleExperimentInfo: properties: id: type: string format: uuid title: Id name: type: string title: Name type: object required: - id - name title: SimpleExperimentInfo description: Simple experiment info schema for use with comparative experiments Dataset: properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description created_at: type: string format: date-time title: Created At inputs_schema_definition: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs Schema Definition outputs_schema_definition: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs Schema Definition externally_managed: anyOf: - type: boolean - type: 'null' title: Externally Managed default: false transformations: anyOf: - items: $ref: '#/components/schemas/DatasetTransformation' type: array - type: 'null' title: Transformations data_type: anyOf: - $ref: '#/components/schemas/DataType' - type: 'null' default: kv id: type: string format: uuid title: Id tenant_id: type: string format: uuid title: Tenant Id example_count: anyOf: - type: integer - type: 'null' title: Example Count session_count: type: integer title: Session Count modified_at: type: string format: date-time title: Modified At last_session_start_time: anyOf: - type: string format: date-time - type: 'null' title: Last Session Start Time metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata baseline_experiment_id: anyOf: - type: string format: uuid - type: 'null' title: Baseline Experiment Id type: object required: - name - id - tenant_id - session_count - modified_at title: Dataset description: Dataset schema. SessionFeedbackDelta: properties: feedback_deltas: additionalProperties: $ref: '#/components/schemas/FeedbackDelta' propertyNames: format: uuid type: object title: Feedback Deltas type: object required: - feedback_deltas title: SessionFeedbackDelta description: List of feedback keys with number of improvements and regressions for each. AutoEvalFeedbackSource: properties: type: type: string const: auto_eval title: Type default: auto_eval metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object title: AutoEvalFeedbackSource description: Auto eval feedback source. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError TracerSession: properties: start_time: type: string format: date-time title: Start Time end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description default_dataset_id: anyOf: - type: string format: uuid - type: 'null' title: Default Dataset Id reference_dataset_id: anyOf: - type: string format: uuid - type: 'null' title: Reference Dataset Id trace_tier: anyOf: - $ref: '#/components/schemas/TraceTier' - type: 'null' id: type: string format: uuid title: Id run_count: anyOf: - type: integer - type: 'null' title: Run Count latency_p50: anyOf: - type: number - type: 'null' title: Latency P50 latency_p99: anyOf: - type: number - type: 'null' title: Latency P99 first_token_p50: anyOf: - type: number - type: 'null' title: First Token P50 first_token_p99: anyOf: - type: number - type: 'null' title: First Token P99 total_tokens: anyOf: - type: integer - type: 'null' title: Total Tokens prompt_tokens: anyOf: - type: integer - type: 'null' title: Prompt Tokens completion_tokens: anyOf: - type: integer - type: 'null' title: Completion Tokens total_cost: anyOf: - type: string - type: 'null' title: Total Cost prompt_cost: anyOf: - type: string - type: 'null' title: Prompt Cost completion_cost: anyOf: - type: string - type: 'null' title: Completion Cost tenant_id: type: string format: uuid title: Tenant Id last_run_start_time: anyOf: - type: string format: date-time - type: 'null' title: Last Run Start Time last_run_start_time_live: anyOf: - type: string format: date-time - type: 'null' title: Last Run Start Time Live feedback_stats: anyOf: - additionalProperties: true type: object - type: 'null' title: Feedback Stats session_feedback_stats: anyOf: - additionalProperties: true type: object - type: 'null' title: Session Feedback Stats run_facets: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Run Facets error_rate: anyOf: - type: number - type: 'null' title: Error Rate streaming_rate: anyOf: - type: number - type: 'null' title: Streaming Rate test_run_number: anyOf: - type: integer - type: 'null' title: Test Run Number type: object required: - id - tenant_id title: TracerSession description: TracerSession schema. FeedbackCreateCoreSchema: properties: created_at: type: string format: date-time title: Created At modified_at: type: string format: date-time title: Modified At key: type: string maxLength: 180 title: Key score: anyOf: - type: number - type: integer - type: boolean - type: 'null' title: Score value: anyOf: - type: number - type: integer - type: boolean - type: string - additionalProperties: true type: object - type: 'null' title: Value comment: anyOf: - type: string - type: 'null' title: Comment correction: anyOf: - additionalProperties: true type: object - type: string - type: 'null' title: Correction feedback_group_id: anyOf: - type: string format: uuid - type: 'null' title: Feedback Group Id comparative_experiment_id: anyOf: - type: string format: uuid - type: 'null' title: Comparative Experiment Id id: type: string format: uuid title: Id feedback_source: anyOf: - oneOf: - $ref: '#/components/schemas/AppFeedbackSource' - $ref: '#/components/schemas/APIFeedbackSource' - $ref: '#/components/schemas/ModelFeedbackSource' - $ref: '#/components/schemas/AutoEvalFeedbackSource' discriminator: propertyName: type mapping: api: '#/components/schemas/APIFeedbackSource' app: '#/components/schemas/AppFeedbackSource' auto_eval: '#/components/schemas/AutoEvalFeedbackSource' model: '#/components/schemas/ModelFeedbackSource' - type: 'null' title: Feedback Source feedback_config: anyOf: - $ref: '#/components/schemas/FeedbackConfig' - type: 'null' extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra type: object required: - key title: FeedbackCreateCoreSchema description: Schema used for creating feedback without run id or session id. DataType: type: string enum: - kv - llm - chat title: DataType description: Enum for dataset data types. StudioRunOverDatasetRequestSchema: properties: project_name: type: string title: Project Name dataset_id: type: string format: uuid title: Dataset Id evaluator_rules: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Evaluator Rules metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object required: - project_name - dataset_id title: StudioRunOverDatasetRequestSchema TraceTier: type: string enum: - longlived - shortlived title: TraceTier GroupedExamplesWithRunsResponse: properties: groups: items: $ref: '#/components/schemas/ExampleGroupWithSessions' type: array title: Groups type: object required: - groups title: GroupedExamplesWithRunsResponse description: 'Response for grouped comparison view of dataset examples. Returns dataset examples grouped by a run metadata value (e.g., model=''gpt-4''). Optional filters are applied to all runs before grouping. Shows: - Which examples were executed with each metadata value - Per-session aggregate statistics for runs on those examples - The actual example data with their associated runs Used for comparing how different sessions performed on the same set of examples.' RunSchemaComparisonView: properties: name: type: string title: Name inputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs inputs_preview: anyOf: - type: string - type: 'null' title: Inputs Preview run_type: $ref: '#/components/schemas/RunTypeEnum' start_time: type: string format: date-time title: Start Time end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra error: anyOf: - type: string - type: 'null' title: Error execution_order: type: integer minimum: 1.0 title: Execution Order default: 1 serialized: anyOf: - additionalProperties: true type: object - type: 'null' title: Serialized outputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs outputs_preview: anyOf: - type: string - type: 'null' title: Outputs Preview parent_run_id: anyOf: - type: string format: uuid - type: 'null' title: Parent Run Id manifest_id: anyOf: - type: string format: uuid - type: 'null' title: Manifest Id manifest_s3_id: anyOf: - type: string format: uuid - type: 'null' title: Manifest S3 Id events: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Events tags: anyOf: - items: type: string type: array - type: 'null' title: Tags inputs_s3_urls: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs S3 Urls outputs_s3_urls: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs S3 Urls s3_urls: anyOf: - additionalProperties: true type: object - type: 'null' title: S3 Urls trace_id: type: string format: uuid title: Trace Id dotted_order: anyOf: - type: string - type: 'null' title: Dotted Order trace_min_start_time: anyOf: - type: string format: date-time - type: 'null' title: Trace Min Start Time trace_max_start_time: anyOf: - type: string format: date-time - type: 'null' title: Trace Max Start Time id: type: string format: uuid title: Id session_id: type: string format: uuid title: Session Id reference_example_id: anyOf: - type: string format: uuid - type: 'null' title: Reference Example Id total_tokens: anyOf: - type: integer - type: 'null' title: Total Tokens prompt_tokens: anyOf: - type: integer - type: 'null' title: Prompt Tokens completion_tokens: anyOf: - type: integer - type: 'null' title: Completion Tokens total_cost: anyOf: - type: string - type: 'null' title: Total Cost prompt_cost: anyOf: - type: string - type: 'null' title: Prompt Cost completion_cost: anyOf: - type: string - type: 'null' title: Completion Cost status: type: string title: Status feedback_stats: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Feedback Stats app_path: anyOf: - type: string - type: 'null' title: App Path feedbacks: items: $ref: '#/components/schemas/FeedbackSchema' type: array title: Feedbacks type: object required: - name - run_type - trace_id - id - session_id - status title: RunSchemaComparisonView description: Run schema for comparison view. DatasetUpdate: properties: name: anyOf: - type: string - $ref: '#/components/schemas/Missing' - type: 'null' title: Name default: __missing__: __missing__ description: anyOf: - type: string - $ref: '#/components/schemas/Missing' - type: 'null' title: Description default: __missing__: __missing__ inputs_schema_definition: anyOf: - additionalProperties: true type: object - $ref: '#/components/schemas/Missing' - type: 'null' title: Inputs Schema Definition default: __missing__: __missing__ outputs_schema_definition: anyOf: - additionalProperties: true type: object - $ref: '#/components/schemas/Missing' - type: 'null' title: Outputs Schema Definition default: __missing__: __missing__ patch_examples: anyOf: - additionalProperties: $ref: '#/components/schemas/ExampleUpdate' propertyNames: format: uuid type: object - type: 'null' title: Patch Examples transformations: anyOf: - items: $ref: '#/components/schemas/DatasetTransformation' type: array - $ref: '#/components/schemas/Missing' - type: 'null' title: Transformations default: __missing__: __missing__ metadata: anyOf: - additionalProperties: true type: object - $ref: '#/components/schemas/Missing' - type: 'null' title: Metadata default: __missing__: __missing__ baseline_experiment_id: anyOf: - type: string format: uuid - $ref: '#/components/schemas/Missing' - type: 'null' title: Baseline Experiment Id default: __missing__: __missing__ type: object title: DatasetUpdate description: Update class for Dataset. DatasetTransformation: properties: path: items: type: string type: array title: Path transformation_type: $ref: '#/components/schemas/DatasetTransformationType' type: object required: - path - transformation_type title: DatasetTransformation FeedbackCategory: properties: value: type: number title: Value label: anyOf: - type: string minLength: 1 - type: 'null' title: Label type: object required: - value title: FeedbackCategory description: Specific value and label pair for feedback SortParamsForRunsComparisonView: properties: sort_by: type: string title: Sort By sort_order: type: string enum: - ASC - DESC title: Sort Order default: DESC type: object required: - sort_by title: SortParamsForRunsComparisonView ComparativeExperiment: properties: id: type: string format: uuid title: Id name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description tenant_id: type: string format: uuid title: Tenant Id created_at: type: string format: date-time title: Created At modified_at: type: string format: date-time title: Modified At reference_dataset_id: type: string format: uuid title: Reference Dataset Id extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra experiments_info: items: $ref: '#/components/schemas/SimpleExperimentInfo' type: array title: Experiments Info feedback_stats: anyOf: - additionalProperties: true type: object - type: 'null' title: Feedback Stats type: object required: - id - tenant_id - created_at - modified_at - reference_dataset_id - experiments_info title: ComparativeExperiment description: ComparativeExperiment schema. FeedbackSchema: properties: created_at: type: string format: date-time title: Created At modified_at: type: string format: date-time title: Modified At key: type: string title: Key score: anyOf: - type: number - type: integer - type: boolean - type: 'null' title: Score value: anyOf: - type: number - type: integer - type: boolean - type: string - additionalProperties: true type: object - type: 'null' title: Value comment: anyOf: - type: string - type: 'null' title: Comment correction: anyOf: - additionalProperties: true type: object - type: string - type: 'null' title: Correction feedback_group_id: anyOf: - type: string format: uuid - type: 'null' title: Feedback Group Id comparative_experiment_id: anyOf: - type: string format: uuid - type: 'null' title: Comparative Experiment Id run_id: anyOf: - type: string format: uuid - type: 'null' title: Run Id session_id: anyOf: - type: string format: uuid - type: 'null' title: Session Id id: type: string format: uuid title: Id trace_id: anyOf: - type: string format: uuid - type: 'null' title: Trace Id start_time: anyOf: - type: string format: date-time - type: 'null' title: Start Time is_root: type: boolean title: Is Root default: false feedback_source: anyOf: - $ref: '#/components/schemas/FeedbackSource' - type: 'null' extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra feedback_thread_id: anyOf: - type: string - type: 'null' title: Feedback Thread Id type: object required: - key - id title: FeedbackSchema description: Schema for getting feedback. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError QueryExampleSchemaWithRunsRequest: properties: session_ids: items: type: string format: uuid type: array minItems: 1 title: Session Ids offset: type: integer minimum: 0.0 title: Offset default: 0 limit: anyOf: - type: integer minimum: 1.0 - type: 'null' title: Limit preview: type: boolean title: Preview default: false comparative_experiment_id: anyOf: - type: string format: uuid - type: 'null' title: Comparative Experiment Id sort_params: anyOf: - $ref: '#/components/schemas/SortParamsForRunsComparisonView' - type: 'null' filters: anyOf: - additionalProperties: items: type: string type: array propertyNames: format: uuid type: object - type: 'null' title: Filters example_ids: anyOf: - items: type: string format: uuid type: array maxItems: 1000 - type: 'null' title: Example Ids include_annotator_detail: type: boolean title: Include Annotator Detail default: false type: object required: - session_ids title: QueryExampleSchemaWithRunsRequest description: 'Request DTO for querying examples with runs - used for API input. This is separate from the internal schema to cleanly handle optional limit values. When limit is None, the internal schema will apply appropriate defaults based on format.' FeedbackDelta: properties: improved_examples: items: type: string format: uuid type: array title: Improved Examples regressed_examples: items: type: string format: uuid type: array title: Regressed Examples type: object required: - improved_examples - regressed_examples title: FeedbackDelta description: Feedback key with number of improvements and regressions. PutDatasetVersionsSchema: properties: as_of: anyOf: - type: string format: date-time - type: string title: As Of description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. tag: type: string title: Tag type: object required: - as_of - tag title: PutDatasetVersionsSchema QueryGroupedExamplesWithRuns: properties: session_ids: items: type: string format: uuid type: array minItems: 1 title: Session Ids offset: type: integer minimum: 0.0 title: Offset default: 0 limit: type: integer minimum: 1.0 title: Limit default: 10 preview: type: boolean title: Preview default: false group_by: $ref: '#/components/schemas/GroupExampleRunsByField' metadata_key: type: string title: Metadata Key per_group_limit: type: integer maximum: 10.0 minimum: 1.0 title: Per Group Limit default: 5 filters: anyOf: - additionalProperties: items: type: string type: array propertyNames: format: uuid type: object - type: 'null' title: Filters type: object required: - session_ids - group_by - metadata_key title: QueryGroupedExamplesWithRuns ModelFeedbackSource: properties: type: type: string const: model title: Type default: model metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object title: ModelFeedbackSource description: Model feedback source. DatasetCreate: properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description created_at: type: string format: date-time title: Created At inputs_schema_definition: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs Schema Definition outputs_schema_definition: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs Schema Definition externally_managed: anyOf: - type: boolean - type: 'null' title: Externally Managed default: false transformations: anyOf: - items: $ref: '#/components/schemas/DatasetTransformation' type: array - type: 'null' title: Transformations id: anyOf: - type: string format: uuid - type: 'null' title: Id extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra data_type: $ref: '#/components/schemas/DataType' default: kv type: object required: - name title: DatasetCreate description: Create class for Dataset. DatasetVersion: properties: tags: anyOf: - items: type: string type: array - type: 'null' title: Tags as_of: type: string format: date-time title: As Of type: object required: - as_of title: DatasetVersion description: Dataset version schema. DatasetTransformationType: type: string enum: - convert_to_openai_message - convert_to_openai_tool - remove_system_messages - remove_extra_fields - extract_tools_from_run title: DatasetTransformationType description: 'Enum for dataset transformation types. Ordering determines the order in which transformations are applied if there are multiple transformations on the same path.' AppFeedbackSource: properties: type: type: string const: app title: Type default: app metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object title: AppFeedbackSource description: Feedback from the LangChainPlus App. PlaygroundRunOverDatasetRequestSchema: properties: manifest: title: Manifest secrets: additionalProperties: type: string type: object title: Secrets run_id: anyOf: - type: string - type: 'null' title: Run Id repo_id: anyOf: - type: string - type: 'null' title: Repo Id tools: anyOf: - items: {} type: array - type: 'null' title: Tools tool_choice: anyOf: - type: string - type: 'null' title: Tool Choice parallel_tool_calls: anyOf: - type: boolean - type: 'null' title: Parallel Tool Calls options: $ref: '#/components/schemas/RunnableConfig' project_name: type: string title: Project Name repo_handle: anyOf: - type: string - type: 'null' title: Repo Handle owner: anyOf: - type: string - type: 'null' title: Owner commit: anyOf: - type: string - type: 'null' title: Commit evaluator_rules: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Evaluator Rules requests_per_second: anyOf: - type: integer - type: 'null' title: Requests Per Second use_or_fallback_to_workspace_secrets: type: boolean title: Use Or Fallback To Workspace Secrets default: false runner_context: anyOf: - $ref: '#/components/schemas/RunnerContextEnum' - type: 'null' default: langsmith_ui dataset_id: type: string format: uuid title: Dataset Id dataset_splits: anyOf: - items: type: string type: array - type: 'null' title: Dataset Splits repetitions: type: integer maximum: 30.0 minimum: 1.0 title: Repetitions default: 1 metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object required: - manifest - secrets - options - project_name - dataset_id title: PlaygroundRunOverDatasetRequestSchema DatasetShareSchema: properties: dataset_id: type: string format: uuid title: Dataset Id share_token: type: string format: uuid title: Share Token type: object required: - dataset_id - share_token title: DatasetShareSchema GenerateSyntheticExamplesBody: properties: example_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Example Ids num_examples: type: integer title: Num Examples type: object required: - num_examples title: GenerateSyntheticExamplesBody GroupedRunsSessionStats: properties: start_time: type: string format: date-time title: Start Time end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description default_dataset_id: anyOf: - type: string format: uuid - type: 'null' title: Default Dataset Id reference_dataset_id: anyOf: - type: string format: uuid - type: 'null' title: Reference Dataset Id trace_tier: anyOf: - $ref: '#/components/schemas/TraceTier' - type: 'null' id: type: string format: uuid title: Id run_count: anyOf: - type: integer - type: 'null' title: Run Count latency_p50: anyOf: - type: number - type: 'null' title: Latency P50 latency_p99: anyOf: - type: number - type: 'null' title: Latency P99 first_token_p50: anyOf: - type: number - type: 'null' title: First Token P50 first_token_p99: anyOf: - type: number - type: 'null' title: First Token P99 total_tokens: anyOf: - type: integer - type: 'null' title: Total Tokens prompt_tokens: anyOf: - type: integer - type: 'null' title: Prompt Tokens completion_tokens: anyOf: - type: integer - type: 'null' title: Completion Tokens total_cost: anyOf: - type: string - type: 'null' title: Total Cost prompt_cost: anyOf: - type: string - type: 'null' title: Prompt Cost completion_cost: anyOf: - type: string - type: 'null' title: Completion Cost tenant_id: type: string format: uuid title: Tenant Id last_run_start_time: anyOf: - type: string format: date-time - type: 'null' title: Last Run Start Time last_run_start_time_live: anyOf: - type: string format: date-time - type: 'null' title: Last Run Start Time Live feedback_stats: anyOf: - additionalProperties: true type: object - type: 'null' title: Feedback Stats session_feedback_stats: anyOf: - additionalProperties: true type: object - type: 'null' title: Session Feedback Stats run_facets: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Run Facets error_rate: anyOf: - type: number - type: 'null' title: Error Rate streaming_rate: anyOf: - type: number - type: 'null' title: Streaming Rate test_run_number: anyOf: - type: integer - type: 'null' title: Test Run Number example_count: anyOf: - type: integer - type: 'null' title: Example Count filter: type: string title: Filter min_start_time: anyOf: - type: string format: date-time - type: 'null' title: Min Start Time max_start_time: anyOf: - type: string format: date-time - type: 'null' title: Max Start Time type: object required: - id - tenant_id - filter title: GroupedRunsSessionStats description: 'TracerSession stats filtered to runs matching a specific metadata value. Extends TracerSession with: - example_count: unique examples (vs run_count = total runs including duplicates) - filter: ClickHouse filter for fetching runs in this session/group - min/max_start_time: time range for runs in this session/group' ExperimentResultsUploadResult: properties: dataset: $ref: '#/components/schemas/Dataset' experiment: $ref: '#/components/schemas/TracerSession' type: object required: - dataset - experiment title: ExperimentResultsUploadResult description: Class for uploading the results of an already-run experiment. ExperimentResultsUpload: properties: experiment_name: type: string title: Experiment Name experiment_description: anyOf: - type: string - type: 'null' title: Experiment Description dataset_id: anyOf: - type: string format: uuid - type: 'null' title: Dataset Id dataset_name: anyOf: - type: string - type: 'null' title: Dataset Name dataset_description: anyOf: - type: string - type: 'null' title: Dataset Description summary_experiment_scores: anyOf: - items: $ref: '#/components/schemas/FeedbackCreateCoreSchema' type: array - type: 'null' title: Summary Experiment Scores results: items: $ref: '#/components/schemas/ExperimentResultRow' type: array title: Results experiment_start_time: type: string format: date-time title: Experiment Start Time experiment_end_time: type: string format: date-time title: Experiment End Time experiment_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Experiment Metadata type: object required: - experiment_name - results - experiment_start_time - experiment_end_time title: ExperimentResultsUpload description: Class for uploading the results of an already-run experiment. Body_upload_csv_dataset_api_v1_datasets_upload_post: properties: file: type: string format: binary title: File input_keys: items: type: string type: array title: Input Keys name: anyOf: - type: string - type: 'null' title: Name data_type: $ref: '#/components/schemas/DataType' default: kv output_keys: items: type: string type: array title: Output Keys default: [] metadata_keys: items: type: string type: array title: Metadata Keys default: [] description: anyOf: - type: string - type: 'null' title: Description inputs_schema_definition: anyOf: - type: string - type: 'null' title: Inputs Schema Definition outputs_schema_definition: anyOf: - type: string - type: 'null' title: Outputs Schema Definition transformations: anyOf: - type: string - type: 'null' title: Transformations input_key_mappings: anyOf: - type: string - type: 'null' title: Input Key Mappings output_key_mappings: anyOf: - type: string - type: 'null' title: Output Key Mappings metadata_key_mappings: anyOf: - type: string - type: 'null' title: Metadata Key Mappings type: object required: - file - input_keys title: Body_upload_csv_dataset_api_v1_datasets_upload_post ExperimentResultRow: properties: row_id: anyOf: - type: string format: uuid - type: 'null' title: Row Id inputs: additionalProperties: true type: object title: Inputs expected_outputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Expected Outputs actual_outputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Actual Outputs evaluation_scores: anyOf: - items: $ref: '#/components/schemas/FeedbackCreateCoreSchema' type: array - type: 'null' title: Evaluation Scores start_time: type: string format: date-time title: Start Time end_time: type: string format: date-time title: End Time run_name: anyOf: - type: string - type: 'null' title: Run Name error: anyOf: - type: string - type: 'null' title: Error run_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Run Metadata type: object required: - inputs - start_time - end_time title: ExperimentResultRow description: Class for a single row in the uploaded experiment results. PlaygroundRunOverDatasetBatchRequestSchema: properties: manifest: title: Manifest secrets: additionalProperties: type: string type: object title: Secrets run_id: anyOf: - type: string - type: 'null' title: Run Id repo_id: anyOf: - type: string - type: 'null' title: Repo Id tools: anyOf: - items: {} type: array - type: 'null' title: Tools tool_choice: anyOf: - type: string - type: 'null' title: Tool Choice parallel_tool_calls: anyOf: - type: boolean - type: 'null' title: Parallel Tool Calls options: $ref: '#/components/schemas/RunnableConfig' project_name: type: string title: Project Name repo_handle: anyOf: - type: string - type: 'null' title: Repo Handle owner: anyOf: - type: string - type: 'null' title: Owner commit: anyOf: - type: string - type: 'null' title: Commit evaluator_rules: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Evaluator Rules requests_per_second: anyOf: - type: integer - type: 'null' title: Requests Per Second use_or_fallback_to_workspace_secrets: type: boolean title: Use Or Fallback To Workspace Secrets default: false runner_context: anyOf: - $ref: '#/components/schemas/RunnerContextEnum' - type: 'null' default: langsmith_ui dataset_id: type: string format: uuid title: Dataset Id dataset_splits: anyOf: - items: type: string type: array - type: 'null' title: Dataset Splits repetitions: type: integer maximum: 30.0 minimum: 1.0 title: Repetitions default: 1 metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata batch_size: anyOf: - type: integer maximum: 100.0 minimum: 1.0 - type: 'null' title: Batch Size type: object required: - manifest - secrets - options - project_name - dataset_id title: PlaygroundRunOverDatasetBatchRequestSchema Body_update_dataset_splits_api_v1_datasets__dataset_id__splits_put: properties: split_name: type: string title: Split Name examples: items: type: string format: uuid type: array title: Examples remove: type: boolean title: Remove default: false type: object required: - split_name - examples title: Body_update_dataset_splits_api_v1_datasets__dataset_id__splits_put QueryFeedbackDelta: properties: baseline_session_id: type: string format: uuid title: Baseline Session Id comparison_session_ids: items: type: string format: uuid type: array title: Comparison Session Ids feedback_key: type: string title: Feedback Key filters: anyOf: - additionalProperties: items: type: string type: array propertyNames: format: uuid type: object - type: 'null' title: Filters offset: type: integer minimum: 0.0 title: Offset default: 0 limit: type: integer maximum: 100.0 minimum: 1.0 title: Limit default: 100 comparative_experiment_id: anyOf: - type: string format: uuid - type: 'null' title: Comparative Experiment Id type: object required: - baseline_session_id - comparison_session_ids - feedback_key title: QueryFeedbackDelta SortByDatasetColumn: type: string enum: - name - created_at - last_session_start_time - example_count - session_count - modified_at title: SortByDatasetColumn description: Enum for available dataset columns to sort by. ExampleGroupWithSessions: properties: filter: type: string title: Filter count: anyOf: - type: integer - type: 'null' title: Count total_tokens: anyOf: - type: integer - type: 'null' title: Total Tokens total_cost: anyOf: - type: string - type: 'null' title: Total Cost min_start_time: anyOf: - type: string format: date-time - type: 'null' title: Min Start Time max_start_time: anyOf: - type: string format: date-time - type: 'null' title: Max Start Time latency_p50: anyOf: - type: number - type: 'null' title: Latency P50 latency_p99: anyOf: - type: number - type: 'null' title: Latency P99 feedback_stats: anyOf: - additionalProperties: true type: object - type: 'null' title: Feedback Stats group_key: anyOf: - type: string - type: integer - type: number title: Group Key sessions: items: $ref: '#/components/schemas/GroupedRunsSessionStats' type: array title: Sessions examples: items: $ref: '#/components/schemas/ExampleWithRunsCH' type: array title: Examples example_count: type: integer title: Example Count prompt_tokens: anyOf: - type: integer - type: 'null' title: Prompt Tokens completion_tokens: anyOf: - type: integer - type: 'null' title: Completion Tokens prompt_cost: anyOf: - type: string - type: 'null' title: Prompt Cost completion_cost: anyOf: - type: string - type: 'null' title: Completion Cost error_rate: anyOf: - type: number - type: 'null' title: Error Rate type: object required: - filter - group_key - sessions - examples - example_count title: ExampleGroupWithSessions description: "Group of examples with a specific metadata value across multiple sessions.\n\nExtends RunGroupBase with:\n- group_key: metadata value that defines this group\n- sessions: per-session stats for runs matching this metadata value\n- examples: shared examples across all sessions (intersection logic)\n with flat array of runs (each run has session_id field for frontend to determine column)\n- example_count: unique example count (pagination-aware, same across all sessions due to intersection)\n\nInherited from RunGroupBase:\n- filter: metadata filter for this group (e.g., \"and(eq(is_root, true), and(eq(metadata_key, 'model'), eq(metadata_value, 'gpt-4')))\")\n- count: total run count across all sessions (includes duplicate runs)\n- total_tokens, total_cost: aggregate across sessions\n- min_start_time, max_start_time: time range across sessions\n- latency_p50, latency_p99: aggregate latency stats across sessions\n- feedback_stats: weighted average feedback across sessions\n\nAdditional aggregate stats:\n- prompt_tokens, completion_tokens: separate token counts\n- prompt_cost, completion_cost: separate costs\n- error_rate: average error rate" QueryFeedbackDeltaBatch: properties: baseline_session_id: type: string format: uuid title: Baseline Session Id comparison_session_ids: items: type: string format: uuid type: array maxItems: 10 minItems: 1 title: Comparison Session Ids feedback_keys: items: type: string type: array maxItems: 100 minItems: 1 title: Feedback Keys filters: anyOf: - additionalProperties: items: type: string type: array propertyNames: format: uuid type: object - type: 'null' title: Filters type: object required: - baseline_session_id - comparison_session_ids - feedback_keys title: QueryFeedbackDeltaBatch description: Request schema for batched feedback delta queries with multiple feedback keys. GetDatasetsSelect: type: string enum: - example_count title: GetDatasetsSelect RunTypeEnum: type: string enum: - tool - chain - llm - retriever - embedding - prompt - parser title: RunTypeEnum description: Enum for run types. ComparativeExperimentCreate: properties: id: type: string format: uuid title: Id experiment_ids: items: type: string format: uuid type: array title: Experiment Ids name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description created_at: type: string format: date-time title: Created At modified_at: type: string format: date-time title: Modified At reference_dataset_id: anyOf: - type: string format: uuid - type: 'null' title: Reference Dataset Id extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra type: object required: - experiment_ids title: ComparativeExperimentCreate description: Create class for ComparativeExperiment. RunnableConfig: properties: tags: items: type: string type: array title: Tags metadata: additionalProperties: true type: object title: Metadata callbacks: anyOf: - items: {} type: array - {} - type: 'null' title: Callbacks run_name: type: string title: Run Name max_concurrency: anyOf: - type: integer - type: 'null' title: Max Concurrency recursion_limit: type: integer title: Recursion Limit configurable: additionalProperties: true type: object title: Configurable run_id: anyOf: - type: string format: uuid - type: 'null' title: Run Id type: object title: RunnableConfig description: "Configuration for a `Runnable`.\n\n!!! note Custom values\n\n The `TypedDict` has `total=False` set intentionally to:\n\n - Allow partial configs to be created and merged together via `merge_configs`\n - Support config propagation from parent to child runnables via\n `var_child_runnable_config` (a `ContextVar` that automatically passes\n config down the call stack without explicit parameter passing), where\n configs are merged rather than replaced\n\n !!! example\n\n ```python\n # Parent sets tags\n chain.invoke(input, config={\"tags\": [\"parent\"]})\n # Child automatically inherits and can add:\n # ensure_config({\"tags\": [\"child\"]}) -> {\"tags\": [\"parent\", \"child\"]}\n ```" AttachmentsOperations: properties: rename: additionalProperties: type: string type: object title: Rename description: Mapping of old attachment names to new names retain: items: type: string type: array title: Retain description: List of attachment names to keep type: object title: AttachmentsOperations ComparativeExperimentBase: properties: id: type: string format: uuid title: Id name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description tenant_id: type: string format: uuid title: Tenant Id created_at: type: string format: date-time title: Created At modified_at: type: string format: date-time title: Modified At reference_dataset_id: type: string format: uuid title: Reference Dataset Id extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra type: object required: - id - tenant_id - created_at - modified_at - reference_dataset_id title: ComparativeExperimentBase description: ComparativeExperiment schema. DatasetDiffInfo: properties: examples_modified: items: type: string format: uuid type: array title: Examples Modified examples_added: items: type: string format: uuid type: array title: Examples Added examples_removed: items: type: string format: uuid type: array title: Examples Removed type: object required: - examples_modified - examples_added - examples_removed title: DatasetDiffInfo description: Dataset diff schema. GroupExampleRunsByField: type: string enum: - run_metadata - example_metadata title: GroupExampleRunsByField DatasetSchemaForUpdate: properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description created_at: type: string format: date-time title: Created At inputs_schema_definition: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs Schema Definition outputs_schema_definition: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs Schema Definition externally_managed: anyOf: - type: boolean - type: 'null' title: Externally Managed default: false transformations: anyOf: - items: $ref: '#/components/schemas/DatasetTransformation' type: array - type: 'null' title: Transformations data_type: anyOf: - $ref: '#/components/schemas/DataType' - type: 'null' default: kv id: type: string format: uuid title: Id tenant_id: type: string format: uuid title: Tenant Id type: object required: - name - id - tenant_id title: DatasetSchemaForUpdate RunnerContextEnum: type: string enum: - langsmith_ui - langsmith_align_evals title: RunnerContextEnum FeedbackType: type: string enum: - continuous - categorical - freeform title: FeedbackType description: Enum for feedback types. APIFeedbackSource: properties: type: type: string const: api title: Type default: api metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object title: APIFeedbackSource description: API feedback source. Body_clone_dataset_api_v1_datasets_clone_post: properties: target_dataset_id: type: string format: uuid title: Target Dataset Id source_dataset_id: type: string format: uuid title: Source Dataset Id as_of: anyOf: - anyOf: - type: string format: date-time - type: string description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used. - type: 'null' title: As Of examples: items: type: string format: uuid type: array title: Examples default: [] split: anyOf: - type: string - items: type: string type: array - type: 'null' title: Split type: object required: - target_dataset_id - source_dataset_id title: Body_clone_dataset_api_v1_datasets_clone_post Missing: properties: __missing__: type: string const: __missing__ title: Missing type: object required: - __missing__ title: Missing FeedbackSource: properties: type: anyOf: - type: string - type: 'null' title: Type metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata user_id: anyOf: - type: string format: uuid - type: 'null' title: User Id ls_user_id: anyOf: - type: string format: uuid - type: 'null' title: Ls User Id user_name: anyOf: - type: string - type: 'null' title: User Name type: object title: FeedbackSource description: The feedback source loaded from the database. SortByComparativeExperimentColumn: type: string enum: - name - created_at title: SortByComparativeExperimentColumn description: Enum for available comparative experiment columns to sort by. ExampleUpdate: properties: dataset_id: anyOf: - type: string format: uuid - type: 'null' title: Dataset Id inputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs outputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs attachments_operations: anyOf: - $ref: '#/components/schemas/AttachmentsOperations' - type: 'null' metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata split: anyOf: - items: type: string type: array - type: string - type: 'null' title: Split overwrite: type: boolean title: Overwrite default: false type: object title: ExampleUpdate description: Update class for Example. GroupedExperimentsRequest: properties: stats_start_time: anyOf: - type: string format: date-time - type: 'null' title: Stats Start Time name_contains: anyOf: - type: string - type: 'null' title: Name Contains tag_value_id: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Tag Value Id dataset_version: anyOf: - type: string - type: 'null' title: Dataset Version filter: anyOf: - type: string - type: 'null' title: Filter use_approx_stats: type: boolean title: Use Approx Stats default: false metadata_keys: items: type: string type: array maxItems: 4 minItems: 1 title: Metadata Keys experiment_limit: type: integer maximum: 1000.0 minimum: 1.0 title: Experiment Limit default: 1000 type: object required: - metadata_keys title: GroupedExperimentsRequest description: Schema for grouped experiment (tracer session) query. FeedbackConfig: properties: type: $ref: '#/components/schemas/FeedbackType' min: anyOf: - type: number - type: 'null' title: Min max: anyOf: - type: number - type: 'null' title: Max categories: anyOf: - items: $ref: '#/components/schemas/FeedbackCategory' type: array - type: 'null' title: Categories type: object required: - type title: FeedbackConfig ExampleWithRunsCH: properties: outputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs dataset_id: type: string format: uuid title: Dataset Id source_run_id: anyOf: - type: string format: uuid - type: 'null' title: Source Run Id metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata inputs: additionalProperties: true type: object title: Inputs created_at: type: string format: date-time title: Created At id: type: string format: uuid title: Id name: type: string title: Name modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At attachment_urls: anyOf: - additionalProperties: true type: object - type: 'null' title: Attachment Urls runs: items: $ref: '#/components/schemas/RunSchemaComparisonView' type: array title: Runs type: object required: - dataset_id - inputs - id - name - runs title: ExampleWithRunsCH description: 'Example schema with list of runs from ClickHouse. For non-grouped endpoint (/datasets/{dataset_id}/runs): runs from single session. For grouped endpoint (/datasets/{dataset_id}/group/runs): flat array of runs from all sessions, where each run has a session_id field for frontend to determine column placement.' securitySchemes: API Key: type: apiKey in: header name: X-API-Key Tenant ID: type: apiKey in: header name: X-Tenant-Id Bearer Auth: type: http description: Bearer tokens are used to authenticate from the UI. Must also specify x-tenant-id or x-organization-id (for org scoped apis). scheme: bearer Organization ID: type: apiKey in: header name: X-Organization-Id