hume 0.1.0 → 0.2.4

package/api/types/LanguagePrediction.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface LanguagePrediction {
+    /** A segment of text (like a word or a sentence). */
+    text: string;
+    position: Hume.PositionInterval;
+    time?: Hume.TimeInterval;
+    /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text. */
+    confidence?: number;
+    /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence that this text was spoken by this speaker. */
+    speakerConfidence?: number;
+    /** A high-dimensional embedding in emotion space. */
+    emotions: Hume.EmotionScore[];
+    /**
+     * Sentiment predictions returned as a distribution. This model predicts the probability that a given text could be interpreted as having each sentiment level from `1` (negative) to `9` (positive).
+     *
+     * Compared to returning one estimate of sentiment, this enables a more nuanced analysis of a text's meaning. For example, a text with very neutral sentiment would have an average rating of `5`. But also a text that could be interpreted as having very positive sentiment or very negative sentiment would also have an average rating of `5`. The average sentiment is less informative than the distribution over sentiment, so this API returns a value for each sentiment level.
+     */
+    sentiment?: Hume.SentimentScore[];
+    /** Toxicity predictions returned as probabilities that the text can be classified into the following categories: `toxic`, `severe_toxic`, `obscene`, `threat`, `insult`, and `identity_hate`. */
+    toxicity?: Hume.ToxicityScore[];
+}

package/api/types/LanguagePrediction.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/LanguageResponse.d.ts

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

package/api/types/LanguageResponse.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/ModelConfig.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * Configuration used to specify which models should be used and with what settings.
+ *
+ */
+export interface ModelConfig {
+    /**
+     * Configuration for the vocal burst emotion model.
+     *
+     * Note: Model configuration is not currently available in streaming.
+     *
+     * Please use the default configuration by passing an empty object `{}`.
+     *
+     */
+    burst?: Record<string, unknown>;
+    /**
+     * 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.
+     *
+     */
+    face?: Hume.FaceModelConfig;
+    /**
+     * Configuration for the facemesh emotion model.
+     *
+     * Note: Model configuration is not currently available in streaming.
+     *
+     * Please use the default configuration by passing an empty object `{}`.
+     *
+     */
+    facemesh?: Record<string, unknown>;
+    /** Configuration for the language emotion model. */
+    language?: Hume.LanguageConfig;
+    /**
+     * Configuration for the speech prosody emotion model.
+     *
+     * Note: Model configuration is not currently available in streaming.
+     *
+     * Please use the default configuration by passing an empty object `{}`.
+     *
+     */
+    prosody?: Record<string, unknown>;
+}

package/api/types/ModelConfig.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/ModelResponse.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ModelResponse {
+    /** Response for the vocal burst emotion model. */
+    burst?: Hume.BurstResponse;
+    /** Response for the facial expression emotion model. */
+    face?: Hume.FaceResponse;
+    /** Response for the facemesh emotion model. */
+    facemesh?: Hume.FacemeshResponse;
+    /** Response for the language emotion model. */
+    language?: Hume.LanguageResponse;
+    /** Response for the speech prosody emotion model. */
+    prosody?: Hume.ProsodyResponse;
+}

package/api/types/ModelResponse.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/Models.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface Models {
+    face?: Hume.Face;
+    burst?: Hume.Empty;
+    prosody?: Hume.Prosody;
+    language?: Hume.Language;
+    ner?: Hume.Ner;
+    facemesh?: Hume.Empty;
+}

package/api/types/Models.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/ModelsError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ModelsError {
+    /** Error message text. */
+    error?: string;
+    /** Unique identifier for the error. */
+    code?: string;
+}

package/api/types/ModelsError.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/ModelsInput.d.ts

