Get dataset by name | Opik Documentation

curl -X POST http://localhost:5173/api/v1/private/datasets/retrieve \
     -H "Content-Type: application/json" \
     -d '{
  "dataset_name": "string"
}'

{
  "name": "string",
  "id": "string",
  "type": "dataset",
  "visibility": "private",
  "tags": [
    "string"
  ],
  "description": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string",
  "experiment_count": 1,
  "dataset_items_count": 1,
  "optimization_count": 1,
  "most_recent_experiment_at": "2024-01-15T09:30:00Z",
  "last_created_experiment_at": "2024-01-15T09:30:00Z",
  "most_recent_optimization_at": "2024-01-15T09:30:00Z",
  "last_created_optimization_at": "2024-01-15T09:30:00Z",
  "status": "unknown",
  "latest_version": {
    "id": "string",
    "version_hash": "string",
    "version_name": "string",
    "change_description": "string",
    "tags": [
      "string"
    ]
  }
}

Get dataset by name

Request

This endpoint expects an object.

dataset_namestringRequired>=1 character

Response

Dataset resource

namestring>=1 character

idstring or nullformat: "uuid"

typeenum or null

Allowed values:

visibilityenum or null

Allowed values:

tagslist of strings or null

descriptionstring or nullformat: "(?s)^\s*(\S.*\S|\S)\s*$"0-255 characters

created_atstring or nullRead-onlyformat: "date-time"

created_bystring or nullRead-only

last_updated_atstring or nullRead-onlyformat: "date-time"

last_updated_bystring or nullRead-only

experiment_countlong or nullRead-only

dataset_items_countlong or nullRead-only

optimization_countlong or nullRead-only

most_recent_experiment_atstring or nullRead-onlyformat: "date-time"

last_created_experiment_atstring or nullRead-onlyformat: "date-time"

most_recent_optimization_atstring or nullRead-onlyformat: "date-time"

last_created_optimization_atstring or nullRead-onlyformat: "date-time"

statusenum or nullRead-only

Allowed values:

latest_versionobject or nullRead-only

Summary of the latest dataset version