hume 0.3.0 → 0.3.1

package/Client.js

@@ -94,7 +94,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -143,7 +143,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 body: yield serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -195,7 +195,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -243,7 +243,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 responseType: "streaming",
@@ -287,7 +287,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/types/FaceModelConfig.d.ts

@@ -5,31 +5,18 @@
  * Configuration for the facial expression emotion model.
  *
  * Note: Using the `reset_stream` parameter does not have any effect on face identification. A single face identifier cache is maintained over a full session whether `reset_stream` is used or not.
- *
  */
 export interface FaceModelConfig {
     /** Configuration for FACS predictions. If missing or null, no FACS predictions will be generated. */
     facs?: Record<string, unknown>;
     /** Configuration for Descriptions predictions. If missing or null, no Descriptions predictions will be generated. */
     descriptions?: Record<string, unknown>;
-    /**
-     * Whether to return identifiers for faces across frames. If true, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If false, all faces will be tagged with an "unknown" ID.
-     *
-     */
+    /** Whether to return identifiers for faces across frames. If true, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If false, all faces will be tagged with an "unknown" ID. */
     identifyFaces?: boolean;
-    /**
-     * Number of frames per second to process. Other frames will be omitted from the response.
-     *
-     */
+    /** Number of frames per second to process. Other frames will be omitted from the response. */
     fpsPred?: number;
-    /**
-     * Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response.
-     *
-     */
+    /** Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response. */
     probThreshold?: number;
-    /**
-     * 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.
-     *
-     */
+    /** 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. */
     minFaceSize?: number;
 }

package/api/types/ModelConfig.d.ts

