Whisper-Node 项目使用教程

Whisper-Node 项目使用教程

whisper-nodeNodeJS bindings for OpenAI's Whisper. (C++ CPU version by ggerganov)项目地址:https://gitcode.com/gh_mirrors/wh/whisper-node

1. 项目的目录结构及介绍

Whisper-Node 项目的目录结构如下：

whisper-node/
├── lib/
├── src/
├── .gitignore
├── .gitmodules
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
└── tsconfig.json

目录结构介绍

• lib/: 编译后的 JavaScript 文件存放目录。
• src/: TypeScript 源代码文件存放目录。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• package-lock.json: npm 依赖锁定文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 编译配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/ 目录下，通常是 index.ts 或 main.ts。以下是一个示例启动文件的内容：

import whisper from 'whisper-node';

const filePath = "example/sample.wav"; // 需要转录的音频文件路径
const options = {
  modelName: "base.en", // 默认模型
  language: 'auto', // 自动检测语言
  gen_file_txt: false, // 是否生成 txt 文件
  gen_file_subtitle: false, // 是否生成 srt 文件
  gen_file_vtt: false // 是否生成 vtt 文件
};

const transcript = await whisper(filePath, options);
console.log(transcript);

启动文件介绍

• 导入模块: 导入 whisper-node 模块。
• 设置文件路径: 指定需要转录的音频文件路径。
• 配置选项: 设置转录的选项，包括模型名称、语言检测等。
• 调用转录函数: 调用 whisper 函数进行音频转录，并输出结果。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他配置信息。以下是一个示例内容：

{
  "name": "whisper-node",
  "version": "1.0.0",
  "description": "Node.js bindings for OpenAI's Whisper",
  "main": "lib/index.js",
  "scripts": {
    "dev": "nodemon src/test.ts",
    "build": "tsc"
  },
  "dependencies": {
    "whisper-node": "^1.0.0"
  },
  "devDependencies": {
    "typescript": "^4.5.2",
    "nodemon": "^2.0.15"
  }
}

tsconfig.json

tsconfig.json 文件包含了 TypeScript 编译的配置信息。以下是一个示例内容：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./lib",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true
  }
}

配置文件介绍

• package.json: 定义了项目的名称、版本、描述、入口文件、脚本和依赖等信息。
• tsconfig.json: 定义了 TypeScript 编译的目标版本、模块系统、输出目录、源代码目录和其他编译选项。

通过以上内容，您可以了解 Whisper-Node 项目的目录结构、启动文件和配置文件的基本信息，并根据这些信息进行项目的开发和使用。

whisper-nodeNodeJS bindings for OpenAI's Whisper. (C++ CPU version by ggerganov)项目地址:https://gitcode.com/gh_mirrors/wh/whisper-node