LAlangchain-ai
datasets

Read Examples With Runs

Changed on

Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids.

post/api/v1/datasets/{dataset_id}/runs

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/datasets/{dataset_id}/runs
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

dataset_idstring uuid required

Query parameters

format'csv' nullable

Response format, e.g., 'csv'

Request body

session_idsstring[] required
offsetinteger
limitinteger nullable
previewboolean
comparative_experiment_idstring uuid nullable
filtersobject nullable
example_idsstring[] nullable
include_annotator_detailboolean

Response

Successful Response

outputsobject nullable
dataset_idstring uuid required
source_run_idstring uuid nullable
source_session_idstring uuid nullable
source_run_start_timestring date-time nullable
source_trace_idstring uuid nullable
metadataobject nullable
inputsobject required
created_atstring date-time
idstring uuid required
namestring required
modified_atstring date-time nullable
source_thread_idstring nullable
attachment_urlsobject nullable

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      endpoint deprecated

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the ///// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the ///// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the ///// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

  • f5481e770416Revision changes
    • warning

      removed the request property