You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Enhance clarity and consistency in authoring bundle doc
Clarified the description of publishing an authoring bundle and improved the explanation of the command's behavior. Adjusted wording for consistency and clarity throughout the document.
Copy file name to clipboardExpand all lines: messages/agent.publish.authoring-bundle.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,28 @@
1
1
# summary
2
2
3
-
Publish an authoring bundle to your org, which results in a new or updated agent.
3
+
Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.
4
4
5
5
# description
6
6
7
7
An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension ".agent") that fully describes the agent using the Agent Script language.
8
8
9
-
When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then the authoring bundle metadata component is deployed to the org, and all associated agent metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either created or updated. The org then either creates a new agent based on the deployed authoring bundle, or creates a new version of the agent if it already existed. Finally, all the new or changed metadata components associated with the new agent are retrieved back to your local DX project.
9
+
When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then the authoring bundle metadata component is deployed to the org. All associated agent metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either created or updated in the org. Finally, all the new or changed metadata components associated with the new agent are retrieved back to your local DX project.
10
10
11
-
This command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.
11
+
This command uses the API name of the authoring bundle.
12
12
13
13
# examples
14
14
15
-
- Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-org":
15
+
- Publish an authoring bundle by being prompted for its API name; use your default org:
0 commit comments