Skip to main content

Zoe API v2 Guides

These guides help you understand how to use the Zoe API v2 to enable dynamic interactions between your application and the Zoe Advisor.

Prerequisites​

Before you start:

  • Make sure Zoe is configured in Advisor Studio.
  • Use a published version of Zoe in production, or add the draft=true parameter to test unpublished configurations.

Message types​

Zoe API supports different message types for different use cases. Each message type allows your application to interact with Zoe in a way that suits your assistant’s goals and user experience. Below is an overview of the message types you can use to communicate effectively with Zoe.

Product description​

  • Use Product description to ask Zoe to describe a product or product group.
  • Depending on how the parameters are configured, Zoe will generate a product description for a single item or a group of related products. This is a good way to start a product-focused conversation.

User question​

  • User question is the default message type for user-initiated queries. Use it when the user types a natural language question and you want Zoe to generate a response.
  • Zoe will process the input and reply based on product data, previous messages, and available context.

Compare products​

  • Use Compare products to generate a comparison between 2 to 4 products.
  • Zoe will return a structured comparison, highlighting differences across selected attributes.

Compare product attributes​

  • This message compares a single attribute (like weight or price) across 2 or 3 products.
  • Compare product attributes is useful when users are focused on a specific detail in their decision-making process.

Categorized input​

  • Use this when you want Zoe to classify user input into a category within a given product family.
  • Categorized input is helpful for understanding the user’s intent and routing the conversation according to it.

Make sure to use context key-value pairs to personalized Zoe responses. Learn more.