honeyhive 1.0.19 → 1.0.21

package/dist/models/components/dataset.d.ts

@@ -0,0 +1,58 @@
+import { SpeakeasyBase } from "../../internal/utils";
+/**
+ * What the dataset is to be used for - "evaluation" or "fine-tuning"
+ */
+export declare enum DatasetType {
+    Evaluation = "evaluation",
+    FineTuning = "fine-tuning"
+}
+/**
+ * The type of data included in the dataset - "event" (default) or "session"
+ */
+export declare enum PipelineType {
+    Event = "event",
+    Session = "session"
+}
+export declare class Dataset extends SpeakeasyBase {
+    /**
+     * UUID of the project associated with this dataset
+     */
+    project?: string;
+    /**
+     * Name of the dataset
+     */
+    name?: string;
+    /**
+     * A description for the dataset
+     */
+    description?: string;
+    /**
+     * What the dataset is to be used for - "evaluation" or "fine-tuning"
+     */
+    type?: DatasetType;
+    /**
+     * List of unique datapoint ids to be included in this dataset
+     */
+    datapoints?: string[];
+    /**
+     * Number of datapoints included in the dataset
+     */
+    numPoints?: number;
+    linkedEvals?: string[];
+    /**
+     * Whether the dataset has been saved or detected
+     */
+    saved?: boolean;
+    /**
+     * The type of data included in the dataset - "event" (default) or "session"
+     */
+    pipelineType?: PipelineType;
+    /**
+     * Timestamp of when the dataset was created
+     */
+    createdAt?: Date;
+    /**
+     * Timestamp of when the dataset was last updated
+     */
+    updatedAt?: Date;
+}

package/dist/models/components/dataset.js

@@ -0,0 +1,119 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dataset = exports.PipelineType = exports.DatasetType = void 0;
+var utils_1 = require("../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+/**
+ * What the dataset is to be used for - "evaluation" or "fine-tuning"
+ */
+var DatasetType;
+(function (DatasetType) {
+    DatasetType["Evaluation"] = "evaluation";
+    DatasetType["FineTuning"] = "fine-tuning";
+})(DatasetType = exports.DatasetType || (exports.DatasetType = {}));
+/**
+ * The type of data included in the dataset - "event" (default) or "session"
+ */
+var PipelineType;
+(function (PipelineType) {
+    PipelineType["Event"] = "event";
+    PipelineType["Session"] = "session";
+})(PipelineType = exports.PipelineType || (exports.PipelineType = {}));
+var Dataset = /** @class */ (function (_super) {
+    __extends(Dataset, _super);
+    function Dataset() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "project" }),
+        __metadata("design:type", String)
+    ], Dataset.prototype, "project", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "name" }),
+        __metadata("design:type", String)
+    ], Dataset.prototype, "name", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "description" }),
+        __metadata("design:type", String)
+    ], Dataset.prototype, "description", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "type" }),
+        __metadata("design:type", String)
+    ], Dataset.prototype, "type", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "datapoints" }),
+        __metadata("design:type", Array)
+    ], Dataset.prototype, "datapoints", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "num_points" }),
+        __metadata("design:type", Number)
+    ], Dataset.prototype, "numPoints", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "linked_evals" }),
+        __metadata("design:type", Array)
+    ], Dataset.prototype, "linkedEvals", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "saved" }),
+        __metadata("design:type", Boolean)
+    ], Dataset.prototype, "saved", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "pipeline_type" }),
+        __metadata("design:type", String)
+    ], Dataset.prototype, "pipelineType", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "created_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Dataset.prototype, "createdAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "updated_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Dataset.prototype, "updatedAt", void 0);
+    return Dataset;
+}(utils_1.SpeakeasyBase));
+exports.Dataset = Dataset;

package/dist/models/components/datasetupdate.d.ts

@@ -0,0 +1,27 @@
+import { SpeakeasyBase } from "../../internal/utils";
+export declare class DatasetUpdate extends SpeakeasyBase {
+    /**
+     * The unique identifier of the dataset being updated
+     */
+    datasetId: string;
+    /**
+     * Updated name for the dataset
+     */
+    name?: string;
+    /**
+     * Updated description for the dataset
+     */
+    description?: string;
+    /**
+     * Updated list of datapoint ids for the dataset - note the full list is needed
+     */
+    datapoints?: string[];
+    /**
+     * Updated list of unique evaluation run ids to be associated with this dataset
+     */
+    linkedEvals?: string[];
+    /**
+     * Updated metadata to track for the dataset
+     */
+    metadata?: Record<string, any>;
+}

package/dist/models/components/datasetupdate.js

@@ -0,0 +1,70 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatasetUpdate = void 0;
+var utils_1 = require("../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+var DatasetUpdate = /** @class */ (function (_super) {
+    __extends(DatasetUpdate, _super);
+    function DatasetUpdate() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "dataset_id" }),
+        __metadata("design:type", String)
+    ], DatasetUpdate.prototype, "datasetId", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "name" }),
+        __metadata("design:type", String)
+    ], DatasetUpdate.prototype, "name", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "description" }),
+        __metadata("design:type", String)
+    ], DatasetUpdate.prototype, "description", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "datapoints" }),
+        __metadata("design:type", Array)
+    ], DatasetUpdate.prototype, "datapoints", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "linked_evals" }),
+        __metadata("design:type", Array)
+    ], DatasetUpdate.prototype, "linkedEvals", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "metadata" }),
+        __metadata("design:type", Object)
+    ], DatasetUpdate.prototype, "metadata", void 0);
+    return DatasetUpdate;
+}(utils_1.SpeakeasyBase));
+exports.DatasetUpdate = DatasetUpdate;

package/dist/models/components/deleterunresponse.d.ts

@@ -0,0 +1,5 @@
+import { SpeakeasyBase } from "../../internal/utils";
+export declare class DeleteRunResponse extends SpeakeasyBase {
+    id?: string;
+    deleted?: boolean;
+}

package/dist/models/components/deleterunresponse.js

@@ -0,0 +1,50 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteRunResponse = void 0;
+var utils_1 = require("../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+var DeleteRunResponse = /** @class */ (function (_super) {
+    __extends(DeleteRunResponse, _super);
+    function DeleteRunResponse() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], DeleteRunResponse.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "deleted" }),
+        __metadata("design:type", Boolean)
+    ], DeleteRunResponse.prototype, "deleted", void 0);
+    return DeleteRunResponse;
+}(utils_1.SpeakeasyBase));
+exports.DeleteRunResponse = DeleteRunResponse;

package/dist/models/components/evaluationrun.d.ts

@@ -0,0 +1,50 @@
+import { SpeakeasyBase } from "../../internal/utils";
+/**
+ * The results of the evaluation (including pass/fails and metric aggregations)
+ */
+export declare class Results extends SpeakeasyBase {
+}
+export declare enum EvaluationRunStatus {
+    Pending = "pending",
+    Completed = "completed"
+}
+export declare class EvaluationRun extends SpeakeasyBase {
+    runId?: string;
+    /**
+     * The UUID of the project this run is associated with
+     */
+    project?: string;
+    /**
+     * The date and time the run was created
+     */
+    createdAt?: Date;
+    /**
+     * The UUIDs of the sessions/events this run is associated with
+     */
+    eventIds?: string[];
+    /**
+     * The UUID of the dataset this run is associated with
+     */
+    datasetId?: string;
+    /**
+     * The UUIDs of the datapoints from the original dataset this run is associated with
+     */
+    datapointIds?: string[];
+    /**
+     * The results of the evaluation (including pass/fails and metric aggregations)
+     */
+    results?: Results;
+    /**
+     * The configuration being used for this run
+     */
+    configuration?: Record<string, any>;
+    /**
+     * Additional metadata for the run
+     */
+    metadata?: Record<string, any>;
+    status?: EvaluationRunStatus;
+    /**
+     * The name of the run to be displayed
+     */
+    name?: string;
+}

package/dist/models/components/evaluationrun.js

