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

Search Index

Resource Reference Grooper.GPT

Exposes a search index containing documents as a resource that an AI Assistant can use for document retrieval via semantic and standard search.

Remarks

The Search Index resource enables the AI Assistant to interact with search indexes containing documents, supporting both vector (semantic) and standard (keyword) search. This allows the assistant to retrieve information that is contextually relevant to user queries, not just based on exact keyword matches.

By configuring a Search Index resource, you empower the assistant to answer questions, retrieve documents, and perform knowledge discovery across large collections of content.

Usage and Configuration

To configure a Search Index resource:

  1. Specify the name of the search index to be exposed.
  2. Enable the desired search types: vector (semantic) search, standard (keyword) search, or both.
  3. Optionally, define logical subsets or filters to target specific document types or field values.
  4. Optionally, set a global filter to restrict all search queries to a subset of documents.

Once configured, the AI Assistant will use this resource to understand how to query the index and present relevant results to users. The assistant can leverage semantic search for context-aware retrieval or standard search for precise keyword-based lookups.

Example Use Cases

  • Answer user questions by retrieving the most relevant documents or passages from a large collection, using semantic search.
  • Perform keyword-based lookups, such as finding all documents containing a specific term or value.
  • Expose logical subsets of a search index (such as by document type or field value) to allow targeted retrieval.
  • Apply filters to restrict search results to a specific set of documents, such as those matching a certain status or date range.

Best Practices

  • Ensure the search index is properly configured and populated before exposing it to the AI Assistant.
  • Enable both vector and standard search to maximize retrieval flexibility and accuracy.
  • Use subsets and filters to tailor the search experience to your business needs and security requirements.
  • Regularly review and update the resource configuration if the underlying index or schema changes.

Diagnostics

Validation errors are logged if neither search type is enabled, or if vector search is enabled but not supported by the index. Additional diagnostic messages may be generated if search queries fail due to misconfiguration or connectivity issues.

Properties

NameTypeDescription

Context Menu Commands

Command Shortcut Description
data_array Generate Subsets Generates subset filters for a search index based on a selected field or document types.

See Also

Notification