examples

Hard Delete Examples

Changed on

This endpoint hard deletes all versions of a dataset example(s). Deletion is performed by setting inputs, outputs, and metadata to null and deleting attachment files while keeping the example ID, dataset ID, and creation timestamp. IMPORTANT: attachment files can take up to 7 days to be deleted. inputs, outputs and metadata are nullified immediately.

post/api/v1/platform/datasets/examples/delete

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/platform/datasets/examples/delete
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Request body

example_idsstring[] required

ExampleIDs is a list of UUIDs identifying the examples to delete.

hard_deleteboolean required

HardDelete indicates whether to perform a hard delete. Currently only True is supported.

Response

OK

countinteger
example_idsstring[]

Example response

{
  "count": 1,
  "example_ids": [
    "[\"123e4567-e89b-12d3-a456-426614174000\"]"
  ]
}

Changes