@@ -0,0 +1,116 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EvaluationRun = exports.EvaluationRunStatus = exports.Results = void 0;
+var utils_1 = require("../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+/**
+ * The results of the evaluation (including pass/fails and metric aggregations)
+ */
+var Results = /** @class */ (function (_super) {
+    __extends(Results, _super);
+    function Results() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return Results;
+}(utils_1.SpeakeasyBase));
+exports.Results = Results;
+var EvaluationRunStatus;
+(function (EvaluationRunStatus) {
+    EvaluationRunStatus["Pending"] = "pending";
+    EvaluationRunStatus["Completed"] = "completed";
+})(EvaluationRunStatus = exports.EvaluationRunStatus || (exports.EvaluationRunStatus = {}));
+var EvaluationRun = /** @class */ (function (_super) {
+    __extends(EvaluationRun, _super);
+    function EvaluationRun() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "run_id" }),
+        __metadata("design:type", String)
+    ], EvaluationRun.prototype, "runId", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "project" }),
+        __metadata("design:type", String)
+    ], EvaluationRun.prototype, "project", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "created_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], EvaluationRun.prototype, "createdAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "event_ids" }),
+        __metadata("design:type", Array)
+    ], EvaluationRun.prototype, "eventIds", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "dataset_id" }),
+        __metadata("design:type", String)
+    ], EvaluationRun.prototype, "datasetId", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "datapoint_ids" }),
+        __metadata("design:type", Array)
+    ], EvaluationRun.prototype, "datapointIds", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "results" }),
+        (0, class_transformer_1.Type)(function () { return Results; }),
+        __metadata("design:type", Results)
+    ], EvaluationRun.prototype, "results", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "configuration" }),
+        __metadata("design:type", Object)
+    ], EvaluationRun.prototype, "configuration", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "metadata" }),
+        __metadata("design:type", Object)
+    ], EvaluationRun.prototype, "metadata", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "status" }),
+        __metadata("design:type", String)
+    ], EvaluationRun.prototype, "status", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "name" }),
+        __metadata("design:type", String)
+    ], EvaluationRun.prototype, "name", void 0);
+    return EvaluationRun;
+}(utils_1.SpeakeasyBase));
+exports.EvaluationRun = EvaluationRun;

package/dist/models/components/event.d.ts

@@ -0,0 +1,88 @@
+import { SpeakeasyBase } from "../../internal/utils";
+/**
+ * Specify whether the event is of "session", "model", "tool" or "chain" type
+ */
+export declare enum EventType {
+    Session = "session",
+    Model = "model",
+    Tool = "tool",
+    Chain = "chain"
+}
+export declare class Event extends SpeakeasyBase {
+    /**
+     * Name of project associated with the event
+     */
+    projectId?: string;
+    /**
+     * Source of the event - production, staging, etc
+     */
+    source?: string;
+    /**
+     * Name of the event
+     */
+    eventName?: string;
+    /**
+     * Specify whether the event is of "session", "model", "tool" or "chain" type
+     */
+    eventType?: EventType;
+    /**
+     * Unique id of the event, if not set, it will be auto-generated
+     */
+    eventId?: string;
+    /**
+     * Unique id of the session associated with the event, if not set, it will be auto-generated
+     */
+    sessionId?: string;
+    /**
+     * Id of the parent event if nested
+     */
+    parentId?: string;
+    /**
+     * Id of events that are nested within the event
+     */
+    childrenIds?: string[];
+    /**
+     * Associated configuration JSON for the event - model name, vector index name, etc
+     */
+    config?: Record<string, any>;
+    /**
+     * Input JSON given to the event - prompt, chunks, etc
+     */
+    inputs?: Record<string, any>;
+    /**
+     * Final output JSON of the event
+     */
+    outputs?: Record<string, any>;
+    /**
+     * Any error description if event failed
+     */
+    error?: string;
+    /**
+     * UTC timestamp (in milliseconds) for the event start
+     */
+    startTime?: number;
+    /**
+     * UTC timestamp (in milliseconds) for the event end
+     */
+    endTime?: number;
+    /**
+     * How long the event took in milliseconds
+     */
+    duration?: number;
+    /**
+     * Any system or application metadata associated with the event
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Any user feedback provided for the event output
+     */
+    feedback?: Record<string, any>;
+    /**
+     * Any values computed over the output of the event
+     */
+    metrics?: Record<string, any>;
+    /**
+     * Any user properties associated with the event
+     */
+    userProperties?: Record<string, any>;
+}