Release 0.1.3

Author: fern-api[bot]

.gitignore

@@ -9,4 +9,5 @@ node_modules
 /index.js
 /api
 /core
-/errors
+/errors
+/serialization

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fern-api/hume",
-    "version": "0.1.2",
+    "version": "0.1.3",
     "private": false,
     "repository": "https://github.com/fern-hume/hume-typescript-sdk",
     "main": "./index.js",

src/Client.ts

@@ -6,6 +6,7 @@ import * as environments from "./environments";
 import * as core from "./core";
 import * as Hume from "./api";
 import urlJoin from "url-join";
+import * as serializers from "./serialization";
 import * as errors from "./errors";
 
 export declare namespace HumeClient {
@@ -72,15 +73,20 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@fern-api/hume",
-                "X-Fern-SDK-Version": "0.1.2",
+                "X-Fern-SDK-Version": "0.1.3",
             },
             contentType: "application/json",
             queryParameters: _queryParams,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
         });
         if (_response.ok) {
-            return _response.body as Hume.JobRequest[];
+            return await serializers.listJobs.Response.parseOrThrow(_response.body, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+                breadcrumbsPrefix: ["response"],
+            });
         }
 
         if (_response.error.reason === "status-code") {
@@ -122,15 +128,20 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@fern-api/hume",
-                "X-Fern-SDK-Version": "0.1.2",
+                "X-Fern-SDK-Version": "0.1.3",
             },
             contentType: "application/json",
-            body: request,
+            body: await serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
         });
         if (_response.ok) {
-            return _response.body as Hume.JobId;
+            return await serializers.JobId.parseOrThrow(_response.body, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+                breadcrumbsPrefix: ["response"],
+            });
         }
 
         if (_response.error.reason === "status-code") {
@@ -172,14 +183,19 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@fern-api/hume",
-                "X-Fern-SDK-Version": "0.1.2",
+                "X-Fern-SDK-Version": "0.1.3",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
         });
         if (_response.ok) {
-            return _response.body as Hume.SourceResult[];
+            return await serializers.getJobPredictions.Response.parseOrThrow(_response.body, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+                breadcrumbsPrefix: ["response"],
+            });
         }
 
         if (_response.error.reason === "status-code") {
@@ -218,7 +234,7 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@fern-api/hume",
-                "X-Fern-SDK-Version": "0.1.2",
+                "X-Fern-SDK-Version": "0.1.3",
             },
             contentType: "application/json",
             responseType: "blob",
@@ -265,14 +281,19 @@ export class HumeClient {
                 "X-Hume-Api-Key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@fern-api/hume",
-                "X-Fern-SDK-Version": "0.1.2",
+                "X-Fern-SDK-Version": "0.1.3",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
         });
         if (_response.ok) {
-            return _response.body as Hume.JobRequest;
+            return await serializers.JobRequest.parseOrThrow(_response.body, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+                breadcrumbsPrefix: ["response"],
+            });
         }
 
         if (_response.error.reason === "status-code") {

src/api/types/Completed.ts

@@ -4,13 +4,13 @@
 
 export interface Completed {
     /** When this job was created (Unix timestamp in milliseconds). */
-    created_timestamp_ms: number;
+    createdTimestampMs: number;
     /** When this job started (Unix timestamp in milliseconds). */
-    started_timestamp_ms: number;
+    startedTimestampMs: number;
     /** When this job ended (Unix timestamp in milliseconds). */
-    ended_timestamp_ms: number;
+    endedTimestampMs: number;
     /** The number of predictions that were generated by this job. */
-    num_predictions: number;
+    numPredictions: number;
     /** The number of errors that occurred while running this job. */
-    num_errors: number;
+    numErrors: number;
 }

src/api/types/Face.ts

@@ -6,15 +6,15 @@ import * as Hume from "..";
 
 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. */
-    fps_pred?: number;
+    fpsPred?: number;
     /** Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response. */
-    prob_threshold?: number;
+    probThreshold?: number;
     /** 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. */
-    identify_faces?: boolean;
+    identifyFaces?: boolean;
     /** 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. */
-    min_face_size?: number;
+    minFaceSize?: number;
     facs?: Hume.Empty;
     descriptions?: Hume.Empty;
     /** Whether to extract and save the detected faces in the artifacts zip created by each job. */
-    save_faces?: boolean;
+    saveFaces?: boolean;
 }

src/api/types/FaceModelConfig.ts

@@ -17,20 +17,20 @@ export interface FaceModelConfig {
      * 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.
      *
      */
-    identify_faces?: boolean;
+    identifyFaces?: boolean;
     /**
      * Number of frames per second to process. Other frames will be omitted from the response.
      *
      */
-    fps_pred?: number;
+    fpsPred?: number;
     /**
      * Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response.
      *
      */
-    prob_threshold?: number;
+    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.
      *
      */
-    min_face_size?: number;
+    minFaceSize?: number;
 }

src/api/types/Failed.ts

@@ -4,11 +4,11 @@
 
 export interface Failed {
     /** When this job was created (Unix timestamp in milliseconds). */
-    created_timestamp_ms: number;
+    createdTimestampMs: number;
     /** When this job started (Unix timestamp in milliseconds). */
-    started_timestamp_ms: number;
+    startedTimestampMs: number;
     /** When this job ended (Unix timestamp in milliseconds). */
-    ended_timestamp_ms: number;
+    endedTimestampMs: number;
     /** An error message. */
     message: string;
 }

src/api/types/File_.ts

@@ -6,7 +6,7 @@ export interface File_ {
     /** The name of the file. */
     filename?: string;
     /** The content type of the file. */
-    content_type?: string;
+    contentType?: string;
     /** The MD5 checksum of the file. */
-    md5sum: string;
+    md5Sum: string;
 }

src/api/types/InProgress.ts

@@ -4,7 +4,7 @@
 
 export interface InProgress {
     /** When this job was created (Unix timestamp in milliseconds). */
-    created_timestamp_ms: number;
+    createdTimestampMs: number;
     /** When this job started (Unix timestamp in milliseconds). */
-    started_timestamp_ms: number;
+    startedTimestampMs: number;
 }

src/api/types/JobId.ts

@@ -4,5 +4,5 @@
 
 export interface JobId {
     /** The ID of the started job. */
-    job_id: string;
+    jobId: string;
 }

src/api/types/JobRequest.ts

@@ -5,8 +5,8 @@
 import * as Hume from "..";
 
 export interface JobRequest {
-    user_id: string;
-    job_id: string;
+    userId: string;
+    jobId: string;
     request: Hume.Request;
     state: Hume.State;
 }

src/api/types/Language.ts

@@ -7,7 +7,7 @@ import * as Hume from "..";
 export interface Language {
     granularity?: Hume.Granularity;
     /** 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. */
-    identify_speakers?: boolean;
+    identifySpeakers?: boolean;
     sentiment?: Hume.Empty;
     toxicity?: Hume.Empty;
 }

src/api/types/LanguagePrediction.ts

@@ -12,7 +12,7 @@ export interface LanguagePrediction {
     /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text. */
     confidence?: number;
     /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence that this text was spoken by this speaker. */
-    speaker_confidence?: number;
+    speakerConfidence?: number;
     /** A high-dimensional embedding in emotion space. */
     emotions: Hume.EmotionScore[];
     /**

src/api/types/ModelsInput.ts

@@ -23,7 +23,7 @@ export interface ModelsInput {
      * Note: This feature is currently only supported for audio data and audio models. For other file types and models this parameter will be ignored.
      *
      */
-    stream_window_ms?: number;
+    streamWindowMs?: number;
     /**
      * Whether to reset the streaming sliding window before processing the current payload.
      *
@@ -32,13 +32,13 @@ export interface ModelsInput {
      * Use reset_stream when one audio file is done being processed and you do not want context to leak across files.
      *
      */
-    reset_stream?: boolean;
+    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.
      *
      */
-    raw_text?: boolean;
+    rawText?: boolean;
     /**
      * Set to `true` to get details about the job.
      *
@@ -47,12 +47,12 @@ export interface ModelsInput {
      * This parameter is useful to get the unique job ID.
      *
      */
-    job_details?: boolean;
+    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.
      *
      */
-    payload_id?: string;
+    payloadId?: string;
 }

src/api/types/ModelsSuccessFacePredictionsItem.ts

@@ -13,7 +13,7 @@ export interface ModelsSuccessFacePredictionsItem {
     /** The predicted probability that a detected face was actually a face. */
     prob?: number;
     /** Identifier for a face. Not that this defaults to `unknown` unless face identification is enabled in the face model configuration. */
-    face_id?: string;
+    faceId?: string;
     emotions?: Hume.EmotionEmbedding;
     facs?: Hume.EmotionEmbedding;
     descriptions?: Hume.EmotionEmbedding;

src/api/types/Ner.ts

@@ -4,5 +4,5 @@
 
 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. */
-    identify_speakers?: boolean;
+    identifySpeakers?: boolean;
 }

src/api/types/NerPrediction.ts

@@ -9,18 +9,18 @@ export interface NerPrediction {
     entity: string;
     position: Hume.PositionInterval;
     /** Our NER model's relative confidence in the recognized topic or entity. */
-    entity_confidence: number;
+    entityConfidence: number;
     /** A measure of how often the entity is linked to by other entities. */
     support: number;
     /** A URL which provides more information about the recognized topic or entity. */
     uri: string;
     /** The specific word to which the emotion predictions are linked. */
-    link_word: string;
+    linkWord: string;
     time?: Hume.TimeInterval;
     /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text. */
     confidence?: number;
     /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence that this text was spoken by this speaker. */
-    speaker_confidence?: number;
+    speakerConfidence?: number;
     /** A high-dimensional embedding in emotion space. */
     emotions: Hume.EmotionScore[];
 }

src/api/types/PredictionsOptionalNullBurstPrediction.ts

@@ -6,5 +6,5 @@ import * as Hume from "..";
 
 export interface PredictionsOptionalNullBurstPrediction {
     metadata?: Hume.Null;
-    grouped_predictions: Hume.GroupedPredictionsBurstPrediction[];
+    groupedPredictions: Hume.GroupedPredictionsBurstPrediction[];
 }

src/api/types/PredictionsOptionalNullFacePrediction.ts

@@ -6,5 +6,5 @@ import * as Hume from "..";
 
 export interface PredictionsOptionalNullFacePrediction {
     metadata?: Hume.Null;
-    grouped_predictions: Hume.GroupedPredictionsFacePrediction[];
+    groupedPredictions: Hume.GroupedPredictionsFacePrediction[];
 }

src/api/types/PredictionsOptionalNullFacemeshPrediction.ts

@@ -6,5 +6,5 @@ import * as Hume from "..";
 
 export interface PredictionsOptionalNullFacemeshPrediction {
     metadata?: Hume.Null;
-    grouped_predictions: Hume.GroupedPredictionsFacemeshPrediction[];
+    groupedPredictions: Hume.GroupedPredictionsFacemeshPrediction[];
 }

src/api/types/PredictionsOptionalTranscriptionMetadataLanguagePrediction.ts

@@ -6,5 +6,5 @@ import * as Hume from "..";
 
 export interface PredictionsOptionalTranscriptionMetadataLanguagePrediction {
     metadata?: Hume.TranscriptionMetadata;
-    grouped_predictions: Hume.GroupedPredictionsLanguagePrediction[];
+    groupedPredictions: Hume.GroupedPredictionsLanguagePrediction[];
 }

src/api/types/PredictionsOptionalTranscriptionMetadataNerPrediction.ts

@@ -6,5 +6,5 @@ import * as Hume from "..";
 
 export interface PredictionsOptionalTranscriptionMetadataNerPrediction {
     metadata?: Hume.TranscriptionMetadata;
-    grouped_predictions: Hume.GroupedPredictionsNerPrediction[];
+    groupedPredictions: Hume.GroupedPredictionsNerPrediction[];
 }

src/api/types/PredictionsOptionalTranscriptionMetadataProsodyPrediction.ts

@@ -6,5 +6,5 @@ import * as Hume from "..";
 
 export interface PredictionsOptionalTranscriptionMetadataProsodyPrediction {
     metadata?: Hume.TranscriptionMetadata;
-    grouped_predictions: Hume.GroupedPredictionsProsodyPrediction[];
+    groupedPredictions: Hume.GroupedPredictionsProsodyPrediction[];
 }

src/api/types/Prosody.ts

@@ -10,6 +10,6 @@ import * as Hume from "..";
 export interface Prosody {
     granularity?: Hume.Granularity;
     /** 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. */
-    identify_speakers?: boolean;
+    identifySpeakers?: boolean;
     window?: Hume.Window;
 }

src/api/types/ProsodyPrediction.ts

@@ -11,7 +11,7 @@ export interface ProsodyPrediction {
     /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text. */
     confidence?: number;
     /** Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence that this text was spoken by this speaker. */
-    speaker_confidence?: number;
+    speakerConfidence?: number;
     /** A high-dimensional embedding in emotion space. */
     emotions: Hume.EmotionScore[];
 }