│ Grooper Help - Version 25.0
25.0.0023 2,165
  • Overview
  • Help Status

Query Helper

Control GrooperReview.Pages.Search

Provides an AI-powered dialog for generating AI Search queries from natural language, with support for voice input and index-aware guidance.

Remarks

The Query Helper control assists users in composing valid search queries for Azure AI Search by translating natural language questions into structured query syntax. Leveraging AI and index-aware guidance, it bridges the gap between user intent and complex search expressions, making advanced search capabilities accessible to users of all skill levels.

Overview

Query Helper is typically presented as a dialog or panel within the search interface. It allows users to enter questions or instructions in plain English, which the AI interprets and converts into Lucene search, OData $filter, Order By, and Select syntax for Azure AI Search. The control is index-aware, providing context and suggestions based on the selected Search Index definition.

Key Features

  • Natural Language Question Editor:

    • Enter questions or instructions in plain English using the text editor.
    • Supports word wrap and is pre-populated with your last question for convenience.
    • AI interprets your input and generates the appropriate search query syntax.

  • Voice Input:

    • Use the {talk} button or press F12 to activate voice recognition and dictate your question.
    • Transcribed text appears in the editor for review and editing.

  • Index Description:

    • Displays an AI-generated summary of the selected Search Index, including available fields and their types.
    • Helps users understand the structure of the index and craft more effective queries.

  • Field Explorer:

    • Browse index fields and complex types to inform your query construction.
    • Visual cues indicate field types and relationships.

  • AI-Powered Query Generation:

    • Instantly generates Lucene, OData, and other query syntax from your natural language input.
    • Reduces the need to memorize or reference query language documentation.

Interactive Components

  • Question Editor:

    • A code editor for entering and editing your question or search instruction.
    • Supports keyboard shortcuts, word wrap, and context menu actions.

  • Voice Input Button:

    • Click {talk} or press F12 to activate voice recognition for hands-free input.

  • Index Description Panel:

    • Shows a summary of the Search Index and its fields, helping you understand available options.

  • Field Explorer:

    • Allows you to browse and select fields, including support for complex types.

Usage Guidance

  • Use Query Helper to quickly generate valid search queries without needing to know Lucene or OData syntax.
  • Dictate your question using voice input for faster, hands-free operation.
  • Review the index description to ensure your queries target the correct fields and data types.
  • Edit or refine the generated query as needed before executing your search.

Accessibility

  • Fully navigable by keyboard and mouse.
  • Screen reader support for all controls, including the editor and field explorer.
  • Visual highlighting for focused controls and active voice input.

Example

┌───────────── Query Helper ────────────┐
│ {Index Description}                   │
│   Fields: Name, Date, Amount, ...     │
│---------------------------------------│
│ {Question Editor}                     │
│   "Show all invoices over $1000"      │
│                                {talk} │
└───────────────────────────────────────┘

Command Buttons

ButtonShortcut KeySummary

Child Controls

NameTypeSummary
Notification