hume 0.8.4 → 0.8.6

package/.mock/definition/expression-measurement/__package__.yml

@@ -76,58 +76,58 @@ types:
   CompletedEmbeddingGeneration:
     properties:
       created_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job was created (Unix timestamp in milliseconds).
       started_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job started (Unix timestamp in milliseconds).
       ended_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job ended (Unix timestamp in milliseconds).
   CompletedInference:
     properties:
       created_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job was created (Unix timestamp in milliseconds).
       started_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job started (Unix timestamp in milliseconds).
       ended_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job ended (Unix timestamp in milliseconds).
       num_predictions:
-        type: integer
+        type: uint64
         docs: The number of predictions that were generated by this job.
       num_errors:
-        type: integer
+        type: uint64
         docs: The number of errors that occurred while running this job.
   CompletedTlInference:
     properties:
       created_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job was created (Unix timestamp in milliseconds).
       started_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job started (Unix timestamp in milliseconds).
       ended_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job ended (Unix timestamp in milliseconds).
       num_predictions:
-        type: integer
+        type: uint64
         docs: The number of predictions that were generated by this job.
       num_errors:
-        type: integer
+        type: uint64
         docs: The number of errors that occurred while running this job.
   CompletedTraining:
     properties:
       created_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job was created (Unix timestamp in milliseconds).
       started_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job started (Unix timestamp in milliseconds).
       ended_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job ended (Unix timestamp in milliseconds).
       custom_model: TrainingCustomModel
       alternatives: optional<map<string, TrainingCustomModel>>
@@ -195,6 +195,12 @@ types:
     properties:
       validation: optional<ValidationArgs>
   Face:
+    docs: >-
+      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`
     properties:
       fps_pred:
         type: optional<double>
@@ -221,14 +227,11 @@ types:
           with an `unknown` ID.
         default: false
       min_face_size:
-        type: optional<integer>
+        type: optional<uint64>
         docs: >-
           Minimum bounding box side length in pixels to treat as a face. Faces
           detected with a bounding box side length in pixels less than this
           threshold will be omitted from the response.
-        default: 60
-        validation:
-          min: 10
       facs: optional<Unconfigurable>
       descriptions: optional<Unconfigurable>
       save_faces:
@@ -240,7 +243,7 @@ types:
   FacePrediction:
     properties:
       frame:
-        type: integer
+        type: uint64
         docs: Frame number
       time:
         type: double
@@ -274,18 +277,19 @@ types:
   Failed:
     properties:
       created_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job was created (Unix timestamp in milliseconds).
       started_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job started (Unix timestamp in milliseconds).
       ended_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job ended (Unix timestamp in milliseconds).
       message:
         type: string
         docs: An error message.
   File:
+    docs: The list of files submitted for analysis.
     properties:
       filename:
         type: optional<string>
@@ -303,9 +307,35 @@ types:
       - utterance
       - conversational_turn
     docs: >-
-      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.
   GroupedPredictionsBurstPrediction:
     properties:
       id:
@@ -363,14 +393,21 @@ types:
   InProgress:
     properties:
       created_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job was created (Unix timestamp in milliseconds).
       started_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job started (Unix timestamp in milliseconds).
   InferenceBaseRequest:
     properties:
-      models: optional<Models>
+      models:
+        type: optional<Models>
+        docs: >-
+          Specify the models to use for inference.
+
+
+          If this field is not explicitly set, then all models will run by
+          default.
       transcription: optional<Transcription>
       urls:
         type: optional<list<string>>
@@ -387,7 +424,9 @@ types:
         docs: List of File IDs corresponding to the files in the asset registry.
       text:
         type: optional<list<string>>
-        docs: Text to supply directly to our language and NER models.
+        docs: >-
+          Text supplied directly to our Emotional Language and NER models for
+          analysis.
       callback_url:
         type: optional<string>
         docs: >-
@@ -470,10 +509,15 @@ types:
           format: uuid
       user_id:
         type: string
+        docs: The unique identifier for the user who initiated the job.
         validation:
           format: uuid
-      request: InferenceRequest
-      state: StateInference
+      request:
+        type: InferenceRequest
+        docs: The request that initiated the job.
+      state:
+        type: StateInference
+        docs: The current state of the job.
   JobTlInference:
     properties:
       job_id:
@@ -508,6 +552,13 @@ types:
         validation:
           format: uuid
   Language:
+    docs: >-
+      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`
     properties:
       granularity: optional<Granularity>
       sentiment: optional<Unconfigurable>
@@ -562,6 +613,7 @@ types:
           classified into the following categories: `toxic`, `severe_toxic`,
           `obscene`, `threat`, `insult`, and `identity_hate`.
   Models:
