│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Query Editor

Control GrooperReview.Pages.Search

Provides an interactive environment for building, editing, and executing AI Search queries with advanced code editing features.

Remarks

The Query Editor control is a comprehensive interface for composing, refining, and executing search queries against Grooper's AI-powered search indexes. It is designed to support both novice and advanced users, offering a blend of code editing tools, AI-assisted query generation, and workflow integration for efficient search operations.

Overview

The Query Editor is typically presented as a central panel or tab within the search experience. It allows users to construct complex queries by editing the main search string, filters, field selection, and result ordering, each with its own dedicated code editor. Syntax highlighting, code completion, and contextual help are provided for each query component, making it easy to build valid and effective search expressions.

Key Features

  • Multi-Component Query Editing:

    • Edit the main search string using Lucene syntax in the {SearchEditor}, with real-time highlighting and suggestions.
    • Define OData-style filters in the {FilterEditor} to narrow search results, with contextual code completion.
    • Specify which fields to return in the {SelectEditor}, using completion for available fields.
    • Set the sort order for results in the {OrderByEditor}, supporting multiple fields and directions.

  • Action Buttons and AI Assistance:

    • {search}: Execute the current query and display results (Ctrl+R).
    • {new_query}: Clear all fields and reset the editor for a new query.
    • {build}: Use AI to generate a query from natural language input via the Query Helper.
    • {save}: Save the current query for future use or sharing.
    • {copy_link}: Copy a shareable link to the current query.

  • Advanced Code Editing:

    • Each editor supports syntax highlighting, code completion, and word wrap for efficient editing.
    • Contextual completion providers offer suggestions based on the selected index and query context.
    • Keyboard shortcuts and context menus accelerate query building and editing.

  • Seamless Workflow Integration:

    • Integrates with the Search Page, Query Helper, and Query List for a unified search experience.
    • Supports AI-powered query generation and direct execution against Grooper's AI Search infrastructure.

Interactive Components

  • Search Editor:

    • Edit the main search string with Lucene syntax, highlighting, and completion.

  • Filter Editor:

    • Compose OData-style filter expressions with syntax support and field suggestions.

  • Select Editor:

    • Choose which fields to include in the search results, with completion for available fields.

  • Order By Editor:

    • Define result sorting, supporting multiple fields and directions.

  • Action Buttons:

    • {search}, {new_query}, {build}, {save}, {copy_link} for query execution, management, and AI assistance.

Usage Guidance

  • Use the Query Editor to build and refine search queries for Grooper's AI Search indexes.
  • Leverage code completion and syntax highlighting to avoid errors and speed up query construction.
  • Use the {build} button to generate queries from natural language instructions, especially if you are unfamiliar with query syntax.
  • Save frequently used queries for easy reuse, and share query links with colleagues as needed.
  • Clear the editor with {new_query} to start a new search from scratch.

Accessibility

  • Fully navigable by keyboard and mouse.
  • Screen reader support for all editors, buttons, and query components.
  • Visual highlighting for focused editors and active buttons.

Example

┌────────────────── Query Editor ─────────────────┐
│ Search: {Search Editor}                         │
│ Filter: {Filter Editor}                         │
│ Select: {Select Editor}                         │
│ Order By: {Order By Editor}                     │
│                                                 │
│ {search} {new_query} {build} {save} {copy_link} │
└─────────────────────────────────────────────────┘

Command Buttons

ButtonShortcut KeySummary

Child Controls

NameTypeSummary

Used By

Search Page

Notification