-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9fb4ff6
commit 5e6bd82
Showing
1 changed file
with
15 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,19 +4,19 @@ Generate an agent spec, which is a YAML file that captures what an agent can do. | |
|
||
# description | ||
|
||
Before you use Salesforce CLI to create an agent in your org, you must first generate an agent spec with this command. An agent spec is a YAML-formatted file that contains information about the agent, such as its role and company description, and then an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle. | ||
The first step in creating an agent in your org with Salesforce CLI is to generate an agent spec using this command. An agent spec is a YAML-formatted file that contains information about the agent, such as its role and company description, and then an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle. | ||
|
||
Use flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the information. Upon command execution, the large language model (LLM) associated with your org uses the information you provided to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply to your agent or change the description of a particular topic. | ||
Use flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be prompted for all required and optional properties. Upon command execution, the large language model (LLM) associated with your org uses the provided information to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate, complete, and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply or change a topic's description. | ||
|
||
You can iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics. | ||
You can also iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics. | ||
|
||
You can also specify a custom prompt template that the agent uses, and ground the prompt template to add context and personalization to the agent's prompts. | ||
You can also specify other agent properties, such as a custom prompt template, how to ground the prompt template to add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the agent. | ||
|
||
When your agent spec is ready, you then create the agent in your org by running the "agent create" CLI command and specifying the spec with the --spec flag. | ||
|
||
# flags.type.summary | ||
|
||
Type of agent to create. | ||
Type of agent to create. Internal types are copilots used internally by your company and customer types are the agents you create for your customers. | ||
|
||
# flags.role.summary | ||
|
||
|
@@ -92,7 +92,7 @@ Language the agent uses in conversations. | |
|
||
# flags.no-prompt.summary | ||
|
||
Don't prompt the user to confirm spec file overwrite. | ||
Don't prompt the user to confirm that an existing spec file will be overwritten. | ||
|
||
# examples | ||
|
||
|
@@ -104,9 +104,17 @@ Don't prompt the user to confirm spec file overwrite. | |
|
||
<%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org | ||
|
||
- Be prompted for all required and optional agent properties; use your default org: | ||
|
||
<%= config.bin %> <%= command.id %> --full-interview | ||
|
||
- Specify an existing agent spec file called "specs/resortManagerAgent.yaml", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag: | ||
|
||
<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role "Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly" --target-org my-org | ||
<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role "Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly" | ||
|
||
- Specify that the conversational tone of the agent is formal and to attach the "[email protected]" username to it; be prompted for the required properties and use your default org: | ||
|
||
<%= config.bin %> <%= command.id %> --tone formal --agent-user [email protected] | ||
|
||
# error.missingRequiredFlags | ||
|
||
|