When creating Reports, instead of manually building complex logical rules, you can simply describe what you are looking for in plain English, and the AI Query Builder will generate a precise search query for you.
Availability: General Available. To get access to this feature it can be toggled on from the organization settings, provided you have Ardoq AI features enabled.
How to Use Query Assistant
1. Data Selection
Before creating a report query, you need to select what Workspaces you want to have in scope.
2. Describe your Query
The AI Query Builder is currently available in the Ardoq Report Builder, under the “Custom data query" section.
In the "Generate query with AI" input field, type a clear description of the data you want to find.
Example: "show all applications that have some reference to or from business capabilities".
As you begin typing, an auto-completion feature will suggest available Component Types and Field Types based on your input.
Note: Make sure to have selected Workspaces that correspond to what you’re searching for.
3. Generate and Review
Click Generate query. The AI will populate the search parameters, including:
Component Types: Automatically identifying the primary search object (e.g., Applications).
Logical Rules: Building the "And/Or" predicates and reference directions (To/From).
Gremlin query: For more advanced queries that can't be created using advanced search, the AI Query Builder will write a Gremlin query instead.
We currently only support Component search, so the AI Query Builder will not work if you want to construct a search query for references.
4. Refine Manually
The Query Assistant does the heavy lifting, but you remain in control. You can manually adjust any of the generated rules—such as changing reference types or adding subqueries—using the manual editor below the prompt.
Tips for Best Results
Be Specific: Use the exact names of component types as they appear in your selected workspaces. As mentioned above the feature will give you auto-completions as you write your query. Use those to make the query as specific as possible.
Confirm Scope: If the Assistant fails to find a specific component type, double-check your Data selection to ensure that workspace is included.
Verify Directions: Review the generated "To" and "From" logic to ensure it matches the actual flow of your data model.
Refine manually: Sometimes the AI manages to get some of the query correct but might miss a detail that you can just add manually.
Frequently Asked Questions
Does it support Gremlin? Currently, the feature supports Advanced search for components and simple Gremlin graph search queries.
Why are no results showing? Even if the query logic is correct, results will not appear if the relevant data is outside your current Data selection. Always verify your workspace sources first.
What if the query is incorrect? AI-generated queries can occasionally misinterpret complex phrasing. You can provide feedback using the "thumbs up/down" icons or refine the rules manually to correct the intent.
Limitations
The Query Assistant, while powerful, has certain constraints:
Scope Dependency: The Assistant is strictly limited to the workspaces selected in the Data selection panel. It cannot generate queries for data residing in unselected areas of your Ardoq environment.
Component Search Only: The Assistant currently supports generating queries for searching Components but does not support generating queries for searching References.
Limited Gremlin Support: AI generation feature will not create arbitrary Gremlin code. It will only create gremlin queries to accommodate graph traversal queries that are unsupported by Advanced search such as evaluating the field value one or two hops out ( e.g. Application components realizing Business Capability components with cost over $5,000,000).
Interpretation of Ambiguity: The AI relies on clear, unambiguous phrasing. Highly complex or vague natural language instructions may result in incorrect or incomplete generated query logic, requiring manual refinement.
No Data Structure Modification: The Assistant is a search tool only; it cannot create, modify, or delete components, references, or data structures within Ardoq.
No Parent-Child Filter Support: The Assistant does not support Hierarchical navigation as of now.
User Resolution: The Assistant does not automatically resolve user names to specific accounts. Queries involving user names (e.g., "Created by...") will default to an "Unknown name" state and require manual verification in the rule builder.