ITADN
receptron/MulmoChatPluginSummarizePdf
receptron/MulmoChatPluginSummarizePdf · 文件
文件最后提交记录最后更新时间
README.md

@mulmochat-plugin/summarize-pdf

npm version

A plugin for MulmoChat - a multi-modal voice chat application with OpenAI's GPT-4 Realtime API.

What this plugin does

Displays and summarizes uploaded PDF documents.

Installation

yarn add @mulmochat-plugin/summarize-pdf gui-chat-protocol

gui-chat-protocol is a peer dependency — install it alongside the plugin; the host application provides the runtime and this plugin only declares the compatible range.

Usage

import Plugin from "@mulmochat-plugin/summarize-pdf";
import "@mulmochat-plugin/summarize-pdf/style.css";

// Add to pluginList
const pluginList = [
  // ... other plugins
  Plugin,
];

Development

# Install dependencies
yarn install

# Start dev server (http://localhost:5173/)
yarn dev

# Build
yarn build

# Type check
yarn typecheck

# Lint
yarn lint

Test Prompts

Try these prompts to test the plugin (after uploading a PDF):

  1. "Summarize this PDF document for me"
  2. "What are the main points in this PDF?"
  3. "Give me a brief overview of the uploaded document"

License

MIT