开源项目使用教程：Offmute

开源项目使用教程：Offmute

offmute An experiment in meeting transcription and diarization with just an LLM. Maybe I went a little overboard though 项目地址: https://gitcode.com/gh_mirrors/of/offmute

1. 项目目录结构及介绍

Offmute 是一个开源项目，用于会议转录和分析。项目目录结构如下：

offmute/
├── src/                       # 源代码目录
│   ├── .gitignore              # Git忽略文件
│   ├── tsconfig.json           # TypeScript配置文件
│   ├── tsup.config.ts          # 打包配置文件
│   ├── ...                     # 其他源代码文件
├── README.md                  # 项目说明文件
├── LICENSE                     # 项目许可证文件
├── TODO.md                    # 待办事项文件
├── package.json               # npm项目配置文件
└── ...                         # 其他项目文件

• src/：存放项目的所有源代码文件。
• .gitignore：指定Git应该忽略的文件和目录。
• tsconfig.json：TypeScript编译器的配置文件。
• tsup.config.ts：项目打包的配置文件。
• README.md：项目的说明文档，包含了项目的使用方法和功能介绍。
• LICENSE：项目的开源许可证信息。
• TODO.md：记录项目中待完成的任务和未来的功能规划。
• package.json：npm项目的配置文件，包含了项目的依赖、脚本等信息。

2. 项目的启动文件介绍

Offmute 项目的启动主要是通过命令行界面（CLI）进行的。没有特定的启动文件，而是通过 npx 命令直接使用包中的CLI工具。

启动CLI的示例命令如下：

npx offmute path/to/your/meeting.mp4

这条命令会处理指定路径的会议视频文件。如果需要更多的选项和配置，可以使用以下格式的命令：

npx offmute <input-file> [options]

其中 <input-file> 是输入的视频文件路径，[options] 是可选的参数，例如：

• -t, --tier <tier>：指定处理级别。
• -s, --save-intermediates：保存中间处理文件。
• -id, --intermediates-dir <path>：指定中间输出文件的目录。
• -sc, --screenshot-count <number>：设置从视频中提取的截图数量。
• -ac, --audio-chunk-minutes <number>：设置音频块处理的时间长度。
• -r, --report：生成结构化的会议报告。
• -rd, --reports-dir <path>：指定报告输出目录。
• -i, --instructions <text>：提供自定义指令给AI模型。

3. 项目的配置文件介绍

Offmute 项目的配置主要通过命令行参数进行。如果需要持久化配置，可以在项目根目录下创建一个配置文件，如 config.json，并在其中定义所需的配置项。

例如，一个基本的配置文件可能包含如下内容：

{
  "tier": "business",
  "saveIntermediates": true,
  "intermediatesDir": "./processing_files",
  "screenshotCount": 4,
  "audioChunkMinutes": 10,
  "report": true,
  "reportsDir": "./reports",
  "instructions": "Focus on technical terminology and highlight all action items"
}

该配置文件定义了处理级别、是否保存中间文件、截图数量、音频块大小、是否生成报告以及自定义指令等。在启动项目时，可以通过命令行参数 --config <path> 来指定配置文件的路径。

请注意，配置文件的详细结构和可用选项可能因项目版本更新而发生变化，请参考最新的项目文档。

offmute An experiment in meeting transcription and diarization with just an LLM. Maybe I went a little overboard though 项目地址: https://gitcode.com/gh_mirrors/of/offmute