@@ -4,7 +4,6 @@
 import * as Hume from "..";
 /**
  * Configuration used to specify which models should be used and with what settings.
- *
  */
 export interface ModelConfig {
     /**
@@ -13,14 +12,12 @@ export interface ModelConfig {
      * Note: Model configuration is not currently available in streaming.
      *
      * Please use the default configuration by passing an empty object `{}`.
-     *
      */
     burst?: Record<string, unknown>;
     /**
      * Configuration for the facial expression emotion model.
      *
      * Note: Using the `reset_stream` parameter does not have any effect on face identification. A single face identifier cache is maintained over a full session whether `reset_stream` is used or not.
-     *
      */
     face?: Hume.FaceModelConfig;
     /**
@@ -29,7 +26,6 @@ export interface ModelConfig {
      * Note: Model configuration is not currently available in streaming.
      *
      * Please use the default configuration by passing an empty object `{}`.
-     *
      */
     facemesh?: Record<string, unknown>;
     /** Configuration for the language emotion model. */
@@ -40,7 +36,6 @@ export interface ModelConfig {
      * Note: Model configuration is not currently available in streaming.
      *
      * Please use the default configuration by passing an empty object `{}`.
-     *
      */
     prosody?: Record<string, unknown>;
 }

package/api/types/ModelsInput.d.ts

@@ -4,10 +4,7 @@
 import * as Hume from "..";
 export interface ModelsInput {
     data?: string;
-    /**
-     * Configuration used to specify which models should be used and with what settings.
-     *
-     */
+    /** Configuration used to specify which models should be used and with what settings. */
     models?: Hume.ModelConfig;
     /**
      * Length in milliseconds of streaming sliding window.
@@ -19,7 +16,6 @@ export interface ModelsInput {
      * A window of 600ms would append the full 500ms of the second payload to the last 100ms of the first payload.
      *
      * Note: This feature is currently only supported for audio data and audio models. For other file types and models this parameter will be ignored.
-     *
      */
     streamWindowMs?: number;
     /**
@@ -28,13 +24,11 @@ export interface ModelsInput {
      * If this parameter is set to `true` then past context will be deleted before processing the current payload.
      *
      * Use reset_stream when one audio file is done being processed and you do not want context to leak across files.
-     *
      */
     resetStream?: boolean;
     /**
      * Set to `true` to enable the data parameter to be parsed as raw text rather than base64 encoded bytes.
      * This parameter is useful if you want to send text to be processed by the language model, but it cannot be used with other file types like audio, image, or video.
-     *
      */
     rawText?: boolean;
     /**
@@ -43,14 +37,12 @@ export interface ModelsInput {
      * This parameter can be set in the same payload as data or it can be set without data and models configuration to get the job details between payloads.
      *
      * This parameter is useful to get the unique job ID.
-     *
      */
     jobDetails?: boolean;
     /**
      * Pass an arbitrary string as the payload ID and get it back at the top level of the socket response.
      *
      * This can be useful if you have multiple requests running asynchronously and want to disambiguate responses as they are received.
-     *
      */
     payloadId?: string;
 }

package/api/types/TextPosition.d.ts

@@ -3,7 +3,6 @@
  */
 /**
  * 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. */

package/dist/Client.js

@@ -94,7 +94,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -143,7 +143,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 body: yield serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -195,7 +195,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -243,7 +243,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 responseType: "streaming",
@@ -287,7 +287,7 @@ class HumeClient {
                     "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "hume",
-                    "X-Fern-SDK-Version": "0.3.0",
+                    "X-Fern-SDK-Version": "0.3.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/api/types/FaceModelConfig.d.ts

@@ -5,31 +5,18 @@
  * Configuration for the facial expression emotion model.
  *
  * Note: Using the `reset_stream` parameter does not have any effect on face identification. A single face identifier cache is maintained over a full session whether `reset_stream` is used or not.
- *
  */
 export interface FaceModelConfig {
     /** Configuration for FACS predictions. If missing or null, no FACS predictions will be generated. */
     facs?: Record<string, unknown>;
     /** Configuration for Descriptions predictions. If missing or null, no Descriptions predictions will be generated. */
     descriptions?: Record<string, unknown>;
-    /**
-     * Whether to return identifiers for faces across frames. If true, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If false, all faces will be tagged with an "unknown" ID.
-     *
-     */
+    /** Whether to return identifiers for faces across frames. If true, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If false, all faces will be tagged with an "unknown" ID. */
     identifyFaces?: boolean;
-    /**
-     * Number of frames per second to process. Other frames will be omitted from the response.
-     *
-     */
+    /** Number of frames per second to process. Other frames will be omitted from the response. */
     fpsPred?: number;
-    /**
-     * Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response.
-     *
-     */
+    /** Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response. */
     probThreshold?: number;
-    /**
-     * 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.
-     *
-     */
+    /** 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. */
     minFaceSize?: number;
 }

package/dist/api/types/ModelConfig.d.ts

@@ -4,7 +4,6 @@
 import * as Hume from "..";
 /**
  * Configuration used to specify which models should be used and with what settings.
- *
  */
 export interface ModelConfig {
     /**
@@ -13,14 +12,12 @@ export interface ModelConfig {
      * Note: Model configuration is not currently available in streaming.
      *
      * Please use the default configuration by passing an empty object `{}`.
-     *
      */
     burst?: Record<string, unknown>;
     /**
      * Configuration for the facial expression emotion model.
      *
      * Note: Using the `reset_stream` parameter does not have any effect on face identification. A single face identifier cache is maintained over a full session whether `reset_stream` is used or not.
-     *
      */
     face?: Hume.FaceModelConfig;
     /**
@@ -29,7 +26,6 @@ export interface ModelConfig {
      * Note: Model configuration is not currently available in streaming.
      *
      * Please use the default configuration by passing an empty object `{}`.
-     *
      */
     facemesh?: Record<string, unknown>;
     /** Configuration for the language emotion model. */
@@ -40,7 +36,6 @@ export interface ModelConfig {
      * Note: Model configuration is not currently available in streaming.
      *
      * Please use the default configuration by passing an empty object `{}`.
-     *
      */
     prosody?: Record<string, unknown>;
 }

package/dist/api/types/ModelsInput.d.ts

@@ -4,10 +4,7 @@
 import * as Hume from "..";
 export interface ModelsInput {
     data?: string;
-    /**
-     * Configuration used to specify which models should be used and with what settings.
-     *
-     */
+    /** Configuration used to specify which models should be used and with what settings. */
     models?: Hume.ModelConfig;
     /**
      * Length in milliseconds of streaming sliding window.
@@ -19,7 +16,6 @@ export interface ModelsInput {
      * A window of 600ms would append the full 500ms of the second payload to the last 100ms of the first payload.
      *
      * Note: This feature is currently only supported for audio data and audio models. For other file types and models this parameter will be ignored.
-     *
      */
     streamWindowMs?: number;
     /**
@@ -28,13 +24,11 @@ export interface ModelsInput {
      * If this parameter is set to `true` then past context will be deleted before processing the current payload.
      *
      * Use reset_stream when one audio file is done being processed and you do not want context to leak across files.
-     *
      */
     resetStream?: boolean;
     /**
      * Set to `true` to enable the data parameter to be parsed as raw text rather than base64 encoded bytes.
      * This parameter is useful if you want to send text to be processed by the language model, but it cannot be used with other file types like audio, image, or video.
-     *
      */
     rawText?: boolean;
     /**
@@ -43,14 +37,12 @@ export interface ModelsInput {
      * This parameter can be set in the same payload as data or it can be set without data and models configuration to get the job details between payloads.
      *
      * This parameter is useful to get the unique job ID.
-     *
      */
     jobDetails?: boolean;
     /**
      * Pass an arbitrary string as the payload ID and get it back at the top level of the socket response.
      *
      * This can be useful if you have multiple requests running asynchronously and want to disambiguate responses as they are received.
-     *
      */
     payloadId?: string;
 }

package/dist/api/types/TextPosition.d.ts

@@ -3,7 +3,6 @@
  */
 /**
  * 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. */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hume",
-    "version": "0.3.0",
+    "version": "0.3.1",
     "private": false,
     "repository": "https://github.com/HumeAI/hume-typescript-sdk",
     "main": "./index.js",