Write and publish guides

AI-generated summary

Genesys Cloud Resource Center provides comprehensive functionality for creating, managing, and publishing AI agent interaction guides within AI Studio's orchestration environment. Users access guides through Menu > Orchestration > AI Studio > Guides, where they can search for existing guides or create new ones using the Instructions tab to add and modify guide steps. Guide creation follows structured best practices that emphasize single-task focus with main steps and substeps bearing unique, descriptive names to ensure proper AI agent context understanding. The platform provides a comprehensive command set for building interactions, including Say for outputting agent messages with simple variable support, Ask for requesting user input with mandatory Store statements to save responses as variables, and Ask and Confirm for combining input requests with confirmation functionality before saving data. Additional commands include Call for executing data actions with input parameters and storing outputs in multiple formats (strings, numbers, and Booleans), Using for presenting list variables during input requests, Store for saving captured data to variables, Go To for step navigation, and Exit for terminating guide execution with specified status options (Completion, Failure, or Escalation). Conditional branching is managed through If:Then:Else logic, enabling the AI agent to direct conversations based on true/false conditions and customer responses, with optional alternative paths. Guide variables are created in the Variables tab and inserted into instructions using the forward slash (/) command interface, with visual emphasis through gray background formatting. Data actions, previously configured for external service integration, can be similarly inserted using the same slash command interface. All commands require consistent formatting with a leading hyphen and space followed by an uppercase first letter, and guide sections must include headings to enable proper navigation. The save and publish workflow requires users to save guides as drafts, run the guide checker to identify and resolve syntax errors, and then publish the guide. Published guides cannot have existing variable names, types, or availability modified, though new variables can be added. When a guide is published and linked to an Architect bot flow enabled with Virtual Agent, the flow automatically updates to call the latest published version. Published guides can be connected to Architect bot flows or digital bot flows through the Call Guide action. Prerequisites include Virtual Agent enablement and appropriate AI Studio permissions assigned by administrators. Commands support tier 1 language localization while maintaining English command names, and Genesys recommends testing Virtual Agent performance across preferred languages before deployment to account for potential language-specific variations.

PrerequisitesClick to expand

After you create a guide using one of the available options for guide creation, you can add instructions to it or edit the existing instructions on the Instructions tab.

Create or open a guide

Click Admin.
Under AI Studio, click Guides.
Click Menu > Orchestration > AI Studio > Guides.
To search for a specific guide, start typing the name of the guide in the search box. As you type, the matching guides are shown.
To open a guide, click its name.
Select the Instructions tab.
In the Instructions tab, add or change the steps of the guide.

Write instructions for the guide

Follow these basic guidelines when writing and formatting your instructions:

Design your guide with a focus on a single task or intent.
Divide your task into main steps and substeps. This type of structuring ensures that your AI agent understands the context and reference when you ask it to jump between steps.
1. Assign a unique name to each main step. Choose a name that provides an accurate description of what happens within the step and its substeps.
2. Use the available predefined commands as building blocks for your guide.

Predefined commands

Note: Write the command name in English; however, the rest of the command’s syntax can be in any supported tier 1 language. For example,

- Say "Bienvenido al registro de nuestro Programa de Lealtad {{Variable.programa_lealtad}}. Te guiaré a través del proceso."

