https://github.com/sbadulin/obsidian-dictation-plugin

Obsidian dictation plugin
https://github.com/sbadulin/obsidian-dictation-plugin

dictation gpt-35-turbo obsidian obsidian-plugin openai speech-to-text whisper

Last synced: 28 days ago
JSON representation

Obsidian dictation plugin

• Host: GitHub
• URL: https://github.com/sbadulin/obsidian-dictation-plugin
• Owner: sbadulin
• Created: 2024-10-16T13:29:49.000Z (30 days ago)
• Default Branch: main
• Last Pushed: 2024-10-16T13:55:33.000Z (30 days ago)
• Last Synced: 2024-10-18T14:05:27.619Z (28 days ago)
• Topics: dictation, gpt-35-turbo, obsidian, obsidian-plugin, openai, speech-to-text, whisper
• Language: TypeScript
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Dictation Plugin for Obsidian

This plugin allows you to quickly dictate notes in Obsidian using OpenAI's Whisper for speech-to-text and GPT-3.5 for summarization.

## Features

- **Start or Stop Recording** using `Cmd + Alt + D`, the ribbon icon, or the command palette.

- **Transcribe Speech or Existing Audio File** using OpenAI Whisper.

- **Summarize the Transcribed Text** using GPT-3.5 Turbo.

- **Create and Open a Note** with the transcription and summary automatically formatted.

## Usage

1. **Start Dictation**: Press `Cmd + Alt + D`, click the microphone icon in the sidebar, or use the command palette to start or stop recording. To transcribe an existing audio use "Transcribe Existing Audio File" command from the Command palette

2. **Transcription**: The recorded audio is sent to OpenAI Whisper for transcription.

3. **Summary**: The transcribed text is summarized using GPT-3.5 Turbo.

4. **Create Note**: The final note, including the summary and transcription, is created and automatically opened in Obsidian.

## Settings

- **OpenAI API Key**: You need to provide your OpenAI API key to use the transcription and summarization features.

- **Note Template**: Customize the template used for creating notes, including placeholders for the date, summary, and transcribed text.

## Installation

1. Clone or download the plugin repository.

2. Copy the plugin folder to your Obsidian vault's `.obsidian/plugins/` directory.

3. Enable the "Dictation Plugin" in Obsidian's community plugins settings.

## Requirements

- **OpenAI API Key**: Required for both transcription (Whisper) and summarization (GPT-3.5).

- **Obsidian**: Version 0.12.0 or higher.

## License

This plugin is licensed under the MIT License.