Conversation
Author
|
(I was committing to the class repo by accident, and I closed a PR there) |
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Solves Issue: #19
Summary
This PR introduces a fully functional Thread Summarizer plugin for NodeBB.
It provides an
/api/thread-summarizer/v2/:tidREST route that generates concise summaries of forum topics using the OpenAI API.Features Implemented
Adds new API route:
/api/thread-summarizer/v2/:tidIntegrates OpenAI API (
gpt-4o-mini) for summarizationIncludes environment variable controls:
OPENAI_API_KEY– required for real summariesEach user must set their own OpenAI API key in the environment before running the server.
TS_STUB=1– enables offline testing (returns fake summaries)Adds an LRU cache (10-minute expiry) to avoid redundant API calls
Implements a per-user cooldown (30 seconds) to prevent spam
Handles permission checks via
privileges.topics.canReturns clean JSON responses for both cached and fresh summaries
Uses
posts.getPostsByPidsto gather thread contentHow It Works
Testing
A. Stub Mode (no API key required)
B. Real Mode (requires OpenAI API key)
Notes
OPENAI_API_KEYto generate real summaries.