hume 0.7.2 → 0.8.0

package/dist/api/resources/customModels/types/EvaluationArgs.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/ExternalModel.d.ts

@@ -1,23 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface ExternalModel {
-    /** Hume-generated Model ID */
-    id: string;
-    /** Model name */
-    name: string;
-    /** Created date and time */
-    createdOn: number;
-    /** Updated date and time */
-    modifiedOn: number;
-    /** Total stars on this model */
-    totalStars: number;
-    /** Model is starred by this user */
-    modelIsStarredByUser: boolean;
-    /** Model is archived. */
-    archived: boolean;
-    latestVersion?: Hume.customModels.ExternalModelVersion;
-    /** Model is shared publicly */
-    isPubliclyShared: boolean;
-}

package/dist/api/resources/customModels/types/ExternalModel.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/ExternalModelVersion.d.ts

@@ -1,37 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-/**
- * Latest Model version number
- */
-export interface ExternalModelVersion {
-    /** Hume-generated Model version ID */
-    id: string;
-    /** Hume-generated Model ID of the parent Model */
-    modelId: string;
-    /** Hume-generated User ID */
-    userId: string;
-    /** Model version number */
-    version: string;
-    /** Model version's source file URI */
-    sourceUri: string;
-    /** Hume-generated Dataset version ID for the Dataset version the Model version was trained on */
-    datasetVersionId: string;
-    /** Created date and time */
-    createdOn: number;
-    /** Additional details as key, value pairs */
-    metadata?: Record<string, Record<string, unknown>>;
-    /** Model version description */
-    description?: string;
-    /** List of Tags associated with the Model version */
-    tags?: Hume.customModels.ExternalModelVersionTag[];
-    /** File type: video, audio, video_no_audio, image, text, or mediapipe_facemesh */
-    fileType?: Hume.customModels.ExternalModelVersionFileType;
-    /** Target feature, the feature the model was trained against */
-    targetFeature?: string;
-    /** Type of the task used to train */
-    taskType?: string;
-    /** ID of the batch training job */
-    trainingJobId?: string;
-}

package/dist/api/resources/customModels/types/ExternalModelVersion.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/ExternalModelVersionFileType.d.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * File type: video, audio, video_no_audio, image, text, or mediapipe_facemesh
- */
-export declare type ExternalModelVersionFileType = "video" | "audio" | "video_no_audio" | "image" | "text" | "mediapipe_facemesh";
-export declare const ExternalModelVersionFileType: {
-    readonly Video: "video";
-    readonly Audio: "audio";
-    readonly VideoNoAudio: "video_no_audio";
-    readonly Image: "image";
-    readonly Text: "text";
-    readonly MediapipeFacemesh: "mediapipe_facemesh";
-};

package/dist/api/resources/customModels/types/ExternalModelVersionFileType.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExternalModelVersionFileType = void 0;
-exports.ExternalModelVersionFileType = {
-    Video: "video",
-    Audio: "audio",
-    VideoNoAudio: "video_no_audio",
-    Image: "image",
-    Text: "text",
-    MediapipeFacemesh: "mediapipe_facemesh",
-};

package/dist/api/resources/customModels/types/ExternalModelVersionTag.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * List of Tags associated with the Model version
- */
-export interface ExternalModelVersionTag {
-    /** Tag name (key) */
-    key: string;
-    /** Tag description (value) */
-    value: string;
-}

package/dist/api/resources/customModels/types/ExternalModelVersionTag.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/Face.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface Face {
-    /** Number of frames per second to process. Other frames will be omitted from the response. Set to `0` to process every frame. */
-    fpsPred?: number;
-    /** Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response. */
-    probThreshold?: number;
-    /** Whether to return identifiers for faces across frames. If `true`, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If `false`, all faces will be tagged with an `unknown` ID. */
-    identifyFaces?: boolean;
-    /** Minimum bounding box side length in pixels to treat as a face. Faces detected with a bounding box side length in pixels less than this threshold will be omitted from the response. */
-    minFaceSize?: number;
-    facs?: Hume.customModels.Unconfigurable;
-    descriptions?: Hume.customModels.Unconfigurable;
-    /** Whether to extract and save the detected faces in the artifacts zip created by each job. */
-    saveFaces?: boolean;
-}

package/dist/api/resources/customModels/types/Face.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/FacePrediction.d.ts

