hume 0.7.1 → 0.8.0

package/.mock/definition/custom-models/models.yml

@@ -1,303 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list-models:
-      path: /v0/registry/models
-      method: GET
-      auth: true
-      docs: Returns 200 if successful
-      display-name: List models
-      request:
-        name: ModelsListModelsRequest
-        query-parameters:
-          name:
-            type: optional<string>
-            docs: Model name to be queried
-          page_number:
-            type: optional<integer>
-            docs: Index of the first result
-          page_size:
-            type: optional<integer>
-            docs: Maximum number of results
-          shared_assets:
-            type: optional<boolean>
-            docs: >-
-              `True` Will show all assets owned by you and shared with you.
-              `False` Will show only your assets. Default: `False`
-      response:
-        docs: Success
-        type: root.ModelPage
-      examples:
-        - response:
-            body:
-              content:
-                - id: id
-                  name: name
-                  created_on: 1
-                  modified_on: 1
-                  total_stars: 1
-                  model_is_starred_by_user: true
-                  archived: true
-                  latest_version:
-                    id: id
-                    model_id: model_id
-                    user_id: user_id
-                    version: version
-                    source_uri: source_uri
-                    dataset_version_id: dataset_version_id
-                    created_on: 1
-                  is_publicly_shared: true
-              pageable:
-                offset: 1
-                sort:
-                  empty: true
-                  sorted: true
-                  unsorted: true
-                paged: true
-                unpaged: true
-                page_number: 1
-                page_size: 1
-              total: 1
-              last: true
-              total_elements: 1
-              total_pages: 1
-              size: 1
-              number: 1
-              sort:
-                empty: true
-                sorted: true
-                unsorted: true
-              first: true
-              number_of_elements: 1
-              empty: true
-    get-model-details:
-      path: /v0/registry/models/{id}
-      method: GET
-      auth: true
-      docs: Returns 200 if successful
-      path-parameters:
-        id:
-          type: string
-          docs: Hume-generated ID of a Model
-      display-name: Get model details
-      response:
-        docs: Success
-        type: root.ExternalModel
-      examples:
-        - path-parameters:
-            id: id
-          response:
-            body:
-              id: id
-              name: name
-              created_on: 1
-              modified_on: 1
-              total_stars: 1
-              model_is_starred_by_user: true
-              archived: true
-              latest_version:
-                id: id
-                model_id: model_id
-                user_id: user_id
-                version: version
-                source_uri: source_uri
-                dataset_version_id: dataset_version_id
-                created_on: 1
-                metadata:
-                  metadata: {}
-                description: description
-                tags:
-                  - key: key
-                    value: value
-                file_type: video
-                target_feature: target_feature
-                task_type: task_type
-                training_job_id: training_job_id
-              is_publicly_shared: true
-    update-model-name:
-      path: /v0/registry/models/{id}
-      method: PATCH
-      auth: true
-      docs: Returns 200 if successful
-      path-parameters:
-        id:
-          type: string
-          docs: Hume-generated ID of a Model
-      display-name: Update model name
-      request:
-        name: ModelsUpdateModelNameRequest
-        query-parameters:
-          name:
-            type: string
-            docs: New Model name
-      response:
-        docs: Success
-        type: root.ExternalModel
-      examples:
-        - path-parameters:
-            id: id
-          query-parameters:
-            name: name
-          response:
-            body:
-              id: id
-              name: name
-              created_on: 1
-              modified_on: 1
-              total_stars: 1
-              model_is_starred_by_user: true
-              archived: true
-              latest_version:
-                id: id
-                model_id: model_id
-                user_id: user_id
-                version: version
-                source_uri: source_uri
-                dataset_version_id: dataset_version_id
-                created_on: 1
-                metadata:
-                  metadata: {}
-                description: description
-                tags:
-                  - key: key
-                    value: value
-                file_type: video
-                target_feature: target_feature
-                task_type: task_type
-                training_job_id: training_job_id
-              is_publicly_shared: true
-    list-model-versions:
-      path: /v0/registry/models/version
-      method: GET
-      auth: true
-      docs: Returns 200 if successful
-      display-name: List model versions
-      request:
-        name: ModelsListModelVersionsRequest
-        query-parameters:
-          id:
-            type: optional<string>
-            allow-multiple: true
-            docs: Hume-generated Model Version IDs to be queried
-          name:
-            type: optional<string>
-            docs: Model version name to be queried
-          version:
-            type: optional<string>
-            docs: Model version number to be queried
-          shared_assets:
-            type: optional<boolean>
-            docs: >-
-              `True` Will show all assets owned by you and shared with you.
-              `False` Will show only your assets. Default: `False`
-      response:
-        docs: Success
-        type: list<root.ExternalModelVersion>
-      examples:
-        - response:
-            body:
-              - id: id
-                model_id: model_id
-                user_id: user_id
-                version: version
-                source_uri: source_uri
-                dataset_version_id: dataset_version_id
-                created_on: 1
-                metadata:
-                  metadata: {}
-                description: description
-                tags:
-                  - key: key
-                    value: value
-                file_type: video
-                target_feature: target_feature
-                task_type: task_type
-                training_job_id: training_job_id
-    get-model-version:
-      path: /v0/registry/models/version/{id}
-      method: GET
-      auth: true
-      docs: Returns 200 if successful
-      path-parameters:
-        id:
-          type: string
-          docs: Hume-generated ID of a Model version
-      display-name: Get model version
-      request:
-        name: ModelsGetModelVersionRequest
-        query-parameters:
-          shared_assets:
-            type: optional<boolean>
-            docs: >-
-              `True` Will show all assets owned by you and shared with you.
-              `False` Will show only your assets. Default: `False`
-      response:
-        docs: Success
-        type: root.ExternalModelVersion
-      examples:
-        - path-parameters:
-            id: id
-          response:
-            body:
-              id: id
-              model_id: model_id
-              user_id: user_id
-              version: version
-              source_uri: source_uri
-              dataset_version_id: dataset_version_id
-              created_on: 1
-              metadata:
-                metadata:
-                  metadata:
-                    key: value
-              description: description
-              tags:
-                - key: key
-                  value: value
-              file_type: video
-              target_feature: target_feature
-              task_type: task_type
-              training_job_id: training_job_id
-    update-model-description:
-      path: /v0/registry/models/version/{id}
-      method: PATCH
-      auth: true
-      docs: Returns 200 if successful
-      path-parameters:
-        id:
-          type: string
-          docs: Hume-generated ID of a Model Version
-      display-name: Update model description
-      request:
-        body: string
-      response:
-        docs: Success
-        type: root.ExternalModelVersion
-      examples:
-        - path-parameters:
-            id: id
-          request: string
-          response:
-            body:
-              id: id
-              model_id: model_id
-              user_id: user_id
-              version: version
-              source_uri: source_uri
-              dataset_version_id: dataset_version_id
-              created_on: 1
-              metadata:
-                metadata:
-                  metadata:
-                    key: value
-              description: description
-              tags:
-                - key: key
-                  value: value
-              file_type: video
-              target_feature: target_feature
-              task_type: task_type
-              training_job_id: training_job_id