+    docs: The models used for inference.
     properties:
       face: optional<Face>
       burst: optional<Unconfigurable>
@@ -578,6 +630,13 @@ types:
       ner: optional<PredictionsOptionalTranscriptionMetadataNerPrediction>
       facemesh: optional<PredictionsOptionalNullFacemeshPrediction>
   Ner:
+    docs: >-
+      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`
     properties:
       identify_speakers:
         type: optional<boolean>
@@ -631,10 +690,10 @@ types:
       the end index is exclusive.
     properties:
       begin:
-        type: integer
+        type: uint64
         docs: The index of the first character in the text segment, inclusive.
       end:
-        type: integer
+        type: uint64
         docs: The index of the last character in the text segment, exclusive.
   PredictionsOptionalNullBurstPrediction:
     properties:
@@ -661,6 +720,12 @@ types:
       metadata: optional<TranscriptionMetadata>
       grouped_predictions: list<GroupedPredictionsProsodyPrediction>
   Prosody:
+    docs: >-
+      The Speech Prosody model analyzes the intonation, stress, and rhythm of
+      spoken word.
+
+
+      Recommended input file types: `.wav`, `.mp3`, `.mp4`
     properties:
       granularity: optional<Granularity>
       window: optional<Window>
@@ -694,7 +759,7 @@ types:
   Queued:
     properties:
       created_timestamp_ms:
-        type: integer
+        type: long
         docs: When this job was created (Unix timestamp in milliseconds).
   RegistryFileDetail:
     properties:
@@ -867,7 +932,7 @@ types:
   Target:
     discriminated: false
     union:
-      - integer
+      - long
       - double
       - string
   Task:
@@ -955,8 +1020,79 @@ types:
       id: string
       version_id: optional<string>
   Transcription:
+    docs: |-
+      Transcription-related configuration options.
+
+      To disable transcription, explicitly set this field to `null`.
     properties:
-      language: optional<Bcp47Tag>
+      language:
+        type: optional<Bcp47Tag>
+        docs: >-
+          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`
       identify_speakers:
         type: optional<boolean>
         docs: >-
@@ -995,35 +1131,35 @@ types:
       To include predictions for this model type, set this field to `{}`. It is
       currently not configurable further.
     type: map<string, unknown>
-  UnionJob:
-    discriminant: type
-    base-properties: {}
-    union:
-      EMBEDDING_GENERATION: UnionJobJobEmbeddingGeneration
-      INFERENCE: UnionJobJobInference
-      TL_INFERENCE: UnionJobJobTlInference
-      TRAINING: UnionJobJobTraining
-  UnionJobJobEmbeddingGeneration:
-    properties: {}
+  UnionJob: InferenceJob
+  EmbeddingGenerationJob:
+    properties:
+      type: string
     extends:
       - JobEmbeddingGeneration
-  UnionJobJobInference:
-    properties: {}
+  InferenceJob:
+    properties:
+      type:
+        type: string
+        docs: >-
+          Denotes the job type.
+
+
+          Jobs created with the Expression Measurement API will have this field
+          set to `INFERENCE`.
     extends:
       - JobInference
-  UnionJobJobTlInference:
-    properties: {}
+  CustomModelsInferenceJob:
+    properties:
+      type: string
     extends:
       - JobTlInference
-  UnionJobJobTraining:
-    properties: {}
+  CustomModelsTrainingJob:
+    properties:
+      type: string
     extends:
       - JobTraining
-  UnionPredictResult:
-    discriminated: false
-    union:
-      - InferenceSourcePredictResult
-      - TlInferenceSourcePredictResult
+  UnionPredictResult: InferenceSourcePredictResult
   ValidationArgs:
     properties:
       positive_label: optional<Target>
@@ -1032,6 +1168,14 @@ types:
       - created_before
       - created_after
   Window:
+    docs: >-
+      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.
     properties:
       length:
         type: optional<double>

package/.mock/definition/expression-measurement/batch.yml

@@ -19,25 +19,63 @@ service:
           status:
             type: optional<root.Status>
             allow-multiple: true
-            docs: Include only jobs with these statuses.
+            docs: >-
+              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.
           when:
             type: optional<root.When>
             docs: >-
-              Include only jobs that were created before or after
+              Specify whether to include jobs created before or after a given
               `timestamp_ms`.
           timestamp_ms:
-            type: optional<integer>
-            docs: Defaults to the current date and time. See `when`.
+            type: optional<long>
+            docs: |-
+              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.
           sort_by:
             type: optional<root.SortBy>
