Ephemeral slack messages as responses to user questions #4142

joachim-danswer · 2025-02-27T01:58:05Z

Description

We want to enable our customers to configure an Onyx bot for a channel such that the bot is able to respond as an ephemeral message to the user who is asking the question. That provides us with the ability to leverage documents for the search that a user has private access to, not just documents that are public to everyone.

See details in the current design doc.

Ticket: https://linear.app/danswer/issue/DAN-1489/enable-ephemeral-replies-by-answer-bot-in-group-channels

How Has This Been Tested?

Locally:

set up new bot in test mode
configured two channels, one with the new is_ephemeral parameter=True, the other one set to false
for each, I sent a request to the bot from
- the channel
- a thread
in the channel with the ephemeral setting I check for both question sources (channel vs thread) the button clicks 'Shae with Channel', and 'Keep for Yourself.

Key test cases:

are the documents properly transferred
are the new locations correct

Backporting (check the box to trigger backport action)

Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.

This PR should be backported (make sure to check that the backport attempt succeeds)
[Optional] Override Linear Check

vercel · 2025-02-27T01:58:09Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
internal-search	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 3, 2025 3:57pm

Weves · 2025-02-27T19:57:54Z

backend/scripts/document_seeding_prep.py

@@ -161,27 +161,33 @@ class SeedPresaveDocument(BaseModel):
    url="https://docs.onyx.app/more/use_cases/overview",
    title=overview_title,
    content=overview,
-    title_embedding=model.encode(f"search_document: {overview_title}"),
-    content_embedding=model.encode(f"search_document: {overview_title}\n{overview}"),
+    title_embedding=list(model.encode(f"search_document: {overview_title}")),


are these just typing changes?

Yes. For anopther PR I need to upgrade HF version, which apparently changes the type here, so 'list' was needed to make it work with my local version.

As that is another PR though, I will remove.

Weves · 2025-02-27T19:58:24Z

backend/onyx/connectors/slack/utils.py

@@ -72,6 +72,11 @@ def make_slack_api_rate_limited(
    @wraps(call)
    def rate_limited_call(**kwargs: Any) -> SlackResponse:
        last_exception = None
+
+        if "thread_ts" in kwargs:


can we add a comment as to why we're doing this? Also, are we sure this should be the desired logic for all slack calls?

Was actually not necessary. Sending thread_ts as None is equivalent to removing that key.

Code snippet removed.

Weves · 2025-02-27T19:59:11Z

backend/onyx/onyxbot/slack/blocks.py

+    channel_conf: ChannelConfig | None = None,
+    feedback_reminder_id: str | None = None,
+) -> Block:
+    if not chat_message_id:


we shouldn't need to have these checks here—we can just rely on mypy / typing to handle this.

In other words, we could just have the typing as:

chat_message_id: int

Agreed. Done.

Weves · 2025-02-27T19:59:22Z

backend/onyx/onyxbot/slack/blocks.py

+    if not chat_message_id:
+        raise ValueError("Chat message id is required to change the ephemeral message")
+
+    if message_info is None:


same as the ^ for these 2

Weves · 2025-02-27T23:26:13Z

backend/onyx/onyxbot/slack/utils.py

+def build_publish_ephemeral_message_id(
+    original_question_ts: str | None = None,
+) -> str:
+    if original_question_ts is None:


same comment here

Weves · 2025-03-03T02:17:57Z

backend/onyx/onyxbot/slack/handlers/handle_buttons.py

+    if action_id == SHOW_EVERYONE_ACTION_ID:
+        # Convert to non-ephemeral message in thread
+        try:
+            webhook.send(


what does this one specifically do? Would be nice to add a comment here

Weves · 2025-03-03T02:20:35Z

backend/onyx/onyxbot/slack/handlers/handle_buttons.py

+    # The additional data required that was added to buttons.
+    # Specifically, this contains the message_info, channel_conf information
+    # and some additional attributes.
+    value_dict = json.loads(req.payload["actions"][0]["value"])


for future reference / a small enhancement: would prefer to get things into the "typed world" as soon as possible. In this case, that would mean converting this into a pydantic model / a typed dict.

todos: - search using private docs - review

- Updated frontend descriptions - removal of 'I need help'-type options - proper handling of response group - no response group + ephemeral

- always check ACL - if not ephemeral, only use public docs (user = None) - changed warning in slack bot - shortened 'share with everyone' button

joachim-danswer requested a review from Weves February 27, 2025 01:58

Weves reviewed Feb 28, 2025

View reviewed changes

joachim-danswer requested a review from a team as a code owner March 1, 2025 00:16

vercel bot deployed to Preview March 1, 2025 00:20 View deployment

vercel bot deployed to Preview March 2, 2025 23:08 View deployment

Weves approved these changes Mar 3, 2025

View reviewed changes

joachim-danswer added 15 commits March 3, 2025 07:45

is_ephemeral

bd4cd71

working base version

71c55d4

todos: - search using private docs - review

basic search base working code

5f97035

mypy adjustment

3d1d0ed

set proper onyx user IFF bot is configured as ephemeral for channel

47efa90

small clean-ups

ad74cb4

nit

c05de96

converted value encoding for buttons to pydantic objects

a6a3e24

cleanup

f3f6b22

send to respond_member_group_list

5b98083

nit

927eb45

nit

d03e1fb

changed receiver_ds in public repost to none

ea5d3cd

fixes based on CW discussion

41b60da

- Updated frontend descriptions - removal of 'I need help'-type options - proper handling of response group - no response group + ephemeral

Final discussion adjustments

a14060b

- always check ACL - if not ephemeral, only use public docs (user = None) - changed warning in slack bot - shortened 'share with everyone' button

joachim-danswer force-pushed the ephemeral-Slack-messages branch from 3ce1225 to a14060b Compare March 3, 2025 15:47

session with current tenant adjustment

eaac54d

vercel bot deployed to Preview March 3, 2025 15:57 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ephemeral slack messages as responses to user questions #4142

Ephemeral slack messages as responses to user questions #4142

joachim-danswer commented Feb 27, 2025

vercel bot commented Feb 27, 2025 •

edited

Loading

Weves Feb 27, 2025

joachim-danswer Feb 28, 2025

Weves Feb 27, 2025

joachim-danswer Feb 28, 2025

Weves Feb 27, 2025

joachim-danswer Feb 28, 2025

Weves Feb 27, 2025

joachim-danswer Feb 28, 2025

Weves Feb 27, 2025

joachim-danswer Feb 28, 2025

Weves Mar 3, 2025

Weves Mar 3, 2025

Ephemeral slack messages as responses to user questions #4142

Are you sure you want to change the base?

Ephemeral slack messages as responses to user questions #4142

Conversation

joachim-danswer commented Feb 27, 2025

Description

How Has This Been Tested?

Backporting (check the box to trigger backport action)

vercel bot commented Feb 27, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Feb 27, 2025 •

edited

Loading