hume 0.1.0 → 0.2.5

package/api/types/BurstPrediction.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface BurstPrediction {
+    time: Hume.TimeInterval;
+    /** A high-dimensional embedding in emotion space. */
+    emotions: Hume.EmotionScore[];
+    /** Modality-specific descriptive features and their scores. */
+    descriptions: Hume.DescriptionsScore[];
+}

package/api/types/BurstPrediction.js

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

package/api/types/BurstResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * Response for the vocal burst emotion model.
+ */
+export interface BurstResponse {
+    predictions?: Hume.ModelsSuccessBurstPredictionsItem[];
+}

package/api/types/BurstResponse.js

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

package/api/types/Completed.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Completed {
+    /** 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;
+    /** The number of predictions that were generated by this job. */
+    numPredictions: number;
+    /** The number of errors that occurred while running this job. */
+    numErrors: number;
+}

package/api/types/Completed.js

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

package/api/types/DescriptionsScore.d.ts

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

package/api/types/DescriptionsScore.js

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

package/api/types/Direction.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Direction = "asc" | "desc";
+export declare const Direction: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};

package/api/types/Direction.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Direction = void 0;
+exports.Direction = {
+    Asc: "asc",
+    Desc: "desc",
+};

package/api/types/EmotionEmbedding.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * A high-dimensional embedding in emotion space.
+ */
+export declare type EmotionEmbedding = Hume.EmotionEmbeddingItem[];

package/api/types/EmotionEmbedding.js

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

package/api/types/EmotionEmbeddingItem.d.ts

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

package/api/types/EmotionEmbeddingItem.js

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

package/api/types/EmotionScore.d.ts

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

package/api/types/EmotionScore.js

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

package/api/types/Empty.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * To include predictions for this model type, set this field to `{}`. It is currently not configurable further.
+ */
+export declare type Empty = Record<string, unknown>;

package/api/types/Empty.js

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

package/api/types/Error_.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Error_ {
+    /** An error message. */
+    message: string;
+    /** A file path relative to the top level source URL or file. */
+    file: string;
+}

package/api/types/Error_.js

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

package/api/types/Face.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+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.Empty;
+    descriptions?: Hume.Empty;
+    /** Whether to extract and save the detected faces in the artifacts zip created by each job. */
+    saveFaces?: boolean;
+}

package/api/types/Face.js

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

package/api/types/FaceModelConfig.d.ts

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Configuration for the facial expression emotion model.
+ *
+ * Note: Using the `reset_stream` parameter does not have any effect on face identification. A single face identifier cache is maintained over a full session whether `reset_stream` is used or not.
+ *
+ */
+export interface FaceModelConfig {
+    /** Configuration for FACS predictions. If missing or null, no FACS predictions will be generated. */
+    facs?: Record<string, unknown>;
+    /** Configuration for Descriptions predictions. If missing or null, no Descriptions predictions will be generated. */
+    descriptions?: Record<string, unknown>;
+    /**
+     * 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;
+    /**
+     * Number of frames per second to process. Other frames will be omitted from the response.
+     *
+     */
+    fpsPred?: number;
+    /**
+     * Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response.
+     *
+     */
+    probThreshold?: number;
+    /**
+     * 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;
+}

package/api/types/FaceModelConfig.js

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

package/api/types/FacePrediction.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+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.BoundingBox;
+    /** A high-dimensional embedding in emotion space. */
+    emotions: Hume.EmotionScore[];
+    /** FACS 2.0 features and their scores. */
+    facs?: Hume.FacsScore[];
+    /** Modality-specific descriptive features and their scores. */
+    descriptions?: Hume.DescriptionsScore[];
+}

package/api/types/FacePrediction.js

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

package/api/types/FaceResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * Response for the facial expression emotion model.
+ */
+export interface FaceResponse {
+    predictions?: Hume.ModelsSuccessFacePredictionsItem[];
+}

package/api/types/FaceResponse.js

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

package/api/types/FacemeshPrediction.d.ts

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

package/api/types/FacemeshPrediction.js

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

package/api/types/FacemeshResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * Response for the facemesh emotion model.
+ */
+export interface FacemeshResponse {
+    predictions?: Hume.ModelsSuccessFacemeshPredictionsItem[];
+}

package/api/types/FacemeshResponse.js

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

package/api/types/FacsScore.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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/api/types/FacsScore.js

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

package/api/types/Failed.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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/api/types/Failed.js

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

package/api/types/File_.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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/api/types/File_.js

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

package/api/types/Granularity.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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/api/types/Granularity.js

@@ -0,0 +1,12 @@
+"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/api/types/GroupedPredictionsBurstPrediction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+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.BurstPrediction[];
+}

package/api/types/GroupedPredictionsBurstPrediction.js

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

package/api/types/GroupedPredictionsFacePrediction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+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.FacePrediction[];
+}

package/api/types/GroupedPredictionsFacePrediction.js

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

package/api/types/GroupedPredictionsFacemeshPrediction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+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.FacemeshPrediction[];
+}

package/api/types/GroupedPredictionsFacemeshPrediction.js

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

package/api/types/GroupedPredictionsLanguagePrediction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+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.LanguagePrediction[];
+}

package/api/types/GroupedPredictionsLanguagePrediction.js

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

package/api/types/GroupedPredictionsNerPrediction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+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.NerPrediction[];
+}

package/api/types/GroupedPredictionsNerPrediction.js

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

package/api/types/GroupedPredictionsProsodyPrediction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+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.ProsodyPrediction[];
+}

package/api/types/GroupedPredictionsProsodyPrediction.js

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

package/api/types/InProgress.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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/api/types/InProgress.js

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

package/api/types/JobId.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface JobId {
+    /** The ID of the started job. */
+    jobId: string;
+}

package/api/types/JobId.js

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

package/api/types/JobRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface JobRequest {
+    userId: string;
+    jobId: string;
+    request: Hume.Request;
+    state: Hume.State;
+}

package/api/types/JobRequest.js

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

package/api/types/Language.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface Language {
+    granularity?: Hume.Granularity;
+    /** Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID. */
+    identifySpeakers?: boolean;
+    sentiment?: Hume.Empty;
+    toxicity?: Hume.Empty;
+}

package/api/types/Language.js

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

package/api/types/LanguageConfig.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Configuration for the language emotion model.
+ */
+export interface LanguageConfig {
+    /** Configuration for sentiment predictions. If missing or null, no sentiment predictions will be generated. */
+    sentiment?: Record<string, unknown>;
+    /** Configuration for toxicity predictions. If missing or null, no toxicity predictions will be generated. */
+    toxicity?: Record<string, unknown>;
+    /** The granularity at which to generate predictions. Values are `word`, `sentence`, `utterance`, or `passage`. To get a single prediction for the entire text of your streaming payload use `passage`. Default value is `word`. */
+    granularity?: string;
+}

package/api/types/LanguageConfig.js

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