slack_bolt.context.assistant.async_assistant_utilities API documentation - Bolt Python

Classes

class AsyncAssistantUtilities (*,payload: dict,context: AsyncBoltContext,thread_context_store: AsyncAssistantThreadContextStore | None = None)#Expand source code

class AsyncAssistantUtilities:
    payload: dict
    client: AsyncWebClient
    channel_id: str
    thread_ts: str
    thread_context_store: AsyncAssistantThreadContextStore

    def __init__ (
        self,
        *,
        payload: dict,
        context: AsyncBoltContext,
        thread_context_store: Optional[AsyncAssistantThreadContextStore] = None,
    ):
        self.payload = payload
        self.client = context.client
        self.thread_context_store = thread_context_store or DefaultAsyncAssistantThreadContextStore(context)

        if has_channel_id_and_thread_ts(self.payload):
            # assistant_thread_started
            thread = self.payload["assistant_thread"]
            self.channel_id = thread["channel_id"]
            self.thread_ts = thread["thread_ts"]
        elif self.payload.get("channel") is not None and self.payload.get("thread_ts") is not None:
            # message event
            self.channel_id = self.payload["channel"]
            self.thread_ts = self.payload["thread_ts"]
        else:
            # When moving this code to Bolt internals, no need to raise an exception for this pattern
            raise ValueError(f"Cannot instantiate Assistant for this event pattern ({self.payload})")

    def is_valid(self) -> bool:
        return self.channel_id is not None and self.thread_ts is not None

    @property
    def set_status(self) -> AsyncSetStatus:
        warnings.warn(
            "AsyncAssistantUtilities.set_status is deprecated. "
            "Use the set_status argument directly in your listener function "
            "or access it via context.set_status instead.",
            DeprecationWarning,
            stacklevel=2,
        )
        return AsyncSetStatus(self.client, self.channel_id, self.thread_ts)

    @property
    def set_title(self) -> AsyncSetTitle:
        return AsyncSetTitle(self.client, self.channel_id, self.thread_ts)

    @property
    def set_suggested_prompts(self) -> AsyncSetSuggestedPrompts:
        return AsyncSetSuggestedPrompts(self.client, self.channel_id, self.thread_ts)

    @property
    def say(self) -> AsyncSay:
        return AsyncSay(
            self.client,
            channel=self.channel_id,
            thread_ts=self.thread_ts,
            build_metadata=self._build_message_metadata,
        )

    async def _build_message_metadata(self) -> dict:
        return {
            "event_type": "assistant_thread_context",
            "event_payload": await self.get_thread_context(),
        }

    @property
    def get_thread_context(self) -> AsyncGetThreadContext:
        return AsyncGetThreadContext(self.thread_context_store, self.channel_id, self.thread_ts, self.payload)

    @property
    def save_thread_context(self) -> AsyncSaveThreadContext:
        return AsyncSaveThreadContext(self.thread_context_store, self.channel_id, self.thread_ts)

Class variables

var channel_id : str

The type of the None singleton.

var client : slack_sdk.web.async_client.AsyncWebClient

The type of the None singleton.

var payload : dict

The type of the None singleton.

var thread_context_store : AsyncAssistantThreadContextStore

The type of the None singleton.

var thread_ts : str

The type of the None singleton.

Instance variables

prop get_thread_context : AsyncGetThreadContext#Expand source code

@property
def get_thread_context(self) -> AsyncGetThreadContext:
    return AsyncGetThreadContext(self.thread_context_store, self.channel_id, self.thread_ts, self.payload)

prop save_thread_context : AsyncSaveThreadContext#Expand source code

@property
def save_thread_context(self) -> AsyncSaveThreadContext:
    return AsyncSaveThreadContext(self.thread_context_store, self.channel_id, self.thread_ts)

prop say : AsyncSay#Expand source code

@property
def say(self) -> AsyncSay:
    return AsyncSay(
        self.client,
        channel=self.channel_id,
        thread_ts=self.thread_ts,
        build_metadata=self._build_message_metadata,
    )

prop set_status : AsyncSetStatus#Expand source code

@property
def set_status(self) -> AsyncSetStatus:
    warnings.warn(
        "AsyncAssistantUtilities.set_status is deprecated. "
        "Use the set_status argument directly in your listener function "
        "or access it via context.set_status instead.",
        DeprecationWarning,
        stacklevel=2,
    )
    return AsyncSetStatus(self.client, self.channel_id, self.thread_ts)

prop set_suggested_prompts : AsyncSetSuggestedPrompts#Expand source code

@property
def set_suggested_prompts(self) -> AsyncSetSuggestedPrompts:
    return AsyncSetSuggestedPrompts(self.client, self.channel_id, self.thread_ts)

prop set_title : AsyncSetTitle#Expand source code

@property
def set_title(self) -> AsyncSetTitle:
    return AsyncSetTitle(self.client, self.channel_id, self.thread_ts)

Methods

def is_valid(self) ‑> bool#Expand source code

def is_valid(self) -> bool:
    return self.channel_id is not None and self.thread_ts is not None