![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@tmacc/use-speech-to-text
Advanced tools
Readme
React Hook for OpenAI Whisper API with speech recorder, real-time transcription and silence removal built-in
https://user-images.githubusercontent.com/2707253/224465747-0b1ee159-21dd-4cd0-af9d-6fc9b882d716.mp4
useWhisper for React Native is being developed.
Repository: https://github.com/chengsokdara/use-whisper-native
Progress: https://github.com/chengsokdara/use-whisper-native/issues/1
npm i @chengsokdara/use-whisper
yarn add @chengsokdara/use-whisper
import { useWhisper } from '@chengsokdara/use-whisper'
const App = () => {
const {
recording,
speaking,
transcribing,
transcript,
pauseRecording,
startRecording,
stopRecording,
} = useWhisper({
apiKey: process.env.OPENAI_API_TOKEN, // YOUR_OPEN_AI_TOKEN
})
return (
<div>
<p>Recording: {recording}</p>
<p>Speaking: {speaking}</p>
<p>Transcribing: {transcribing}</p>
<p>Transcribed Text: {transcript.text}</p>
<button onClick={() => startRecording()}>Start</button>
<button onClick={() => pauseRecording()}>Pause</button>
<button onClick={() => stopRecording()}>Stop</button>
</div>
)
}
import { useWhisper } from '@chengsokdara/use-whisper'
const App = () => {
/**
* you have more control like this
* do whatever you want with the recorded speech
* send it to your own custom server
* and return the response back to useWhisper
*/
const onTranscribe = (blob: Blob) => {
const base64 = await new Promise<string | ArrayBuffer | null>(
(resolve) => {
const reader = new FileReader()
reader.onloadend = () => resolve(reader.result)
reader.readAsDataURL(blob)
}
)
const body = JSON.stringify({ file: base64, model: 'whisper-1' })
const headers = { 'Content-Type': 'application/json' }
const { default: axios } = await import('axios')
const response = await axios.post('/api/whisper', body, {
headers,
})
const { text } = await response.data
// you must return result from your server in Transcript format
return {
blob,
text,
}
}
const { transcript } = useWhisper({
// callback to handle transcription with custom server
onTranscribe,
})
return (
<div>
<p>{transcript.text}</p>
</div>
)
}
import { useWhisper } from '@chengsokdara/use-whisper'
const App = () => {
const { transcript } = useWhisper({
apiKey: process.env.OPENAI_API_TOKEN, // YOUR_OPEN_AI_TOKEN
streaming: true,
timeSlice: 1_000, // 1 second
whisperConfig: {
language: 'en',
},
})
return (
<div>
<p>{transcript.text}</p>
</div>
)
}
import { useWhisper } from '@chengsokdara/use-whisper'
const App = () => {
const { transcript } = useWhisper({
apiKey: process.env.OPENAI_API_TOKEN, // YOUR_OPEN_AI_TOKEN
// use ffmpeg-wasp to remove silence from recorded speech
removeSilence: true,
})
return (
<div>
<p>{transcript.text}</p>
</div>
)
}
import { useWhisper } from '@chengsokdara/use-whisper'
const App = () => {
const { transcript } = useWhisper({
apiKey: process.env.OPENAI_API_TOKEN, // YOUR_OPEN_AI_TOKEN
// will auto start recording speech upon component mounted
autoStart: true,
})
return (
<div>
<p>{transcript.text}</p>
</div>
)
}
import { useWhisper } from '@chengsokdara/use-whisper'
const App = () => {
const { transcript } = useWhisper({
apiKey: process.env.OPENAI_API_TOKEN, // YOUR_OPEN_AI_TOKEN
nonStop: true, // keep recording as long as the user is speaking
stopTimeout: 5000, // auto stop after 5 seconds
})
return (
<div>
<p>{transcript.text}</p>
</div>
)
}
import { useWhisper } from '@chengsokdara/use-whisper'
const App = () => {
const { transcript } = useWhisper({
apiKey: process.env.OPENAI_API_TOKEN, // YOUR_OPEN_AI_TOKEN
autoTranscribe: true,
whisperConfig: {
prompt: 'previous conversation', // you can pass previous conversation for context
response_format: 'text', // output text instead of json
temperature: 0.8, // random output
language: 'es', // Spanish
},
})
return (
<div>
<p>{transcript.text}</p>
</div>
)
}
most of these dependecies are lazy loaded, so it is only imported when it is needed
Name | Type | Default Value | Description |
---|---|---|---|
apiKey | string | '' | your OpenAI API token |
autoStart | boolean | false | auto start speech recording on component mount |
autoTranscribe | boolean | true | should auto transcribe after stop recording |
mode | string | transcriptions | control Whisper mode either transcriptions or translations, currently only support translation to English |
nonStop | boolean | false | if true, record will auto stop after stopTimeout. However if user keep on speaking, the recorder will keep recording |
removeSilence | boolean | false | remove silence before sending file to OpenAI API |
stopTimeout | number | 5,000 ms | if nonStop is true, this become required. This control when the recorder auto stop |
streaming | boolean | false | transcribe speech in real-time based on timeSlice |
timeSlice | number | 1000 ms | interval between each onDataAvailable event |
whisperConfig | WhisperApiConfig | undefined | Whisper API transcription config |
onDataAvailable | (blob: Blob) => void | undefined | callback function for getting recorded blob in interval between timeSlice |
onTranscribe | (blob: Blob) => Promise<Transcript> | undefined | callback function to handle transcription on your own custom server |
Name | Type | Default Value | Description |
---|---|---|---|
prompt | string | undefined | An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. |
response_format | string | json | The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt. |
temperature | number | 0 | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. |
language | string | en | The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. |
Name | Type | Description |
---|---|---|
recording | boolean | speech recording state |
speaking | boolean | detect when user is speaking |
transcribing | boolean | while removing silence from speech and send request to OpenAI Whisper API |
transcript | Transcript | object return after Whisper transcription complete |
pauseRecording | Promise | pause speech recording |
startRecording | Promise | start speech recording |
stopRecording | Promise | stop speech recording |
Name | Type | Description |
---|---|---|
blob | Blob | recorded speech in JavaScript Blob |
text | string | transcribed text returned from Whisper API |
Contact me for web or mobile app development using React or React Native
https://chengsokdara.github.io
FAQs
React Hook for OpenAI Whisper API with speech recorder
The npm package @tmacc/use-speech-to-text receives a total of 3 weekly downloads. As such, @tmacc/use-speech-to-text popularity was classified as not popular.
We found that @tmacc/use-speech-to-text demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.