hume 0.8.4 → 0.8.6

package/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts

@@ -51,7 +51,7 @@ export declare class Batch {
     /**
      * Get the request details and state of a given job.
      *
-     * @param {string} id
+     * @param {string} id - The unique identifier for the job.
      * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -59,9 +59,9 @@ export declare class Batch {
      */
     getJobDetails(id: string, requestOptions?: Batch.RequestOptions): Promise<Hume.expressionMeasurement.UnionJob>;
     /**
-     * Get the JSON predictions of a completed measurement or custom models inference job.
+     * Get the JSON predictions of a completed inference job.
      *
-     * @param {string} id
+     * @param {string} id - The unique identifier for the job.
      * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -69,7 +69,7 @@ export declare class Batch {
      */
     getJobPredictions(id: string, requestOptions?: Batch.RequestOptions): Promise<Hume.expressionMeasurement.UnionPredictResult[]>;
     /**
-     * Get the artifacts ZIP of a completed measurement or custom models inference job.
+     * Get the artifacts ZIP of a completed inference job.
      */
     getJobArtifacts(id: string, requestOptions?: Batch.RequestOptions): Promise<stream.Readable>;
     /**

package/api/resources/expressionMeasurement/resources/batch/client/Client.js

@@ -60,7 +60,7 @@ class Batch {
     listJobs(request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { limit, status, when, timestampMs, sortBy, direction, type: type_, } = request;
+            const { limit, status, when, timestampMs, sortBy, direction } = request;
             const _queryParams = {};
             if (limit != null) {
                 _queryParams['limit'] = limit.toString();
@@ -85,18 +85,10 @@ class Batch {
             if (direction != null) {
                 _queryParams['direction'] = direction;
             }
-            if (type_ != null) {
-                if (Array.isArray(type_)) {
-                    _queryParams['type'] = type_.map((item) => item);
-                }
-                else {
-                    _queryParams['type'] = type_;
-                }
-            }
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, 'v0/batch/jobs'),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.6', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
@@ -152,7 +144,7 @@ class Batch {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, 'v0/batch/jobs'),
                 method: 'POST',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.6', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.expressionMeasurement.InferenceBaseRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',
@@ -195,7 +187,7 @@ class Batch {
     /**
      * Get the request details and state of a given job.
      *
-     * @param {string} id
+     * @param {string} id - The unique identifier for the job.
      * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -207,7 +199,7 @@ class Batch {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/batch/jobs/${encodeURIComponent(id)}`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.6', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000
@@ -245,9 +237,9 @@ class Batch {
         });
     }
     /**
-     * Get the JSON predictions of a completed measurement or custom models inference job.
+     * Get the JSON predictions of a completed inference job.
      *
-     * @param {string} id
+     * @param {string} id - The unique identifier for the job.
      * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -259,7 +251,7 @@ class Batch {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/batch/jobs/${encodeURIComponent(id)}/predictions`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.6', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000
@@ -297,7 +289,7 @@ class Batch {
         });
     }
     /**
-     * Get the artifacts ZIP of a completed measurement or custom models inference job.
+     * Get the artifacts ZIP of a completed inference job.
      */
     getJobArtifacts(id, requestOptions) {
         var _a, _b;
@@ -305,7 +297,7 @@ class Batch {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/batch/jobs/${encodeURIComponent(id)}/artifacts`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.6', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 responseType: 'streaming',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
@@ -362,7 +354,7 @@ class Batch {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, 'v0/batch/jobs'),
                 method: 'POST',
-                headers: Object.assign(Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), (yield _maybeEncodedRequest.getHeaders())),
+                headers: Object.assign(Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.6', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), (yield _maybeEncodedRequest.getHeaders())),
                 body: yield _maybeEncodedRequest.getBody(),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000

package/api/resources/expressionMeasurement/resources/batch/client/requests/BatchListJobsRequest.d.ts

@@ -12,27 +12,43 @@ export interface BatchListJobsRequest {
      */
     limit?: number;
     /**
-     * Include only jobs with these statuses.
+     * Include only jobs of this status in the response. There are four possible statuses:
+     *
+     * - `QUEUED`: The job has been received and is waiting to be processed.
+     *
+     * - `IN_PROGRESS`: The job is currently being processed.
+     *
+     * - `COMPLETED`: The job has finished processing.
+     *
+     * - `FAILED`: The job encountered an error and could not be completed successfully.
      */
     status?: Hume.expressionMeasurement.Status | Hume.expressionMeasurement.Status[];
     /**
-     * Include only jobs that were created before or after `timestamp_ms`.
+     * Specify whether to include jobs created before or after a given `timestamp_ms`.
      */
     when?: Hume.expressionMeasurement.When;
     /**
-     * Defaults to the current date and time. See `when`.
+     * Provide a timestamp in milliseconds to filter jobs.
+     *
+     * When combined with the `when` parameter, you can filter jobs before or after the given timestamp. Defaults to the current Unix timestamp if one is not provided.
      */
     timestampMs?: number;
     /**
-     * The job timestamp to sort by.
+     * Specify which timestamp to sort the jobs by.
+     *
+     * - `created`: Sort jobs by the time of creation, indicated by `created_timestamp_ms`.
+     *
+     * - `started`: Sort jobs by the time processing started, indicated by `started_timestamp_ms`.
+     *
+     * - `ended`: Sort jobs by the time processing ended, indicated by `ended_timestamp_ms`.
      */
     sortBy?: Hume.expressionMeasurement.SortBy;
     /**
-     * The sort direction.
+     * Specify the order in which to sort the jobs. Defaults to descending order.
+     *
+     * - `asc`: Sort in ascending order (chronological, with the oldest records first).
+     *
+     * - `desc`: Sort in descending order (reverse-chronological, with the newest records first).
      */
     direction?: Hume.expressionMeasurement.Direction;
-    /**
-     * Include only jobs of these types.
-     */
-    type?: Hume.expressionMeasurement.Type | Hume.expressionMeasurement.Type[];
 }

package/api/resources/expressionMeasurement/resources/batch/client/requests/BatchStartInferenceJobFromLocalFileRequest.d.ts

@@ -7,5 +7,6 @@ import * as Hume from '../../../../../../index';
  *     {}
  */
 export interface BatchStartInferenceJobFromLocalFileRequest {
+    /** Stringified JSON object containing the inference job configuration. */
     json?: Hume.expressionMeasurement.InferenceBaseRequest;
 }

package/api/resources/expressionMeasurement/types/{UnionJobJobInference.d.ts → CustomModelsInferenceJob.d.ts}

@@ -2,5 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
-export interface UnionJobJobInference extends Hume.expressionMeasurement.JobInference {
+export interface CustomModelsInferenceJob extends Hume.expressionMeasurement.JobTlInference {
+    type: string;
 }

package/api/resources/expressionMeasurement/types/{UnionJobJobEmbeddingGeneration.d.ts → CustomModelsTrainingJob.d.ts}

@@ -2,5 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
-export interface UnionJobJobEmbeddingGeneration extends Hume.expressionMeasurement.JobEmbeddingGeneration {
+export interface CustomModelsTrainingJob extends Hume.expressionMeasurement.JobTraining {
+    type: string;
 }

package/api/resources/expressionMeasurement/types/EmbeddingGenerationJob.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from '../../../index';
+export interface EmbeddingGenerationJob extends Hume.expressionMeasurement.JobEmbeddingGeneration {
+    type: string;
+}

package/api/resources/expressionMeasurement/types/Face.d.ts

@@ -2,6 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
+/**
+ * The Facial Emotional Expression model analyzes human facial expressions in images and videos. Results will be provided per frame for video files.
+ *
+ * Recommended input file types: `.png`, `.jpeg`, `.mp4`
+ */
 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;

package/api/resources/expressionMeasurement/types/File_.d.ts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * The list of files submitted for analysis.
+ */
 export interface File_ {
     /** The name of the file. */
     filename?: string;

package/api/resources/expressionMeasurement/types/Granularity.d.ts

@@ -2,7 +2,15 @@
  * 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.
+ * The granularity at which to generate predictions. The `granularity` field is ignored if transcription is not enabled or if the `window` field has been set.
+ *
+ * - `word`: At the word level, our model provides a separate output for each word, offering the most granular insight into emotional expression during speech.
+ *
+ * - `sentence`: At the sentence level of granularity, we annotate the emotional tone of each spoken sentence with our Prosody and Emotional Language models.
+ *
+ * - `utterance`: Utterance-level granularity is between word- and sentence-level. It takes into account natural pauses or breaks in speech, providing more rapidly updated measures of emotional expression within a flowing conversation. For text inputs, utterance-level granularity will produce results identical to sentence-level granularity.
+ *
+ * - `conversational_turn`: Conversational turn-level granularity provides a distinct output for each change in speaker. It captures the full sequence of words and sentences spoken uninterrupted by each person. This approach provides a higher-level view of the emotional dynamics in a multi-participant dialogue. For text inputs, specifying conversational turn-level granularity for our Emotional Language model will produce results for the entire passage.
  */
 export declare type Granularity = 'word' | 'sentence' | 'utterance' | 'conversational_turn';
 export declare const Granularity: {

package/api/resources/expressionMeasurement/types/InferenceBaseRequest.d.ts

@@ -3,6 +3,11 @@
  */
 import * as Hume from '../../../index';
 export interface InferenceBaseRequest {
+    /**
+     * Specify the models to use for inference.
+     *
+     * If this field is not explicitly set, then all models will run by default.
+     */
     models?: Hume.expressionMeasurement.Models;
     transcription?: Hume.expressionMeasurement.Transcription;
     /**
@@ -13,7 +18,7 @@ export interface InferenceBaseRequest {
     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 supplied directly to our Emotional Language and NER models for analysis. */
     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;

package/api/resources/expressionMeasurement/types/InferenceJob.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from '../../../index';
+export interface InferenceJob extends Hume.expressionMeasurement.JobInference {
+    /**
+     * Denotes the job type.
+     *
+     * Jobs created with the Expression Measurement API will have this field set to `INFERENCE`.
+     */
+    type: string;
+}

package/api/resources/expressionMeasurement/types/JobInference.d.ts

@@ -5,7 +5,10 @@ import * as Hume from '../../../index';
 export interface JobInference {
     /** The ID associated with this job. */
     jobId: string;
+    /** The unique identifier for the user who initiated the job. */
     userId: string;
+    /** The request that initiated the job. */
     request: Hume.expressionMeasurement.InferenceRequest;
+    /** The current state of the job. */
     state: Hume.expressionMeasurement.StateInference;
 }

package/api/resources/expressionMeasurement/types/Language.d.ts

@@ -2,6 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
+/**
+ * The Emotional Language model analyzes passages of text. This also supports audio and video files by transcribing and then directly analyzing the transcribed text.
+ *
+ * Recommended input filetypes: `.txt`, `.mp3`, `.wav`, `.mp4`
+ */
 export interface Language {
     granularity?: Hume.expressionMeasurement.Granularity;
     sentiment?: Hume.expressionMeasurement.Unconfigurable;

package/api/resources/expressionMeasurement/types/Models.d.ts

@@ -2,6 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
+/**
+ * The models used for inference.
+ */
 export interface Models {
     face?: Hume.expressionMeasurement.Face;
     burst?: Hume.expressionMeasurement.Unconfigurable;

package/api/resources/expressionMeasurement/types/Ner.d.ts

@@ -1,6 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * The NER (Named-entity Recognition) model identifies real-world objects and concepts in passages of text. This also supports audio and video files by transcribing and then directly analyzing the transcribed text.
+ *
+ * Recommended input filetypes: `.txt`, `.mp3`, `.wav`, `.mp4`
+ */
 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/resources/expressionMeasurement/types/Prosody.d.ts

@@ -2,6 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
+/**
+ * The Speech Prosody model analyzes the intonation, stress, and rhythm of spoken word.
+ *
+ * Recommended input file types: `.wav`, `.mp3`, `.mp4`
+ */
 export interface Prosody {
     granularity?: Hume.expressionMeasurement.Granularity;
     window?: Hume.expressionMeasurement.Window;

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

@@ -2,7 +2,47 @@
  * 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;

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

@@ -2,18 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
-export declare type UnionJob = Hume.expressionMeasurement.UnionJob.EmbeddingGeneration | Hume.expressionMeasurement.UnionJob.Inference | Hume.expressionMeasurement.UnionJob.TlInference | Hume.expressionMeasurement.UnionJob.Training;
-export declare namespace UnionJob {
-    interface EmbeddingGeneration extends Hume.expressionMeasurement.UnionJobJobEmbeddingGeneration {
-        type: 'EMBEDDING_GENERATION';
-    }
-    interface Inference extends Hume.expressionMeasurement.UnionJobJobInference {
-        type: 'INFERENCE';
-    }
-    interface TlInference extends Hume.expressionMeasurement.UnionJobJobTlInference {
-        type: 'TL_INFERENCE';
-    }
-    interface Training extends Hume.expressionMeasurement.UnionJobJobTraining {
-        type: 'TRAINING';
-    }
-}
+export declare type UnionJob = Hume.expressionMeasurement.InferenceJob;

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

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
-export declare type UnionPredictResult = Hume.expressionMeasurement.InferenceSourcePredictResult | Hume.expressionMeasurement.TlInferenceSourcePredictResult;
+export declare type UnionPredictResult = Hume.expressionMeasurement.InferenceSourcePredictResult;

package/api/resources/expressionMeasurement/types/Window.d.ts

@@ -1,6 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Generate predictions based on time.
+ *
+ * Setting the `window` field allows for a 'sliding window' approach, where a fixed-size window moves across the audio or video file in defined steps. This enables continuous analysis of prosody within subsets of the file, providing dynamic and localized insights into emotional expression.
+ */
 export interface Window {
     /** The length of the sliding window. */
     length?: number;

package/api/resources/expressionMeasurement/types/index.d.ts

@@ -111,10 +111,10 @@ export * from './TranscriptionMetadata';
 export * from './Type';
 export * from './Unconfigurable';
 export * from './UnionJob';
-export * from './UnionJobJobEmbeddingGeneration';
-export * from './UnionJobJobInference';
-export * from './UnionJobJobTlInference';
-export * from './UnionJobJobTraining';
+export * from './EmbeddingGenerationJob';
+export * from './InferenceJob';
+export * from './CustomModelsInferenceJob';
+export * from './CustomModelsTrainingJob';
 export * from './UnionPredictResult';
 export * from './ValidationArgs';
 export * from './When';

package/api/resources/expressionMeasurement/types/index.js

@@ -127,10 +127,10 @@ __exportStar(require("./TranscriptionMetadata"), exports);
 __exportStar(require("./Type"), exports);
 __exportStar(require("./Unconfigurable"), exports);
 __exportStar(require("./UnionJob"), exports);
-__exportStar(require("./UnionJobJobEmbeddingGeneration"), exports);
-__exportStar(require("./UnionJobJobInference"), exports);
-__exportStar(require("./UnionJobJobTlInference"), exports);
-__exportStar(require("./UnionJobJobTraining"), exports);
+__exportStar(require("./EmbeddingGenerationJob"), exports);
+__exportStar(require("./InferenceJob"), exports);
+__exportStar(require("./CustomModelsInferenceJob"), exports);
+__exportStar(require("./CustomModelsTrainingJob"), exports);
 __exportStar(require("./UnionPredictResult"), exports);
 __exportStar(require("./ValidationArgs"), exports);
 __exportStar(require("./When"), exports);

package/api/resources/index.d.ts

@@ -1,2 +1,2 @@
-export * as empathicVoice from './empathicVoice';
 export * as expressionMeasurement from './expressionMeasurement';
+export * as empathicVoice from './empathicVoice';

package/api/resources/index.js

@@ -23,6 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.expressionMeasurement = exports.empathicVoice = void 0;
-exports.empathicVoice = __importStar(require("./empathicVoice"));
+exports.empathicVoice = exports.expressionMeasurement = void 0;
 exports.expressionMeasurement = __importStar(require("./expressionMeasurement"));
+exports.empathicVoice = __importStar(require("./empathicVoice"));

package/core/index.d.ts

@@ -2,4 +2,5 @@ export * from './fetcher';
 export * from './runtime';
 export * from './form-data-utils';
 export * from './websocket';
+export * from './pagination';
 export * as serialization from './schemas';

package/core/index.js

@@ -31,4 +31,5 @@ __exportStar(require("./fetcher"), exports);
 __exportStar(require("./runtime"), exports);
 __exportStar(require("./form-data-utils"), exports);
 __exportStar(require("./websocket"), exports);
+__exportStar(require("./pagination"), exports);
 exports.serialization = __importStar(require("./schemas"));

package/core/pagination/Page.d.ts

@@ -0,0 +1,29 @@
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ */
+export declare class Page<T> implements AsyncIterable<T> {
+    data: T[];
+    private response;
+    private _hasNextPage;
+    private getItems;
+    private loadNextPage;
+    constructor({ response, hasNextPage, getItems, loadPage, }: {
+        response: unknown;
+        hasNextPage: (response: unknown) => boolean;
+        getItems: (response: unknown) => T[];
+        loadPage: (response: unknown) => Promise<any>;
+    });
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    getNextPage(): Promise<this>;
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage(): boolean;
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, any>;
+}

package/core/pagination/Page.js

@@ -0,0 +1,94 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Page = void 0;
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ */
+class Page {
+    constructor({ response, hasNextPage, getItems, loadPage, }) {
+        this.response = response;
+        this.data = getItems(response);
+        this._hasNextPage = hasNextPage;
+        this.getItems = getItems;
+        this.loadNextPage = loadPage;
+    }
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    getNextPage() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.response = yield this.loadNextPage(this.response);
+            this.data = this.getItems(this.response);
+            return this;
+        });
+    }
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage() {
+        return this._hasNextPage(this.response);
+    }
+    iterMessages() {
+        return __asyncGenerator(this, arguments, function* iterMessages_1() {
+            for (const item of this.data) {
+                yield yield __await(item);
+            }
+            while (this.hasNextPage()) {
+                yield __await(this.getNextPage());
+                for (const item of this.data) {
+                    yield yield __await(item);
+                }
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var e_1, _b;
+            try {
+                for (var _c = __asyncValues(this.iterMessages()), _d; _d = yield __await(_c.next()), !_d.done;) {
+                    const message = _d.value;
+                    yield yield __await(message);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_d && !_d.done && (_b = _c.return)) yield __await(_b.call(_c));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+}
+exports.Page = Page;