Updates and adds the raw-text-processor example (#71)

Co-authored-by: Norman Bukingolts <norman@hume.ai>
Co-authored-by: zach <zachary.greathouse@hume.ai>

README.md

@@ -4,23 +4,24 @@ This repository contains examples of how to use the [Hume API](https://docs.hume
 
 ## [Empathic Voice Interface (EVI)](https://dev.hume.ai/docs/empathic-voice-interface-evi/overview)
 
-| Name | Language | Framework |
-| ------------------------------------------------------------------- | ---------- | --------- |
-| [`evi-custom-language-model`](/evi-custom-language-model/README.md) | Python | |
-| [`evi-modal-clm`](/evi-modal-clm/README.md) | Python | Modal |
-| [`evi-next-js-app-router`](/evi-next-js-app-router/README.md) | Typescript | Next.js |
-| [`evi-next-js-pages-router`](/evi-next-js-pages-router/README.md) | Typescript | Next.js |
-| [`evi-typescript-example`](/evi-typescript-example/README.md) | Typescript | |
-| [`evi-embed-vue`](/evi-embed-vue/README.md) | Typescript | Vue |
+| Name | Language | Framework  |
+| ------------------------------------------------------------------- | ---------- | --------------- |
+| [`evi-custom-language-model`](/evi-custom-language-model/README.md) | Python |  |
+| [`evi-modal-clm`](/evi-modal-clm/README.md)  | Python | Modal  |
+| [`evi-next-js-app-router`](/evi-next-js-app-router/README.md) | Typescript | Next.js  |
+| [`evi-next-js-pages-router`](/evi-next-js-pages-router/README.md) | Typescript | Next.js  |
+| [`evi-typescript-example`](/evi-typescript-example/README.md) | Typescript |  |
+| [`evi-embed-vue`](/evi-embed-vue/README.md)    | Typescript | Vue  |
 | [`evi-python-example`](/evi-python-example/README.md) | Python | Hume Python SDK |
-| [`evi-python-api-example`](/evi-python-api-example/README.md)    | Python | |
-| [`meld`](/meld/README.md) (`evi-react-example`) | Typescript | React |
+| [`evi-python-api-example`](/evi-python-api-example/README.md) | Python |  |
+| [`meld`](/meld/README.md) (`evi-react-example`) | Typescript | React  |
 
 ## [Expression Measurement API](https://dev.hume.ai/docs/expression-measurement-api/overview)
 
-| Name | Models | Language | Framework |
-| -------------------------------------------------------------------------- | ------------------------------------- | ---------- | --------- |
-| [`python-top-emotions`](/python-top-emotions/top_emotions.py) | `face` | Python | |
-| [`visualization-example`](./visualization-example/example-notebook.ipynb) | `face` | Python | |
-| [`typescript-next-api-language`](./typescript-next-api-language/README.md) | `language` | Typescript | Next.js |
-| [`typescript-streaming-sandbox`](./typescript-streaming-sandbox/README.md) | `language`, `face`, `burst`, `speech` | Typescript | Next.js |
+| Name | Models | Language | Framework |
+| ---------------------------------------------------------------------------- | ------------------------------------- | ---------- | --------- |
+| [`python-top-emotions`](/python-top-emotions/top_emotions.py) | `face` | Python | |
+| [`visualization-example`](./visualization-example/example-notebook.ipynb) | `face` | Python | |
+| [`typescript-next-api-language`](./typescript-next-api-language/README.md) | `language` | Typescript | Next.js |
+| [`typescript-streaming-sandbox`](./typescript-streaming-sandbox/README.md) | `language`, `face`, `burst`, `speech` | Typescript | Next.js |
+| [`typescript-raw-text-processor`](./typescript-raw-text-processor/README.md) | `language` | Typescript | |

evi-typescript-example/package.json

@@ -9,7 +9,7 @@
  "preview": "vite preview"
  },
  "dependencies": {
- "hume": "^0.7.0"
+ "hume": "^0.7.2"
  },
  "devDependencies": {
  "typescript": "^5.2.2",

typescript-raw-text-processor/.env.example

@@ -0,0 +1 @@
+HUME_API_KEY='<YOUR API KEY>'

typescript-raw-text-processor/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

typescript-raw-text-processor/README.md

@@ -0,0 +1,29 @@
+# Hume Raw Text Processor
+
+## Summary
+
+This project serves as an example implementation of our Expression Measurement (REST) API processing raw text using our [Typescript SDK](https://www.npmjs.com/package/hume).
+
+## Running Locally
+
+1. Clone the repo with `git clone origin https://github.com/HumeAI/hume-api-examples.git`
+
+2. Navigate to project directory `cd typescript-raw-text-processor`
+
+3. Install dependencies with `npm i`
+
+4. Setup environment variables
+
+ a. Create `.env` file based off of `.env.example`
+
+ b. Copy/paste your API key in from the [Portal](https://beta.hume.ai/settings/keys).
+
+5. Set configurations within the `src/index.ts` file.
+
+ a. Specify which language.
+
+ b. Copy and paste the text to be processed.
+
+ c. Set Language Model configurations.
+
+6. Run `npm run start` to process the specified text with the specified configurations and log predictions to the console.