System tools for Optimizely Graph

4 min

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 Graph includes a set of system tools to help you with Content Management System-related tasks, such as managing content.

Note

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.

Note

The Optimizely Graph tools are available for CMS (SaaS), CMS 12 (PaaS), and CMS 13 (Paas) for users who also have Optimizely Graph.

When to use

List pinned results or pinned result collections in Optimizely Graph.

Add a pinned result collection and associate search phrases with a target content key.

Update a pinned result or a collection to change the priority or the active status.

Remove a pinned result or a pinned result collection.

Retrieve pinned results in a collection with filtering, sorting, and pagination.

Parameters

operation_id – The unique identifier for the pinned result operation.

0 – List all pinned results.

1 – List all pinned result collections.

2 – List pinned results in specific collection.

3 – Add or update pinned result collection.

4 – Remove pinned result collection.

5 – Add or update pinned result.

6 – Remove pinned result.

(Optional) collection_id – The unique identifier for the pinned result collection. Use this together with operation_id 2 or 3 (in case of update, leave blank in case of add), or 4.

(Optional) isActive – Specifies if the pinned result collection should be active. Use this together with operation_id 5.

(Optional) key – The key of the pinned result collection. Use this together with operation_id 5.

(Optional) language – The language the item will be added for. Use this together with operation_id 5.

(Optional) limit – Maximum number of items to return. Use this together with operation_id 0 and 2.

(Optional) offset – Number of items to skip for pagination. Use this together with operation_id 0 and 2.

(Optional) phrase – Filter items by phrase. Use this together with operation_id 0 and 2.

(Optional) phrases – The phrases to add. Use this together with operation_id 5.

(Optional) pinned_result_id – The unique identifier for the pinned result. Use this together with operation_id 5 (in case of update, leave blank in case of add), or 6.

(Optional) priority – The priority for the item. Use this together with operation_id 5.

(Optional) sort – Sort field (for example, "priority" or "created"). Use this together with operation_id 0 and 2.

(Optional) targetKey – The target key for the pinned result item. Use this together with operation_id 5.

(Optional) title – The title of the pinned result collection. Use this together with operation_id 5.

Example prompts

Show me the pinned result collections in Optimizely Graph.

Create a pinned result collection with the phrase "winter sale" that targets the key winter-promo-page.

Update the pinned result with ID 42 and set the priority to 1.

List the pinned results in collection 15, sorted by priority.

Remove the pinned result collection with ID 7.

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.

System tools for Optimizely Graph

graph_content_type_schema – Use as your starting point for understanding the content structure within your Optimizely Graph instance. The tool lets you and Opal discover available content types and their fields, which is crucial for constructing accurate GraphQL queries.

graph_content_graphql_executor – Execute custom GraphQL queries against your Optimizely Graph instance. You can retrieve specific content items, filter results, sort, and get aggregated data (facets).

graph_content_search_tool – Use as a simpler alternative for searching content in Optimizely Graph when constructing complex GraphQL queries might be excessive. It lets you search for content based on a search phrase across a specified content type.

graph_pinned_result – Manages pinned results and pinned result collections in Optimizely Graph. See Pinned resultsPinned results in the Optimizely Graph documentation.

graph_synonyms – Manages synonyms in Optimizely Graph. Synonyms help you find content using alternative terms. See SynonymsSynonyms in the Optimizely Graph documentation.