Skip to content

Global Search

Usage

Consumers query Global Search through its query API.

The API supports querying one or more indices and returns search results from the indexed search documents.

Query scenarios

Global Search can be used for:

  • broad text search across all indexed data
  • scoped search against selected indices
  • autocomplete or suggestion experiences
  • quick lookup from UI search bars, pickers, and navigation dialogs

Search capabilities

The feature is intended to support the following capabilities:

Full-text search

Allows callers to search for a term across indexed documents.

This is the default capability for global lookup scenarios where the caller wants to find matching documents without knowing the exact field in advance.

Queries can be executed against:

  • all indices
  • a selected subset of indices

This allows the same API to support both broad global search and more focused search experiences.

Autocomplete / suggestions

Supports prefix-based suggestion scenarios for interactive UIs.

This is useful for:

  • search bars
  • entity pickers
  • quick navigation
  • type-ahead experiences

Relevance scoring

Results are returned with a score so consumers can order matches by relevance.

Raw source retrieval

Search results return the indexed source document, allowing the consumer to render the result using the search projection without requiring an immediate follow-up call to the source service.

Typical query inputs

A search request usually includes:

  • the search term
  • optional target indices
  • optional result size or take limit

An autocomplete request usually includes:

  • the typed prefix
  • optional target indices
  • suggestion size

Typical query outputs

A search result typically includes:

  • index name
  • document identifier
  • relevance score
  • indexed source payload

A suggestion result typically includes:

  • suggestion text
  • related document identifier
  • source index

Use Global Search when the caller needs:

  • fast lookup across services or entity types
  • search-first navigation
  • autocomplete suggestions
  • a unified search entry point