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.

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

Add summary feature #24

Open
himynamesdave opened this issue Nov 7, 2024 · 1 comment · May be fixed by #38
Open

Add summary feature #24

himynamesdave opened this issue Nov 7, 2024 · 1 comment · May be fixed by #38
Assignees
Labels
enhancement New feature or request

Comments

@himynamesdave
Copy link
Member

himynamesdave commented Nov 7, 2024

Sometime blog posts can be long and users only want a simplified version of what the post is talking about

We can get the AI (if keys exist) to simplify the posts into a few paragraphs and produce a markdown summary for each

This should then be provided on feeds/id/posts/id/summary

        <persona>

        You are a cyber-security threat intelligence analyst responsible for analysing intelligence. You have a deep understanding of cybersecurity concepts and threat intelligence. You are responsible for simplifying long intelligence reports into concise summaries for other to quickly understand the contents.

        </persona>

        <requirement>

        Using HTML of the report provided, provide an executive summary of it containing no more than three paragraphs.

       IMPORTANT: the output should be structured as markdown text.

        </requirement>

        <accuracy>

        Think about your answer first before you respond.

        If you don't know how to summaries the report simply reply "false", do not every try to make up an answer.

        </accuracy>

In profile, user should be able to set --ai_summary_provider in form provider:model e.g. openai:gpt4o

if not provided, no summary will be generated for the post.

@himynamesdave
Copy link
Member Author

change

/api/v1/feeds/{feed_id}/posts/{post_id}/summarize/

to

/api/v1/feeds/{feed_id}/posts/{post_id}/summarise/

Also make the endpoint summary / description

Get the summary of the Post
Get the summary of the post if ai_summary_provider was enabled

@himynamesdave himynamesdave moved this from Pushed to Todo in open-source roadmap Nov 13, 2024
@fqrious fqrious moved this from Todo to Pushed in open-source roadmap Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Pushed
Development

Successfully merging a pull request may close this issue.

2 participants