agent preview send
Send a message to an existing agent preview session.
You must have previously started a programmatic agent preview session with the “agent preview start” command to then use this command to send the agent a message (utterance). This command then displays the agent’s response.
The original “agent preview start” command outputs a session ID which you then use with the –session-id flag of this command to send a message. You don’t have to specify the –session-id flag if an agent has only one active preview session. You must also use either the –authoring-bundle or –api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the “aiAuthoringBundles” metadata directory. Similarly, the published agent’s API name is the same as its directory name under the “Bots” metadata directory.
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
‑‑api‑name | ‑n | Type: Value API name of the activated published agent you want to preview. |
‑‑api‑version | N/A | Type: Value Override the api version used for api requests made by this command |
‑‑authoring‑bundle | N/A | Type: Value API name of the authoring bundle metadata component that contains the agent’s Agent Script file. |
‑‑flags‑dir | N/A | Type: Value Import flag values from a directory. |
‑‑json | N/A | Type: Boolean Format output as json. |
‑‑session‑id | N/A | Type: Value Session ID outputted by “agent preview start”. Not required when the agent has exactly one active session. Run “agent preview sessions” to see list of all sessions. |
‑‑target‑org | ‑o | Type: Value Required Username or alias of the target org. Not required if the target-org configuration variable is already set. |
‑‑utterance | ‑u | Type: Value Required Utterance to send to the agent, enclosed in double quotes. |
Send a message to an activated published agent using its API name and session ID; use the default org:
Similar to previous example, but don’t specify a session ID; you get an error if the agent has more than one active session. Use the org with alias “my-dev-org”:
Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session: