From dd5f4e60ae6773ecc86979c64230ecf08a079dfc Mon Sep 17 00:00:00 2001 From: ArielTM Date: Sun, 9 Mar 2025 17:02:38 +1100 Subject: [PATCH 1/2] add support for assistant.search.context --- slack_sdk/web/async_client.py | 39 ++++++++++++++++++++++++++++++++++ slack_sdk/web/client.py | 39 ++++++++++++++++++++++++++++++++++ slack_sdk/web/legacy_client.py | 39 ++++++++++++++++++++++++++++++++++ 3 files changed, 117 insertions(+) diff --git a/slack_sdk/web/async_client.py b/slack_sdk/web/async_client.py index b7ea40771..e43c157f6 100644 --- a/slack_sdk/web/async_client.py +++ b/slack_sdk/web/async_client.py @@ -2014,6 +2014,45 @@ async def tooling_tokens_rotate( kwargs.update({"refresh_token": refresh_token}) return await self.api_call("tooling.tokens.rotate", params=kwargs) + async def assistant_search_context( + self, + *, + query: str, + action_token: str, + channel_types: Optional[Union[str, Sequence[str]]] = None, + content_types: Optional[Union[str, Sequence[str]]] = None, + context_channel_id: Optional[str] = None, + cursor: Optional[str] = None, + include_bots: Optional[bool] = None, + limit: Optional[int] = None, + **kwargs, + ) -> AsyncSlackResponse: + """Searches messages across your Slack organization—perfect for broad, specific, and real-time data retrieval. + https://api.slack.com/methods/assistant.search.context + """ + kwargs.update( + { + "query": query, + "action_token": action_token, + "context_channel_id": context_channel_id, + "cursor": cursor, + "include_bots": include_bots, + "limit": limit, + } + ) + + if isinstance(channel_types, (list, tuple)): + kwargs.update({"channel_types": ",".join(channel_types)}) + else: + kwargs.update({"channel_types": channel_types}) + + if isinstance(content_types, (list, tuple)): + kwargs.update({"content_types": ",".join(content_types)}) + else: + kwargs.update({"content_types": content_types}) + + return await self.api_call("assistant.search.context", params=kwargs) + async def assistant_threads_setStatus( self, *, diff --git a/slack_sdk/web/client.py b/slack_sdk/web/client.py index 55e9763de..3de7fdcde 100644 --- a/slack_sdk/web/client.py +++ b/slack_sdk/web/client.py @@ -2004,6 +2004,45 @@ def tooling_tokens_rotate( kwargs.update({"refresh_token": refresh_token}) return self.api_call("tooling.tokens.rotate", params=kwargs) + def assistant_search_context( + self, + *, + query: str, + action_token: str, + channel_types: Optional[Union[str, Sequence[str]]] = None, + content_types: Optional[Union[str, Sequence[str]]] = None, + context_channel_id: Optional[str] = None, + cursor: Optional[str] = None, + include_bots: Optional[bool] = None, + limit: Optional[int] = None, + **kwargs, + ) -> SlackResponse: + """Searches messages across your Slack organization—perfect for broad, specific, and real-time data retrieval. + https://api.slack.com/methods/assistant.search.context + """ + kwargs.update( + { + "query": query, + "action_token": action_token, + "context_channel_id": context_channel_id, + "cursor": cursor, + "include_bots": include_bots, + "limit": limit, + } + ) + + if isinstance(channel_types, (list, tuple)): + kwargs.update({"channel_types": ",".join(channel_types)}) + else: + kwargs.update({"channel_types": channel_types}) + + if isinstance(content_types, (list, tuple)): + kwargs.update({"content_types": ",".join(content_types)}) + else: + kwargs.update({"content_types": content_types}) + + return self.api_call("assistant.search.context", params=kwargs) + def assistant_threads_setStatus( self, *, diff --git a/slack_sdk/web/legacy_client.py b/slack_sdk/web/legacy_client.py index 18f745632..c5c7a1687 100644 --- a/slack_sdk/web/legacy_client.py +++ b/slack_sdk/web/legacy_client.py @@ -2016,6 +2016,45 @@ def tooling_tokens_rotate( kwargs.update({"refresh_token": refresh_token}) return self.api_call("tooling.tokens.rotate", params=kwargs) + def assistant_search_context( + self, + *, + query: str, + action_token: str, + channel_types: Optional[Union[str, Sequence[str]]] = None, + content_types: Optional[Union[str, Sequence[str]]] = None, + context_channel_id: Optional[str] = None, + cursor: Optional[str] = None, + include_bots: Optional[bool] = None, + limit: Optional[int] = None, + **kwargs, + ) -> Union[Future, SlackResponse]: + """Searches messages across your Slack organization—perfect for broad, specific, and real-time data retrieval. + https://api.slack.com/methods/assistant.search.context + """ + kwargs.update( + { + "query": query, + "action_token": action_token, + "context_channel_id": context_channel_id, + "cursor": cursor, + "include_bots": include_bots, + "limit": limit, + } + ) + + if isinstance(channel_types, (list, tuple)): + kwargs.update({"channel_types": ",".join(channel_types)}) + else: + kwargs.update({"channel_types": channel_types}) + + if isinstance(content_types, (list, tuple)): + kwargs.update({"content_types": ",".join(content_types)}) + else: + kwargs.update({"content_types": content_types}) + + return self.api_call("assistant.search.context", params=kwargs) + def assistant_threads_setStatus( self, *, From 440c81b4632fd5ff0db503408091934f99ff6e0e Mon Sep 17 00:00:00 2001 From: Eden Zimbelman Date: Wed, 18 Nov 2026 20:42:04 -0800 Subject: [PATCH 2/2] fix: match assistant.search.context arguments to the reference Co-Authored-By: Claude --- slack_sdk/web/async_client.py | 39 +++++++++++++++---- slack_sdk/web/client.py | 39 +++++++++++++++---- slack_sdk/web/legacy_client.py | 39 +++++++++++++++---- .../web/test_web_client_coverage.py | 10 ++++- 4 files changed, 102 insertions(+), 25 deletions(-) diff --git a/slack_sdk/web/async_client.py b/slack_sdk/web/async_client.py index 8e543fba3..9da6414e4 100644 --- a/slack_sdk/web/async_client.py +++ b/slack_sdk/web/async_client.py @@ -2762,39 +2762,62 @@ async def assistant_search_context( self, *, query: str, - action_token: str, + action_token: Optional[str] = None, channel_types: Optional[Union[str, Sequence[str]]] = None, content_types: Optional[Union[str, Sequence[str]]] = None, + include_bots: Optional[bool] = None, + include_deleted_users: Optional[bool] = None, + before: Optional[int] = None, + after: Optional[int] = None, + include_context_messages: Optional[bool] = None, context_channel_id: Optional[str] = None, cursor: Optional[str] = None, - include_bots: Optional[bool] = None, limit: Optional[int] = None, + sort: Optional[str] = None, + sort_dir: Optional[str] = None, + include_message_blocks: Optional[bool] = None, + highlight: Optional[bool] = None, + term_clauses: Optional[Sequence[str]] = None, + modifiers: Optional[str] = None, + include_archived_channels: Optional[bool] = None, + disable_semantic_search: Optional[bool] = None, **kwargs, ) -> AsyncSlackResponse: - """Searches messages across your Slack organization—perfect for broad, specific, and real-time data retrieval. - https://api.slack.com/methods/assistant.search.context + """Searches messages, files, channels and users across your Slack organization. + + https://docs.slack.dev/reference/methods/assistant.search.context """ kwargs.update( { "query": query, "action_token": action_token, + "include_bots": include_bots, + "include_deleted_users": include_deleted_users, + "before": before, + "after": after, + "include_context_messages": include_context_messages, "context_channel_id": context_channel_id, "cursor": cursor, - "include_bots": include_bots, "limit": limit, + "sort": sort, + "sort_dir": sort_dir, + "include_message_blocks": include_message_blocks, + "highlight": highlight, + "modifiers": modifiers, + "include_archived_channels": include_archived_channels, + "disable_semantic_search": disable_semantic_search, } ) - if isinstance(channel_types, (list, tuple)): kwargs.update({"channel_types": ",".join(channel_types)}) else: kwargs.update({"channel_types": channel_types}) - if isinstance(content_types, (list, tuple)): kwargs.update({"content_types": ",".join(content_types)}) else: kwargs.update({"content_types": content_types}) - + if term_clauses is not None: + kwargs.update({"term_clauses": json.dumps(term_clauses)}) return await self.api_call("assistant.search.context", params=kwargs) async def assistant_threads_setStatus( diff --git a/slack_sdk/web/client.py b/slack_sdk/web/client.py index d213fe409..c6f959a79 100644 --- a/slack_sdk/web/client.py +++ b/slack_sdk/web/client.py @@ -2752,39 +2752,62 @@ def assistant_search_context( self, *, query: str, - action_token: str, + action_token: Optional[str] = None, channel_types: Optional[Union[str, Sequence[str]]] = None, content_types: Optional[Union[str, Sequence[str]]] = None, + include_bots: Optional[bool] = None, + include_deleted_users: Optional[bool] = None, + before: Optional[int] = None, + after: Optional[int] = None, + include_context_messages: Optional[bool] = None, context_channel_id: Optional[str] = None, cursor: Optional[str] = None, - include_bots: Optional[bool] = None, limit: Optional[int] = None, + sort: Optional[str] = None, + sort_dir: Optional[str] = None, + include_message_blocks: Optional[bool] = None, + highlight: Optional[bool] = None, + term_clauses: Optional[Sequence[str]] = None, + modifiers: Optional[str] = None, + include_archived_channels: Optional[bool] = None, + disable_semantic_search: Optional[bool] = None, **kwargs, ) -> SlackResponse: - """Searches messages across your Slack organization—perfect for broad, specific, and real-time data retrieval. - https://api.slack.com/methods/assistant.search.context + """Searches messages, files, channels and users across your Slack organization. + + https://docs.slack.dev/reference/methods/assistant.search.context """ kwargs.update( { "query": query, "action_token": action_token, + "include_bots": include_bots, + "include_deleted_users": include_deleted_users, + "before": before, + "after": after, + "include_context_messages": include_context_messages, "context_channel_id": context_channel_id, "cursor": cursor, - "include_bots": include_bots, "limit": limit, + "sort": sort, + "sort_dir": sort_dir, + "include_message_blocks": include_message_blocks, + "highlight": highlight, + "modifiers": modifiers, + "include_archived_channels": include_archived_channels, + "disable_semantic_search": disable_semantic_search, } ) - if isinstance(channel_types, (list, tuple)): kwargs.update({"channel_types": ",".join(channel_types)}) else: kwargs.update({"channel_types": channel_types}) - if isinstance(content_types, (list, tuple)): kwargs.update({"content_types": ",".join(content_types)}) else: kwargs.update({"content_types": content_types}) - + if term_clauses is not None: + kwargs.update({"term_clauses": json.dumps(term_clauses)}) return self.api_call("assistant.search.context", params=kwargs) def assistant_threads_setStatus( diff --git a/slack_sdk/web/legacy_client.py b/slack_sdk/web/legacy_client.py index 8a4b35625..103da1d41 100644 --- a/slack_sdk/web/legacy_client.py +++ b/slack_sdk/web/legacy_client.py @@ -2763,39 +2763,62 @@ def assistant_search_context( self, *, query: str, - action_token: str, + action_token: Optional[str] = None, channel_types: Optional[Union[str, Sequence[str]]] = None, content_types: Optional[Union[str, Sequence[str]]] = None, + include_bots: Optional[bool] = None, + include_deleted_users: Optional[bool] = None, + before: Optional[int] = None, + after: Optional[int] = None, + include_context_messages: Optional[bool] = None, context_channel_id: Optional[str] = None, cursor: Optional[str] = None, - include_bots: Optional[bool] = None, limit: Optional[int] = None, + sort: Optional[str] = None, + sort_dir: Optional[str] = None, + include_message_blocks: Optional[bool] = None, + highlight: Optional[bool] = None, + term_clauses: Optional[Sequence[str]] = None, + modifiers: Optional[str] = None, + include_archived_channels: Optional[bool] = None, + disable_semantic_search: Optional[bool] = None, **kwargs, ) -> Union[Future, SlackResponse]: - """Searches messages across your Slack organization—perfect for broad, specific, and real-time data retrieval. - https://api.slack.com/methods/assistant.search.context + """Searches messages, files, channels and users across your Slack organization. + + https://docs.slack.dev/reference/methods/assistant.search.context """ kwargs.update( { "query": query, "action_token": action_token, + "include_bots": include_bots, + "include_deleted_users": include_deleted_users, + "before": before, + "after": after, + "include_context_messages": include_context_messages, "context_channel_id": context_channel_id, "cursor": cursor, - "include_bots": include_bots, "limit": limit, + "sort": sort, + "sort_dir": sort_dir, + "include_message_blocks": include_message_blocks, + "highlight": highlight, + "modifiers": modifiers, + "include_archived_channels": include_archived_channels, + "disable_semantic_search": disable_semantic_search, } ) - if isinstance(channel_types, (list, tuple)): kwargs.update({"channel_types": ",".join(channel_types)}) else: kwargs.update({"channel_types": channel_types}) - if isinstance(content_types, (list, tuple)): kwargs.update({"content_types": ",".join(content_types)}) else: kwargs.update({"content_types": content_types}) - + if term_clauses is not None: + kwargs.update({"term_clauses": json.dumps(term_clauses)}) return self.api_call("assistant.search.context", params=kwargs) def assistant_threads_setStatus( diff --git a/tests/slack_sdk_async/web/test_web_client_coverage.py b/tests/slack_sdk_async/web/test_web_client_coverage.py index c9f1ffaf0..3bf979726 100644 --- a/tests/slack_sdk_async/web/test_web_client_coverage.py +++ b/tests/slack_sdk_async/web/test_web_client_coverage.py @@ -67,7 +67,6 @@ def setUp(self): # TODO: admin.audit.anomaly.allow.* / The endpoints requires a "session" token "admin.audit.anomaly.allow.getItem", "admin.audit.anomaly.allow.updateItem", - "assistant.search.context", # TODO: add this method in follow up PR "conversations.requestSharedInvite.list", # TODO: add this method in follow up PR ]: continue @@ -548,6 +547,15 @@ async def run_method(self, method_name, method, async_method): elif method_name == "apps_user_connection_update": self.api_methods_to_call.remove(method(user_id="U12345678", status="connected")["method"]) await async_method(user_id="U12345678", status="connected") + elif method_name == "assistant_search_context": + self.api_methods_to_call.remove(method(query="What is project gizmo?")["method"]) + method( + query="What is the latest on project Gizmo?", + channel_types=["public_channel", "private_channel", "mpim", "im"], + content_types=["messages", "files", "channels"], + term_clauses=["project gizmo"], + ) + await async_method(query="What is project gizmo?") elif method_name == "assistant_threads_setStatus": self.api_methods_to_call.remove( method(channel_id="D111", thread_ts="111.222", status="is typing...")["method"]