hume 0.2.4 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/Client.js +5 -5
  2. package/README.md +8 -17
  3. package/dist/Client.js +5 -5
  4. package/package.json +1 -1
package/Client.js CHANGED
@@ -86,7 +86,7 @@ class HumeClient {
86
86
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
87
87
  "X-Fern-Language": "JavaScript",
88
88
  "X-Fern-SDK-Name": "hume",
89
- "X-Fern-SDK-Version": "0.2.4",
89
+ "X-Fern-SDK-Version": "0.2.5",
90
90
  },
91
91
  contentType: "application/json",
92
92
  queryParameters: _queryParams,
@@ -135,7 +135,7 @@ class HumeClient {
135
135
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
136
136
  "X-Fern-Language": "JavaScript",
137
137
  "X-Fern-SDK-Name": "hume",
138
- "X-Fern-SDK-Version": "0.2.4",
138
+ "X-Fern-SDK-Version": "0.2.5",
139
139
  },
140
140
  contentType: "application/json",
141
141
  body: yield serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -184,7 +184,7 @@ class HumeClient {
184
184
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
185
185
  "X-Fern-Language": "JavaScript",
186
186
  "X-Fern-SDK-Name": "hume",
187
- "X-Fern-SDK-Version": "0.2.4",
187
+ "X-Fern-SDK-Version": "0.2.5",
188
188
  },
189
189
  contentType: "application/json",
190
190
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -232,7 +232,7 @@ class HumeClient {
232
232
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
233
233
  "X-Fern-Language": "JavaScript",
234
234
  "X-Fern-SDK-Name": "hume",
235
- "X-Fern-SDK-Version": "0.2.4",
235
+ "X-Fern-SDK-Version": "0.2.5",
236
236
  },
237
237
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
238
238
  });
@@ -252,7 +252,7 @@ class HumeClient {
252
252
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
253
253
  "X-Fern-Language": "JavaScript",
254
254
  "X-Fern-SDK-Name": "hume",
255
- "X-Fern-SDK-Version": "0.2.4",
255
+ "X-Fern-SDK-Version": "0.2.5",
256
256
  },
257
257
  contentType: "application/json",
258
258
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
package/README.md CHANGED
@@ -8,12 +8,15 @@
8
8
 
9
9
  <br>
10
10
  <div>
11
- <a href="https://www.npmjs.com/package/@fern-api/hume"><img src="https://img.shields.io/npm/v/@fern-api/hume">
11
+ <a href="https://www.npmjs.com/package/hume"><img src="https://img.shields.io/npm/v/hume">
12
12
  <a href="https://buildwithfern.com/"><img src="https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen">
13
13
  </div>
14
14
  <br>
15
15
  </div>
16
16
 