-            docs: The job timestamp to sort by.
+            docs: >-
+              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`.
           direction:
             type: optional<root.Direction>
-            docs: The sort direction.
-          type:
-            type: optional<root.Type>
-            allow-multiple: true
-            docs: Include only jobs of these types.
+            docs: >-
+              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).
       response:
         docs: ''
         type: list<root.UnionJob>
@@ -106,27 +144,14 @@ service:
       auth: true
       docs: Get the request details and state of a given job.
       path-parameters:
-        id: string
+        id:
+          type: string
+          docs: The unique identifier for the job.
       display-name: Get job details
       response:
         docs: ''
         type: root.UnionJob
       examples:
-        - name: Embedding Generation
-          path-parameters:
-            id: job_id
-          response:
-            body:
-              type: EMBEDDING_GENERATION
-              job_id: string
-              request:
-                registry_file_details:
-                  - file_id: string
-                    file_url: string
-              state:
-                status: QUEUED
-                created_timestamp_ms: 0
-              user_id: string
         - name: Inference
           path-parameters:
             id: job_id
@@ -170,11 +195,11 @@ service:
       path: /v0/batch/jobs/{id}/predictions
       method: GET
       auth: true
-      docs: >-
-        Get the JSON predictions of a completed measurement or custom models
-        inference job.
+      docs: Get the JSON predictions of a completed inference job.
       path-parameters:
-        id: string
+        id:
+          type: string
+          docs: The unique identifier for the job.
       display-name: Get job predictions
       response:
         docs: ''
@@ -305,11 +330,11 @@ service:
       path: /v0/batch/jobs/{id}/artifacts
       method: GET
       auth: true
-      docs: >-
-        Get the artifacts ZIP of a completed measurement or custom models
-        inference job.
+      docs: Get the artifacts ZIP of a completed inference job.
       path-parameters:
-        id: string
+        id:
+          type: string
+          docs: The unique identifier for the job.
       display-name: Get job artifacts
       response:
         docs: ''
@@ -324,7 +349,11 @@ service:
         name: BatchStartInferenceJobFromLocalFileRequest
         body:
           properties:
-            json: optional<root.InferenceBaseRequest>
+            json:
+              type: optional<root.InferenceBaseRequest>
+              docs: >-
+                Stringified JSON object containing the inference job
+                configuration.
             file: list<file>
         content-type: multipart/form-data
       response:

package/.mock/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization": "hume",
-  "version": "0.31.24"
+  "version": "0.37.4"
 }

package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts

@@ -27,16 +27,25 @@ export declare class ChatGroups {
      * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.chatGroups.listChatGroups()
+     *     await client.empathicVoice.chatGroups.listChatGroups({
+     *         pageNumber: 0,
+     *         pageSize: 1,
+     *         ascendingOrder: true,
+     *         configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
+     *     })
      */
     listChatGroups(request?: Hume.empathicVoice.ChatGroupsListChatGroupsRequest, requestOptions?: ChatGroups.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedChatGroups>;
     /**
-     * @param {string} id - Identifier for a chat. Formatted as a UUID.
+     * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
      * @param {Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest} request
      * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.chatGroups.listChatGroupEvents("id")
+     *     await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
+     *         pageNumber: 0,
+     *         pageSize: 3,
+     *         ascendingOrder: true
+     *     })
      */
     listChatGroupEvents(id: string, request?: Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest, requestOptions?: ChatGroups.RequestOptions): Promise<Hume.empathicVoice.ReturnChatGroupPagedEvents>;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/api/resources/empathicVoice/resources/chatGroups/client/Client.js

@@ -53,7 +53,12 @@ class ChatGroups {
      * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.chatGroups.listChatGroups()
+     *     await client.empathicVoice.chatGroups.listChatGroups({
+     *         pageNumber: 0,
+     *         pageSize: 1,
+     *         ascendingOrder: true,
+     *         configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
+     *     })
      */
     listChatGroups(request = {}, requestOptions) {
         var _a, _b;
@@ -75,7 +80,7 @@ class ChatGroups {
             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/evi/chat_groups'),
                 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
@@ -114,12 +119,16 @@ class ChatGroups {
         });
     }
     /**
-     * @param {string} id - Identifier for a chat. Formatted as a UUID.
+     * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
      * @param {Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest} request
      * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.chatGroups.listChatGroupEvents("id")
+     *     await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
+     *         pageNumber: 0,
+     *         pageSize: 3,
+     *         ascendingOrder: true
+     *     })
      */
     listChatGroupEvents(id, request = {}, requestOptions) {
         var _a, _b;
@@ -138,7 +147,7 @@ class ChatGroups {
             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/evi/chat_groups/${encodeURIComponent(id)}/events`),
                 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