@@ -1,19 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface FacePrediction {
-    /** Frame number */
-    frame: number;
-    /** Time in seconds when face detection occurred. */
-    time: number;
-    /** The predicted probability that a detected face was actually a face. */
-    prob: number;
-    box: Hume.customModels.BoundingBox;
-    /** A high-dimensional embedding in emotion space. */
-    emotions: Hume.customModels.EmotionScore[];
-    /** FACS 2.0 features and their scores. */
-    facs?: Hume.customModels.FacsScore[];
-    /** Modality-specific descriptive features and their scores. */
-    descriptions?: Hume.customModels.DescriptionsScore[];
-}

package/dist/api/resources/customModels/types/FacePrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/FacemeshPrediction.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface FacemeshPrediction {
-    /** A high-dimensional embedding in emotion space. */
-    emotions: Hume.customModels.EmotionScore[];
-}

package/dist/api/resources/customModels/types/FacemeshPrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/FacsScore.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface FacsScore {
-    /** Name of the FACS 2.0 feature being expressed. */
-    name: string;
-    /** Embedding value for the FACS 2.0 feature being expressed. */
-    score: string;
-}

package/dist/api/resources/customModels/types/FacsScore.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/Failed.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface Failed {
-    /** When this job was created (Unix timestamp in milliseconds). */
-    createdTimestampMs: number;
-    /** When this job started (Unix timestamp in milliseconds). */
-    startedTimestampMs: number;
-    /** When this job ended (Unix timestamp in milliseconds). */
-    endedTimestampMs: number;
-    /** An error message. */
-    message: string;
-}

package/dist/api/resources/customModels/types/Failed.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/FileInput.d.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * File details
- */
-export interface FileInput {
-    /** File name */
-    name: string;
-    /** File URI */
-    uri?: string;
-    /** Flag which denotes whether the file is stored with Hume */
-    humeStorage: boolean;
-    /** File type: video, audio, video_no_audio, image, text, or mediapipe_facemesh */
-    dataType: string;
-}

package/dist/api/resources/customModels/types/FileInput.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/FilePage.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface FilePage {
-    content?: Hume.customModels.FileWithAttributes[];
-    pageable?: Hume.customModels.PageableObject;
-    total?: number;
-    last?: boolean;
-    totalElements?: number;
-    totalPages?: number;
-    size?: number;
-    number?: number;
-    sort?: Hume.customModels.SortObject;
-    first?: boolean;
-    numberOfElements?: number;
-    empty?: boolean;
-}

package/dist/api/resources/customModels/types/FilePage.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/FileWithAttributes.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface FileWithAttributes {
-    file: Hume.customModels.AuthorizedFile;
-    /** List of Attributes */
-    attributes?: Hume.customModels.AttributeFilter[];
-}

package/dist/api/resources/customModels/types/FileWithAttributes.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/FileWithAttributesInput.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface FileWithAttributesInput {
-    file: Hume.customModels.FileInput;
-    /** List of Attributes */
-    attributes?: Hume.customModels.AttributeFilter[];
-}

package/dist/api/resources/customModels/types/FileWithAttributesInput.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/File_.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface File_ {
-    /** The name of the file. */
-    filename?: string;
-    /** The content type of the file. */
-    contentType?: string;
-    /** The MD5 checksum of the file. */
-    md5Sum: string;
-}

package/dist/api/resources/customModels/types/File_.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/Granularity.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The granularity at which to generate predictions. `utterance` corresponds to a natural pause or break in conversation, while `conversational_turn` corresponds to a change in speaker.
- */
-export declare type Granularity = "word" | "sentence" | "utterance" | "conversational_turn";
-export declare const Granularity: {
-    readonly Word: "word";
-    readonly Sentence: "sentence";
-    readonly Utterance: "utterance";
-    readonly ConversationalTurn: "conversational_turn";
-};

package/dist/api/resources/customModels/types/Granularity.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Granularity = void 0;
-exports.Granularity = {
-    Word: "word",
-    Sentence: "sentence",
-    Utterance: "utterance",
-    ConversationalTurn: "conversational_turn",
-};

package/dist/api/resources/customModels/types/GroupedPredictionsBurstPrediction.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface GroupedPredictionsBurstPrediction {
-    /** An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals. */
-    id: string;
-    predictions: Hume.customModels.BurstPrediction[];
-}

