Retrieval-Augmented Generation (RAG) tools

4 min

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.

Note

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.

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.

Note

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

Retrieval-Augmented Generation (RAG) tools

RAG tools

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.

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.

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.

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.