Files
sdk/docs/DatasetsApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

12 KiB

DatasetsApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
consoleCreateDataset POST /v1/console/datasets Create a dataset
consoleDeleteDatasetRun DELETE /v1/console/datasets/{datasetName}/runs/{runName} Delete a dataset run and all its run items
consoleGetDataset GET /v1/console/datasets/{datasetName} Get a dataset by name
consoleGetDatasetRun GET /v1/console/datasets/{datasetName}/runs/{runName} Get a dataset run and its items
consoleListDatasetRuns GET /v1/console/datasets/{datasetName}/runs Get dataset runs
consoleListDatasets GET /v1/console/datasets Get all datasets
evalsPostV1EvalsDatasetItems POST /v1/evals/dataset-items Add an item (input + optional expected output) to a dataset
evalsPostV1EvalsDatasets POST /v1/evals/datasets Create a dataset

consoleCreateDataset

ConsoleDataset consoleCreateDataset(consoleCreateDatasetRequest)

Create a dataset

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DatasetsApi()
val consoleCreateDatasetRequest : ConsoleCreateDatasetRequest =  // ConsoleCreateDatasetRequest | 
try {
    val result : ConsoleDataset = apiInstance.consoleCreateDataset(consoleCreateDatasetRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DatasetsApi#consoleCreateDataset")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DatasetsApi#consoleCreateDataset")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
consoleCreateDatasetRequest ConsoleCreateDatasetRequest

Return type

ConsoleDataset

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

consoleDeleteDatasetRun

ConsoleDeleteDatasetItem200Response consoleDeleteDatasetRun(datasetName, runName)

Delete a dataset run and all its run items

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DatasetsApi()
val datasetName : kotlin.String = datasetName_example // kotlin.String | 
val runName : kotlin.String = runName_example // kotlin.String | 
try {
    val result : ConsoleDeleteDatasetItem200Response = apiInstance.consoleDeleteDatasetRun(datasetName, runName)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DatasetsApi#consoleDeleteDatasetRun")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DatasetsApi#consoleDeleteDatasetRun")
    e.printStackTrace()
}

Parameters

| datasetName | kotlin.String| | |

Name Type Description Notes
runName kotlin.String

Return type

ConsoleDeleteDatasetItem200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

consoleGetDataset

ConsoleDataset consoleGetDataset(datasetName)

Get a dataset by name

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DatasetsApi()
val datasetName : kotlin.String = datasetName_example // kotlin.String | 
try {
    val result : ConsoleDataset = apiInstance.consoleGetDataset(datasetName)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DatasetsApi#consoleGetDataset")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DatasetsApi#consoleGetDataset")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
datasetName kotlin.String

Return type

ConsoleDataset

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

consoleGetDatasetRun

ConsoleGetDatasetRun200Response consoleGetDatasetRun(datasetName, runName)

Get a dataset run and its items

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DatasetsApi()
val datasetName : kotlin.String = datasetName_example // kotlin.String | 
val runName : kotlin.String = runName_example // kotlin.String | 
try {
    val result : ConsoleGetDatasetRun200Response = apiInstance.consoleGetDatasetRun(datasetName, runName)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DatasetsApi#consoleGetDatasetRun")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DatasetsApi#consoleGetDatasetRun")
    e.printStackTrace()
}

Parameters

| datasetName | kotlin.String| | |

Name Type Description Notes
runName kotlin.String

Return type

ConsoleGetDatasetRun200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

consoleListDatasetRuns

ConsoleListDatasetRuns200Response consoleListDatasetRuns(datasetName, page, limit)

Get dataset runs

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DatasetsApi()
val datasetName : kotlin.String = datasetName_example // kotlin.String | 
val page : kotlin.Int = 56 // kotlin.Int | 
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : ConsoleListDatasetRuns200Response = apiInstance.consoleListDatasetRuns(datasetName, page, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DatasetsApi#consoleListDatasetRuns")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DatasetsApi#consoleListDatasetRuns")
    e.printStackTrace()
}

Parameters

| datasetName | kotlin.String| | | | page | kotlin.Int| | [optional] |

Name Type Description Notes
limit kotlin.Int [optional]

Return type

ConsoleListDatasetRuns200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

consoleListDatasets

ConsoleListDatasets200Response consoleListDatasets(page, limit)

Get all datasets

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DatasetsApi()
val page : kotlin.Int = 56 // kotlin.Int | 
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : ConsoleListDatasets200Response = apiInstance.consoleListDatasets(page, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DatasetsApi#consoleListDatasets")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DatasetsApi#consoleListDatasets")
    e.printStackTrace()
}

Parameters

| page | kotlin.Int| | [optional] |

Name Type Description Notes
limit kotlin.Int [optional]

Return type

ConsoleListDatasets200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

evalsPostV1EvalsDatasetItems

EvalsDatasetItem evalsPostV1EvalsDatasetItems(evalsDatasetItemCreate)

Add an item (input + optional expected output) to a dataset

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DatasetsApi()
val evalsDatasetItemCreate : EvalsDatasetItemCreate =  // EvalsDatasetItemCreate | 
try {
    val result : EvalsDatasetItem = apiInstance.evalsPostV1EvalsDatasetItems(evalsDatasetItemCreate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DatasetsApi#evalsPostV1EvalsDatasetItems")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DatasetsApi#evalsPostV1EvalsDatasetItems")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
evalsDatasetItemCreate EvalsDatasetItemCreate

Return type

EvalsDatasetItem

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

evalsPostV1EvalsDatasets

EvalsDataset evalsPostV1EvalsDatasets(evalsDatasetCreate)

Create a dataset

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DatasetsApi()
val evalsDatasetCreate : EvalsDatasetCreate =  // EvalsDatasetCreate | 
try {
    val result : EvalsDataset = apiInstance.evalsPostV1EvalsDatasets(evalsDatasetCreate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DatasetsApi#evalsPostV1EvalsDatasets")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DatasetsApi#evalsPostV1EvalsDatasets")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
evalsDatasetCreate EvalsDatasetCreate

Return type

EvalsDataset

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json