@@ -0,0 +1,56 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ModelsInput {
+    data?: string;
+    /**
+     * Configuration used to specify which models should be used and with what settings.
+     *
+     */
+    models?: Hume.ModelConfig;
+    /**
+     * Length in milliseconds of streaming sliding window.
+     *
+     * Extending the length of this window will prepend media context from past payloads into the current payload.
+     *
+     * For example, if on the first payload you send 500ms of data and on the second payload you send an additional 500ms of data, a window of at least 1000ms will allow the model to process all 1000ms of stream data.
+     *
+     * A window of 600ms would append the full 500ms of the second payload to the last 100ms of the first payload.
+     *
+     * Note: This feature is currently only supported for audio data and audio models. For other file types and models this parameter will be ignored.
+     *
+     */
+    streamWindowMs?: number;
+    /**
+     * Whether to reset the streaming sliding window before processing the current payload.
+     *
+     * If this parameter is set to `true` then past context will be deleted before processing the current payload.
+     *
+     * Use reset_stream when one audio file is done being processed and you do not want context to leak across files.
+     *
+     */
+    resetStream?: boolean;
+    /**
+     * Set to `true` to enable the data parameter to be parsed as raw text rather than base64 encoded bytes.
+     * This parameter is useful if you want to send text to be processed by the language model, but it cannot be used with other file types like audio, image, or video.
+     *
+     */
+    rawText?: boolean;
+    /**
+     * Set to `true` to get details about the job.
+     *
+     * This parameter can be set in the same payload as data or it can be set without data and models configuration to get the job details between payloads.
+     *
+     * This parameter is useful to get the unique job ID.
+     *
+     */
+    jobDetails?: boolean;
+    /**
+     * Pass an arbitrary string as the payload ID and get it back at the top level of the socket response.
+     *
+     * This can be useful if you have multiple requests running asynchronously and want to disambiguate responses as they are received.
+     *
+     */
+    payloadId?: string;
+}

package/api/types/ModelsInput.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/ModelsPredictions.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ModelsPredictions {
+    face?: Hume.PredictionsOptionalNullFacePrediction;
+    burst?: Hume.PredictionsOptionalNullBurstPrediction;
+    prosody?: Hume.PredictionsOptionalTranscriptionMetadataProsodyPrediction;
+    language?: Hume.PredictionsOptionalTranscriptionMetadataLanguagePrediction;
+    ner?: Hume.PredictionsOptionalTranscriptionMetadataNerPrediction;
+    facemesh?: Hume.PredictionsOptionalNullFacemeshPrediction;
+}

package/api/types/ModelsPredictions.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/ModelsSuccessBurstPredictionsItem.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ModelsSuccessBurstPredictionsItem {
+    time?: Hume.TimeRange;
+    emotions?: Hume.EmotionEmbedding;
+}

package/api/types/ModelsSuccessBurstPredictionsItem.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/ModelsSuccessFacePredictionsItem.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ModelsSuccessFacePredictionsItem {
+    /** Frame number */
+    frame?: number;
+    /** Time in seconds when face detection occurred. */
+    time?: number;
+    bbox?: Hume.BoundingBox;
+    /** The predicted probability that a detected face was actually a face. */
+    prob?: number;
+    /** Identifier for a face. Not that this defaults to `unknown` unless face identification is enabled in the face model configuration. */
+    faceId?: string;
+    emotions?: Hume.EmotionEmbedding;
+    facs?: Hume.EmotionEmbedding;
+    descriptions?: Hume.EmotionEmbedding;
+}

package/api/types/ModelsSuccessFacePredictionsItem.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/ModelsSuccessFacemeshPredictionsItem.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ModelsSuccessFacemeshPredictionsItem {
+    emotions?: Hume.EmotionEmbedding;
+}

package/api/types/ModelsSuccessFacemeshPredictionsItem.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/ModelsSuccessLanguagePredictionsItem.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ModelsSuccessLanguagePredictionsItem {
+    /** A segment of text (like a word or a sentence). */
+    text?: string;
+    position?: Hume.TextPosition;
+    emotions?: Hume.EmotionEmbedding;
+    sentiment?: Hume.Sentiment;
+    toxicity?: Hume.Toxicity;
+}

package/api/types/ModelsSuccessLanguagePredictionsItem.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/ModelsSuccessProsodyPredictionsItem.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ModelsSuccessProsodyPredictionsItem {
+    time?: Hume.TimeRange;
+    emotions?: Hume.EmotionEmbedding;
+}

package/api/types/ModelsSuccessProsodyPredictionsItem.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/ModelsWarning.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ModelsWarning {
+    /** Warning message text. */
+    warning?: string;
+    /** Unique identifier for the error. */
+    code?: string;
+}

