hume 0.8.6 → 0.8.8

package/api/resources/expressionMeasurement/resources/batch/types/StateInference.d.ts

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

package/api/resources/expressionMeasurement/resources/batch/types/StateInferenceCompletedInference.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateInferenceCompletedInference extends Hume.expressionMeasurement.CompletedInference {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateInferenceFailed.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateInferenceFailed extends Hume.expressionMeasurement.Failed {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateInferenceInProgress.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateInferenceInProgress extends Hume.expressionMeasurement.InProgress {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateInferenceQueued.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateInferenceQueued extends Hume.expressionMeasurement.Queued {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateTlInference.d.ts

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

package/api/resources/expressionMeasurement/resources/batch/types/StateTlInferenceCompletedTlInference.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateTlInferenceCompletedTlInference extends Hume.expressionMeasurement.CompletedTlInference {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateTlInferenceFailed.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateTlInferenceFailed extends Hume.expressionMeasurement.Failed {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateTlInferenceInProgress.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateTlInferenceInProgress extends Hume.expressionMeasurement.InProgress {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateTlInferenceQueued.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateTlInferenceQueued extends Hume.expressionMeasurement.Queued {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateTraining.d.ts

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

package/api/resources/expressionMeasurement/resources/batch/types/StateTrainingCompletedTraining.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateTrainingCompletedTraining extends Hume.expressionMeasurement.CompletedTraining {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateTrainingFailed.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateTrainingFailed extends Hume.expressionMeasurement.Failed {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateTrainingInProgress.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateTrainingInProgress extends Hume.expressionMeasurement.InProgress {
+}

package/api/resources/expressionMeasurement/resources/batch/types/StateTrainingQueued.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface StateTrainingQueued extends Hume.expressionMeasurement.Queued {
+}

package/api/resources/expressionMeasurement/resources/batch/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/resources/expressionMeasurement/resources/batch/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/resources/expressionMeasurement/resources/batch/types/Task.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export declare type Task = Hume.expressionMeasurement.Task.Classification | Hume.expressionMeasurement.Task.Regression;
+export declare namespace Task {
+    interface Classification extends Hume.expressionMeasurement.TaskClassification {
+        type: "classification";
+    }
+    interface Regression extends Hume.expressionMeasurement.TaskRegression {
+        type: "regression";
+    }
+}

package/api/resources/expressionMeasurement/resources/batch/types/TlInferenceBaseRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface TlInferenceBaseRequest {
+    customModel: Hume.expressionMeasurement.CustomModel;
+    /**
+     * 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[];
+    /** 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/api/resources/expressionMeasurement/resources/batch/types/TlInferencePrediction.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface TlInferencePrediction {
+    /** A file path relative to the top level source URL or file. */
+    file: string;
+    fileType: string;
+    customModels: Record<string, Hume.expressionMeasurement.CustomModelPrediction>;
+}

package/api/resources/expressionMeasurement/resources/batch/types/TlInferenceResults.d.ts

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

package/api/resources/expressionMeasurement/resources/batch/types/TlInferenceSourcePredictResult.d.ts

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

package/api/resources/expressionMeasurement/resources/batch/types/TrainingBaseRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+export interface TrainingBaseRequest {
+    customModel: Hume.expressionMeasurement.CustomModelRequest;
+    dataset: Hume.expressionMeasurement.Dataset;
+    targetFeature?: string;
+    task?: Hume.expressionMeasurement.Task;
+    evaluation?: Hume.expressionMeasurement.EvaluationArgs;
+    alternatives?: Hume.expressionMeasurement.Alternative[];
+    callbackUrl?: string;
+    notify?: boolean;
+}

package/api/resources/expressionMeasurement/resources/batch/types/Transcription.d.ts

@@ -0,0 +1,51 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../../index";
+/**
+ * Transcription-related configuration options.
+ *
+ * To disable transcription, explicitly set this field to `null`.
+ */
+export interface Transcription {
+    /**
+     * By default, we use an automated language detection method for our Speech Prosody, Language, and NER models. However, if you know what language is being spoken in your media samples, you can specify it via its BCP-47 tag and potentially obtain more accurate results.
+     *
+     * You can specify any of the following languages:
+     *
+     * - Chinese: `zh`
+     * - Danish: `da`
+     * - Dutch: `nl`
+     * - English: `en`
+     * - English (Australia): `en-AU`
+     * - English (India): `en-IN`
+     * - English (New Zealand): `en-NZ`
+     * - English (United Kingdom): `en-GB`
+     * - French: `fr`
+     * - French (Canada): `fr-CA`
+     * - German: `de`
+     * - Hindi: `hi`
+     * - Hindi (Roman Script): `hi-Latn`
+     * - Indonesian: `id`
+     * - Italian: `it`
+     * - Japanese: `ja`
+     * - Korean: `ko`
+     * - Norwegian: `no`
+     * - Polish: `pl`
+     * - Portuguese: `pt`
+     * - Portuguese (Brazil): `pt-BR`
+     * - Portuguese (Portugal): `pt-PT`
+     * - Russian: `ru`
+     * - Spanish: `es`
+     * - Spanish (Latin America): `es-419`
+     * - Swedish: `sv`
+     * - Tamil: `ta`
+     * - Turkish: `tr`
+     * - Ukrainian: `uk`
+     */
+    language?: Hume.expressionMeasurement.Bcp47Tag;
+    /** 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;
+    /** Transcript confidence threshold. Transcripts generated with a confidence less than this threshold will be considered invalid and not used as an input for model inference. */
+    confidenceThreshold?: number;
+}

package/api/resources/expressionMeasurement/resources/batch/types/TranscriptionMetadata.d.ts

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

package/api/resources/expressionMeasurement/resources/batch/types/Type.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Type = "EMBEDDING_GENERATION" | "INFERENCE" | "TL_INFERENCE" | "TRAINING";
+export declare const Type: {
+    readonly EmbeddingGeneration: "EMBEDDING_GENERATION";
+    readonly Inference: "INFERENCE";
+    readonly TlInference: "TL_INFERENCE";
+    readonly Training: "TRAINING";
+};

package/api/resources/expressionMeasurement/resources/batch/types/Type.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.Type = void 0;
+exports.Type = {
+    EmbeddingGeneration: "EMBEDDING_GENERATION",
+    Inference: "INFERENCE",
+    TlInference: "TL_INFERENCE",
+    Training: "TRAINING",
+};

package/api/resources/expressionMeasurement/resources/batch/types/UnionJob.d.ts

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

package/api/resources/expressionMeasurement/resources/batch/types/UnionPredictResult.d.ts

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

package/api/resources/expressionMeasurement/resources/batch/types/ValidationArgs.d.ts

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

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

@@ -0,0 +1,121 @@
+export * from "./Alternative";
+export * from "./Bcp47Tag";
+export * from "./BoundingBox";
+export * from "./BurstPrediction";
+export * from "./Classification";
+export * from "./CompletedEmbeddingGeneration";
+export * from "./CompletedInference";
+export * from "./CompletedTlInference";
+export * from "./CompletedTraining";
+export * from "./CustomModelPrediction";
+export * from "./CustomModelRequest";
+export * from "./Dataset";
+export * from "./DatasetId";
+export * from "./DatasetVersionId";
+export * from "./DescriptionsScore";
+export * from "./Direction";
+export * from "./EmbeddingGenerationBaseRequest";
+export * from "./EmotionScore";
+export * from "./Error_";
+export * from "./EvaluationArgs";
+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 "./InferenceBaseRequest";
+export * from "./InferencePrediction";
+export * from "./InferenceRequest";
+export * from "./InferenceResults";
+export * from "./InferenceSourcePredictResult";
+export * from "./JobEmbeddingGeneration";
+export * from "./JobInference";
+export * from "./JobTlInference";
+export * from "./JobTraining";
+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 "./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 "./RegistryFileDetail";
+export * from "./Regression";
+export * from "./SentimentScore";
+export * from "./SortBy";
+export * from "./Source";
+export * from "./SourceFile";
+export * from "./SourceTextSource";
+export * from "./SourceUrl";
+export * from "./Url";
+export * from "./StateEmbeddingGeneration";
+export * from "./StateEmbeddingGenerationCompletedEmbeddingGeneration";
+export * from "./StateEmbeddingGenerationFailed";
+export * from "./StateEmbeddingGenerationInProgress";
+export * from "./StateEmbeddingGenerationQueued";
+export * from "./StateInference";
+export * from "./StateInferenceCompletedInference";
+export * from "./StateInferenceFailed";
+export * from "./StateInferenceInProgress";
+export * from "./StateInferenceQueued";
+export * from "./StateTlInference";
+export * from "./StateTlInferenceCompletedTlInference";
+export * from "./StateTlInferenceFailed";
+export * from "./StateTlInferenceInProgress";
+export * from "./StateTlInferenceQueued";
+export * from "./StateTraining";
+export * from "./StateTrainingCompletedTraining";
+export * from "./StateTrainingFailed";
+export * from "./StateTrainingInProgress";
+export * from "./StateTrainingQueued";
+export * from "./Status";
+export * from "./TlInferencePrediction";
+export * from "./TlInferenceResults";
+export * from "./TlInferenceSourcePredictResult";
+export * from "./Tag";
+export * from "./Target";
+export * from "./Task";
+export * from "./TaskClassification";
+export * from "./TaskRegression";
+export * from "./TextSource";
+export * from "./TimeInterval";
+export * from "./TlInferenceBaseRequest";
+export * from "./CustomModel";
+export * from "./CustomModelId";
+export * from "./CustomModelVersionId";
+export * from "./ToxicityScore";
+export * from "./TrainingBaseRequest";
+export * from "./TrainingCustomModel";
+export * from "./Transcription";
+export * from "./TranscriptionMetadata";
+export * from "./Type";
+export * from "./Unconfigurable";
+export * from "./UnionJob";
+export * from "./EmbeddingGenerationJob";
+export * from "./InferenceJob";
+export * from "./CustomModelsInferenceJob";
+export * from "./CustomModelsTrainingJob";
+export * from "./UnionPredictResult";
+export * from "./ValidationArgs";
+export * from "./When";
+export * from "./Window";