@salesforce/plugin-agent 1.11.1 → 1.12.0

package/messages/agent.generate.spec-v2.md

@@ -1,121 +0,0 @@
-# summary
-
-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.
-
-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.
-
-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 specify a custom prompt template that the agent uses, and ground the prompt template to add context and personalization to the agent's prompts.
-
-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.
-
-# flags.role.summary
-
-Role of the agent.
-
-# flags.company-name.summary
-
-Name of your company.
-
-# flags.company-description.summary
-
-Description of your company.
-
-# flags.company-website.summary
-
-Website URL of your company.
-
-# flags.output-file.summary
-
-Path for the generated YAML agent spec file; can be an absolute or relative path.
-
-# flags.max-topics.summary
-
-Maximum number of topics to generate in the agent spec; default is 10.
-
-# flags.max-topics.prompt
-
-Max number of topics to generate (1-30)
-
-# flags.prompt-template.summary
-
-API name of a customized prompt template to use instead of the default prompt template.
-
-# flags.grounding-context.summary
-
-Context information and personalization that's added to your prompts when using a custom prompt template.
-
-# flags.spec.summary
-
-Agent spec file, in YAML format, to use as input to the command.
-
-# flags.full-interview.summary
-
-Prompt for both required and optional flags.
-
-# flags.agent-user.summary
-
-Username of a user in your org to assign to your agent; determines what your agent can access and do.
-
-# flags.agent-user.prompt
-
-Username for agent
-
-# flags.enrich-logs.summary
-
-Adds agent conversation data to event logs so you can view all agent session activity in one place.
-
-# flags.enrich-logs.prompt
-
-Enrich event logs
-
-# flags.tone.summary
-
-Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.
-
-# flags.tone.prompt
-
-Agent conversation tone
-
-# flags.primary-language.summary
-
-Language the agent uses in conversations.
-
-# flags.no-prompt.summary
-
-Don't prompt the user to confirm spec file overwrite.
-
-# examples
-
-- Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and your company details; use your default org:
-
-  <%= config.bin %> <%= command.id %> --type customer --role "Field customer complaints and manage employee schedules." --company-name "Coral Cloud Resorts" --company-description "Provide customers with exceptional destination activities, unforgettable experiences, and reservation services."
-
-- Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics; write the generated file to the "specs/resortManagerSpec.yaml" file and use the org with alias "my-org":
-
-  <%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org
-
-- 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
-
-# error.missingRequiredFlags
-
-Missing required flags: %s
-
-# confirmSpecOverwrite
-
-Confirm overwrite of spec file %s?
-
-# commandCanceled
-
-Command canceled by user confirmation.

package/schemas/agent-create__v2.json

@@ -1,145 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$ref": "#/definitions/AgentCreateResult",
-  "definitions": {
-    "AgentCreateResult": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "previewFilePath": {
-          "type": "string"
-        },
-        "isSuccess": {
-          "type": "boolean"
-        },
-        "errorMessage": {
-          "type": "string"
-        },
-        "agentId": {
-          "type": "object",
-          "properties": {
-            "botId": {
-              "type": "string"
-            },
-            "botVersionId": {
-              "type": "string"
-            },
-            "plannerId": {
-              "type": "string"
-            }
-          },
-          "required": ["botId", "botVersionId", "plannerId"],
-          "additionalProperties": false,
-          "description": "If the agent was created with saveAgent=true, these are the IDs that make up an agent; Bot, BotVersion, and GenAiPlanner metadata."
-        },
-        "agentDefinition": {
-          "type": "object",
-          "properties": {
-            "agentDescription": {
-              "type": "string"
-            },
-            "topics": {
-              "type": "array",
-              "items": {
-                "type": "object",
-                "properties": {
-                  "scope": {
-                    "type": "string"
-                  },
-                  "topic": {
-                    "type": "string"
-                  },
-                  "actions": {
-                    "type": "array",
-                    "items": {
-                      "type": "object",
-                      "properties": {
-                        "actionName": {
-                          "type": "string"
-                        },
-                        "exampleOutput": {
-                          "type": "string"
-                        },
-                        "actionDescription": {
-                          "type": "string"
-                        },
-                        "inputs": {
-                          "type": "array",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "inputName": {
-                                "type": "string"
-                              },
-                              "inputDataType": {
-                                "type": "string"
-                              },
-                              "inputDescription": {
-                                "type": "string"
-                              }
-                            },
-                            "required": ["inputName", "inputDataType", "inputDescription"],
-                            "additionalProperties": false
-                          },
-                          "minItems": 1,
-                          "maxItems": 1
-                        },
-                        "outputs": {
-                          "type": "array",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "outputName": {
-                                "type": "string"
-                              },
-                              "outputDataType": {
-                                "type": "string"
-                              },
-                              "outputDescription": {
-                                "type": "string"
-                              }
-                            },
-                            "required": ["outputName", "outputDataType", "outputDescription"],
-                            "additionalProperties": false
-                          },
-                          "minItems": 1,
-                          "maxItems": 1
-                        }
-                      },
-                      "required": ["actionName", "exampleOutput", "actionDescription", "inputs", "outputs"],
-                      "additionalProperties": false
-                    },
-                    "minItems": 1,
-                    "maxItems": 1
-                  },
-                  "instructions": {
-                    "type": "array",
-                    "items": {
-                      "type": "string"
-                    }
-                  },
-                  "classificationDescription": {
-                    "type": "string"
-                  }
-                },
-                "required": ["scope", "topic", "actions", "instructions", "classificationDescription"],
-                "additionalProperties": false
-              },
-              "minItems": 1,
-              "maxItems": 1
-            },
-            "sampleUtterances": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            }
-          },
-          "required": ["agentDescription", "topics", "sampleUtterances"],
-          "additionalProperties": false
-        }
-      },
-      "required": ["agentDefinition", "isSuccess"]
-    }
-  }
-}

package/schemas/agent-generate-spec__v2.json

@@ -1,85 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$ref": "#/definitions/AgentCreateSpecResult",
-  "definitions": {
-    "AgentCreateSpecResult": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "topics": {
-          "$ref": "#/definitions/DraftAgentTopics"
-        },
-        "agentType": {
-          "type": "string",
-          "enum": [
-            "customer",
-            "internal"
-          ],
-          "description": "Internal type is copilots; used by customers' employees. Customer type is agents; used by customers' customers."
-        },
-        "role": {
-          "type": "string"
-        },
-        "companyName": {
-          "type": "string"
-        },
-        "companyDescription": {
-          "type": "string"
-        },
-        "companyWebsite": {
-          "type": "string"
-        },
-        "maxNumOfTopics": {
-          "type": "number",
-          "description": "The maximum number of topics to create in the spec. Default is 10."
-        },
-        "promptTemplateName": {
-          "type": "string",
-          "description": "Developer name of the prompt template."
-        },
-        "groundingContext": {
-          "type": "string",
-          "description": "Context info to be used in customized prompt template"
-        },
-        "isSuccess": {
-          "type": "boolean"
-        },
-        "errorMessage": {
-          "type": "string"
-        },
-        "specPath": {
-          "type": "string"
-        }
-      },
-      "required": [
-        "agentType",
-        "companyDescription",
-        "companyName",
-        "isSuccess",
-        "role",
-        "topics"
-      ]
-    },
-    "DraftAgentTopics": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string"
-          },
-          "description": {
-            "type": "string"
-          }
-        },
-        "required": [
-          "name",
-          "description"
-        ],
-        "additionalProperties": false
-      },
-      "minItems": 1,
-      "maxItems": 1
-    }
-  }
-}