Command	Usage description	Syntax	Examples
Say	Use this command to enter an output message that the AI agent must send to the user. It can include simple variables that are captured in the guide or provided as input from the flow to the guide.	`- Say "Exactly what you want the AI agent to say”`	`- Say "Welcome to ACME insurance."` Or `- Say "Your current rewards balance for your card_type is points_balance points."` Or `- Say "Hello contact_username."`
Ask	Use this command to request input from the user. You can include simple variables too. For example, the AI agent can ask questions to the user using their name or referring to any previous information. A Store statement must always follow the Ask command to save customers’ answers as variables. You can use these variables later in the guide, for example, to call a data action or to pass values to an Architect flow.	`- Ask "The question that your AI agent must ask"` `- Store in {{Variable name}} [ { and \| , } ... ]`	`- Ask "Please provide the email address."` `- Store in email_address` Or `- Ask "Are you sure you want to book a flight to trip_destination?"` `- Store in booking_confirmation`
Ask and Confirm	Use this command to request input from the user and then confirm that the provided value is correct. It works like an Ask command, but includes a confirmation step that allows the user to revise their answer if their initial input is incorrect. This command supports all types of variables. A Store statement must always follow the Ask and Confirm command to save customers’ confirmed answers as variables. You can use these variables later in the guide, for example, to call a data action or to pass values to an Architect flow.	`- Ask and Confirm "The question that your AI agent must ask"` `- Store in {{Variable name}} [ { and \| , } ... ]`	Example A with single variable: `- Ask and Confirm "Can you please provide your order number?"` `- Store in order_number` Example B with multiple variables: `- Ask and Confirm "Can you please provide your order number and email address?"` `- Store in order_number and email_address`
Call	Use this command to call a data action with input parameters and store the output in variables. If there are multiple parameters to call, you can denote them with commas and by specifying other separators. Also, if you want to store the output, you can follow it with a Store command. Currently, data actions that return simple data types including strings, numbers, and Booleans are supported.	`- Call [Data action name] with [variable name]`	`- Call VerifyUserDetails_Action with card_type` `- Call VerifyCustomer_Action with customer_ID and customer_email` Example A with Store: `- Call VerifyUserDetails_Action with card_type` `- Store in verification_status` Example B with Store: `- Call VerifyCustomer.Action with customer_ID and customer_email` `- Store in verification_status`
Using	Use this command before an Ask or Ask and Confirm command to call a list variable when requesting input from the participant. Follow it with a Store command to store the captured value in the corresponding list selection variable.	`- Using {{List variable name}}` `- Ask "The question that your AI agent must ask"` `- Store in {{Variable name}} [ { and \| , } ... ]`	`- Using car_models_list` `- Ask "Please provide your car model name."` `- Store in car_model_selection`
Store	Use this command to save data to variables. You can then use the variables in other areas of the guide. You can store multiple variables at a time from Ask, Ask and Confirm, and Call commands. Note: Proper descriptions are important for the variables. Update these descriptions in the Variables tab.	`- Store in {{Variable name}} [ { and \| , } ... ]`	`- Store in variable_name` Or `- Store in variable1_name and variable2_name`
Go To	Use this command to navigate to another step in the guide. Ensure that you match the step names correctly.	`- Go To [step_name]`	`- Go To Email Collection` Or `- Go To Escalation`
If:Then:Else	Use this command to follow conditional branching logic. It allows you to direct the AI agent to different paths depending on the customer’s responses. The If condition must be a true or false statement and you must follow it by a Then statement. The Else statement is optional.	Without Else statement: `- If CONDITION` `- Then Go To [step_name]` With Else statement: `- If CONDITION` `- Then Go To [step_name]` `- Else Go To [Other_step_name]`	`- If router_model == "A100"` `- Then Go To Troubleshoot A100` Or `- If router_model is A100` `- Then Go To Troubleshoot A100` Or `- If is_VIP_customer is true` `- Then Go To VIP Customer Handling` `- Else Go To Standard Customer Handling` Or `- If customer is a VIP type` `- Then Go To VIP Customer Handling` `- Else Go To Standard Customer Handling` Or `- If account_type == Checking` `- Then Go To Checking Balance` `- If account_type == Savings` `- Then Go To Savings Balance` `- Else Go To Other Account Balance`
Exit	Use this command to end the guide execution. By default, the guide ends if there is nothing else to do. However, this optional command allows you to set the exit status or to branch certain answers to specific exit paths.	`- Exit with { Completion \| Failure \| Escalation }`	`- Exit with Completion` Or `- Exit with Escalation`

Formatting of commands

To improve reliability and consistency across guides, ensure that each command line starts with a hyphen (-) followed by a space. Also, the first letter of the command must be in uppercase.

Example:

...
– Say “text”
...
– Ask and Confirm “text”
...

Generating a guide using an AI prompt or document upload creates instructions in this format.

All sections (main steps) in the guide must have a heading to which the AI agent can navigate. For more guidelines and best practices on writing instructions, see Best practices for writing guides.

Show meClick to expand

Add variables

Create a guide or open an existing one.
Select the Variables tab.
In the Variables tab, create guide variables that you plan to use in your guide.
Select the Instructions tab.
In the Instructions tab, place your cursor where you want to insert a variable and type /. A dialog box shows all available variables.
Select the required variable.

The editor emphasizes variables present in your guide using a gray background.

Show meClick to expand

Add data actions

You can add a previously configured data action to your guide. For more information about creating a custom data action, see Create a custom action for integrations.

Create a guide or open an existing one.
Select the Instructions tab.
In the Instructions tab, place your cursor where you want to insert a data action and type /. A dialog box shows all available data actions.
Select the required data action.

The editor emphasizes variables present in your guide with a gray background and the data action icon . For more information about how to use data actions in guides, see Connect guides to external services with data actions.

Show meClick to expand

Save and publish the guide

When you finish editing, click Save to save the guide as a draft.
Run the guide checker. If the checker returns any syntax errors, troubleshoot them. For more information about the guide checker, see Validate your guide using checker.
Click Publish to publish the guide.

Notes:

While your guide is in draft mode, you can change the guide variables, if needed. After you publish a guide, you cannot change an existing variable’s name, type, or availability, but you can add new variables.
When you publish a guide, which is already linked to an Architect bot flow that is enabled with Virtual Agent, the flow immediately updates its configuration to call the latest published guide during its execution.
The performance of the Virtual Agent can vary across languages. Genesys encourages testing with preferred languages before going live.
When you publish a guide, the editor runs the guide checker automatically. Before you can publish the guide, you must troubleshoot and fix all the errors shown by the checker. Also, whenever you change the guide and save it, you are prompted to run the checker again.

After you publish a guide, you can connect it to an Architect bot flow or digital bot flow that is enabled with Virtual Agent using the Call Guide action. For more information, see Connect guides to your Virtual Agent flows. For more information about how to duplicate or delete a guide, see Duplicate or delete guides.

[NEXT] Was this article helpful?

Get user feedback about articles.

Write and publish guides

AI-generated summary

PrerequisitesClick to expand

After you create a guide using one of the available options for guide creation, you can add instructions to it or edit the existing instructions on the Instructions tab.

Create or open a guide

Click Admin.
Under AI Studio, click Guides.
Click Menu > Orchestration > AI Studio > Guides.
To search for a specific guide, start typing the name of the guide in the search box. As you type, the matching guides are shown.
To open a guide, click its name.
Select the Instructions tab.
In the Instructions tab, add or change the steps of the guide.

Write instructions for the guide

Follow these basic guidelines when writing and formatting your instructions:

Design your guide with a focus on a single task or intent.
Divide your task into main steps and substeps. This type of structuring ensures that your AI agent understands the context and reference when you ask it to jump between steps.
1. Assign a unique name to each main step. Choose a name that provides an accurate description of what happens within the step and its substeps.
2. Use the available predefined commands as building blocks for your guide.

Predefined commands

Note: Write the command name in English; however, the rest of the command’s syntax can be in any supported tier 1 language. For example,

- Say "Bienvenido al registro de nuestro Programa de Lealtad {{Variable.programa_lealtad}}. Te guiaré a través del proceso."

Command	Usage description	Syntax	Examples
Say	Use this command to enter an output message that the AI agent must send to the user. It can include simple variables that are captured in the guide or provided as input from the flow to the guide.	`- Say "Exactly what you want the AI agent to say”`	`- Say "Welcome to ACME insurance."` Or `- Say "Your current rewards balance for your card_type is points_balance points."` Or `- Say "Hello contact_username."`
Ask	Use this command to request input from the user. You can include simple variables too. For example, the AI agent can ask questions to the user using their name or referring to any previous information. A Store statement must always follow the Ask command to save customers’ answers as variables. You can use these variables later in the guide, for example, to call a data action or to pass values to an Architect flow.	`- Ask "The question that your AI agent must ask"` `- Store in {{Variable name}} [ { and \| , } ... ]`	`- Ask "Please provide the email address."` `- Store in email_address` Or `- Ask "Are you sure you want to book a flight to trip_destination?"` `- Store in booking_confirmation`
Ask and Confirm	Use this command to request input from the user and then confirm that the provided value is correct. It works like an Ask command, but includes a confirmation step that allows the user to revise their answer if their initial input is incorrect. This command supports all types of variables. A Store statement must always follow the Ask and Confirm command to save customers’ confirmed answers as variables. You can use these variables later in the guide, for example, to call a data action or to pass values to an Architect flow.	`- Ask and Confirm "The question that your AI agent must ask"` `- Store in {{Variable name}} [ { and \| , } ... ]`	Example A with single variable: `- Ask and Confirm "Can you please provide your order number?"` `- Store in order_number` Example B with multiple variables: `- Ask and Confirm "Can you please provide your order number and email address?"` `- Store in order_number and email_address`
Call	Use this command to call a data action with input parameters and store the output in variables. If there are multiple parameters to call, you can denote them with commas and by specifying other separators. Also, if you want to store the output, you can follow it with a Store command. Currently, data actions that return simple data types including strings, numbers, and Booleans are supported.	`- Call [Data action name] with [variable name]`	`- Call VerifyUserDetails_Action with card_type` `- Call VerifyCustomer_Action with customer_ID and customer_email` Example A with Store: `- Call VerifyUserDetails_Action with card_type` `- Store in verification_status` Example B with Store: `- Call VerifyCustomer.Action with customer_ID and customer_email` `- Store in verification_status`
Using	Use this command before an Ask or Ask and Confirm command to call a list variable when requesting input from the participant. Follow it with a Store command to store the captured value in the corresponding list selection variable.	`- Using {{List variable name}}` `- Ask "The question that your AI agent must ask"` `- Store in {{Variable name}} [ { and \| , } ... ]`	`- Using car_models_list` `- Ask "Please provide your car model name."` `- Store in car_model_selection`
Store	Use this command to save data to variables. You can then use the variables in other areas of the guide. You can store multiple variables at a time from Ask, Ask and Confirm, and Call commands. Note: Proper descriptions are important for the variables. Update these descriptions in the Variables tab.	`- Store in {{Variable name}} [ { and \| , } ... ]`	`- Store in variable_name` Or `- Store in variable1_name and variable2_name`
Go To	Use this command to navigate to another step in the guide. Ensure that you match the step names correctly.	`- Go To [step_name]`	`- Go To Email Collection` Or `- Go To Escalation`
If:Then:Else	Use this command to follow conditional branching logic. It allows you to direct the AI agent to different paths depending on the customer’s responses. The If condition must be a true or false statement and you must follow it by a Then statement. The Else statement is optional.	Without Else statement: `- If CONDITION` `- Then Go To [step_name]` With Else statement: `- If CONDITION` `- Then Go To [step_name]` `- Else Go To [Other_step_name]`	`- If router_model == "A100"` `- Then Go To Troubleshoot A100` Or `- If router_model is A100` `- Then Go To Troubleshoot A100` Or `- If is_VIP_customer is true` `- Then Go To VIP Customer Handling` `- Else Go To Standard Customer Handling` Or `- If customer is a VIP type` `- Then Go To VIP Customer Handling` `- Else Go To Standard Customer Handling` Or `- If account_type == Checking` `- Then Go To Checking Balance` `- If account_type == Savings` `- Then Go To Savings Balance` `- Else Go To Other Account Balance`
Exit	Use this command to end the guide execution. By default, the guide ends if there is nothing else to do. However, this optional command allows you to set the exit status or to branch certain answers to specific exit paths.	`- Exit with { Completion \| Failure \| Escalation }`	`- Exit with Completion` Or `- Exit with Escalation`

