diff --git a/expression-measurement/batch/next-js-emotional-language/README.md b/expression-measurement/batch/next-js-emotional-language/README.md index 61aebd2e..d4ec6560 100644 --- a/expression-measurement/batch/next-js-emotional-language/README.md +++ b/expression-measurement/batch/next-js-emotional-language/README.md @@ -1,8 +1,10 @@ -# Next.js Emotional Language Example - -| API | Models | Framework | -| ------- | ---------- | -------------------- | -| `batch` | `language` | Next.js (TypeScript) | +
+ +

Expression Measurement | Next.js Emotional Language Example

+

+ Batch-analyze Language to Uncover Nuanced Human Expression. +

+
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/fork/github/HumeAI/hume-api-examples/tree/main/typescript-next-api-language) diff --git a/expression-measurement/batch/python-top-emotions/README.md b/expression-measurement/batch/python-top-emotions/README.md index 8db362fa..e0f472d6 100644 --- a/expression-measurement/batch/python-top-emotions/README.md +++ b/expression-measurement/batch/python-top-emotions/README.md @@ -1,8 +1,8 @@
-

Batch Expression Measurement | Sample Python Implementation

+

Expression Measurement | Sample Python Implementation

- Jumpstart your development with Hume's Expression Measurement! + Batch-analyze Facial Expressions using Hume's Python SDK.

diff --git a/expression-measurement/batch/typescript-raw-text-processor/README.md b/expression-measurement/batch/typescript-raw-text-processor/README.md index 3b53836e..7dea287e 100644 --- a/expression-measurement/batch/typescript-raw-text-processor/README.md +++ b/expression-measurement/batch/typescript-raw-text-processor/README.md @@ -1,24 +1,43 @@ -# Hume Raw Text Processor +
+ +

Expression Measurement | TypeScript Raw Text Processor

+

+ Batch-analyze Text using Hume's TypeScript SDK. +

+
-## Summary +## Overview 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` +1. Clone this examples repository: -2. Navigate to project directory `cd typescript-raw-text-processor` + ```shell + git clone https://github.com/humeai/hume-api-examples + cd hume-api-examples/expression-measurement/batch/typescript-raw-text-processor + ``` -3. Install dependencies with `npm i` +2. Install dependencies: -4. Setup environment variables + ```shell + npm install + ``` - a. Create `.env` file based off of `.env.example` +3. Set up your API key: - b. Copy/paste your API key in from the [Portal](https://beta.hume.ai/settings/keys). + You must authenticate to use the Hume Expression Measurement API. Your API key can be retrieved from the [Hume AI platform](https://platform.hume.ai/settings/keys). For detailed instructions, see our documentation on [getting your api keys](https://dev.hume.ai/docs/introduction/api-key). -5. Set configurations within the `src/index.ts` file. + This example uses [dotenv](https://www.npmjs.com/package/dotenv). Place your API key in a `.env` file at the root of your project. + + ```shell + echo "HUME_API_KEY=''" > .env + ``` + + You can copy the `.env.example` file to use as a template. + +4. Set configurations within the `src/index.ts` file. a. Specify which language. @@ -26,4 +45,4 @@ This project serves as an example implementation of our Expression Measurement ( 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. +5. Run `npm run start` to process the specified text with the specified configurations and log predictions to the console. diff --git a/expression-measurement/streaming/next-js-streaming-example/README.md b/expression-measurement/streaming/next-js-streaming-example/README.md index 3a2423f5..e28288d5 100644 --- a/expression-measurement/streaming/next-js-streaming-example/README.md +++ b/expression-measurement/streaming/next-js-streaming-example/README.md @@ -1,6 +1,12 @@ -# Sandbox - -## About +
+ +

Expression Measurement | Next.js Streaming Example

+

+ Real-time Streaming of Facial, Vocal, and Language Expressions. +

+
+ +## Overview This repo contains a NextJS app for demoing and testing Hume APIs. It implements several streaming interfaces that provide an intuitive validation of model quality.