Skip to content

Latest commit

 

History

History
275 lines (203 loc) · 12.5 KB

README.md

File metadata and controls

275 lines (203 loc) · 12.5 KB
Raw

Datasets

(datasets)

Available Operations

getDatasets

Get datasets

Example Usage

import { HoneyHive } from "honeyhive";
import { GetDatasetsRequest, TypeT } from "honeyhive/dist/models/operations";

async function run() {
  const sdk = new HoneyHive({
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  });
const project: string = "<value>";
const type: TypeT = TypeT.Evaluation;
const datasetId: string = "<value>";

  const res = await sdk.datasets.getDatasets(project, type, datasetId);

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
project string ✔️ Project Name associated with the datasets like New Project
type operations.TypeT ➖ Type of the dataset - "evaluation" or "fine-tuning"
datasetId string ➖ Unique dataset ID for filtering specific dataset like 663876ec4611c47f4970f0c3
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetDatasetsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

createDataset

Create a dataset

Example Usage

import { HoneyHive } from "honeyhive";
import { CreateDatasetRequestPipelineType, CreateDatasetRequestType } from "honeyhive/dist/models/components";

async function run() {
  const sdk = new HoneyHive({
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  });

  const res = await sdk.datasets.createDataset({
    project: "New Project",
    name: "test-dataset",
    description: "A test dataset",
    type: CreateDatasetRequestType.Evaluation,
    datapoints: [
      "66369748b5773befbdc661e2",
    ],
    linkedEvals: [
      "<value>",
    ],
    saved: false,
    pipelineType: CreateDatasetRequestPipelineType.Event,
    metadata: {
      "source": "dev",
    },
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request components.CreateDatasetRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.CreateDatasetResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

updateDataset

Update a dataset

Example Usage

import { HoneyHive } from "honeyhive";

async function run() {
  const sdk = new HoneyHive({
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  });

  const res = await sdk.datasets.updateDataset({
    datasetId: "663876ec4611c47f4970f0c3",
    name: "new-dataset-name",
    description: "An updated dataset description",
    datapoints: [
      "66369748b5773befbdc661e",
    ],
    linkedEvals: [
      "66369748b5773befbdasdk1",
    ],
    metadata: {
      "updated": true,
      "source": "prod",
    },
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request components.DatasetUpdate ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.UpdateDatasetResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteDataset

Delete a dataset

Example Usage

import { HoneyHive } from "honeyhive";
import { DeleteDatasetRequest } from "honeyhive/dist/models/operations";

async function run() {
  const sdk = new HoneyHive({
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  });
const datasetId: string = "<value>";

  const res = await sdk.datasets.deleteDataset(datasetId);

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
datasetId string ✔️ The unique identifier of the dataset to be deleted like 663876ec4611c47f4970f0c3
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.DeleteDatasetResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

addDatapoints

Add datapoints to a dataset

Example Usage

import { HoneyHive } from "honeyhive";
import { AddDatapointsRequest, AddDatapointsRequestBody, Mapping } from "honeyhive/dist/models/operations";

async function run() {
  const sdk = new HoneyHive({
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  });
const datasetId: string = "<value>";
const requestBody: AddDatapointsRequestBody = {
  data: [
    {
      "key": "<value>",
    },
  ],
  mapping: {
    inputs: [
      "<value>",
    ],
    groundTruth: [
      "<value>",
    ],
    history: [
      "<value>",
    ],
  },
};

  const res = await sdk.datasets.addDatapoints(datasetId, requestBody);

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
datasetId string ✔️ The unique identifier of the dataset to add datapoints to like 663876ec4611c47f4970f0c3
requestBody operations.AddDatapointsRequestBody ✔️ N/A
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.AddDatapointsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /