Skip to content

Commit 11ae5c9

Browse files
Remove mention of assistants and replace with AI apps (#2432)
Co-authored-by: Luke Russell <luke.russell@slack-corp.com>
1 parent b466937 commit 11ae5c9

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

docs/content/concepts/assistant.md docs/content/concepts/ai-apps.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Agents & Assistants
2+
title: AI Apps
33
lang: en
4-
slug: /concepts/assistant
4+
slug: /concepts/ai-apps
55
---
66

77
:::info[This feature requires a paid plan]
88
If you don't have a paid workspace for development, you can join the [Developer Program](https://api.slack.com/developer-program) and provision a sandbox with access to all Slack features for free.
99
:::
1010

11-
Agents and assistants comprise a new messaging experience for Slack. If you're unfamiliar with using agents and assistants within Slack, you'll want to read the [API documentation on the subject](https://api.slack.com/docs/apps/ai). Then come back here to implement them with Bolt!
11+
AI apps comprise a new messaging experience for Slack. If you're unfamiliar with using AI apps within Slack, you'll want to read the [API documentation on the subject](https://api.slack.com/docs/apps/ai). Then come back here to implement them with Bolt!
1212

13-
## Configuring your app to support assistants
13+
## Configuring your app to support AI features
1414

15-
1. Within [App Settings](https://api.slack.com/apps), enable the **Agents & Assistants** feature.
15+
1. Within [App Settings](https://api.slack.com/apps), enable the **Agents & AI Apps** feature.
1616

1717
2. Within the App Settings **OAuth & Permissions** page, add the following scopes:
1818
* [`assistant:write`](https://api.slack.com/scopes/assistant:write)
@@ -25,12 +25,12 @@ Agents and assistants comprise a new messaging experience for Slack. If you're u
2525
* [`message.im`](https://api.slack.com/events/message.im)
2626

2727
:::info
28-
You _could_ implement your own assistants by [listening](/concepts/event-listening) for the `assistant_thread_started`, `assistant_thread_context_changed`, and `message.im` events. That being said, using the `Assistant` class will streamline the process. And we already wrote this nice guide for you!
28+
You _could_ implement your own AI app by [listening](/concepts/event-listening) for the `assistant_thread_started`, `assistant_thread_context_changed`, and `message.im` events. That being said, using the `Assistant` class will streamline the process. And we already wrote this nice guide for you!
2929
:::
3030

3131
## The `Assistant` class instance
3232

33-
The [`Assistant`](/reference#the-assistantconfig-configuration-object) can be used to handle the incoming events expected from a user interacting with an assistant in Slack. A typical flow would look like:
33+
The [`Assistant`](/reference#the-assistantconfig-configuration-object) can be used to handle the incoming events expected from a user interacting with an AI app in Slack. A typical flow would look like:
3434

3535
1. [The user starts a thread](#handling-new-thread). The `Assistant` class handles the incoming [`assistant_thread_started`](https://api.slack.com/events/assistant_thread_started) event.
3636
2. [The thread context may change at any point](#handling-thread-context-changes). The `Assistant` class can handle any incoming [`assistant_thread_context_changed`](https://api.slack.com/events/assistant_thread_context_changed) events. The class also provides a default `context` store to keep track of thread context changes as the user moves through Slack.
@@ -52,17 +52,17 @@ const assistant = new Assistant({
5252
});
5353
```
5454

55-
While the `assistant_thread_started` and `assistant_thread_context_changed` events do provide Slack-client thread context information, the `message.im` event does not. Any subsequent user message events won't contain thread context data. For that reason, Bolt not only provides a way to store thread context — the `threadContextStore` property — but it also provides a `DefaultThreadContextStore` instance that is utilized by default. This implementation relies on storing and retrieving [message metadata](https://api.slack.com/metadata/using) as the user interacts with the assistant.
55+
While the `assistant_thread_started` and `assistant_thread_context_changed` events do provide Slack-client thread context information, the `message.im` event does not. Any subsequent user message events won't contain thread context data. For that reason, Bolt not only provides a way to store thread context — the `threadContextStore` property — but it also provides a `DefaultThreadContextStore` instance that is utilized by default. This implementation relies on storing and retrieving [message metadata](https://api.slack.com/metadata/using) as the user interacts with the app.
5656

5757
If you do provide your own `threadContextStore` property, it must feature `get` and `save` methods.
5858

5959
:::tip
60-
Be sure to give the [assistants reference docs](/reference#agents--assistants) a look!
60+
Be sure to give the [AI apps reference docs](/reference#agents--assistants) a look!
6161
:::
6262

6363
## Handling a new thread {#handling-new-thread}
6464

65-
When the user opens a new thread with your assistant, the [`assistant_thread_started`](https://api.slack.com/events/assistant_thread_started) event will be sent to your app. Capture this with the `threadStarted` handler to allow your app to respond.
65+
When the user opens a new thread with your AI app, the [`assistant_thread_started`](https://api.slack.com/events/assistant_thread_started) event will be sent to your app. Capture this with the `threadStarted` handler to allow your app to respond.
6666

6767
In the example below, the app is sending a message — containing thread context [message metadata](https://api.slack.com/metadata/using) behind the scenes — to the user, along with a single [prompt](https://api.slack.com/methods/assistant.threads.setSuggestedPrompts).
6868

@@ -85,7 +85,7 @@ In the example below, the app is sending a message — containing thread context
8585
```
8686

8787
:::tip
88-
When a user opens an assistant thread while in a channel, the channel info is stored as the thread's `AssistantThreadContext` data. You can grab that info using the `getThreadContext()` utility, as subsequent user message event payloads won't include the channel info.
88+
When a user opens an AI app thread while in a channel, the channel info is stored as the thread's `AssistantThreadContext` data. You can grab that info using the `getThreadContext()` utility, as subsequent user message event payloads won't include the channel info.
8989
:::
9090

9191
## Handling thread context changes {#handling-thread-context-changes}
@@ -100,13 +100,13 @@ When the user switches channels, the [`assistant_thread_context_changed`](https:
100100
...
101101
```
102102

103-
If you use the built-in `AssistantThreadContextStore` without any custom configuration, you can skip this — the updated thread context data is automatically saved as [message metadata](https://api.slack.com/metadata/using) on the first reply from the assistant bot.
103+
If you use the built-in `AssistantThreadContextStore` without any custom configuration, you can skip this — the updated thread context data is automatically saved as [message metadata](https://api.slack.com/metadata/using) on the first reply from the app.
104104

105105
## Handling the user response {#handling-user-response}
106106

107-
When the user messages your assistant, the [`message.im`](https://api.slack.com/events/message.im) event will be sent to your app. Capture this with the `userMessage` handler.
107+
When the user messages your AI app, the [`message.im`](https://api.slack.com/events/message.im) event will be sent to your app. Capture this with the `userMessage` handler.
108108

109-
Messages sent to the assistant do not contain a [subtype](https://api.slack.com/events/message#subtypes) and must be deduced based on their shape and any provided [message metadata](https://api.slack.com/metadata/using).
109+
Messages sent to the app do not contain a [subtype](https://api.slack.com/events/message#subtypes) and must be deduced based on their shape and any provided [message metadata](https://api.slack.com/metadata/using).
110110

111111
There are three [utilities](/reference#the-assistantconfig-configuration-object) that are particularly useful in curating the user experience:
112112
* `say`

docs/docusaurus.config.js

+4
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ const config = {
6969
to: '/',
7070
from: ['/concepts', '/concepts/advanced', '/concepts/basic'],
7171
},
72+
{
73+
to: '/concepts/ai-apps',
74+
from: '/concepts/assistant',
75+
},
7276
],
7377
},
7478
],

docs/sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const sidebars = {
3939
'concepts/publishing-views',
4040
],
4141
},
42-
'concepts/assistant',
42+
'concepts/ai-apps',
4343
'concepts/custom-steps',
4444
{
4545
type: 'category',

0 commit comments

Comments
 (0)