Release 0.1.0

package.json

@@ -1,6 +1,6 @@
 {
  "name": "@fern-api/hume",
- "version": "0.0.10",
+ "version": "0.1.0",
  "private": false,
  "repository": "https://github.com/fern-hume/hume-typescript-sdk",
  "main": "./index.js",
@@ -11,10 +11,11 @@
  "prepack": "cp -rv dist/. ."
  },
  "dependencies": {
- "@ungap/url-search-params": "0.2.2",
  "url-join": "4.0.1",
  "@types/url-join": "4.0.1",
- "axios": "0.27.2"
+ "axios": "0.27.2",
+ "qs": "6.11.2",
+ "@types/qs": "6.9.8"
  },
  "devDependencies": {
  "@types/node": "17.0.33",

src/Client.ts

@@ -5,7 +5,6 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import * as Hume from "./api";
-import { default as URLSearchParams } from "@ungap/url-search-params";
 import urlJoin from "url-join";
 import * as serializers from "./serialization";
 import * as errors from "./errors";
@@ -15,62 +14,71 @@ export declare namespace HumeClient {
  environment?: core.Supplier<environments.HumeEnvironment | string>;
  apiKey: core.Supplier<string>;
  }
+
+ interface RequestOptions {
+ timeoutInSeconds?: number;
+ maxRetries?: number;
+ }
 }
 
 export class HumeClient {
- constructor(protected readonly options: HumeClient.Options) {}
+ constructor(protected readonly _options: HumeClient.Options) {}
 
  /**
  * Sort and filter jobs.
  */
- public async listJobs(request: Hume.ListJobsRequest = {}): Promise<Hume.JobRequest[]> {
+ public async listJobs(
+ request: Hume.ListJobsRequest = {},
+ requestOptions?: HumeClient.RequestOptions
+ ): Promise<Hume.JobRequest[]> {
  const { limit, status, when, timestampMs, sortBy, direction } = request;
- const _queryParams = new URLSearchParams();
+ const _queryParams: Record<string, string> = {};
  if (limit != null) {
- _queryParams.append("limit", limit.toString());
+ _queryParams["limit"] = limit.toString();
  }
 
  if (status != null) {
  if (Array.isArray(status)) {
  for (const _item of status) {
- _queryParams.append("status", _item);
+ _queryParams["status"] = _item;
  }
  } else {
- _queryParams.append("status", status);
+ _queryParams["status"] = status;
  }
  }
 
  if (when != null) {
- _queryParams.append("when", when);
+ _queryParams["when"] = when;
  }
 
  if (timestampMs != null) {
- _queryParams.append("timestamp_ms", timestampMs.toString());
+ _queryParams["timestamp_ms"] = timestampMs.toString();
  }
 
  if (sortBy != null) {
- _queryParams.append("sort_by", sortBy);
+ _queryParams["sort_by"] = sortBy;
  }
 
  if (direction != null) {
- _queryParams.append("direction", direction);
+ _queryParams["direction"] = direction;
  }
 
  const _response = await core.fetcher({
  url: urlJoin(
- (await core.Supplier.get(this.options.environment)) ?? environments.HumeEnvironment.Default,
+ (await core.Supplier.get(this._options.environment)) ?? environments.HumeEnvironment.Default,
  "v0/batch/jobs"
  ),
  method: "GET",
  headers: {
- "X-Hume-Api-Key": await core.Supplier.get(this.options.apiKey),
+ "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.0.10",
+ "X-Fern-SDK-Version": "0.1.0",
  },
  contentType: "application/json",
  queryParameters: _queryParams,
- timeoutMs: 60000,
+ timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+ maxRetries: requestOptions?.maxRetries,
  });
  if (_response.ok) {
  return await serializers.listJobs.Response.parseOrThrow(_response.body, {
@@ -106,22 +114,26 @@ export class HumeClient {
  /**
  * Start a new batch job.
  */
- public async submitJob(request: Hume.BaseRequest = {}): Promise<Hume.JobId> {
+ public async submitJob(
+ request: Hume.BaseRequest = {},
+ requestOptions?: HumeClient.RequestOptions
+ ): Promise<Hume.JobId> {
  const _response = await core.fetcher({
  url: urlJoin(
- (await core.Supplier.get(this.options.environment)) ?? environments.HumeEnvironment.Default,
+ (await core.Supplier.get(this._options.environment)) ?? environments.HumeEnvironment.Default,
  "v0/batch/jobs"
  ),
  method: "POST",
  headers: {
- "X-Hume-Api-Key": await core.Supplier.get(this.options.apiKey),
+ "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.0.10",
+ "X-Fern-SDK-Version": "0.1.0",
  },
  contentType: "application/json",
  body: await serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
- timeoutMs: 60000,
+ timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+ maxRetries: requestOptions?.maxRetries,
  });
  if (_response.ok) {
  return await serializers.JobId.parseOrThrow(_response.body, {
@@ -157,21 +169,25 @@ export class HumeClient {
  /**
  * Get the JSON predictions of a completed job.
  */
- public async getJobPredictions(id: string): Promise<Hume.SourceResult[]> {
+ public async getJobPredictions(
+ id: string,
+ requestOptions?: HumeClient.RequestOptions
+ ): Promise<Hume.SourceResult[]> {
  const _response = await core.fetcher({
  url: urlJoin(
- (await core.Supplier.get(this.options.environment)) ?? environments.HumeEnvironment.Default,
+ (await core.Supplier.get(this._options.environment)) ?? environments.HumeEnvironment.Default,
  `v0/batch/jobs/${id}/predictions`
  ),
  method: "GET",
  headers: {
- "X-Hume-Api-Key": await core.Supplier.get(this.options.apiKey),
+ "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.0.10",
+ "X-Fern-SDK-Version": "0.1.0",
  },
  contentType: "application/json",
- timeoutMs: 60000,
+ timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+ maxRetries: requestOptions?.maxRetries,
  });
  if (_response.ok) {
  return await serializers.getJobPredictions.Response.parseOrThrow(_response.body, {
@@ -207,22 +223,23 @@ export class HumeClient {
  /**
  * Get the artifacts ZIP of a completed job.
  */
- public async getJobArtifacts(id: string): Promise<Blob> {
- const _response = await core.fetcher({
+ public async getJobArtifacts(id: string, requestOptions?: HumeClient.RequestOptions): Promise<Blob> {
+ const _response = await core.fetcher<Blob>({
  url: urlJoin(
- (await core.Supplier.get(this.options.environment)) ?? environments.HumeEnvironment.Default,
+ (await core.Supplier.get(this._options.environment)) ?? environments.HumeEnvironment.Default,
  `v0/batch/jobs/${id}/artifacts`
  ),
  method: "GET",
  headers: {
- "X-Hume-Api-Key": await core.Supplier.get(this.options.apiKey),
+ "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.0.10",
+ "X-Fern-SDK-Version": "0.1.0",
  },
  contentType: "application/json",
  responseType: "blob",
- timeoutMs: 60000,
+ timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+ maxRetries: requestOptions?.maxRetries,
  });
  if (_response.ok) {
  return _response.body;
@@ -253,21 +270,22 @@ export class HumeClient {
  /**
  * Get the request details and state of a given job.
  */
- public async getJobDetails(id: string): Promise<Hume.JobRequest> {
+ public async getJobDetails(id: string, requestOptions?: HumeClient.RequestOptions): Promise<Hume.JobRequest> {
  const _response = await core.fetcher({
  url: urlJoin(
- (await core.Supplier.get(this.options.environment)) ?? environments.HumeEnvironment.Default,
+ (await core.Supplier.get(this._options.environment)) ?? environments.HumeEnvironment.Default,
  `v0/batch/jobs/${id}`
  ),
  method: "GET",
  headers: {
- "X-Hume-Api-Key": await core.Supplier.get(this.options.apiKey),
+ "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.0.10",
+ "X-Fern-SDK-Version": "0.1.0",
  },
  contentType: "application/json",
- timeoutMs: 60000,
+ timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+ maxRetries: requestOptions?.maxRetries,
  });
  if (_response.ok) {
  return await serializers.JobRequest.parseOrThrow(_response.body, {

src/api/types/BoundingBox.ts

@@ -7,11 +7,11 @@
  */
 export interface BoundingBox {
  /** x-coordinate of bounding box top left corner. */
- x: number;
+ x?: number;
  /** y-coordinate of bounding box top left corner. */
- y: number;
+ y?: number;
  /** Bounding box width. */
- w: number;
+ w?: number;
  /** Bounding box height. */
- h: number;
+ h?: number;
 }

src/api/types/EmotionEmbedding.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Hume from "..";
+
+/**
+ * A high-dimensional embedding in emotion space.
+ */
+export type EmotionEmbedding = Hume.EmotionEmbeddingItem[];

src/api/types/EmotionEmbeddingItem.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface EmotionEmbeddingItem {
+ /** Name of the emotion being expressed. */
+ name?: string;
+ /** Embedding value for the emotion being expressed. */
+ score?: number;
+}

src/api/types/Sentiment.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Hume from "..";
+
+/**
+ * Sentiment predictions returned as a distribution. This model predicts the probability that a given text could be interpreted as having each sentiment level from 1 (negative) to 9 (positive).
+ *
+ * Compared to returning one estimate of sentiment, this enables a more nuanced analysis of a text's meaning. For example, a text with very neutral sentiment would have an average rating of 5. But also a text that could be interpreted as having very positive sentiment or very negative sentiment would also have an average rating of 5. The average sentiment is less informative than the distribution over sentiment, so this API returns a value for each sentiment level.
+ */
+export type Sentiment = Hume.SentimentItem[];

src/api/types/SentimentItem.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface SentimentItem {
+ /** Level of sentiment, ranging from 1 (negative) to 9 (positive) */
+ name?: string;
+ /** Prediction for this level of sentiment */
+ score?: number;
+}

src/api/types/TextPosition.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * 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. */
+ begin?: number;
+ /** The index of the last character in the text segment, exclusive. */
+ end?: number;
+}

src/api/types/TimeRange.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * A time range with a beginning and end, measured in seconds.
+ */
+export interface TimeRange {
+ /** Beginning of time range in seconds. */
+ begin?: number;
+ /** End of time range in seconds. */
+ end?: number;
+}

src/api/types/Toxicity.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Hume from "..";
+
+/**
+ * Toxicity predictions returned as probabilities that the text can be classified into the following categories: toxic, severe_toxic, obscene, threat, insult, and identity_hate.
+ */
+export type Toxicity = Hume.ToxicityItem[];

src/api/types/ToxicityItem.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface ToxicityItem {
+ /** Category of toxicity. */
+ name?: string;
+ /** Prediction for this category of toxicity */
+ score?: number;
+}

src/api/types/index.ts

@@ -62,3 +62,11 @@ export * from "./TranscriptionMetadata";
 export * from "./Url";
 export * from "./When";
 export * from "./Window";
+export * from "./EmotionEmbedding";
+export * from "./EmotionEmbeddingItem";
+export * from "./TimeRange";
+export * from "./TextPosition";
+export * from "./Sentiment";
+export * from "./SentimentItem";
+export * from "./Toxicity";
+export * from "./ToxicityItem";