package/dist/api/resources/customModels/types/GroupedPredictionsBurstPrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/GroupedPredictionsFacePrediction.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface GroupedPredictionsFacePrediction {
-    /** An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals. */
-    id: string;
-    predictions: Hume.customModels.FacePrediction[];
-}

package/dist/api/resources/customModels/types/GroupedPredictionsFacePrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/GroupedPredictionsFacemeshPrediction.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface GroupedPredictionsFacemeshPrediction {
-    /** An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals. */
-    id: string;
-    predictions: Hume.customModels.FacemeshPrediction[];
-}

package/dist/api/resources/customModels/types/GroupedPredictionsFacemeshPrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/GroupedPredictionsLanguagePrediction.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface GroupedPredictionsLanguagePrediction {
-    /** An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals. */
-    id: string;
-    predictions: Hume.customModels.LanguagePrediction[];
-}

package/dist/api/resources/customModels/types/GroupedPredictionsLanguagePrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/GroupedPredictionsNerPrediction.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface GroupedPredictionsNerPrediction {
-    /** An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals. */
-    id: string;
-    predictions: Hume.customModels.NerPrediction[];
-}

package/dist/api/resources/customModels/types/GroupedPredictionsNerPrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/GroupedPredictionsProsodyPrediction.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface GroupedPredictionsProsodyPrediction {
-    /** An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals. */
-    id: string;
-    predictions: Hume.customModels.ProsodyPrediction[];
-}

package/dist/api/resources/customModels/types/GroupedPredictionsProsodyPrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/InProgress.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface InProgress {
-    /** When this job was created (Unix timestamp in milliseconds). */
-    createdTimestampMs: number;
-    /** When this job started (Unix timestamp in milliseconds). */
-    startedTimestampMs: number;
-}

package/dist/api/resources/customModels/types/InProgress.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/InferenceBaseRequest.d.ts

@@ -1,22 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface InferenceBaseRequest {
-    models?: Hume.customModels.Models;
-    transcription?: Hume.customModels.Transcription;
-    /**
-     * URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.
-     *
-     * If you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`).
-     */
-    urls?: string[];
-    /** List of File IDs corresponding to the files in the asset registry. */
-    registryFiles?: string[];
-    /** Text to supply directly to our language and NER models. */
-    text?: string[];
-    /** If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure. */
-    callbackUrl?: string;
-    /** Whether to send an email notification to the user upon job completion/failure. */
-    notify?: boolean;
-}

package/dist/api/resources/customModels/types/InferenceBaseRequest.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/InferencePrediction.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface InferencePrediction {
-    /** A file path relative to the top level source URL or file. */
-    file: string;
-    models: Hume.customModels.ModelsPredictions;
-}

package/dist/api/resources/customModels/types/InferencePrediction.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/InferenceRequest.d.ts

@@ -1,23 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface InferenceRequest {
-    models?: Hume.customModels.Models;
-    transcription?: Hume.customModels.Transcription;
-    /**
-     * URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.
-     *
-     * If you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`).
-     */
-    urls?: string[];
-    /** List of File IDs corresponding to the files in the asset registry. */
-    registryFiles?: string[];
-    /** Text to supply directly to our language and NER models. */
-    text?: string[];
-    /** If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure. */
-    callbackUrl?: string;
-    /** Whether to send an email notification to the user upon job completion/failure. */
-    notify?: boolean;
-    files: Hume.customModels.File_[];
-}

package/dist/api/resources/customModels/types/InferenceRequest.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/InferenceResults.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface InferenceResults {
-    predictions: Hume.customModels.InferencePrediction[];
-    errors: Hume.customModels.Error_[];
-}

package/dist/api/resources/customModels/types/InferenceResults.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/InferenceSourcePredictResult.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface InferenceSourcePredictResult {
-    source: Hume.customModels.Source;
-    results?: Hume.customModels.InferenceResults;
-    /** An error message. */
-    error?: string;
-}

package/dist/api/resources/customModels/types/InferenceSourcePredictResult.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/customModels/types/JobEmbeddingGeneration.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Hume from "../../../index";
-export interface JobEmbeddingGeneration {
-    /** The ID associated with this job. */
-    jobId: string;
-    userId: string;
-    request: Hume.customModels.EmbeddingGenerationBaseRequest;
-    state: Hume.customModels.StateEmbeddingGeneration;
-}