17
+ > **Note**
18
+ > This TypeScript SDK is under heavy development. It is NOT recommended that anyone uses this SDK in their production workloads. We will continue to publish updates to this SDK and hope to ensure a more stable and reliable release in the future. We encourage you to keep up with our [API changelog](https://dev.hume.ai/changelog) and mailing list to stay up to date with the latest changes.
19
+
17
20
  ## Documentation
18
21
 
19
22
  API reference documentation is available [here](https://docs.hume.ai/doc/batch-api).
@@ -21,9 +24,7 @@ API reference documentation is available [here](https://docs.hume.ai/doc/batch-a
21
24
  ## Installation
22
25
 
23
26
  ```
24
- npm install --save @fern-api/hume
25
- # or
26
- yarn add @fern-api/hume
27
+ npm i hume
27
28
  ```
28
29
 
29
30
  ## Batch Client
@@ -33,7 +34,7 @@ The SDK exports a batch client which you can use to hit our REST APIs.
33
34
  <a href="https://stackblitz.com/edit/typescript-example-using-sdk-built-with-fern-jlhehr?file=app.ts&view=editor"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg">
34
35
 
35
36
  ```typescript
36
- import { HumeBatchClient } from "@fern-api/hume";
37
+ import { HumeBatchClient } from "hume";
37
38
 
38
39
  const client = new HumeBatchClient({
39
40
  apiKey: "YOUR_API_KEY",
@@ -55,7 +56,7 @@ await job.awaitCompletion();
55
56
  The SDK exports a streaming client which you can use to hit our WebSocket APIs.
56
57
 
57
58
  ```typescript
58
- import { HumeStreamingClient } from "@fern-api/hume";
59
+ import { HumeStreamingClient } from "hume";
59
60
 
60
61
  const client = new HumeStreamingClient({
61
62
  apiKey: "YOUR_API_KEY",
@@ -86,7 +87,7 @@ When the API returns a non-success status code (4xx or 5xx response),
86
87
  a subclass of [HumeError](./src/errors/HumeError.ts) will be thrown:
87
88
 
88
89
  ```typescript
89
- import { HumeError, HumeTimeoutError } from "@fern-api/hume";
90
+ import { HumeError, HumeTimeoutError } from "hume";
90
91
 
91
92
  try {
92
93
  await hume.submitJob(/* ... */);
@@ -123,13 +124,3 @@ await hume.submitJob(..., {
123
124
  timeoutInSeconds: 10, // timeout after 10 seconds
124
125
  });
125
126
  ```
126
-
127
- ## Beta status
128
-
129
- This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
130
-
131
- ## Contributing
132
-
133
- While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
134
-
135
- On the other hand, contributions to the README are always very welcome!
package/dist/Client.js CHANGED
@@ -86,7 +86,7 @@ class HumeClient {
86
86
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
87
87
  "X-Fern-Language": "JavaScript",
88
88
  "X-Fern-SDK-Name": "hume",
89
- "X-Fern-SDK-Version": "0.2.4",
89
+ "X-Fern-SDK-Version": "0.2.5",
90
90
  },
91
91
  contentType: "application/json",
92
92
  queryParameters: _queryParams,
@@ -135,7 +135,7 @@ class HumeClient {
135
135
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
136
136
  "X-Fern-Language": "JavaScript",
137
137
  "X-Fern-SDK-Name": "hume",
138
- "X-Fern-SDK-Version": "0.2.4",
138
+ "X-Fern-SDK-Version": "0.2.5",
139
139
  },
140
140
  contentType: "application/json",
141
141
  body: yield serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -184,7 +184,7 @@ class HumeClient {
184
184
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
185
185
  "X-Fern-Language": "JavaScript",
186
186
  "X-Fern-SDK-Name": "hume",
187
- "X-Fern-SDK-Version": "0.2.4",
187
+ "X-Fern-SDK-Version": "0.2.5",
188
188
  },
189
189
  contentType: "application/json",
190
190
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -232,7 +232,7 @@ class HumeClient {
232
232
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
233
233
  "X-Fern-Language": "JavaScript",
234
234
  "X-Fern-SDK-Name": "hume",
235
- "X-Fern-SDK-Version": "0.2.4",
235
+ "X-Fern-SDK-Version": "0.2.5",
236
236
  },
237
237
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
238
238
  });
@@ -252,7 +252,7 @@ class HumeClient {
252
252
  "X-Hume-Api-Key": yield core.Supplier.get(this._options.apiKey),
253
253
  "X-Fern-Language": "JavaScript",
254
254
  "X-Fern-SDK-Name": "hume",
255
- "X-Fern-SDK-Version": "0.2.4",
255
+ "X-Fern-SDK-Version": "0.2.5",
256
256
  },
257
257
  contentType: "application/json",
258
258
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hume",
3
- "version": "0.2.4",
3
+ "version": "0.2.5",
4
4
  "private": false,
5
5
  "repository": "https://github.com/HumeAI/hume-typescript-sdk",
6
6
  "main": "./index.js",