package/api/resources/customModels/client/Client.d.ts

@@ -1,33 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import { Files } from "../resources/files/client/Client";
-import { Datasets } from "../resources/datasets/client/Client";
-import { Models } from "../resources/models/client/Client";
-import { Jobs } from "../resources/jobs/client/Client";
-export declare namespace CustomModels {
-    interface Options {
-        environment?: core.Supplier<environments.HumeEnvironment | string>;
-        apiKey?: core.Supplier<string | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        timeoutInSeconds?: number;
-        maxRetries?: number;
-        abortSignal?: AbortSignal;
-    }
-}
-export declare class CustomModels {
-    protected readonly _options: CustomModels.Options;
-    constructor(_options?: CustomModels.Options);
-    protected _files: Files | undefined;
-    get files(): Files;
-    protected _datasets: Datasets | undefined;
-    get datasets(): Datasets;
-    protected _models: Models | undefined;
-    get models(): Models;
-    protected _jobs: Jobs | undefined;
-    get jobs(): Jobs;
-}

package/api/resources/customModels/client/Client.js

@@ -1,32 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomModels = void 0;
-const Client_1 = require("../resources/files/client/Client");
-const Client_2 = require("../resources/datasets/client/Client");
-const Client_3 = require("../resources/models/client/Client");
-const Client_4 = require("../resources/jobs/client/Client");
-class CustomModels {
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    get files() {
-        var _a;
-        return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new Client_1.Files(this._options)));
-    }
-    get datasets() {
-        var _a;
-        return ((_a = this._datasets) !== null && _a !== void 0 ? _a : (this._datasets = new Client_2.Datasets(this._options)));
-    }
-    get models() {
-        var _a;
-        return ((_a = this._models) !== null && _a !== void 0 ? _a : (this._models = new Client_3.Models(this._options)));
-    }
-    get jobs() {
-        var _a;
-        return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new Client_4.Jobs(this._options)));
-    }
-}
-exports.CustomModels = CustomModels;

package/api/resources/customModels/client/index.d.ts

@@ -1 +0,0 @@
-export {};

package/api/resources/customModels/client/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/customModels/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./types";
-export * from "./client";
-export * from "./resources";

package/api/resources/customModels/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./client"), exports);
-__exportStar(require("./resources"), exports);

