Retrieval-Augmented Generation (RAG) tools

  • Updated

This page lists the built-in Optimizely Opal tools provided and maintained by Optimizely for Retrieval-Augmented Generation (RAG). You and Opal can call these tools if they are enabled. Review the tools so you can see what actions are available for you and your workflows.

RAG tools only display on Opal instances where RAG is provisioned.

RAG tools

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.

rag_retrieve_from_canvas – Searches your canvas artifacts by topic and returns the ones that match. Results include only the artifacts you have permission to see.
  • When to use
    • Find an artifact by topic when you do not remember its name.
    • Pull context from earlier work into a new request.
    • Search inside one space or one artifact.
    • Review what you created about a subject across every space.
    • Find the notes or documents that relate to a project.
  • Parameters
    • query – The topic to find, written in plain language. Search matches meaning rather than exact wording, so describe the subject instead of guessing at a title.
    • (Optional) element_id – Limits the search to one artifact. Use this value when you reference an artifact you already identified.
    • (Optional) space_ids – Limits the search to the spaces you name. Omit this value to search every space you access.
    • (Optional) thread_id – Limits the search to one space. Omit this value to search every space you access.
    • (Optional) chat_history – Earlier conversation context for a follow-up question. Opal supplies this value.
    • (Optional) chat_thread_id – The conversation ID that Opal records for tracing. Opal supplies this value.
    • (Optional) agent_execution_id – The run ID that Opal records for tracing. Opal supplies this value.
  • Example prompts
    • Find my notes about the launch plan.
    • Which documents do I have about our third quarter goals?
    • Search my product space for the onboarding checklist.
    • What did I write about pricing last month?
rag_retrieve_from_cmp – Searches your Optimizely Content Marketing Platform (CMP) data, campaigns, tasks, assets, work requests, and briefs, using semantic similarity and SQL-based queries. Returns results as structured data for use in conversation responses.
  • When to use
    • Finding specific campaigns, tasks, or assets in CMP.
    • Retrieving campaign briefs or task details.
    • Searching content across your CMP workspace by topic, label, or category.
    • Pulling context for content creation or planning.
    • Answering questions like "our blogs", "assets assigned to me", or "overdue tasks".
  • Parameters
    • query – Natural language description of the content to find. Example: "Find campaigns related to summer marketing".
    • (Optional) resource_types – Filter by resource type: asset, campaign, task, work_request.
    • (Optional) asset_types – Filter by asset type: image, video, pdf, article, and so on.
    • (Optional) status – Filter by status values such as On Hold, Overdue, In Progress, Done.
    • (Optional) assignees – Filter by assignee name, email, or ID.
    • (Optional) owners – Filter by owner name, email, or ID.
    • (Optional) creators – Filter by creator name, email, or ID.
    • (Optional) date_filters – Date range filters specifying a field, start date, and end date.
    • (Optional) field_filters – Custom field or label filters using a field ID and value.
    • (Optional) limit – Maximum number of results to return.
    • (Optional) chat_history – Previous conversation context for multi-turn queries.
    • (Optional) thread_id – Thread ID for conversation tracking.
    • (Optional) agent_execution_id – Agent execution ID for request tracing.
  • Example prompt
    • Show me all overdue tasks assigned to Sarah.
    • What campaigns are currently at risk?
    • Find all video assets created this month related to our product launch.
rag_retrieve_from_cmp_as_csv – Searches your Optimizely CMP data, campaigns, tasks, assets, work requests, and briefs, using semantic similarity and SQL-based queries. Returns results as tabular CSV data. 
  • When to use
    • When you want a table, spreadsheet, or CSV export of your CMP data.
    • The results need to be processed as structured tabular data.
  • Parameters
    • query – Natural language description of the content to find. Example: "All assets created in Q3".
    • (Optional) resource_types – Filter by resource type: asset, campaign, task, work_request.
    • (Optional) asset_types – Filter by asset type: image, video, pdf, article, and so on.
    • (Optional) status – Filter by status values such as On Hold, Overdue, In Progress, Done.
    • (Optional) assignees – Filter by assignee name, email, or ID.
    • (Optional) owners – Filter by owner name, email, or ID.
    • (Optional) creators – Filter by creator name, email, or ID.
    • (Optional) date_filters – Date range filters specifying a field, start date, and end date.
    • (Optional) field_filters – Custom field or label filters using a field ID and value.
    • (Optional) limit – Maximum number of results to return.
    • (Optional) chat_history – Previous conversation context for multi-turn queries.
    • (Optional) thread_id – Thread ID for conversation tracking.
    • (Optional) agent_execution_id – Agent execution ID for request tracing.
  • Example prompt
    • Export a table of all image assets tagged with 'brand' created last month.
    • Give me a report of all in-progress tasks assigned to the design team this quarter.
    • Export all work requests submitted in the last 30 days.
rag_retrieve_from_cmp_for_mcp – Searches your Optimizely CMP workspace for campaigns, tasks, assets, work requests, and briefs. Opal returns a summarized answer with the title, status, owner, and link for each record. Each filter you add narrows the results further.
  • When to use
    • Find campaigns, tasks, or assets by topic.
    • Review the work assigned to a person or a team.
    • Check the status of items in your workspace.
    • Find a past campaign or brief that informs new work.
    • Narrow results by date, owner, folder, or file type.
  • Parameters
    • query – What you want to find, written as a plain-language search phrase.
    • (Optional) resource_types – Limits the search to asset, campaign, task, or work_request. Omit this value to search every type.
    • (Optional) asset_types – Limits asset results to file types, including image, video, pdf, docx, pptx, article, markdown, plaintext, raw_file, and structured_content.
    • (Optional) assignees – Limits results to the tasks and work requests assigned to the people you name. Use a full name, an email address, or a user ID.
    • (Optional) owners – Limits results to the items owned by the people you name.
    • (Optional) creators – Limits results to the items created by the people you name.
    • (Optional) status – Limits results to a workflow status, such as completed, in_progress, accepted, or draft. Your organization defines the available values.
    • (Optional) date_filters – Limits results to a date range. Available date fields are created_at, last_modified, due_date, start_date, end_date, completed_date, and expires_at.
    • (Optional) field_filters – Limits results by a custom field or a label.
    • (Optional) folders – Limits results to the folders you name. Opal includes the items in subfolders.
    • (Optional) limit – The number of results to return. Defaults to about 10 for a topic search and up to 100 for a list request.
    • (Optional) cmp_org_sso_id – The CMP workspace to search. Set this value only when your account connects to more than one workspace.
    • (Optional) chat_history – Earlier conversation context for a follow-up question. Opal supplies this value.
    • (Optional) chat_thread_id – The conversation ID that Opal records for tracing. Opal supplies this value.
    • (Optional) agent_execution_id – The run ID that Opal records for tracing. Opal supplies this value.
  • Example prompts
    • Find campaigns related to summer marketing.
    • Show me the tasks assigned to the design team.
    • Which assets do we have for product launches?
    • List the PDFs in the Brand Assets folder created this quarter.
    • Show me the top five overdue tasks.
rag_retrieve_from_optimizely_graph – Search for relevant information in your CMP and Content Management System (CMS) data using RAG for Optimizely Graph. The tool provides powerful search, filtering, and content delivery capabilities for your applications. The tool can return both structured documents (like content items) and unstructured analytical data, depending on your query.
  • When to use
    • Search for content across your Optimizely products (CMS, CMP).
    • Find specific content, such as articles, products, or experiments.
    • Get analytics or summary data from Optimizely Graph.
    • Power headless content delivery for mobile or web applications.
  • Parameters
    • query – Search query to find relevant application data in CMP or CMS.
    • (Optional) chat_history – Previous conversation context for better search results.
    • (Optional) thread_id – Thread identifier for conversation continuity.
  • Example prompts
    • Find content related to 'winter promotions'.
    • Show me analytics for the latest homepage experiment.
    • What features are enabled for US users?

If you use Opti ID, administrators can turn off generative AI in the Opti ID Admin Center. See Turn generative AI off across Optimizely applications.