DocSearchHit

Type definitions for DocSearch hit objects returned from Algolia

DocSearchHit Types

DocSearch uses several hit type definitions to represent search results at different stages of processing. These types define the structure of search results returned from Algolia and how they’re used internally.

DocSearchHit

The primary type representing a search result from Algolia. This is the base hit type returned from search queries and includes all highlighting and snippet information.

objectID · string · required

Unique identifier for the search result.

content · string | null · required

The text content of the search result. May be null for hierarchy-only results.

query · string

The search query that produced this result.

url · string · required

Full URL to the page, including any anchor.

url_without_anchor · string · required

URL to the page without the anchor/hash portion.

type · ContentType · required

The type of content this hit represents.

type ContentType = 'askAI' | 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';

• askAI: Ask AI suggestion or result
• content: Regular page content
• lvl0 through lvl6: Hierarchical heading levels

anchor · string | null · required

The anchor/hash portion of the URL, if any.

Hierarchy

hierarchy · object · required

Hierarchical structure representing the page organization and headings.

Show Hierarchy Properties

lvl0 · string · required

Top-level heading (typically site name or main section).

lvl1 · string · required

Second-level heading (typically page title).

lvl2 · string | null · required

Third-level heading (subsection).

lvl3 · string | null · required

Fourth-level heading.

lvl4 · string | null · required

Fifth-level heading.

lvl5 · string | null · required

Sixth-level heading.

lvl6 · string | null · required

Seventh-level heading.

Example Hierarchy

{
  "lvl0": "Documentation",
  "lvl1": "Getting Started",
  "lvl2": "Installation",
  "lvl3": "React",
  "lvl4": null,
  "lvl5": null,
  "lvl6": null
}

Highlight Results

_highlightResult · DocSearchHitHighlightResult · required

Highlighting information showing which parts of the result matched the search query.

Show DocSearchHitHighlightResult Type

interface DocSearchHitHighlightResult {
  content: DocSearchHitAttributeHighlightResult;
  hierarchy: DocSearchHitHighlightResultHierarchy;
  hierarchy_camel: DocSearchHitHighlightResultHierarchy[];
}

content · DocSearchHitAttributeHighlightResult

Highlighting information for the content field.

hierarchy · DocSearchHitHighlightResultHierarchy

Highlighting information for each hierarchy level.

hierarchy_camel · DocSearchHitHighlightResultHierarchy[]

Alternative hierarchy highlighting format.

Show DocSearchHitAttributeHighlightResult Type

interface DocSearchHitAttributeHighlightResult {
  value: string;
  matchLevel: 'full' | 'none' | 'partial';
  matchedWords: string[];
  fullyHighlighted?: boolean;
}

value · string

The highlighted value with <mark> tags around matched portions.

matchLevel · 'full' | 'none' | 'partial'

Indicates how well the attribute matched the query.

matchedWords · string[]

Array of words that matched in this attribute.

fullyHighlighted · boolean

Whether the entire value was highlighted.

Show DocSearchHitHighlightResultHierarchy Type

interface DocSearchHitHighlightResultHierarchy {
  lvl0: DocSearchHitAttributeHighlightResult;
  lvl1: DocSearchHitAttributeHighlightResult;
  lvl2: DocSearchHitAttributeHighlightResult;
  lvl3: DocSearchHitAttributeHighlightResult;
  lvl4: DocSearchHitAttributeHighlightResult;
  lvl5: DocSearchHitAttributeHighlightResult;
  lvl6: DocSearchHitAttributeHighlightResult;
}

Contains highlight results for each hierarchy level (lvl0 through lvl6).

Snippet Results

_snippetResult · DocSearchHitSnippetResult · required

Snippet information showing contextual excerpts around matched terms.

Show DocSearchHitSnippetResult Type

interface DocSearchHitSnippetResult {
  content: DocSearchHitAttributeSnippetResult;
  hierarchy: DocSearchHitHighlightResultHierarchy;
  hierarchy_camel: DocSearchHitHighlightResultHierarchy[];
}

content · DocSearchHitAttributeSnippetResult

Snippet information for the content field.

hierarchy · DocSearchHitHighlightResultHierarchy

Snippet information for hierarchy levels.

hierarchy_camel · DocSearchHitHighlightResultHierarchy[]

Alternative hierarchy snippet format.

Show DocSearchHitAttributeSnippetResult Type

interface DocSearchHitAttributeSnippetResult {
  value: string;
  matchLevel: 'full' | 'none' | 'partial';
}

value · string

The snippet value with <mark> tags around matched portions.

matchLevel · 'full' | 'none' | 'partial'

Indicates how well the snippet matched the query.

Ranking Information

_rankingInfo · object

Optional ranking information from Algolia explaining why this result was ranked at its position.

Show Ranking Info Properties

promoted · boolean

Whether this result was promoted (boosted) in the ranking.

nbTypos · number

Number of typos in the matched query.

firstMatchedWord · number

Position of the first matched word.

proximityDistance · number

Distance between matched words.

geoDistance · number

Geographic distance (if geo search is used).

geoPrecision · number

Precision of the geo match.

nbExactWords · number

Number of exact word matches.

words · number

Word count metric.

filters · number

Filter matching score.

userScore · number

Custom user-defined score.

matchedGeoLocation · object

Geographic location that matched.

Show Properties

lat · number

Latitude.

lng · number

Longitude.

distance · number

Distance from search point.

Autocomplete Metadata

_distinctSeqID · number

Sequence ID for distinct results (used when distinct parameter is enabled).

__autocomplete_indexName · string

Internal: The index name this result came from.

__autocomplete_queryID · string

Internal: Query ID for analytics tracking.

__autocomplete_algoliaCredentials · object

Internal: Algolia credentials for analytics.

Show Properties

appId · string

Algolia application ID.

apiKey · string

Algolia API key.

__autocomplete_id · number

Internal: Autocomplete-assigned ID for this hit.

InternalDocSearchHit

Extends DocSearchHit with internal metadata used during rendering. This type is used internally by DocSearch components.

type InternalDocSearchHit = DocSearchHit & {
  __docsearch_parent: InternalDocSearchHit | null;
};

__docsearch_parent · InternalDocSearchHit | null

Reference to the parent hit in the hierarchy. Used to group related results and build breadcrumb navigation.

This creates a tree structure where child results can reference their parent headings.

StoredDocSearchHit

A lightweight version of DocSearchHit used for storing hits in localStorage (recent searches, favorites). Excludes highlight and snippet data to reduce storage size.

type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;

This type includes all properties of DocSearchHit except:

• _highlightResult: Highlighting information (excluded to save space)
• _snippetResult: Snippet information (excluded to save space)

Usage Examples

Transform Items

<DocSearch
  appId="YOUR_APP_ID"
  apiKey="YOUR_SEARCH_API_KEY"
  indexName="docs"
  transformItems={(items: DocSearchHit[]) => {
    // Filter out certain types
    return items.filter(item => item.type !== 'lvl6');
  }}
/>

Type Relationships

• DocSearchHit: Base type from Algolia searches
• InternalDocSearchHit: Adds parent references for rendering
• StoredDocSearchHit: Optimized for localStorage (no highlights/snippets)