hume 0.1.0 → 0.2.4

package/api/types/Queued.d.ts

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

package/api/types/Queued.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/Request.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export interface Request {
+    models?: Hume.Models;
+    transcription?: Hume.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[];
+    /** 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.File_[];
+}

package/api/types/Request.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/Results.d.ts

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

package/api/types/Results.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/Sentiment.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * 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.
+ */
+export declare type Sentiment = Hume.SentimentItem[];

package/api/types/Sentiment.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/SentimentItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SentimentItem {
+    /** Level of sentiment, ranging from 1 (negative) to 9 (positive) */
+    name?: string;
+    /** Prediction for this level of sentiment */
+    score?: number;
+}

package/api/types/SentimentItem.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/SentimentScore.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SentimentScore {
+    /** Level of sentiment, ranging from `1` (negative) to `9` (positive) */
+    name: string;
+    /** Prediction for this level of sentiment */
+    score: string;
+}

package/api/types/SentimentScore.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/SortBy.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type SortBy = "created" | "started" | "ended";
+export declare const SortBy: {
+    readonly Created: "created";
+    readonly Started: "started";
+    readonly Ended: "ended";
+};

package/api/types/SortBy.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortBy = void 0;
+exports.SortBy = {
+    Created: "created",
+    Started: "started",
+    Ended: "ended",
+};

package/api/types/Source.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export declare type Source = Hume.Source.Url | Hume.Source.File_;
+export declare namespace Source {
+    interface Url extends Hume.Url {
+        type: "url";
+    }
+    interface File_ extends Hume.File_ {
+        type: "file";
+    }
+}

package/api/types/Source.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/SourceFile.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export declare type SourceFile = Hume.File_;

package/api/types/SourceFile.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/SourceResult.d.ts

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

package/api/types/SourceResult.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/SourceUrl.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export declare type SourceUrl = Hume.Url;

package/api/types/SourceUrl.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/State.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export declare type State = Hume.State.Queued | Hume.State.InProgress | Hume.State.Completed | Hume.State.Failed;
+export declare namespace State {
+    interface Queued extends Hume.Queued {
+        status: "QUEUED";
+    }
+    interface InProgress extends Hume.InProgress {
+        status: "IN_PROGRESS";
+    }
+    interface Completed extends Hume.Completed {
+        status: "COMPLETED";
+    }
+    interface Failed extends Hume.Failed {
+        status: "FAILED";
+    }
+}

package/api/types/State.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/StateCompleted.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export declare type StateCompleted = Hume.Completed;

package/api/types/StateCompleted.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/StateFailed.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export declare type StateFailed = Hume.Failed;

package/api/types/StateFailed.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/StateInProgress.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export declare type StateInProgress = Hume.InProgress;

package/api/types/StateInProgress.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/StateQueued.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+export declare type StateQueued = Hume.Queued;

package/api/types/StateQueued.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/Status.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Status = "QUEUED" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
+export declare const Status: {
+    readonly Queued: "QUEUED";
+    readonly InProgress: "IN_PROGRESS";
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+};

package/api/types/Status.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.Status = void 0;
+exports.Status = {
+    Queued: "QUEUED",
+    InProgress: "IN_PROGRESS",
+    Completed: "COMPLETED",
+    Failed: "FAILED",
+};

package/api/types/TextPosition.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 TextPosition {
+    /** 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/TextPosition.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/TimeInterval.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A time range with a beginning and end, measured in seconds.
+ */
+export interface TimeInterval {
+    /** Beginning of time range in seconds. */
+    begin: number;
+    /** End of time range in seconds. */
+    end: number;
+}

package/api/types/TimeInterval.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/TimeRange.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A time range with a beginning and end, measured in seconds.
+ */
+export interface TimeRange {
+    /** Beginning of time range in seconds. */
+    begin?: number;
+    /** End of time range in seconds. */
+    end?: number;
+}

package/api/types/TimeRange.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/Toxicity.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * Toxicity predictions returned as probabilities that the text can be classified into the following categories: toxic, severe_toxic, obscene, threat, insult, and identity_hate.
+ */
+export declare type Toxicity = Hume.ToxicityItem[];

package/api/types/Toxicity.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/ToxicityItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToxicityItem {
+    /** Category of toxicity. */
+    name?: string;
+    /** Prediction for this category of toxicity */
+    score?: number;
+}

package/api/types/ToxicityItem.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/ToxicityScore.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToxicityScore {
+    /** Category of toxicity. */
+    name: string;
+    /** Prediction for this category of toxicity */
+    score: string;
+}

package/api/types/ToxicityScore.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/Transcription.d.ts

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

package/api/types/Transcription.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/TranscriptionMetadata.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "..";
+/**
+ * Transcription metadata for your media file.
+ */
+export interface TranscriptionMetadata {
+    /** Value between `0.0` and `1.0` indicating our transcription model’s relative confidence in the transcription of your media file. */
+    confidence: number;
+    detectedLanguage?: Hume.Bcp47Tag;
+}

package/api/types/TranscriptionMetadata.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/Url.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Url {
+    /** The URL of the source media file. */
+    url: string;
+}

package/api/types/Url.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/When.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type When = "created_before" | "created_after";
+export declare const When: {
+    readonly CreatedBefore: "created_before";
+    readonly CreatedAfter: "created_after";
+};

package/api/types/When.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.When = void 0;
+exports.When = {
+    CreatedBefore: "created_before",
+    CreatedAfter: "created_after",
+};

package/api/types/Window.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Window {
+    /** The length of the sliding window. */
+    length?: number;
+    /** The step size of the sliding window. */
+    step?: number;
+}

package/api/types/Window.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/index.d.ts

@@ -0,0 +1,89 @@
+export * from "./Bcp47Tag";
+export * from "./BoundingBox";
+export * from "./BurstPrediction";
+export * from "./Completed";
+export * from "./DescriptionsScore";
+export * from "./Direction";
+export * from "./EmotionScore";
+export * from "./Empty";
+export * from "./Error_";
+export * from "./Face";
+export * from "./FacePrediction";
+export * from "./FacemeshPrediction";
+export * from "./FacsScore";
+export * from "./Failed";
+export * from "./File_";
+export * from "./Granularity";
+export * from "./GroupedPredictionsBurstPrediction";
+export * from "./GroupedPredictionsFacePrediction";
+export * from "./GroupedPredictionsFacemeshPrediction";
+export * from "./GroupedPredictionsLanguagePrediction";
+export * from "./GroupedPredictionsNerPrediction";
+export * from "./GroupedPredictionsProsodyPrediction";
+export * from "./InProgress";
+export * from "./JobRequest";
+export * from "./JobId";
+export * from "./Language";
+export * from "./LanguagePrediction";
+export * from "./Models";
+export * from "./ModelsPredictions";
+export * from "./Ner";
+export * from "./NerPrediction";
+export * from "./Null";
+export * from "./PositionInterval";
+export * from "./Prediction";
+export * from "./PredictionsOptionalNullBurstPrediction";
+export * from "./PredictionsOptionalNullFacePrediction";
+export * from "./PredictionsOptionalNullFacemeshPrediction";
+export * from "./PredictionsOptionalTranscriptionMetadataLanguagePrediction";
+export * from "./PredictionsOptionalTranscriptionMetadataNerPrediction";
+export * from "./PredictionsOptionalTranscriptionMetadataProsodyPrediction";
+export * from "./Prosody";
+export * from "./ProsodyPrediction";
+export * from "./Queued";
+export * from "./Request";
+export * from "./Results";
+export * from "./SentimentScore";
+export * from "./SortBy";
+export * from "./Source";
+export * from "./SourceResult";
+export * from "./SourceFile";
+export * from "./SourceUrl";
+export * from "./State";
+export * from "./StateCompleted";
+export * from "./StateFailed";
+export * from "./StateInProgress";
+export * from "./StateQueued";
+export * from "./Status";
+export * from "./TimeInterval";
+export * from "./ToxicityScore";
+export * from "./Transcription";
+export * from "./TranscriptionMetadata";
+export * from "./Url";
+export * from "./When";
+export * from "./Window";
+export * from "./ModelsInput";
+export * from "./ModelConfig";
+export * from "./FaceModelConfig";
+export * from "./LanguageConfig";
+export * from "./ModelResponse";
+export * from "./BurstResponse";
+export * from "./ModelsSuccessBurstPredictionsItem";
+export * from "./FaceResponse";
+export * from "./ModelsSuccessFacePredictionsItem";
+export * from "./FacemeshResponse";
+export * from "./ModelsSuccessFacemeshPredictionsItem";
+export * from "./LanguageResponse";
+export * from "./ModelsSuccessLanguagePredictionsItem";
+export * from "./ProsodyResponse";
+export * from "./ModelsSuccessProsodyPredictionsItem";
+export * from "./ModelsError";
+export * from "./ModelsWarning";
+export * from "./EmotionEmbedding";
+export * from "./EmotionEmbeddingItem";
+export * from "./TimeRange";
+export * from "./TextPosition";
+export * from "./Sentiment";
+export * from "./SentimentItem";
+export * from "./Toxicity";
+export * from "./ToxicityItem";