Integrate Hume APIs directly into your Node application or frontend

Documentation

Installation

npm i hume

Usage

import{HumeClient}from"hume";consthume=newHumeClient({apiKey:"YOUR_API_KEY",});constjob=awaithume.expressionMeasurement.batch.startInferenceJob({models:{face:{},},urls:["https://hume-tutorials.s3.amazonaws.com/faces.zip"],});console.log("Running...");awaitjob.awaitCompletion();constpredictions=awaithume.expressionMeasurement.batch.getJobPredictions(job.jobId);console.log(predictions);

Namespaces

import{HumeClient}from"hume";consthume=newHumeClient({apiKey:"YOUR_API_KEY"});hume.expressionMeasurement.// APIs specific to Expression Measurementhume.emapthicVoice.// APIs specific to Empathic Voice

Websockets

Request-Reply

import{HumeClient}from"hume";consthume=newHumeClient({apiKey:"YOUR_API_KEY",});constsocket=hume.expressionMeasurement.stream.connect({config:{language:{},},});for(constsampleofsamples){constresult=awaitsocket.sendText({text:sample});console.log(result);}

Empathic Voice

import{HumeClient}from"hume";consthume=newHumeClient({apiKey:"<>",secretKey:"<>",});constsocket=hume.empathicVoice.chat.connect();socket.on("message",(message)=>{if(message.type==="audio_output"){constdecoded=Buffer.from(message.data,"base64");// play decoded message}});// optional utility to wait for socket to be openawaitsocket.tillSocketOpen();socket.sendUserInput("Hello, how are you?");

Errors

import{HumeError,HumeTimeoutError}from"hume";try{awaithume.expressionMeasurement.batch.startInferenceJob(/* ... */);}catch(err){if(errinstanceofHumeTimeoutError){console.log("Request timed out",err);}elseif(errinstanceofHumeError){// catch all errrosconsole.log(err.statusCode);console.log(err.message);console.log(err.body);}}

Retries

awaithume.expressionMeasurement.batch.startInferenceJob(...,{maxRetries:0,// disable retries});

Timeouts

awaithume.expressionMeasurement.batch.startInferenceJob(...,{timeoutInSeconds:10,// timeout after 10 seconds});

Beta Status

Contributing