Root - Indexes

Overview

The {Open} button allows users to quickly navigate to the Content Type associated with the currently selected search index. This provides a seamless workflow for reviewing or editing the configuration of the content type that underlies a given index.

Usage Guidance

• Select a search index in the list.
• Click the {Open} button to navigate directly to the associated Content Type in the Grooper UI.
• The button is only enabled when a valid content type is associated with the selected index.

Overview

The {Delete} button removes the currently selected search index from the repository and the connected AI Search service. This action is irreversible and should be used with caution, as it will permanently delete the index and its data.

Usage Guidance

• Select a search index in the list.
• Click the {Delete} button to initiate deletion.
• A confirmation dialog will appear to prevent accidental deletion.
• The button is only enabled when a valid index is selected and can be deleted.

Overview

The {Show All} button toggles the index list between displaying only indexes associated with the current Grooper repository and all indexes available in the connected AI Search service. This is useful for environments where multiple repositories share a single AI Search instance, allowing users to distinguish between local and global indexes.

Usage Guidance

• Click the {Show All} button to switch between repository-only and all-index views.
• The button icon and label update to reflect the current mode.
• When enabled, additional indexes (not associated with the current repository) are shown in the list.

Overview

The 'Index List' control displays all search indexes available in the current Grooper repository in a dynamic, interactive table. It uses the Reflection List control to automatically generate columns for key index properties, including index name, associated Content Type, document count, storage size, and vector index size.

UI Components

• Dynamic Table:
  • Each row represents a search index, with columns for properties such as 'Index Name', 'Content Type', 'Document Count', 'Storage Size', and 'Vector Index Size'.
  • Columns are generated at runtime based on the properties of Search Index Info.
• Selection Controls:
  • Click to select an index.
  • Supports multi-select and keyboard navigation for efficient review and management.
• Row Attributes:
  • Rows include data attributes for index identification and filtering.
  • Visual cues highlight the selected index and indicate totals rows.

Interactive Features

• Select an index to view its details and enable toolbar actions.
• Use keyboard shortcuts for rapid navigation and selection.
• Filtering and sorting are available for large index lists.

Usage Guidance

Use the index list to review, select, and manage search indexes. Selecting an index enables actions such as opening the associated Content Type, deleting the index, or viewing its definition and statistics.

Example

┌─────────────┬──────────────┬─────────────┬──────────────┬──────────────────┐
│ Index Name  │ Content Type │ Doc Count   │ Storage Size │ Vector Index Size│
├─────────────┼──────────────┼─────────────┼──────────────┼──────────────────┤
│ Invoices    │ Invoice      │ 1,234       │ 0.25 GB      │ 0.10 GB          │
│ Orders      │ Order        │ 2,345       │ 0.40 GB      │ 0.15 GB          │
│ ...         │ ...          │ ...         │ ...          │ ...              │
└─────────────┴──────────────┴─────────────┴──────────────┴──────────────────┘

Overview

The 'Service Properties' control presents a property grid showing usage statistics and metrics for the connected AI Search service. This includes information such as total document count, storage consumption, and other service-level statistics.

UI Components

• Property Grid:
  • Displays key metrics and statistics for the AI Search service.
  • Organized for easy review and comparison.

Usage Guidance

Use this grid to monitor overall service usage, plan for capacity, and troubleshoot issues related to search indexing and storage.

Overview

The 'Index Definition' control uses the Code Editor to present the full JSON schema of the selected search index. This allows users to inspect the structure, fields, and configuration of the index in a formatted, syntax-highlighted view.

UI Components

• Read-Only Code Editor:
  • Displays the JSON definition with syntax highlighting.
  • Supports code navigation and selection, but editing is disabled.

Usage Guidance

Use this viewer to audit or troubleshoot the configuration of a search index.
The editor is read-only to prevent accidental changes to the index definition.

Overview

The 'Index Properties' control presents a property grid showing detailed properties and statistics for the currently selected search index. This includes document counts, storage usage, and other relevant metrics for the selected index.

Usage Guidance

Use this grid to review the configuration and status of a specific search index.
The grid updates automatically when a new index is selected in the list.