package/api/types/ModelsWarning.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/Ner.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Ner {
+    /** 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;
+}

package/api/types/Ner.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/NerPrediction.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface NerPrediction {
+    /** The recognized topic or entity. */
+    entity: string;
+    position: Hume.PositionInterval;
+    /** Our NER model's relative confidence in the recognized topic or entity. */
+    entityConfidence: number;
+    /** A measure of how often the entity is linked to by other entities. */
+    support: number;
+    /** A URL which provides more information about the recognized topic or entity. */
+    uri: string;
+    /** The specific word to which the emotion predictions are linked. */
+    linkWord: string;
+    time?: Hume.TimeInterval;
+    /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text. */
+    confidence?: number;
+    /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence that this text was spoken by this speaker. */
+    speakerConfidence?: number;
+    /** A high-dimensional embedding in emotion space. */
+    emotions: Hume.EmotionScore[];
+}

package/api/types/NerPrediction.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/Null.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * No associated metadata for this model. Value will be `null`.
+ */
+export declare type Null = Record<string, unknown>;

package/api/types/Null.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/PositionInterval.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Position of a segment of text within a larger document, measured in characters. Uses zero-based indexing. The beginning index is inclusive and the end index is exclusive.
+ */
+export interface PositionInterval {
+    /** The index of the first character in the text segment, inclusive. */
+    begin: number;
+    /** The index of the last character in the text segment, exclusive. */
+    end: number;
+}

package/api/types/PositionInterval.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/Prediction.d.ts

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

package/api/types/Prediction.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/PredictionsOptionalNullBurstPrediction.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface PredictionsOptionalNullBurstPrediction {
+    metadata?: Hume.Null;
+    groupedPredictions: Hume.GroupedPredictionsBurstPrediction[];
+}

package/api/types/PredictionsOptionalNullBurstPrediction.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/PredictionsOptionalNullFacePrediction.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface PredictionsOptionalNullFacePrediction {
+    metadata?: Hume.Null;
+    groupedPredictions: Hume.GroupedPredictionsFacePrediction[];
+}

package/api/types/PredictionsOptionalNullFacePrediction.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/PredictionsOptionalNullFacemeshPrediction.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface PredictionsOptionalNullFacemeshPrediction {
+    metadata?: Hume.Null;
+    groupedPredictions: Hume.GroupedPredictionsFacemeshPrediction[];
+}

package/api/types/PredictionsOptionalNullFacemeshPrediction.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/PredictionsOptionalTranscriptionMetadataLanguagePrediction.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface PredictionsOptionalTranscriptionMetadataLanguagePrediction {
+    metadata?: Hume.TranscriptionMetadata;
+    groupedPredictions: Hume.GroupedPredictionsLanguagePrediction[];
+}

package/api/types/PredictionsOptionalTranscriptionMetadataLanguagePrediction.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/PredictionsOptionalTranscriptionMetadataNerPrediction.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface PredictionsOptionalTranscriptionMetadataNerPrediction {
+    metadata?: Hume.TranscriptionMetadata;
+    groupedPredictions: Hume.GroupedPredictionsNerPrediction[];
+}

package/api/types/PredictionsOptionalTranscriptionMetadataNerPrediction.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/PredictionsOptionalTranscriptionMetadataProsodyPrediction.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface PredictionsOptionalTranscriptionMetadataProsodyPrediction {
+    metadata?: Hume.TranscriptionMetadata;
+    groupedPredictions: Hume.GroupedPredictionsProsodyPrediction[];
+}

package/api/types/PredictionsOptionalTranscriptionMetadataProsodyPrediction.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/Prosody.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * NOTE: the `granularity` field is ignored if transcription is not enabled or if the `window` field has been set.
+ */
+export interface Prosody {
+    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;
+    window?: Hume.Window;
+}

package/api/types/Prosody.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/ProsodyPrediction.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface ProsodyPrediction {
+    /** A segment of text (like a word or a sentence). */
+    text?: string;
+    time: Hume.TimeInterval;
+    /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text. */
+    confidence?: number;
+    /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence that this text was spoken by this speaker. */
+    speakerConfidence?: number;
+    /** A high-dimensional embedding in emotion space. */
+    emotions: Hume.EmotionScore[];
+}

package/api/types/ProsodyPrediction.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/ProsodyResponse.d.ts

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

package/api/types/ProsodyResponse.js

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