Formatting of commands

To improve reliability and consistency across guides, ensure that each command line starts with a hyphen (-) followed by a space. Also, the first letter of the command must be in uppercase.

Example:

...
– Say “text”
...
– Ask and Confirm “text”
...

Generating a guide using an AI prompt or document upload creates instructions in this format.

All sections (main steps) in the guide must have a heading to which the AI agent can navigate. For more guidelines and best practices on writing instructions, see Best practices for writing guides.

Show meClick to expand

Add variables

Create a guide or open an existing one.
Select the Variables tab.
In the Variables tab, create guide variables that you plan to use in your guide.
Select the Instructions tab.
In the Instructions tab, place your cursor where you want to insert a variable and type /. A dialog box shows all available variables.
Select the required variable.

The editor emphasizes variables present in your guide using a gray background.

Show meClick to expand

Add data actions

You can add a previously configured data action to your guide. For more information about creating a custom data action, see Create a custom action for integrations.

Create a guide or open an existing one.
Select the Instructions tab.
In the Instructions tab, place your cursor where you want to insert a data action and type /. A dialog box shows all available data actions.
Select the required data action.

Show meClick to expand

Save and publish the guide

When you finish editing, click Save to save the guide as a draft.
Run the guide checker. If the checker returns any syntax errors, troubleshoot them. For more information about the guide checker, see Validate your guide using checker.
Click Publish to publish the guide.

Notes:

While your guide is in draft mode, you can change the guide variables, if needed. After you publish a guide, you cannot change an existing variable’s name, type, or availability, but you can add new variables.
When you publish a guide, which is already linked to an Architect bot flow that is enabled with Virtual Agent, the flow immediately updates its configuration to call the latest published guide during its execution.
The performance of the Virtual Agent can vary across languages. Genesys encourages testing with preferred languages before going live.
When you publish a guide, the editor runs the guide checker automatically. Before you can publish the guide, you must troubleshoot and fix all the errors shown by the checker. Also, whenever you change the guide and save it, you are prompted to run the checker again.

[NEXT] Was this article helpful?

Get user feedback about articles.

Write and publish guides

Create or open a guide

Write instructions for the guide

Predefined commands

Formatting of commands

Add variables

Add data actions

Save and publish the guide

[NEXT] Was this article helpful?

Loading...

Write and publish guides

Create or open a guide

Write instructions for the guide

Predefined commands

Formatting of commands

Add variables

Add data actions

Save and publish the guide

[NEXT] Was this article helpful?