System tools for Optimizely Data Platform (ODP)

  • Updated

System tools are built-in features that help Optimizely Opal take action. Each tool performs a specific task, such as creating a campaign, uploading files, or generating images. Think of tools like attachments on a Swiss Army knife. Each one has a distinct purpose that helps you get work done.

In addition to the system tools available in Opal, Optimizely Data Platform (ODP) includes a set of system tools designed to support getting campaign information.

Ask Opal what tools it has at any time. For example, enter "Please list the tools you have with a brief description of what they do and the parameters" into Opal Chat.

Click a tool's name to expand it and learn when to use it, its required and optional parameters, and example prompts for calling the tool. If you do not provide a required parameter, Opal prompts you for it.

suggest_odp_audiences – Suggests new real-time audiences you can create in ODP based on your existing schema.
  • When to use
    • You are looking for inspiration or ideas for useful real-time audiences.
    • You want to understand what types of audiences you can create with your existing data.
  • What Opal produces
    • Three suggested real-time audiences. Audiences are not created automatically in ODP. Review and approve them to create the audience. 
  • Example prompts
    • Generate some ODP audiences for my customer data.
    • Provide me with ideas for audiences I could create. 
odp_get_audience_list – Returns the list of existing real-time audience IDs within the connected ODP instance. See the Connections section in the Get started with Optimizely Opal for administrators.
  • When to use
    • You want to know existing real-time audiences.
    • You want to retrieve valid audience IDs before fetching details. 
  • What Opal produces
    • A list of audience IDs, without configuration or metadata. 
  • Example prompts
    • List all real-time audiences.
    • Show all existing audiences. 
odp_get_audience_by_id – Retrieves the full configuration and metadata for a specific real-time audience. 
  • When to use
    • You have an audience ID and want to inspect its definition.
    • You want metadata for the audience, such as author, version count, or creation date. 
  • Parameters
    • id – ID of the audience you want information about.
  • What Opal produces
    • The complete audience configuration and associated metadata. 
  • Example prompts
    • Get details for audience ID vip_customers_123.
    • Show me how this audience is defined.
create_odp_audiences – Creates a real-time audience based on a natural-language description.
  • When to use
    • You already know the audience you want to create and want ODP to configure it as a real-time audience.
    • You prefer to use natural language instead of providing a technical definition for your audience.
  • Parameters
    • user_query – The natural-language description of the real-time audience you want to create.
  • What Opal produces
    • A proposed audience definition built from your schema.
    • A confirmation step before the audience is actually created. No audience is created if the available ODP instance schema is unsupported by the query. 
  • Example prompts
    • Create an audience of VIP customers in the Nordics.
    • Build a real-time audience of users who made a purchase in the last 30 days.