hume 0.2.5 → 0.3.0

package/CITATIONS.md

@@ -0,0 +1,258 @@
+# Citations
+
+To cite Hume's expressive communication platform, please reference one or more of the papers relevant to your application.
+
+| Publication                                                                                                                                                                          | Year | Modality |   BibTeX    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--: | :------: | :---------: |
+| [Self-report captures 27 distinct categories of emotion bridged by continuous gradients](https://doi.org/10.1073/pnas.1702247114)                                                    | 2017 |  multi   | [Cite](#1)  |
+| [Mapping the Passions: Toward a High-Dimensional Taxonomy of Emotional Experience and Expression](https://doi.org/10.1177/1529100619850176)                                          | 2019 |  multi   | [Cite](#2)  |
+| [The primacy of categories in the recognition of 12 emotions in speech prosody across two cultures](https://doi.org/10.1038/s41562-019-0533-6)                                       | 2019 |  voice   | [Cite](#3)  |
+| [Mapping 24 emotions conveyed by brief human vocalization](https://doi.org/10.1037/amp0000399)                                                                                       | 2019 |  voice   | [Cite](#4)  |
+| [Emotional expression: Advances in basic emotion theory](https://doi.org/10.1007%2Fs10919-019-00293-3)                                                                               | 2019 |  multi   | [Cite](#5)  |
+| [What the face displays: Mapping 28 emotions conveyed by naturalistic expression](https://doi.org/10.1037/amp0000488)                                                                | 2020 |   face   | [Cite](#6)  |
+| [The neural representation of visually evoked emotion is high-dimensional, categorical, and distributed across transmodal brain regions](https://doi.org/10.1016/j.isci.2020.101060) | 2020 |  multi   | [Cite](#7)  |
+| [What music makes us feel: At least 13 dimensions organize subjective experiences associated with music across different cultures](https://doi.org/10.1073/pnas.1910704117)          | 2020 |  music   | [Cite](#8)  |
+| [GoEmotions: A Dataset of Fine-Grained Emotions](https://doi.org/10.18653/v1/2020.acl-main.372)                                                                                      | 2020 |   text   | [Cite](#9)  |
+| [Universal facial expressions uncovered in art of the ancient Americas: A computational approach](https://doi.org/10.1126/sciadv.abb1005)                                            | 2020 |   face   | [Cite](#10) |
+| [Sixteen facial expressions occur in similar contexts worldwide](https://doi.org/10.1038/s41586-020-3037-7)                                                                          | 2021 |   face   | [Cite](#11) |
+| [The MuSe 2022 Multimodal Sentiment Analysis Challenge: Humor, Emotional Reactions, and Stress](https://doi.org/10.48550/arXiv.2207.05691)                                           | 2022 |  multi   | [Cite](#12) |
+| [The ACII 2022 Affective Vocal Bursts Workshop & Competition: Understanding a critically understudied modality of emotional expression](https://doi.org/10.48550/arXiv.2207.03572)   | 2022 |  voice   | [Cite](#13) |
+| [The ICML 2022 Expressive Vocalizations Workshop and Competition: Recognizing, Generating, and Personalizing Vocal Bursts](https://doi.org/10.48550/arXiv.2205.01780)                | 2022 |  voice   | [Cite](#14) |
+| [Intersectionality in emotion signaling and recognition: The influence of gender, ethnicity, and social class](https://doi.org/10.1037/emo0001082)                                   | 2022 |   body   | [Cite](#15) |
+| [How emotions, relationships, and culture constitute each other: advances in social functionalist theory](https://doi.org/10.1080/02699931.2022.2047009)                             | 2022 |  multi   | [Cite](#16) |
+| [State & Trait Measurement from Nonverbal Vocalizations: A Multi-Task Joint Learning Approach](https://doi.org/10.21437/Interspeech.2022-10927)                                      | 2022 |  voice   | [Cite](#17) |
+
+## BibTeX
+
+### <a id="1"></a>
+
+```bibtex
+@article{cowen2017self,
+  title={Self-report captures 27 distinct categories of emotion bridged by continuous gradients},
+  author={Cowen, Alan S and Keltner, Dacher},
+  journal={Proceedings of the national academy of sciences},
+  volume={114},
+  number={38},
+  pages={E7900--E7909},
+  year={2017},
+  publisher={National Acad Sciences}
+}
+```
+
+### <a id="2"></a>
+
+```bibtex
+@article{cowen2019mapping,
+  title={Mapping the passions: Toward a high-dimensional taxonomy of emotional experience and expression},
+  author={Cowen, Alan and Sauter, Disa and Tracy, Jessica L and Keltner, Dacher},
+  journal={Psychological Science in the Public Interest},
+  volume={20},
+  number={1},
+  pages={69--90},
+  year={2019},
+  publisher={Sage Publications Sage CA: Los Angeles, CA}
+}
+```
+
+### <a id="3"></a>
+
+```bibtex
+@article{cowen2019primacy,
+  title={The primacy of categories in the recognition of 12 emotions in speech prosody across two cultures},
+  author={Cowen, Alan S and Laukka, Petri and Elfenbein, Hillary Anger and Liu, Runjing and Keltner, Dacher},
+  journal={Nature human behaviour},
+  volume={3},
+  number={4},
+  pages={369--382},
+  year={2019},
+  publisher={Nature Publishing Group}
+}
+```
+
+### <a id="4"></a>
+
+```bibtex
+@article{cowen2019mapping,
+  title={Mapping 24 emotions conveyed by brief human vocalization.},
+  author={Cowen, Alan S and Elfenbein, Hillary Anger and Laukka, Petri and Keltner, Dacher},
+  journal={American Psychologist},
+  volume={74},
+  number={6},
+  pages={698},
+  year={2019},
+  publisher={American Psychological Association}
+}
+```
+
+### <a id="5"></a>
+
+```bibtex
+@article{keltner2019emotional,
+  title={Emotional expression: Advances in basic emotion theory},
+  author={Keltner, Dacher and Sauter, Disa and Tracy, Jessica and Cowen, Alan},
+  journal={Journal of nonverbal behavior},
+  volume={43},
+  number={2},
+  pages={133--160},
+  year={2019},
+  publisher={Springer}
+}
+```
+
+### <a id="6"></a>
+
+```bibtex
+@article{cowen2020face,
+  title={What the face displays: Mapping 28 emotions conveyed by naturalistic expression.},
+  author={Cowen, Alan S and Keltner, Dacher},
+  journal={American Psychologist},
+  volume={75},
+  number={3},
+  pages={349},
+  year={2020},
+  publisher={American Psychological Association}
+}
+```
+
+### <a id="7"></a>
+
+```bibtex
+@article{horikawa2020neural,
+  title={The neural representation of visually evoked emotion is high-dimensional, categorical, and distributed across transmodal brain regions},
+  author={Horikawa, Tomoyasu and Cowen, Alan S and Keltner, Dacher and Kamitani, Yukiyasu},
+  journal={Iscience},
+  volume={23},
+  number={5},
+  pages={101060},
+  year={2020},
+  publisher={Elsevier}
+}
+```
+
+### <a id="8"></a>
+
+```bibtex
+@article{cowen2020music,
+  title={What music makes us feel: At least 13 dimensions organize subjective experiences associated with music across different cultures},
+  author={Cowen, Alan S and Fang, Xia and Sauter, Disa and Keltner, Dacher},
+  journal={Proceedings of the National Academy of Sciences},
+  volume={117},
+  number={4},
+  pages={1924--1934},
+  year={2020},
+  publisher={National Acad Sciences}
+}
+```
+
+### <a id="9"></a>
+
+```bibtex
+@article{demszky2020goemotions,
+  title={GoEmotions: A dataset of fine-grained emotions},
+  author={Demszky, Dorottya and Movshovitz-Attias, Dana and Ko, Jeongwoo and Cowen, Alan and Nemade, Gaurav and Ravi, Sujith},
+  journal={arXiv preprint arXiv:2005.00547},
+  year={2020}
+}
+```
+
+### <a id="10"></a>
+
+```bibtex
+@article{cowen2020universal,
+  title={Universal facial expressions uncovered in art of the ancient Americas: A computational approach},
+  author={Cowen, Alan S and Keltner, Dacher},
+  journal={Science advances},
+  volume={6},
+  number={34},
+  pages={eabb1005},
+  year={2020},
+  publisher={American Association for the Advancement of Science}
+}
+```
+
+### <a id="11"></a>
+
+```bibtex
+@article{cowen2021sixteen,
+  title={Sixteen facial expressions occur in similar contexts worldwide},
+  author={Cowen, Alan S and Keltner, Dacher and Schroff, Florian and Jou, Brendan and Adam, Hartwig and Prasad, Gautam},
+  journal={Nature},
+  volume={589},
+  number={7841},
+  pages={251--257},
+  year={2021},
+  publisher={Nature Publishing Group}
+}
+```
+
+### <a id="12"></a>
+
+```bibtex
+@article{christ2022muse,
+  title={The MuSe 2022 Multimodal Sentiment Analysis Challenge: Humor, Emotional Reactions, and Stress},
+  author={Christ, Lukas and Amiriparian, Shahin and Baird, Alice and Tzirakis, Panagiotis and Kathan, Alexander and M{\"u}ller, Niklas and Stappen, Lukas and Me{\ss}ner, Eva-Maria and K{\"o}nig, Andreas and Cowen, Alan and others},
+  year={2022}
+}
+```
+
+### <a id="13"></a>
+
+```bibtex
+@article{baird2022acii,
+  title={The ACII 2022 Affective Vocal Bursts Workshop \& Competition: Understanding a critically understudied modality of emotional expression},
+  author={Baird, Alice and Tzirakis, Panagiotis and Brooks, Jeffrey A and Gregory, Christopher B and Schuller, Bj{\"o}rn and Batliner, Anton and Keltner, Dacher and Cowen, Alan},
+  journal={arXiv preprint arXiv:2207.03572},
+  year={2022}
+}
+```
+
+### <a id="14"></a>
+
+```bibtex
+@article{baird2022icml,
+  title={The ICML 2022 Expressive Vocalizations Workshop and Competition: Recognizing, Generating, and Personalizing Vocal Bursts},
+  author={Baird, Alice and Tzirakis, Panagiotis and Gidel, Gauthier and Jiralerspong, Marco and Muller, Eilif B and Mathewson, Kory and Schuller, Bj{\"o}rn and Cambria, Erik and Keltner, Dacher and Cowen, Alan},
+  journal={arXiv preprint arXiv:2205.01780},
+  year={2022}
+}
+```
+
+### <a id="15"></a>
+
+```bibtex
+@article{monroy2022intersectionality,
+  title={Intersectionality in emotion signaling and recognition: The influence of gender, ethnicity, and social class.},
+  author={Monroy, Maria and Cowen, Alan S and Keltner, Dacher},
+  journal={Emotion},
+  year={2022},
+  publisher={American Psychological Association}
+}
+```
+
+### <a id="16"></a>
+
+```bibtex
+@article{keltner2022emotions,
+  title={How emotions, relationships, and culture constitute each other: advances in social functionalist theory},
+  author={Keltner, Dacher and Sauter, Disa and Tracy, Jessica L and Wetchler, Everett and Cowen, Alan S},
+  journal={Cognition and Emotion},
+  volume={36},
+  number={3},
+  pages={388--401},
+  year={2022},
+  publisher={Taylor \& Francis}
+}
+```
+
+### <a id="17"></a>
+
+```bibtex
+@inproceedings{baird22_interspeech,
+  author={Alice Baird and Panagiotis Tzirakis and Jeff Brooks and Lauren Kim and Michael Opara and Chris Gregory and Jacob Metrick and Garrett Boseck and Dacher Keltner and Alan Cowen},
+  title={{State & Trait Measurement from Nonverbal Vocalizations: A Multi-Task Joint Learning Approach}},
+  year=2022,
+  booktitle={Proc. Interspeech 2022},
+  pages={2028--2032},
+  doi={10.21437/Interspeech.2022-10927}
+}
+```

package/Client.d.ts

@@ -21,6 +21,14 @@ export declare class HumeClient {
     constructor(_options: HumeClient.Options);
     /**
      * Sort and filter jobs.
+     *
+     * @example
+     *     await hume.listJobs({
+     *         status: Hume.Status.Queued,
+     *         when: Hume.When.CreatedBefore,
+     *         sortBy: Hume.SortBy.Created,
+     *         direction: Hume.Direction.Asc
+     *     })
      */
     listJobs(request?: Hume.ListJobsRequest, requestOptions?: HumeClient.RequestOptions): Promise<Hume.JobRequest[]>;
     /**
@@ -29,6 +37,9 @@ export declare class HumeClient {
     submitJob(request?: Hume.BaseRequest, requestOptions?: HumeClient.RequestOptions): Promise<Hume.JobId>;
     /**
      * Get the JSON predictions of a completed job.
+     *
+     * @example
+     *     await hume.getJobPredictions("id")
      */
     getJobPredictions(id: string, requestOptions?: HumeClient.RequestOptions): Promise<Hume.SourceResult[]>;
     /**

package/Client.js

@@ -50,6 +50,14 @@ class HumeClient {
     }
     /**
      * Sort and filter jobs.
+     *
+     * @example
+     *     await hume.listJobs({
+     *         status: Hume.Status.Queued,
+     *         when: Hume.When.CreatedBefore,
+     *         sortBy: Hume.SortBy.Created,
+     *         direction: Hume.Direction.Asc
+     *     })
      */
     listJobs(request = {}, requestOptions) {
         var _a;
@@ -86,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.2.5",
+                    "X-Fern-SDK-Version": "0.3.0",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -135,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.2.5",
+                    "X-Fern-SDK-Version": "0.3.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.BaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -173,6 +181,9 @@ class HumeClient {
     }
     /**
      * Get the JSON predictions of a completed job.
+     *
+     * @example
+     *     await hume.getJobPredictions("id")
      */
     getJobPredictions(id, requestOptions) {
         var _a;
@@ -184,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.2.5",
+                    "X-Fern-SDK-Version": "0.3.0",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -225,18 +236,42 @@ class HumeClient {
     getJobArtifacts(id, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const _response = yield core.streamingFetcher({
+            const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.HumeEnvironment.Default, `v0/batch/jobs/${id}/artifacts`),
                 method: "GET",
                 headers: {
                     "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.2.5",
+                    "X-Fern-SDK-Version": "0.3.0",
                 },
+                contentType: "application/json",
+                responseType: "streaming",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
             });
-            return _response.data;
+            if (_response.ok) {
+                return _response.body;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.HumeError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.HumeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.HumeTimeoutError();
+                case "unknown":
+                    throw new errors.HumeError({
+                        message: _response.error.errorMessage,
+                    });
+            }
         });
     }
     /**
@@ -252,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.2.5",
+                    "X-Fern-SDK-Version": "0.3.0",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Hume AI, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/api/client/requests/ListJobsRequest.d.ts

@@ -2,6 +2,15 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from "../..";
+/**
+ * @example
+ *     {
+ *         status: Hume.Status.Queued,
+ *         when: Hume.When.CreatedBefore,
+ *         sortBy: Hume.SortBy.Created,
+ *         direction: Hume.Direction.Asc
+ *     }
+ */
 export interface ListJobsRequest {
     /**
      * The maximum number of jobs to include in the response.

package/api/types/index.d.ts

@@ -62,28 +62,28 @@ export * from "./TranscriptionMetadata";
 export * from "./Url";
 export * from "./When";
 export * from "./Window";
-export * from "./ModelsInput";
-export * from "./ModelConfig";
 export * from "./FaceModelConfig";
 export * from "./LanguageConfig";
-export * from "./ModelResponse";
-export * from "./BurstResponse";
+export * from "./ModelConfig";
+export * from "./ModelsInput";
 export * from "./ModelsSuccessBurstPredictionsItem";
-export * from "./FaceResponse";
+export * from "./BurstResponse";
 export * from "./ModelsSuccessFacePredictionsItem";
-export * from "./FacemeshResponse";
+export * from "./FaceResponse";
 export * from "./ModelsSuccessFacemeshPredictionsItem";
-export * from "./LanguageResponse";
+export * from "./FacemeshResponse";
 export * from "./ModelsSuccessLanguagePredictionsItem";
-export * from "./ProsodyResponse";
+export * from "./LanguageResponse";
 export * from "./ModelsSuccessProsodyPredictionsItem";
+export * from "./ProsodyResponse";
+export * from "./ModelResponse";
 export * from "./ModelsError";
 export * from "./ModelsWarning";
-export * from "./EmotionEmbedding";
 export * from "./EmotionEmbeddingItem";
+export * from "./EmotionEmbedding";
 export * from "./TimeRange";
 export * from "./TextPosition";
-export * from "./Sentiment";
 export * from "./SentimentItem";
-export * from "./Toxicity";
+export * from "./Sentiment";
 export * from "./ToxicityItem";
+export * from "./Toxicity";

package/api/types/index.js

@@ -78,28 +78,28 @@ __exportStar(require("./TranscriptionMetadata"), exports);
 __exportStar(require("./Url"), exports);
 __exportStar(require("./When"), exports);
 __exportStar(require("./Window"), exports);
-__exportStar(require("./ModelsInput"), exports);
-__exportStar(require("./ModelConfig"), exports);
 __exportStar(require("./FaceModelConfig"), exports);
 __exportStar(require("./LanguageConfig"), exports);
-__exportStar(require("./ModelResponse"), exports);
-__exportStar(require("./BurstResponse"), exports);
+__exportStar(require("./ModelConfig"), exports);
+__exportStar(require("./ModelsInput"), exports);
 __exportStar(require("./ModelsSuccessBurstPredictionsItem"), exports);
-__exportStar(require("./FaceResponse"), exports);
+__exportStar(require("./BurstResponse"), exports);
 __exportStar(require("./ModelsSuccessFacePredictionsItem"), exports);
-__exportStar(require("./FacemeshResponse"), exports);
+__exportStar(require("./FaceResponse"), exports);
 __exportStar(require("./ModelsSuccessFacemeshPredictionsItem"), exports);
-__exportStar(require("./LanguageResponse"), exports);
+__exportStar(require("./FacemeshResponse"), exports);
 __exportStar(require("./ModelsSuccessLanguagePredictionsItem"), exports);
-__exportStar(require("./ProsodyResponse"), exports);
+__exportStar(require("./LanguageResponse"), exports);
 __exportStar(require("./ModelsSuccessProsodyPredictionsItem"), exports);
+__exportStar(require("./ProsodyResponse"), exports);
+__exportStar(require("./ModelResponse"), exports);
 __exportStar(require("./ModelsError"), exports);
 __exportStar(require("./ModelsWarning"), exports);
-__exportStar(require("./EmotionEmbedding"), exports);
 __exportStar(require("./EmotionEmbeddingItem"), exports);
+__exportStar(require("./EmotionEmbedding"), exports);
 __exportStar(require("./TimeRange"), exports);
 __exportStar(require("./TextPosition"), exports);
-__exportStar(require("./Sentiment"), exports);
 __exportStar(require("./SentimentItem"), exports);
-__exportStar(require("./Toxicity"), exports);
+__exportStar(require("./Sentiment"), exports);
 __exportStar(require("./ToxicityItem"), exports);
+__exportStar(require("./Toxicity"), exports);

package/core/fetcher/APIResponse.d.ts

@@ -2,6 +2,7 @@ export declare type APIResponse<Success, Failure> = SuccessfulResponse<Success>
 export interface SuccessfulResponse<T> {
     ok: true;
     body: T;
+    headers?: Record<string, any>;
 }
 export interface FailedResponse<T> {
     ok: false;

package/core/fetcher/Fetcher.d.ts

@@ -1,4 +1,3 @@
-import { AxiosAdapter } from "axios";
 import { APIResponse } from "./APIResponse";
 export declare type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
 export declare namespace Fetcher {
@@ -12,9 +11,7 @@ export declare namespace Fetcher {
         timeoutMs?: number;
         maxRetries?: number;
         withCredentials?: boolean;
-        responseType?: "json" | "blob";
-        adapter?: AxiosAdapter;
-        onUploadProgress?: (event: ProgressEvent) => void;
+        responseType?: "json" | "blob" | "streaming";
     }
     type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
     interface FailedStatusCodeError {