Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make the existing document title available in prompt template. #158

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Make the existing document title available in prompt template. #158

merged 1 commit into from
Jan 27, 2025

Conversation

IngmarStein
Copy link
Contributor

@IngmarStein IngmarStein commented Jan 27, 2025 •
edited by coderabbitai bot
Loading

This allow a prompt to feed the LLM with the title as determined by Paperless to improve its suggestion.

This also fixes the case when getSuggestedTags or getSuggestedCorrespondent are called, but GenerateTitles is off (in which case an empty title was used).

Fixes #137

Summary by CodeRabbit

  • New Features

    • Enhanced title suggestion functionality by incorporating an existing document title into the suggestion process
    • Updated method to allow more context-aware title generation

  • Refactor

    • Modified method signature to include a suggested title parameter
    • Updated internal logic to leverage the provided document title during suggestion generation

@IngmarStein
Make the existing document title available in prompt template.
8448e36 
This allow a prompt to feed the LLM with the title as determined by
Paperless to improve its suggestion.

This also fixes the case when `getSuggestedTags` or
`getSuggestedCorrespondent` are called, but `GenerateTitles` is off (in
which case an empty title was used).

Fixes icereed#137
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025 •
edited
Loading

Walkthrough

The changes modify the getSuggestedTitle method in the app_llm.go file to include a new parameter suggestedTitle. This enhancement allows passing the existing document title into the title suggestion process. The method signature is updated to accept this additional parameter, and the implementation is adjusted to incorporate the existing title into the context of generating title suggestions.

Changes

File Change Summary
app_llm.go - Updated getSuggestedTitle method signature to include suggestedTitle parameter
- Modified method to use the new suggestedTitle parameter in template execution
- Updated generateDocumentSuggestions to initialize suggestedTitle with doc.Title

Assessment against linked issues

Objective Addressed Explanation
Pass existing title to LLM [#137] ✅

Poem

🐰 A rabbit's tale of titles bright,
Where words dance with algorithmic might,
A whisker's tweak, a parameter new,
Suggestions flow with context true,
Code hops forward, innovation's delight! 🌟

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27b56ee and 8448e36.

📒 Files selected for processing (1)
  • app_llm.go (3 hunks)
🔇 Additional comments (3)
app_llm.go (3)

194-194: LGTM! The changes effectively incorporate the existing document title into the prompt template.

The modification to include suggestedTitle as a parameter and pass it to the template execution is well-implemented and aligns with the PR objectives.

Also applies to: 204-204

280-280: LGTM! Correctly initializes suggestedTitle with the document's existing title.

This change resolves the issue where functions would return an empty title when GenerateTitles was disabled.

285-285: Verify the title suggestion behavior with the updated implementation.

The function call correctly passes the existing title to getSuggestedTitle. Let's verify that the title suggestion behavior works as expected in all scenarios.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@icereed icereed merged commit 8b6041a into icereed:main Jan 27, 2025
2 of 3 checks passed
@icereed
Copy link
Owner

icereed commented Jan 27, 2025

Awesome, thanks for this contribution! That makes you officially a contributor for paperless-gpt 🎉

This was referenced Jan 27, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Pass existing title to llm
2 participants
@IngmarStein @icereed