Skip to content

Commit 52cd366

Browse files
committed
update action doc
1 parent de586e6 commit 52cd366

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

api-reference/action.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,22 @@ The `Action` class is designed to create and manage actions to be sent and displ
77
### Parameters
88

99
<ParamField path="name" type="str">
10-
The unique identifier for the action, used to reference the action within the
11-
chatbot.
10+
Name of the action, this should be used in the action_callback
1211
</ParamField>
1312

1413
<ParamField path="value" type="str">
1514
The value associated with the action. This is useful to differentiate between
1615
multiple actions with the same name.
1716
</ParamField>
1817

19-
<ParamField path="description" type="str" optional>
20-
A short, descriptive text for the action, used to provide additional
21-
information about the action to the user.
18+
<ParamField path="label" type="str" optional>
19+
The label of the action. This is what the user will see. If not provided the
20+
name will be used.
2221
</ParamField>
2322

24-
<ParamField path="forId" type="str" optional>
25-
The optional target element identifier to which the action is bound. You
26-
should not use this parameter.
23+
<ParamField path="description" type="str" optional>
24+
The description of the action. This is what the user will see when they hover
25+
the action.
2726
</ParamField>
2827

2928
### Usage

0 commit comments

Comments
 (0)