Skip to content

Thread Summarizer Plugin #19

@skkuwari-alt

Description

@skkuwari-alt

Description

Description
Adds a new API endpoint /api/thread-summarizer/v2/:tid that generates concise summaries of forum threads using the OpenAI API. Includes caching, cooldowns, and permission checks.

Technical Requirements

  • Implement API route for summarization
  • Integrate OpenAI (gpt-4o-mini)
  • Add LRU cache (10-min expiry)
  • Add per-user cooldown (30 s)
  • Handle permission checks
  • Write automated tests (≥ 80 % coverage)
  • Add UserGuide.md with setup and usage

Effort: ~1 week
Milestone: Sprint 2
Dependencies: NodeBB core modules, OpenAI API

Acceptance Criteria

  • Clickable button for each thread
  • Valid summaries returned for threads
  • Proper error handling (400, 403, 429, 500)
    -Cached responses served correctly
  • Tests pass in CI

Community forum reference

No response

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions