From fb1c49ae45881a1d7e05dfae0c228f12086be6fb Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Thu, 29 Jan 2026 14:56:28 -0800 Subject: [PATCH 1/3] adds docs --- docs/reference/index.html | 6 +-- .../models/blocks/basic_components.html | 12 +++--- .../models/blocks/block_elements.html | 12 +++--- docs/reference/models/blocks/blocks.html | 20 ++++----- docs/reference/models/blocks/index.html | 42 +++++++++---------- docs/reference/models/messages/chunk.html | 10 ++--- docs/reference/models/views/index.html | 4 +- docs/reference/web/async_chat_stream.html | 16 +++---- docs/reference/web/async_client.html | 6 +-- docs/reference/web/chat_stream.html | 16 +++---- docs/reference/web/client.html | 6 +-- docs/reference/web/index.html | 6 +-- slack_sdk/models/blocks/block_elements.py | 2 +- slack_sdk/models/blocks/blocks.py | 8 ++-- slack_sdk/models/messages/chunk.py | 4 +- slack_sdk/web/async_chat_stream.py | 6 +-- slack_sdk/web/async_client.py | 2 +- slack_sdk/web/chat_stream.py | 6 +-- slack_sdk/web/client.py | 2 +- 19 files changed, 93 insertions(+), 93 deletions(-) diff --git a/docs/reference/index.html b/docs/reference/index.html index c2f518bcf..31b766b61 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -3098,7 +3098,7 @@

Classes

streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: @@ -10738,7 +10738,7 @@

Methods

streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: @@ -10799,7 +10799,7 @@

Args

The encoded ID of the user to receive the streaming text. Required when streaming to channels.
task_display_mode
Specifies how tasks are displayed in the message. A "timeline" displays individual tasks -interleaved with text and "plan" displays all tasks together.
+with text and "plan" displays all tasks together.
**kwargs
Additional arguments passed to the underlying API calls.
diff --git a/docs/reference/models/blocks/basic_components.html b/docs/reference/models/blocks/basic_components.html index 2821b6a4b..50554265d 100644 --- a/docs/reference/models/blocks/basic_components.html +++ b/docs/reference/models/blocks/basic_components.html @@ -188,7 +188,7 @@

Class variables

Static methods

-def parse(confirm: ForwardRef('ConfirmObject') | Dict[str, Any]) +def parse(confirm: ConfirmObject | Dict[str, Any])
@@ -324,7 +324,7 @@

Class variables

Static methods

-def parse(config: ForwardRef('DispatchActionConfig') | Dict[str, Any]) +def parse(config: DispatchActionConfig | Dict[str, Any])
@@ -446,7 +446,7 @@

Class variables

Static methods

-def parse(feedback_button: ForwardRef('FeedbackButtonObject') | Dict[str, Any]) +def parse(feedback_button: FeedbackButtonObject | Dict[str, Any])
@@ -907,7 +907,7 @@

Static methods

Creates a simple Option instance with the same value and label

-def parse_all(options: Sequence[Dict[str, Any] | ForwardRef('Option')] | None) ‑> List[Option] | None +def parse_all(options: Sequence[Dict[str, Any] | Option] | None) ‑> List[Option] | None
@@ -1105,7 +1105,7 @@

Class variables

Static methods

-def parse_all(option_groups: Sequence[Dict[str, Any] | ForwardRef('OptionGroup')] | None) ‑> List[OptionGroup] | None +def parse_all(option_groups: Sequence[Dict[str, Any] | OptionGroup] | None) ‑> List[OptionGroup] | None
@@ -1536,7 +1536,7 @@

Class variables

Static methods

-def parse(text: str | Dict[str, Any] | ForwardRef('TextObject'),
default_type: str = 'mrkdwn') ‑> TextObject | None +def parse(text: str | Dict[str, Any] | TextObject,
default_type: str = 'mrkdwn') ‑> TextObject | None
diff --git a/docs/reference/models/blocks/block_elements.html b/docs/reference/models/blocks/block_elements.html index c7f1347fe..81f5e42d6 100644 --- a/docs/reference/models/blocks/block_elements.html +++ b/docs/reference/models/blocks/block_elements.html @@ -146,13 +146,13 @@

Class variables

Static methods

-def parse(block_element: dict | ForwardRef('BlockElement')) ‑> BlockElement | TextObject | None +def parse(block_element: dict | BlockElement) ‑> BlockElement | TextObject | None
-def parse_all(block_elements: Sequence[dict | ForwardRef('BlockElement') | TextObject]) ‑> List[BlockElement | TextObject] +def parse_all(block_elements: Sequence[dict | BlockElement | TextObject]) ‑> List[BlockElement | TextObject]
@@ -829,7 +829,7 @@

Class variables

Static methods

-def parse(filter: dict | ForwardRef('ConversationFilter')) +def parse(filter: dict | ConversationFilter)
@@ -3505,7 +3505,7 @@

Class variables

class RichTextInputElement -(*,
action_id: str | None = None,
placeholder: str | dict | TextObject | None = None,
initial_value: Dict[str, Any] | ForwardRef('RichTextBlock') | None = None,
dispatch_action_config: dict | DispatchActionConfig | None = None,
focus_on_load: bool | None = None,
**others: dict) +(*,
action_id: str | None = None,
placeholder: str | dict | TextObject | None = None,
initial_value: Dict[str, Any] | RichTextBlock | None = None,
dispatch_action_config: dict | DispatchActionConfig | None = None,
focus_on_load: bool | None = None,
**others: dict)
@@ -4695,7 +4695,7 @@

Inherited members

**others: Dict, ): """ - A URL source element to reference in a task card block. + A URL source element that displays a URL source for referencing within a task card block. https://docs.slack.dev/reference/block-kit/block-elements/url-source-element Args: @@ -4711,7 +4711,7 @@

Inherited members

Block Elements are things that exists inside of your Blocks. https://docs.slack.dev/reference/block-kit/block-elements/

-

A URL source element to reference in a task card block. +

A URL source element that displays a URL source for referencing within a task card block. https://docs.slack.dev/reference/block-kit/block-elements/url-source-element

Args

diff --git a/docs/reference/models/blocks/blocks.html b/docs/reference/models/blocks/blocks.html index 934dd977e..9262265bd 100644 --- a/docs/reference/models/blocks/blocks.html +++ b/docs/reference/models/blocks/blocks.html @@ -298,13 +298,13 @@

Class variables

Static methods

-def parse(block: dict | ForwardRef('Block')) ‑> Block | None +def parse(block: dict | Block) ‑> Block | None
-def parse_all(blocks: Sequence[dict | ForwardRef('Block')] | None) ‑> List[Block] +def parse_all(blocks: Sequence[dict | Block] | None) ‑> List[Block]
@@ -1358,7 +1358,7 @@

Inherited members

block_id: Optional[str] = None, **others: dict, ): - """A collection of related tasks. + """Displays a collection of related tasks. https://docs.slack.dev/reference/block-kit/blocks/plan-block/ Args: @@ -1381,7 +1381,7 @@

Inherited members

Blocks are a series of components that can be combined to create visually rich and compellingly interactive messages. https://docs.slack.dev/reference/block-kit/blocks

-

A collection of related tasks. +

Displays a collection of related tasks. https://docs.slack.dev/reference/block-kit/blocks/plan-block/

Args

@@ -1861,7 +1861,7 @@

Inherited members

block_id: Optional[str] = None, **others: dict, ): - """A discrete action or tool call. + """Displays a single task, representing a single action. https://docs.slack.dev/reference/block-kit/blocks/task-card-block/ Args: @@ -1873,8 +1873,8 @@

Inherited members

title (required): Title of the task in plain text details: Details of the task in the form of a single "rich_text" entity. output: Output of the task in the form of a single "rich_text" entity. - sources: List of sources used to generate a response - status: The state of a task. Either "pending" or "in_progress" or "complete" or "error". + sources: Array of URL source elements used to generate a response. + status: The state of a task. Either "pending", "in_progress", "complete", or "error". """ super().__init__(type=self.type, block_id=block_id) show_unknown_key_warning(self, others) @@ -1893,7 +1893,7 @@

Inherited members

Blocks are a series of components that can be combined to create visually rich and compellingly interactive messages. https://docs.slack.dev/reference/block-kit/blocks

-

A discrete action or tool call. +

Displays a single task, representing a single action. https://docs.slack.dev/reference/block-kit/blocks/task-card-block/

Args

@@ -1911,9 +1911,9 @@

Args

output
Output of the task in the form of a single "rich_text" entity.
sources
-
List of sources used to generate a response
+
Array of URL source elements used to generate a response.
status
-
The state of a task. Either "pending" or "in_progress" or "complete" or "error".
+
The state of a task. Either "pending", "in_progress", "complete", or "error".

Ancestors

    diff --git a/docs/reference/models/blocks/index.html b/docs/reference/models/blocks/index.html index 00d480aee..40c1e1719 100644 --- a/docs/reference/models/blocks/index.html +++ b/docs/reference/models/blocks/index.html @@ -320,13 +320,13 @@

    Class variables

    Static methods

    -def parse(block: dict | ForwardRef('Block')) ‑> Block | None +def parse(block: dict | Block) ‑> Block | None
    -def parse_all(blocks: Sequence[dict | ForwardRef('Block')] | None) ‑> List[Block] +def parse_all(blocks: Sequence[dict | Block] | None) ‑> List[Block]
    @@ -458,13 +458,13 @@

    Class variables

    Static methods

    -def parse(block_element: dict | ForwardRef('BlockElement')) ‑> BlockElement | TextObject | None +def parse(block_element: dict | BlockElement) ‑> BlockElement | TextObject | None
    -def parse_all(block_elements: Sequence[dict | ForwardRef('BlockElement') | TextObject]) ‑> List[BlockElement | TextObject] +def parse_all(block_elements: Sequence[dict | BlockElement | TextObject]) ‑> List[BlockElement | TextObject]
    @@ -1278,7 +1278,7 @@

    Class variables

    Static methods

    -def parse(confirm: ForwardRef('ConfirmObject') | Dict[str, Any]) +def parse(confirm: ConfirmObject | Dict[str, Any])
    @@ -1650,7 +1650,7 @@

    Class variables

    Static methods

    -def parse(filter: dict | ForwardRef('ConversationFilter')) +def parse(filter: dict | ConversationFilter)
    @@ -2842,7 +2842,7 @@

    Class variables

    Static methods

    -def parse(feedback_button: ForwardRef('FeedbackButtonObject') | Dict[str, Any]) +def parse(feedback_button: FeedbackButtonObject | Dict[str, Any])
    @@ -4727,7 +4727,7 @@

    Static methods

    Creates a simple Option instance with the same value and label

    -def parse_all(options: Sequence[Dict[str, Any] | ForwardRef('Option')] | None) ‑> List[Option] | None +def parse_all(options: Sequence[Dict[str, Any] | Option] | None) ‑> List[Option] | None
    @@ -4925,7 +4925,7 @@

    Class variables

    Static methods

    -def parse_all(option_groups: Sequence[Dict[str, Any] | ForwardRef('OptionGroup')] | None) ‑> List[OptionGroup] | None +def parse_all(option_groups: Sequence[Dict[str, Any] | OptionGroup] | None) ‑> List[OptionGroup] | None
    @@ -5383,7 +5383,7 @@

    Inherited members

    block_id: Optional[str] = None, **others: dict, ): - """A collection of related tasks. + """Displays a collection of related tasks. https://docs.slack.dev/reference/block-kit/blocks/plan-block/ Args: @@ -5406,7 +5406,7 @@

    Inherited members

    Blocks are a series of components that can be combined to create visually rich and compellingly interactive messages. https://docs.slack.dev/reference/block-kit/blocks

    -

    A collection of related tasks. +

    Displays a collection of related tasks. https://docs.slack.dev/reference/block-kit/blocks/plan-block/

    Args

    @@ -6152,7 +6152,7 @@

    Class variables

    class RichTextInputElement -(*,
    action_id: str | None = None,
    placeholder: str | dict | TextObject | None = None,
    initial_value: Dict[str, Any] | ForwardRef('RichTextBlock') | None = None,
    dispatch_action_config: dict | DispatchActionConfig | None = None,
    focus_on_load: bool | None = None,
    **others: dict)     +(*,
    action_id: str | None = None,
    placeholder: str | dict | TextObject | None = None,
    initial_value: Dict[str, Any] | RichTextBlock | None = None,
    dispatch_action_config: dict | DispatchActionConfig | None = None,
    focus_on_load: bool | None = None,
    **others: dict)
    @@ -7358,7 +7358,7 @@

    Inherited members

    block_id: Optional[str] = None, **others: dict, ): - """A discrete action or tool call. + """Displays a single task, representing a single action. https://docs.slack.dev/reference/block-kit/blocks/task-card-block/ Args: @@ -7370,8 +7370,8 @@

    Inherited members

    title (required): Title of the task in plain text details: Details of the task in the form of a single "rich_text" entity. output: Output of the task in the form of a single "rich_text" entity. - sources: List of sources used to generate a response - status: The state of a task. Either "pending" or "in_progress" or "complete" or "error". + sources: Array of URL source elements used to generate a response. + status: The state of a task. Either "pending", "in_progress", "complete", or "error". """ super().__init__(type=self.type, block_id=block_id) show_unknown_key_warning(self, others) @@ -7390,7 +7390,7 @@

    Inherited members

    Blocks are a series of components that can be combined to create visually rich and compellingly interactive messages. https://docs.slack.dev/reference/block-kit/blocks

    -

    A discrete action or tool call. +

    Displays a single task, representing a single action. https://docs.slack.dev/reference/block-kit/blocks/task-card-block/

    Args

    @@ -7408,9 +7408,9 @@

    Args

    output
    Output of the task in the form of a single "rich_text" entity.
    sources
    -
    List of sources used to generate a response
    +
    Array of URL source elements used to generate a response.
    status
    -
    The state of a task. Either "pending" or "in_progress" or "complete" or "error".
    +
    The state of a task. Either "pending", "in_progress", "complete", or "error".

    Ancestors

      @@ -7556,7 +7556,7 @@

      Class variables

      Static methods

      -def parse(text: str | Dict[str, Any] | ForwardRef('TextObject'),
      default_type: str = 'mrkdwn') ‑> TextObject | None       +def parse(text: str | Dict[str, Any] | TextObject,
      default_type: str = 'mrkdwn') ‑> TextObject | None
      @@ -7892,7 +7892,7 @@

      Inherited members

      **others: Dict, ): """ - A URL source element to reference in a task card block. + A URL source element that displays a URL source for referencing within a task card block. https://docs.slack.dev/reference/block-kit/block-elements/url-source-element Args: @@ -7908,7 +7908,7 @@

      Inherited members

    Block Elements are things that exists inside of your Blocks. https://docs.slack.dev/reference/block-kit/block-elements/

    -

    A URL source element to reference in a task card block. +

    A URL source element that displays a URL source for referencing within a task card block. https://docs.slack.dev/reference/block-kit/block-elements/url-source-element

    Args

    diff --git a/docs/reference/models/messages/chunk.html b/docs/reference/models/messages/chunk.html index 722f018c9..49c1ef1bc 100644 --- a/docs/reference/models/messages/chunk.html +++ b/docs/reference/models/messages/chunk.html @@ -121,7 +121,7 @@

    Class variables

    Static methods

    -def parse(chunk: Dict | ForwardRef('Chunk')) ‑> Chunk | None +def parse(chunk: Dict | Chunk) ‑> Chunk | None
    @@ -235,7 +235,7 @@

    Inherited members

    title: str, **others: Dict, ): - """An updated title of plans for task and tool calls. + """Used for displaying an updated title of a plan. https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming """ @@ -246,7 +246,7 @@

    Inherited members

    Chunk for streaming messages.

    https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

    -

    An updated title of plans for task and tool calls.

    +

    Used for displaying an updated title of a plan.

    https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

    Ancestors

      @@ -324,7 +324,7 @@

      Inherited members

      sources: Optional[Sequence[Union[Dict, UrlSourceElement]]] = None, **others: Dict, ): - """Used for displaying tool execution progress in a timeline-style UI. + """Used for displaying task progress in a timeline-style UI. https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming """ @@ -340,7 +340,7 @@

      Inherited members

      Chunk for streaming messages.

      https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

      -

      Used for displaying tool execution progress in a timeline-style UI.

      +

      Used for displaying task progress in a timeline-style UI.

      https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

      Ancestors

        diff --git a/docs/reference/models/views/index.html b/docs/reference/models/views/index.html index d9e60359b..b7bad66bc 100644 --- a/docs/reference/models/views/index.html +++ b/docs/reference/models/views/index.html @@ -48,7 +48,7 @@

        Classes

        class View -(type: str,
        id: str | None = None,
        callback_id: str | None = None,
        external_id: str | None = None,
        team_id: str | None = None,
        bot_id: str | None = None,
        app_id: str | None = None,
        root_view_id: str | None = None,
        previous_view_id: str | None = None,
        title: str | dict | PlainTextObject | None = None,
        submit: str | dict | PlainTextObject | None = None,
        close: str | dict | PlainTextObject | None = None,
        blocks: Sequence[dict | Block] | None = None,
        private_metadata: str | None = None,
        state: dict | ForwardRef('ViewState') | None = None,
        hash: str | None = None,
        clear_on_close: bool | None = None,
        notify_on_close: bool | None = None,
        **kwargs)         +(type: str,
        id: str | None = None,
        callback_id: str | None = None,
        external_id: str | None = None,
        team_id: str | None = None,
        bot_id: str | None = None,
        app_id: str | None = None,
        root_view_id: str | None = None,
        previous_view_id: str | None = None,
        title: str | dict | PlainTextObject | None = None,
        submit: str | dict | PlainTextObject | None = None,
        close: str | dict | PlainTextObject | None = None,
        blocks: Sequence[dict | Block] | None = None,
        private_metadata: str | None = None,
        state: dict | ViewState | None = None,
        hash: str | None = None,
        clear_on_close: bool | None = None,
        notify_on_close: bool | None = None,
        **kwargs)
        @@ -229,7 +229,7 @@

        Inherited members

        class ViewState -(*,
        values: Dict[str, Dict[str, dict | ForwardRef('ViewStateValue')]])         +(*,
        values: Dict[str, Dict[str, dict | ViewStateValue]])
        diff --git a/docs/reference/web/async_chat_stream.html b/docs/reference/web/async_chat_stream.html index 994f7df4e..0e396ea5a 100644 --- a/docs/reference/web/async_chat_stream.html +++ b/docs/reference/web/async_chat_stream.html @@ -89,7 +89,7 @@

        Classes

        streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits. **kwargs: Additional arguments passed to the underlying API calls. @@ -123,7 +123,7 @@

        Classes

        is stopped this method cannot be called. Args: - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -179,7 +179,7 @@

        Classes

        Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you @@ -287,7 +287,7 @@

        Args

        The encoded ID of the user to receive the streaming text. Required when streaming to channels.
        task_display_mode
        Specifies how tasks are displayed in the message. A "timeline" displays individual tasks -interleaved with text and "plan" displays all tasks together.
        +with text and "plan" displays all tasks together.
        buffer_size
        The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
        @@ -317,7 +317,7 @@

        Methods

        is stopped this method cannot be called. Args: - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -366,7 +366,7 @@

        Methods

        Args

        chunks
        -
        An array of streaming chunks that can contain either markdown text or task updates.
        +
        An array of streaming chunks. Chunks can be markdown text chunks or task update chunks.
        markdown_text
        Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.
        @@ -413,7 +413,7 @@

        Example

        Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you @@ -477,7 +477,7 @@

        Args

        blocks
        A list of blocks that will be rendered at the bottom of the finalized message.
        chunks
        -
        An array of streaming chunks that can contain either markdown text or task updates.
        +
        An array of streaming chunks. Chunks can be markdown text chunks or task update chunks.
        markdown_text
        Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.
        diff --git a/docs/reference/web/async_client.html b/docs/reference/web/async_client.html index 6efcb62e5..070de0e95 100644 --- a/docs/reference/web/async_client.html +++ b/docs/reference/web/async_client.html @@ -2994,7 +2994,7 @@

        Classes

        streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: @@ -10634,7 +10634,7 @@

        Methods

        streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: @@ -10695,7 +10695,7 @@

        Args

        The encoded ID of the user to receive the streaming text. Required when streaming to channels.
        task_display_mode
        Specifies how tasks are displayed in the message. A "timeline" displays individual tasks -interleaved with text and "plan" displays all tasks together.
        +with text and "plan" displays all tasks together.
    **kwargs
    Additional arguments passed to the underlying API calls.
    diff --git a/docs/reference/web/chat_stream.html b/docs/reference/web/chat_stream.html index 4ac9750a5..3b5302d8d 100644 --- a/docs/reference/web/chat_stream.html +++ b/docs/reference/web/chat_stream.html @@ -89,7 +89,7 @@

    Classes

    streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits. **kwargs: Additional arguments passed to the underlying API calls. @@ -123,7 +123,7 @@

    Classes

    is stopped this method cannot be called. Args: - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -179,7 +179,7 @@

    Classes

    Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you @@ -287,7 +287,7 @@

    Args

    The encoded ID of the user to receive the streaming text. Required when streaming to channels.
    task_display_mode
    Specifies how tasks are displayed in the message. A "timeline" displays individual tasks -interleaved with text and "plan" displays all tasks together.
    +with text and "plan" displays all tasks together.
    buffer_size
    The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
    @@ -317,7 +317,7 @@

    Methods

    is stopped this method cannot be called. Args: - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -366,7 +366,7 @@

    Methods

    Args

    chunks
    -
    An array of streaming chunks that can contain either markdown text or task updates.
    +
    An array of streaming chunks. Chunks can be markdown text chunks or task update chunks.
    markdown_text
    Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.
    @@ -413,7 +413,7 @@

    Example

    Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you @@ -477,7 +477,7 @@

    Args

    blocks
    A list of blocks that will be rendered at the bottom of the finalized message.
    chunks
    -
    An array of streaming chunks that can contain either markdown text or task updates.
    +
    An array of streaming chunks. Chunks can be markdown text chunks or task update chunks.
    markdown_text
    Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.
    diff --git a/docs/reference/web/client.html b/docs/reference/web/client.html index 7431a0038..fecd86b7c 100644 --- a/docs/reference/web/client.html +++ b/docs/reference/web/client.html @@ -2994,7 +2994,7 @@

    Classes

    streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: @@ -10634,7 +10634,7 @@

    Methods

    streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: @@ -10695,7 +10695,7 @@

    Args

    The encoded ID of the user to receive the streaming text. Required when streaming to channels.
    task_display_mode
    Specifies how tasks are displayed in the message. A "timeline" displays individual tasks -interleaved with text and "plan" displays all tasks together.
    +with text and "plan" displays all tasks together.
    **kwargs
    Additional arguments passed to the underlying API calls.
    diff --git a/docs/reference/web/index.html b/docs/reference/web/index.html index 5780f1f91..bec63590c 100644 --- a/docs/reference/web/index.html +++ b/docs/reference/web/index.html @@ -3363,7 +3363,7 @@

    Raises

    streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: @@ -11003,7 +11003,7 @@

    Methods

    streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: @@ -11064,7 +11064,7 @@

    Args

    The encoded ID of the user to receive the streaming text. Required when streaming to channels.
    task_display_mode
    Specifies how tasks are displayed in the message. A "timeline" displays individual tasks -interleaved with text and "plan" displays all tasks together.
    +with text and "plan" displays all tasks together.
    **kwargs
    Additional arguments passed to the underlying API calls.
    diff --git a/slack_sdk/models/blocks/block_elements.py b/slack_sdk/models/blocks/block_elements.py index be683162b..b5c9e8862 100644 --- a/slack_sdk/models/blocks/block_elements.py +++ b/slack_sdk/models/blocks/block_elements.py @@ -1681,7 +1681,7 @@ def __init__( **others: Dict, ): """ - A URL source element to reference in a task card block. + A URL source element that displays a URL source for referencing within a task card block. https://docs.slack.dev/reference/block-kit/block-elements/url-source-element Args: diff --git a/slack_sdk/models/blocks/blocks.py b/slack_sdk/models/blocks/blocks.py index 26c25d73f..51043bcb4 100644 --- a/slack_sdk/models/blocks/blocks.py +++ b/slack_sdk/models/blocks/blocks.py @@ -812,7 +812,7 @@ def __init__( block_id: Optional[str] = None, **others: dict, ): - """A discrete action or tool call. + """Displays a single task, representing a single action. https://docs.slack.dev/reference/block-kit/blocks/task-card-block/ Args: @@ -824,8 +824,8 @@ def __init__( title (required): Title of the task in plain text details: Details of the task in the form of a single "rich_text" entity. output: Output of the task in the form of a single "rich_text" entity. - sources: List of sources used to generate a response - status: The state of a task. Either "pending" or "in_progress" or "complete" or "error". + sources: Array of URL source elements used to generate a response. + status: The state of a task. Either "pending", "in_progress", "complete", or "error". """ super().__init__(type=self.type, block_id=block_id) show_unknown_key_warning(self, others) @@ -864,7 +864,7 @@ def __init__( block_id: Optional[str] = None, **others: dict, ): - """A collection of related tasks. + """Displays a collection of related tasks. https://docs.slack.dev/reference/block-kit/blocks/plan-block/ Args: diff --git a/slack_sdk/models/messages/chunk.py b/slack_sdk/models/messages/chunk.py index 4db35621b..657d95ae4 100644 --- a/slack_sdk/models/messages/chunk.py +++ b/slack_sdk/models/messages/chunk.py @@ -82,7 +82,7 @@ def __init__( title: str, **others: Dict, ): - """An updated title of plans for task and tool calls. + """Used for displaying an updated title of a plan. https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming """ @@ -119,7 +119,7 @@ def __init__( sources: Optional[Sequence[Union[Dict, UrlSourceElement]]] = None, **others: Dict, ): - """Used for displaying tool execution progress in a timeline-style UI. + """Used for displaying task progress in a timeline-style UI. https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming """ diff --git a/slack_sdk/web/async_chat_stream.py b/slack_sdk/web/async_chat_stream.py index 7af774bbc..fbe9cda0b 100644 --- a/slack_sdk/web/async_chat_stream.py +++ b/slack_sdk/web/async_chat_stream.py @@ -56,7 +56,7 @@ def __init__( streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits. **kwargs: Additional arguments passed to the underlying API calls. @@ -90,7 +90,7 @@ async def append( is stopped this method cannot be called. Args: - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -146,7 +146,7 @@ async def stop( Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you diff --git a/slack_sdk/web/async_client.py b/slack_sdk/web/async_client.py index 7464b754d..e96a4f6d5 100644 --- a/slack_sdk/web/async_client.py +++ b/slack_sdk/web/async_client.py @@ -2974,7 +2974,7 @@ async def chat_stream( streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: diff --git a/slack_sdk/web/chat_stream.py b/slack_sdk/web/chat_stream.py index 580f7cacb..88af1e706 100644 --- a/slack_sdk/web/chat_stream.py +++ b/slack_sdk/web/chat_stream.py @@ -46,7 +46,7 @@ def __init__( streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits. **kwargs: Additional arguments passed to the underlying API calls. @@ -80,7 +80,7 @@ def append( is stopped this method cannot be called. Args: - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -136,7 +136,7 @@ def stop( Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks that can contain either markdown text or task updates. + chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you diff --git a/slack_sdk/web/client.py b/slack_sdk/web/client.py index 638b4ab67..200b216ff 100644 --- a/slack_sdk/web/client.py +++ b/slack_sdk/web/client.py @@ -2964,7 +2964,7 @@ def chat_stream( streaming to channels. recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels. task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks - interleaved with text and "plan" displays all tasks together. + with text and "plan" displays all tasks together. **kwargs: Additional arguments passed to the underlying API calls. Returns: From cbbeb96820dcdeef15a9eb29f577f80005f1267a Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Fri, 30 Jan 2026 09:23:12 -0800 Subject: [PATCH 2/3] plan chunk inclusion --- .../models/blocks/block_elements.html | 11 ++-------- docs/reference/models/blocks/blocks.html | 11 +--------- docs/reference/models/blocks/index.html | 22 +++---------------- docs/reference/web/async_chat_stream.html | 22 +++++++++---------- docs/reference/web/chat_stream.html | 22 +++++++++---------- slack_sdk/web/async_chat_stream.py | 4 ++-- slack_sdk/web/chat_stream.py | 4 ++-- 7 files changed, 32 insertions(+), 64 deletions(-) diff --git a/docs/reference/models/blocks/block_elements.html b/docs/reference/models/blocks/block_elements.html index 81f5e42d6..e79ac10d1 100644 --- a/docs/reference/models/blocks/block_elements.html +++ b/docs/reference/models/blocks/block_elements.html @@ -4666,7 +4666,7 @@

    Inherited members

    class UrlSourceElement -(*, url: str, text: str, icon_url: str | None = None, **others: Dict) +(*, url: str, text: str, **others: Dict)
    @@ -4682,7 +4682,6 @@

    Inherited members

    { "url", "text", - "icon_url", } ) @@ -4691,7 +4690,6 @@

    Inherited members

    *, url: str, text: str, - icon_url: Optional[str] = None, **others: Dict, ): """ @@ -4701,13 +4699,11 @@

    Inherited members

    Args: url (required): The URL type source. text (required): Display text for the URL. - icon_url: Optional icon URL to display with the source. """ super().__init__(type=self.type) show_unknown_key_warning(self, others) self.url = url - self.text = text - self.icon_url = icon_url + self.text = text

    Block Elements are things that exists inside of your Blocks. https://docs.slack.dev/reference/block-kit/block-elements/

    @@ -4719,8 +4715,6 @@

    Args

    The URL type source.
    text : required
    Display text for the URL.
    -
    icon_url
    -
    Optional icon URL to display with the source.

Ancestors

    @@ -4749,7 +4743,6 @@

    Instance variables

    { "url", "text", - "icon_url", } ) diff --git a/docs/reference/models/blocks/blocks.html b/docs/reference/models/blocks/blocks.html index 9262265bd..a4f511858 100644 --- a/docs/reference/models/blocks/blocks.html +++ b/docs/reference/models/blocks/blocks.html @@ -1329,7 +1329,7 @@

    Inherited members

class PlanBlock -(*,
plan_id: str,
title: str,
tasks: Sequence[Dict | TaskCardBlock] | None = None,
block_id: str | None = None,
**others: dict) +(*,
title: str,
tasks: Sequence[Dict | TaskCardBlock] | None = None,
block_id: str | None = None,
**others: dict)
@@ -1343,7 +1343,6 @@

Inherited members

def attributes(self) -> Set[str]: # type: ignore[override] return super().attributes.union( { - "plan_id", "title", "tasks", } @@ -1352,7 +1351,6 @@

Inherited members

def __init__( self, *, - plan_id: str, title: str, tasks: Optional[Sequence[Union[Dict, TaskCardBlock]]] = None, block_id: Optional[str] = None, @@ -1366,15 +1364,12 @@

Inherited members

Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id. - plan_id (required): ID for the plan (May be removed / made optional, feel free to pass in a random UUID - for now) title (required): Title of the plan in plain text tasks: Details of the task in the form of a single "rich_text" entity. """ super().__init__(type=self.type, block_id=block_id) show_unknown_key_warning(self, others) - self.plan_id = plan_id self.title = title self.tasks = tasks
@@ -1390,9 +1385,6 @@

Args

Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.
-
plan_id : required
-
ID for the plan (May be removed / made optional, feel free to pass in a random UUID -for now)
title : required
Title of the plan in plain text
tasks
@@ -1423,7 +1415,6 @@

Instance variables

def attributes(self) -> Set[str]: # type: ignore[override] return super().attributes.union( { - "plan_id", "title", "tasks", } diff --git a/docs/reference/models/blocks/index.html b/docs/reference/models/blocks/index.html index 40c1e1719..4444d208b 100644 --- a/docs/reference/models/blocks/index.html +++ b/docs/reference/models/blocks/index.html @@ -5354,7 +5354,7 @@

Inherited members

class PlanBlock -(*,
plan_id: str,
title: str,
tasks: Sequence[Dict | TaskCardBlock] | None = None,
block_id: str | None = None,
**others: dict) +(*,
title: str,
tasks: Sequence[Dict | TaskCardBlock] | None = None,
block_id: str | None = None,
**others: dict)
@@ -5368,7 +5368,6 @@

Inherited members

def attributes(self) -> Set[str]: # type: ignore[override] return super().attributes.union( { - "plan_id", "title", "tasks", } @@ -5377,7 +5376,6 @@

Inherited members

def __init__( self, *, - plan_id: str, title: str, tasks: Optional[Sequence[Union[Dict, TaskCardBlock]]] = None, block_id: Optional[str] = None, @@ -5391,15 +5389,12 @@

Inherited members

Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id. - plan_id (required): ID for the plan (May be removed / made optional, feel free to pass in a random UUID - for now) title (required): Title of the plan in plain text tasks: Details of the task in the form of a single "rich_text" entity. """ super().__init__(type=self.type, block_id=block_id) show_unknown_key_warning(self, others) - self.plan_id = plan_id self.title = title self.tasks = tasks
@@ -5415,9 +5410,6 @@

Args

Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.
-
plan_id : required
-
ID for the plan (May be removed / made optional, feel free to pass in a random UUID -for now)
title : required
Title of the plan in plain text
tasks
@@ -5448,7 +5440,6 @@

Instance variables

def attributes(self) -> Set[str]: # type: ignore[override] return super().attributes.union( { - "plan_id", "title", "tasks", } @@ -7863,7 +7854,7 @@

Inherited members

class UrlSourceElement -(*, url: str, text: str, icon_url: str | None = None, **others: Dict) +(*, url: str, text: str, **others: Dict)
@@ -7879,7 +7870,6 @@

Inherited members

{ "url", "text", - "icon_url", } ) @@ -7888,7 +7878,6 @@

