2024-10-15 13:53:26 -03:00
# frozen_string_literal: true
module DiscourseAi
module Summarization
module Strategies
class TopicSummary < Base
def type
AiSummary . summary_types [ :complete ]
end
FIX: Make summaries backfill job more resilient. (#1071)
To quickly select backfill candidates without comparing SHAs, we compare the last summarized post to the topic's highest_post_number. However, hiding or deleting a post and adding a small action will update this column, causing the job to stall and re-generate the same summary repeatedly until someone posts a regular reply. On top of this, this is not always true for topics with `best_replies`, as this last reply isn't necessarily included.
Since this is not evident at first glance and each summarization strategy picks its targets differently, I'm opting to simplify the backfill logic and how we track potential candidates.
The first step is dropping `content_range`, which serves no purpose and it's there because summary caching was supposed to work differently at the beginning. So instead, I'm replacing it with a column called `highest_target_number`, which tracks `highest_post_number` for topics and could track other things like channel's `message_count` in the future.
Now that we have this column when selecting every potential backfill candidate, we'll check if the summary is truly outdated by comparing the SHAs, and if it's not, we just update the column and move on
2025-01-16 09:42:53 -03:00
def highest_target_number
target . highest_post_number
end
2024-10-15 13:53:26 -03:00
def targets_data
2025-03-10 22:29:13 -05:00
post_attributes = % i [ post_number raw username last_version_at ]
if SiteSetting . enable_names && ! SiteSetting . prioritize_username_in_ux
post_attributes . push ( :name )
end
posts_data = ( target . has_summary? ? best_replies : pick_selection ) . pluck ( post_attributes )
posts_data . reduce ( [ ] ) do | memo , ( pn , raw , username , last_version_at , name ) |
2024-10-15 13:53:26 -03:00
raw_text = raw
if pn == 1 && target . topic_embed & . embed_content_cache . present?
raw_text = target . topic_embed & . embed_content_cache
end
2025-03-10 22:29:13 -05:00
display_name = name . presence || username
memo << {
poster : display_name ,
id : pn ,
text : raw_text ,
last_version_at : last_version_at ,
}
2024-10-15 13:53:26 -03:00
end
end
2024-10-31 12:17:42 -03:00
def summary_extension_prompt ( summary , contents )
2024-10-25 11:51:17 -03:00
resource_path = " #{ Discourse . base_path } /t/-/ #{ target . id } "
content_title = target . title
input =
contents . map { | item | " ( #{ item [ :id ] } #{ item [ :poster ] } said: #{ item [ :text ] } ) " } . join
2024-12-10 05:59:19 +11:00
prompt = DiscourseAi :: Completions :: Prompt . new ( << ~ TEXT , topic_id : target . id )
2024-10-25 11:51:17 -03:00
You are an advanced summarization bot tasked with enhancing an existing summary by incorporating additional posts .
### Guidelines:
- Only include the enhanced summary , without any additional commentary .
- Understand and generate Discourse forum Markdown ; including links , _italics_ , ** bold ** .
- Maintain the original language of the text being summarized .
- Aim for summaries to be 400 words or less .
- Each new post is formatted as " <POST_NUMBER>) <USERNAME> <MESSAGE> "
2024-12-03 07:23:31 +11:00
- Cite specific noteworthy posts using the format [ DESCRIPTION ] ( #{resource_path}/POST_NUMBER)
- Example : links to the 3 rd and 6 th posts by sam : sam ( [ #3](#{resource_path}/3), [#6](#{resource_path}/6))
2024-10-25 11:51:17 -03:00
- Example : link to the 6 th post by jane : [ agreed with ] ( #{resource_path}/6)
2024-12-03 07:23:31 +11:00
- Example : link to the 13 th post by joe : [ joe ] ( #{resource_path}/13)
2024-10-25 11:51:17 -03:00
- When formatting usernames either use @USERNAME or [ USERNAME ] ( #{resource_path}/POST_NUMBER)
2024-10-15 13:53:26 -03:00
TEXT
prompt . push ( type : :user , content : << ~ TEXT . strip )
2024-10-25 11:51:17 -03:00
### Context:
#{content_title.present? ? "The discussion title is: " + content_title + ".\n" : ""}
2024-12-03 07:23:31 +11:00
2024-10-25 11:51:17 -03:00
Here is the existing summary :
2024-12-03 07:23:31 +11:00
2024-10-25 11:51:17 -03:00
#{summary}
2024-12-03 07:23:31 +11:00
2024-10-25 11:51:17 -03:00
Here are the new posts , inside < input > < / input> XML tags:
2024-10-15 13:53:26 -03:00
< input >
2024-10-25 11:51:17 -03:00
#{input}
2024-10-15 13:53:26 -03:00
< / input>
2024-10-25 11:51:17 -03:00
Integrate the new information to generate an enhanced concise and coherent summary .
2024-10-15 13:53:26 -03:00
TEXT
prompt
end
2024-10-31 12:17:42 -03:00
def first_summary_prompt ( contents )
2024-10-25 11:51:17 -03:00
resource_path = " #{ Discourse . base_path } /t/-/ #{ target . id } "
content_title = target . title
input =
contents . map { | item | " ( #{ item [ :id ] } #{ item [ :poster ] } said: #{ item [ :text ] } " } . join
2024-12-10 05:59:19 +11:00
prompt = DiscourseAi :: Completions :: Prompt . new ( << ~ TEXT . strip , topic_id : target . id )
2024-10-25 11:51:17 -03:00
You are an advanced summarization bot that generates concise , coherent summaries of provided text .
- Only include the summary , without any additional commentary .
- You understand and generate Discourse forum Markdown ; including links , _italics_ , ** bold ** .
- Maintain the original language of the text being summarized .
- Aim for summaries to be 400 words or less .
- Each post is formatted as " <POST_NUMBER>) <USERNAME> <MESSAGE> "
2024-12-03 07:23:31 +11:00
- Cite specific noteworthy posts using the format [ DESCRIPTION ] ( #{resource_path}/POST_NUMBER)
- Example : links to the 3 rd and 6 th posts by sam : sam ( [ #3](#{resource_path}/3), [#6](#{resource_path}/6))
2024-10-25 11:51:17 -03:00
- Example : link to the 6 th post by jane : [ agreed with ] ( #{resource_path}/6)
2024-12-03 07:23:31 +11:00
- Example : link to the 13 th post by joe : [ joe ] ( #{resource_path}/13)
2024-10-25 11:51:17 -03:00
- When formatting usernames either use @USERNMAE OR [ USERNAME ] ( #{resource_path}/POST_NUMBER)
TEXT
prompt . push (
type : :user ,
content :
" Here are the posts inside <input></input> XML tags: \n \n <input>1) user1 said: I love Mondays 2) user2 said: I hate Mondays</input> \n \n Generate a concise, coherent summary of the text above maintaining the original language. " ,
)
prompt . push (
type : :model ,
content :
" Two users are sharing their feelings toward Mondays. [user1]( #{ resource_path } /1) hates them, while [user2]( #{ resource_path } /2) loves them. " ,
)
2024-10-15 13:53:26 -03:00
prompt . push ( type : :user , content : << ~ TEXT . strip )
2024-10-25 11:51:17 -03:00
#{content_title.present? ? "The discussion title is: " + content_title + ".\n" : ""}
Here are the posts , inside < input > < / input> XML tags:
2024-10-15 13:53:26 -03:00
2024-10-25 11:51:17 -03:00
< input >
#{input}
< / input>
2024-10-15 13:53:26 -03:00
2024-10-25 11:51:17 -03:00
Generate a concise , coherent summary of the text above maintaining the original language .
TEXT
2024-10-15 13:53:26 -03:00
prompt
end
private
attr_reader :topic
def best_replies
Post
. summary ( target . id )
. where ( " post_type = ? " , Post . types [ :regular ] )
. where ( " NOT hidden " )
. joins ( :user )
. order ( :post_number )
end
def pick_selection
posts =
Post
. where ( topic_id : target . id )
. where ( " post_type = ? " , Post . types [ :regular ] )
. where ( " NOT hidden " )
. order ( :post_number )
post_numbers = posts . limit ( 5 ) . pluck ( :post_number )
post_numbers += posts . reorder ( " posts.score desc " ) . limit ( 50 ) . pluck ( :post_number )
post_numbers += posts . reorder ( " post_number desc " ) . limit ( 5 ) . pluck ( :post_number )
Post
. where ( topic_id : target . id )
. joins ( :user )
. where ( " post_number in (?) " , post_numbers )
. order ( :post_number )
end
end
end
end
end