package/api/resources/customModels/resources/datasets/client/Client.d.ts

@@ -1,126 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/// <reference types="node" />
-import * as environments from "../../../../../../environments";
-import * as core from "../../../../../../core";
-import * as Hume from "../../../../../index";
-import * as fs from "fs";
-export declare namespace Datasets {
-    interface Options {
-        environment?: core.Supplier<environments.HumeEnvironment | string>;
-        apiKey?: core.Supplier<string | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        timeoutInSeconds?: number;
-        maxRetries?: number;
-        abortSignal?: AbortSignal;
-    }
-}
-export declare class Datasets {
-    protected readonly _options: Datasets.Options;
-    constructor(_options?: Datasets.Options);
-    /**
-     * Returns 200 if successful
-     *
-     * @param {Hume.customModels.DatasetsListDatasetsRequest} request
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.listDatasets()
-     */
-    listDatasets(request?: Hume.customModels.DatasetsListDatasetsRequest, requestOptions?: Datasets.RequestOptions): Promise<Hume.customModels.DatasetPage>;
-    /**
-     * Returns 201 if successful
-     *
-     * @param {File | fs.ReadStream | undefined} featureTypes
-     * @param {File | fs.ReadStream} labelsFile
-     * @param {Hume.customModels.DatasetsCreateDatasetRequest} request
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.createDataset(fs.createReadStream("/path/to/your/file"), fs.createReadStream("/path/to/your/file"), {
-     *         name: "name"
-     *     })
-     */
-    createDataset(featureTypes: File | fs.ReadStream | undefined, labelsFile: File | fs.ReadStream, request: Hume.customModels.DatasetsCreateDatasetRequest, requestOptions?: Datasets.RequestOptions): Promise<Hume.customModels.ReturnDataset>;
-    /**
-     * Returns 200 if successful
-     *
-     * @param {string} id - Hume-generated ID of a Dataset
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.getDataset("id")
-     */
-    getDataset(id: string, requestOptions?: Datasets.RequestOptions): Promise<Hume.customModels.ReturnDataset>;
-    /**
-     * Returns 200 if successful
-     *
-     * @param {File | fs.ReadStream | undefined} featureTypes
-     * @param {File | fs.ReadStream} labelsFile
-     * @param {string} id
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.createDatasetVersion(fs.createReadStream("/path/to/your/file"), fs.createReadStream("/path/to/your/file"), "id")
-     */
-    createDatasetVersion(featureTypes: File | fs.ReadStream | undefined, labelsFile: File | fs.ReadStream, id: string, requestOptions?: Datasets.RequestOptions): Promise<Hume.customModels.ReturnDataset[]>;
-    /**
-     * Returns 204 if successful
-     *
-     * @param {string} id - Hume-generated ID of a Dataset
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.deleteDataset("id")
-     */
-    deleteDataset(id: string, requestOptions?: Datasets.RequestOptions): Promise<void>;
-    /**
-     * Returns 200 if successful
-     *
-     * @param {string} id - Hume-generated ID of a Dataset
-     * @param {Hume.customModels.DatasetsListDatasetVersionsRequest} request
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.listDatasetVersions("id")
-     */
-    listDatasetVersions(id: string, request?: Hume.customModels.DatasetsListDatasetVersionsRequest, requestOptions?: Datasets.RequestOptions): Promise<Hume.customModels.DatasetVersionPage>;
-    /**
-     * Returns 200 if successful
-     *
-     * @param {string} id - Hume-generated ID of a Dataset
-     * @param {Hume.customModels.DatasetsListDatasetFilesRequest} request
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.listDatasetFiles("id")
-     */
-    listDatasetFiles(id: string, request?: Hume.customModels.DatasetsListDatasetFilesRequest, requestOptions?: Datasets.RequestOptions): Promise<Hume.customModels.FilePage[]>;
-    /**
-     * Returns 200 if successful
-     *
-     * @param {string} id - Hume-generated ID of a Dataset version
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.getDatasetVersion("id")
-     */
-    getDatasetVersion(id: string, requestOptions?: Datasets.RequestOptions): Promise<Hume.customModels.DatasetLabels>;
-    /**
-     * Returns 200 if successful
-     *
-     * @param {string} id - Hume-generated ID of a Dataset version
-     * @param {Hume.customModels.DatasetsListDatasetVersionFilesRequest} request
-     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await hume.customModels.datasets.listDatasetVersionFiles("id")
-     */
-    listDatasetVersionFiles(id: string, request?: Hume.customModels.DatasetsListDatasetVersionFilesRequest, requestOptions?: Datasets.RequestOptions): Promise<Hume.customModels.FilePage[]>;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Hume-Api-Key": string | undefined;
-    }>;
-}