Inherited members

*, url: str, text: str, - icon_url: Optional[str] = None, **others: Dict, ): """ @@ -7898,13 +7887,11 @@

Inherited members

Args: url (required): The URL type source. text (required): Display text for the URL. - icon_url: Optional icon URL to display with the source. """ super().__init__(type=self.type) show_unknown_key_warning(self, others) self.url = url - self.text = text - self.icon_url = icon_url + self.text = text

Block Elements are things that exists inside of your Blocks. https://docs.slack.dev/reference/block-kit/block-elements/

@@ -7916,8 +7903,6 @@

Args

The URL type source.
text : required
Display text for the URL.
-
icon_url
-
Optional icon URL to display with the source.

Ancestors

    @@ -7946,7 +7931,6 @@

    Instance variables

    { "url", "text", - "icon_url", } ) diff --git a/docs/reference/web/async_chat_stream.html b/docs/reference/web/async_chat_stream.html index 0e396ea5a..d8e4f5bfe 100644 --- a/docs/reference/web/async_chat_stream.html +++ b/docs/reference/web/async_chat_stream.html @@ -123,7 +123,7 @@

    Classes

    is stopped this method cannot be called. Args: - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -179,7 +179,7 @@

    Classes

    Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you @@ -239,17 +239,17 @@

    Classes

    async def _flush_buffer(self, chunks: Optional[Sequence[Union[Dict, Chunk]]] = None, **kwargs) -> AsyncSlackResponse: """Flush the internal buffer with chunks by making appropriate API calls.""" - flushings: List[Union[Dict, Chunk]] = [] + chunks_to_flush: List[Union[Dict, Chunk]] = [] if len(self._buffer) != 0: - flushings.append(MarkdownTextChunk(text=self._buffer)) + chunks_to_flush.append(MarkdownTextChunk(text=self._buffer)) if chunks is not None: - flushings.extend(chunks) + chunks_to_flush.extend(chunks) if not self._stream_ts: response = await self._client.chat_startStream( **self._stream_args, token=self._token, **kwargs, - chunks=flushings, + chunks=chunks_to_flush, ) self._stream_ts = response.get("ts") self._state = "in_progress" @@ -259,7 +259,7 @@

    Classes

    channel=self._stream_args["channel"], ts=self._stream_ts, **kwargs, - chunks=flushings, + chunks=chunks_to_flush, ) self._buffer = "" return response @@ -317,7 +317,7 @@

    Methods

    is stopped this method cannot be called. Args: - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -366,7 +366,7 @@

    Methods

    Args

    chunks
    -
    An array of streaming chunks. Chunks can be markdown text chunks or task update chunks.
    +
    An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks.
    markdown_text
    Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.
    @@ -413,7 +413,7 @@

    Example

    Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you @@ -477,7 +477,7 @@

    Args

    blocks
    A list of blocks that will be rendered at the bottom of the finalized message.
    chunks
    -
    An array of streaming chunks. Chunks can be markdown text chunks or task update chunks.
    +
    An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks.
    markdown_text
    Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.
    diff --git a/docs/reference/web/chat_stream.html b/docs/reference/web/chat_stream.html index 3b5302d8d..59fcbbd84 100644 --- a/docs/reference/web/chat_stream.html +++ b/docs/reference/web/chat_stream.html @@ -123,7 +123,7 @@

    Classes

    is stopped this method cannot be called. Args: - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -179,7 +179,7 @@

    Classes

    Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you @@ -239,17 +239,17 @@

    Classes

    def _flush_buffer(self, chunks: Optional[Sequence[Union[Dict, Chunk]]] = None, **kwargs) -> SlackResponse: """Flush the internal buffer with chunks by making appropriate API calls.""" - flushings: List[Union[Dict, Chunk]] = [] + chunks_to_flush: List[Union[Dict, Chunk]] = [] if len(self._buffer) != 0: - flushings.append(MarkdownTextChunk(text=self._buffer)) + chunks_to_flush.append(MarkdownTextChunk(text=self._buffer)) if chunks is not None: - flushings.extend(chunks) + chunks_to_flush.extend(chunks) if not self._stream_ts: response = self._client.chat_startStream( **self._stream_args, token=self._token, **kwargs, - chunks=flushings, + chunks=chunks_to_flush, ) self._stream_ts = response.get("ts") self._state = "in_progress" @@ -259,7 +259,7 @@

    Classes

    channel=self._stream_args["channel"], ts=self._stream_ts, **kwargs, - chunks=flushings, + chunks=chunks_to_flush, ) self._buffer = "" return response @@ -317,7 +317,7 @@

    Methods

    is stopped this method cannot be called. Args: - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -366,7 +366,7 @@

    Methods

    Args

    chunks
    -
    An array of streaming chunks. Chunks can be markdown text chunks or task update chunks.
    +
    An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks.
    markdown_text
    Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.
    @@ -413,7 +413,7 @@

    Example

    Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you @@ -477,7 +477,7 @@

    Args

    blocks
    A list of blocks that will be rendered at the bottom of the finalized message.
    chunks
    -
    An array of streaming chunks. Chunks can be markdown text chunks or task update chunks.
    +
    An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks.
    markdown_text
    Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.
    diff --git a/slack_sdk/web/async_chat_stream.py b/slack_sdk/web/async_chat_stream.py index 6bfd2fb21..7348b90bc 100644 --- a/slack_sdk/web/async_chat_stream.py +++ b/slack_sdk/web/async_chat_stream.py @@ -90,7 +90,7 @@ async def append( is stopped this method cannot be called. Args: - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -146,7 +146,7 @@ async def stop( Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you diff --git a/slack_sdk/web/chat_stream.py b/slack_sdk/web/chat_stream.py index 08b838493..683859490 100644 --- a/slack_sdk/web/chat_stream.py +++ b/slack_sdk/web/chat_stream.py @@ -80,7 +80,7 @@ def append( is stopped this method cannot be called. Args: - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. **kwargs: Additional arguments passed to the underlying API calls. @@ -136,7 +136,7 @@ def stop( Args: blocks: A list of blocks that will be rendered at the bottom of the finalized message. - chunks: An array of streaming chunks. Chunks can be markdown text chunks or task update chunks. + chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks. markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far. metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you From 7b17257523c6bcee8ecceb1c621e1ee8979d7e27 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Fri, 30 Jan 2026 09:34:02 -0800 Subject: [PATCH 3/3] copy miss --- slack_sdk/models/blocks/blocks.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/slack_sdk/models/blocks/blocks.py b/slack_sdk/models/blocks/blocks.py index 7d5b44483..bcd7efd6e 100644 --- a/slack_sdk/models/blocks/blocks.py +++ b/slack_sdk/models/blocks/blocks.py @@ -871,7 +871,7 @@ def __init__( block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id. title (required): Title of the plan in plain text - tasks: Details of the task in the form of a single "rich_text" entity. + tasks: A sequence of task card blocks. Each task represents a single action within the plan. """ super().__init__(type=self.type, block_id=block_id) show_unknown_key_warning(self, others)