Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: edit messages for agent create and agent generte spec #41

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

jshackell-sfdc
Copy link
Contributor

What does this PR do?

Edits and adds a bit more info to the --help of "agent generate spec" and "agent create"

What issues does this PR fix or reference?

@W-17417430@

@jshackell-sfdc jshackell-sfdc requested a review from a team as a code owner December 11, 2024 22:42
@jshackell-sfdc jshackell-sfdc requested review from shetzel and WillieRuemmele and removed request for a team December 11, 2024 22:43
Copy link
Contributor

@shetzel shetzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that the commands are not final and the way they work is going to change based on using the v2 APIs.


# flags.name.summary

The name of the agent.
API name of the new agent.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is actually the label, not the API name (aka developer name).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WillieRuemmele said it was the API name. I originally thought it was the label.

@@ -1,25 +1,25 @@
# summary

Create an Agent from an agent spec.
Create an agent in your org from a local agent spec file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is going to change with the v2 agent creator APIs that will allow "agent preview" behavior, meaning the metadata will not be created in the org but sent back in the response to be previewed by the customer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. I was writing this with the Dec milestone in mind, so I will change it when you implement v2. Okay?


# flags.job-spec.summary
When this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new agent already has a list of topics and actions that were automatically created from the list of jobs in the provided agent spec file. This command also retrieves all the metadata files associated with the new agent to your local DX project.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true with the current implementation but not necessarily with the v2 implementation.

Copy link
Contributor Author

@jshackell-sfdc jshackell-sfdc Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see my previous comment.


# description

Create an Agent spec, which is a list of job titles and descriptions that the agent performs.
When using Salesforce CLI to create an agent in your org, the first step is to generate the local JSON-formatted agent spec file with this command.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true for the existing commands but not necessarily true with v2. The v2 APIs allow agent creation from the fields used to generate a spec and not only from a spec.

Copy link
Contributor Author

@jshackell-sfdc jshackell-sfdc Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see my previous comment.

@jshackell-sfdc
Copy link
Contributor Author

I'll update the --help after you implement v2. I was writing this for the Dec milestone, in case Vivek wants to run --help on the commands in his demo. :)

@shetzel shetzel merged commit 5f1862e into main Dec 13, 2024
15 checks passed
@shetzel shetzel deleted the js/edit-messages-agent-create branch December 13, 2024 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants