use-whisper 项目教程

use-whisper 项目教程

use-whisperReact hook for OpenAI Whisper with speech recorder, real-time transcription, and silence removal built-in项目地址:https://gitcode.com/gh_mirrors/us/use-whisper

1、项目介绍

use-whisper 是一个基于 React 的 Hook，用于与 OpenAI 的 Whisper API 进行交互，实现语音录制的实时转录和静音去除功能。该项目旨在简化语音转文本的过程，特别适用于需要实时语音识别的应用场景。

2、项目快速启动

安装

首先，通过 npm 或 yarn 安装 use-whisper：

npm install @chengsokdara/use-whisper
# 或者
yarn add @chengsokdara/use-whisper

基本使用

以下是一个简单的示例，展示如何使用 use-whisper 进行实时语音转录：

import React from 'react';
import { useWhisper } from '@chengsokdara/use-whisper';

const App = () => {
  const [transcript] = useWhisper({
    apiKey: process.env.OPENAI_API_TOKEN, // 你的 OpenAI API 密钥
    streaming: true,
    timeSlice: 1000, // 每秒发送一次数据
    whisperConfig: {
      language: 'en', // 设置语言为英语
    },
  });

  return (
    <div>
      <p>{transcript.text}</p>
    </div>
  );
};

export default App;

配置说明

• apiKey: OpenAI API 的密钥。
• streaming: 是否启用实时流式传输。
• timeSlice: 每次发送数据的时间间隔（毫秒）。
• whisperConfig: Whisper API 的配置选项，如语言设置等。

3、应用案例和最佳实践

实时语音转录

在实时语音转录的应用中，use-whisper 可以用于实时记录会议内容、实时字幕生成等场景。通过设置 streaming: true，可以确保语音数据实时发送到 Whisper API 进行处理。

静音去除

use-whisper 内置了静音去除功能，可以减少不必要的 API 调用，从而节省成本。通过设置 silence removal 选项，可以在发送数据前自动去除静音部分。

4、典型生态项目

React Native 支持

use-whisper 正在开发对 React Native 的支持，未来可以通过 use-whisper/native 模块在移动端应用中使用。

相关项目

• @chengsokdara/react-hooks-async: 一个用于处理异步操作的 React Hook 库，与 use-whisper 结合使用可以更好地管理异步任务。

通过以上步骤，你可以快速上手并使用 use-whisper 进行语音转录和处理。

use-whisperReact hook for OpenAI Whisper with speech recorder, real-time transcription, and silence removal built-in项目地址:https://gitcode.com/gh_mirrors/us/use-whisper