> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/algolia/docsearch/llms.txt > Use this file to discover all available pages before exploring further. # 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. Unique identifier for the search result. The text content of the search result. May be null for hierarchy-only results. The search query that produced this result. Full URL to the page, including any anchor. URL to the page without the anchor/hash portion. The type of content this hit represents. ```typescript theme={null} 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 The anchor/hash portion of the URL, if any. ### Hierarchy Hierarchical structure representing the page organization and headings. Top-level heading (typically site name or main section). Second-level heading (typically page title). Third-level heading (subsection). Fourth-level heading. Fifth-level heading. Sixth-level heading. Seventh-level heading. ```json Example Hierarchy theme={null} { "lvl0": "Documentation", "lvl1": "Getting Started", "lvl2": "Installation", "lvl3": "React", "lvl4": null, "lvl5": null, "lvl6": null } ``` ### Highlight Results Highlighting information showing which parts of the result matched the search query. ```typescript theme={null} interface DocSearchHitHighlightResult { content: DocSearchHitAttributeHighlightResult; hierarchy: DocSearchHitHighlightResultHierarchy; hierarchy_camel: DocSearchHitHighlightResultHierarchy[]; } ``` Highlighting information for the content field. Highlighting information for each hierarchy level. Alternative hierarchy highlighting format. ```typescript theme={null} interface DocSearchHitAttributeHighlightResult { value: string; matchLevel: 'full' | 'none' | 'partial'; matchedWords: string[]; fullyHighlighted?: boolean; } ``` The highlighted value with `` tags around matched portions. Indicates how well the attribute matched the query. Array of words that matched in this attribute. Whether the entire value was highlighted. ```typescript theme={null} 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 Snippet information showing contextual excerpts around matched terms. ```typescript theme={null} interface DocSearchHitSnippetResult { content: DocSearchHitAttributeSnippetResult; hierarchy: DocSearchHitHighlightResultHierarchy; hierarchy_camel: DocSearchHitHighlightResultHierarchy[]; } ``` Snippet information for the content field. Snippet information for hierarchy levels. Alternative hierarchy snippet format. ```typescript theme={null} interface DocSearchHitAttributeSnippetResult { value: string; matchLevel: 'full' | 'none' | 'partial'; } ``` The snippet value with `` tags around matched portions. Indicates how well the snippet matched the query. ### Ranking Information Optional ranking information from Algolia explaining why this result was ranked at its position. Whether this result was promoted (boosted) in the ranking. Number of typos in the matched query. Position of the first matched word. Distance between matched words. Geographic distance (if geo search is used). Precision of the geo match. Number of exact word matches. Word count metric. Filter matching score. Custom user-defined score. Geographic location that matched. Latitude. Longitude. Distance from search point. ### Autocomplete Metadata Sequence ID for distinct results (used when `distinct` parameter is enabled). Internal: The index name this result came from. Internal: Query ID for analytics tracking. Internal: Algolia credentials for analytics. Algolia application ID. Algolia API key. Internal: Autocomplete-assigned ID for this hit. ## InternalDocSearchHit Extends `DocSearchHit` with internal metadata used during rendering. This type is used internally by DocSearch components. ```typescript theme={null} type InternalDocSearchHit = DocSearchHit & { __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. ```typescript theme={null} type StoredDocSearchHit = Omit; ``` This type includes all properties of `DocSearchHit` except: * `_highlightResult`: Highlighting information (excluded to save space) * `_snippetResult`: Snippet information (excluded to save space) ## Usage Examples ```tsx Transform Items theme={null} { // Filter out certain types return items.filter(item => item.type !== 'lvl6'); }} /> ``` ```tsx Custom Hit Component theme={null} { const internalHit = hit as InternalDocSearchHit; return (

{hit.hierarchy.lvl0} › {hit.hierarchy.lvl1}

{children} ); }} /> ``` ```tsx Access Highlight Results theme={null} function processHits(items: DocSearchHit[]) { items.forEach(hit => { // Access highlighted content const highlightedContent = hit._highlightResult.content.value; // Check match quality const matchLevel = hit._highlightResult.content.matchLevel; // Get matched words const matchedWords = hit._highlightResult.content.matchedWords; console.log({ highlightedContent, matchLevel, matchedWords }); }); } ``` ## Type Relationships ```mermaid theme={null} graph TD A[DocSearchHit] --> B[InternalDocSearchHit] A --> C[StoredDocSearchHit] B --> D[Used in hitComponent] B --> E[Used in resultsFooterComponent] C --> F[Stored in localStorage] A --> G[Used in transformItems] ``` * **DocSearchHit**: Base type from Algolia searches * **InternalDocSearchHit**: Adds parent references for rendering * **StoredDocSearchHit**: Optimized for localStorage (no highlights/snippets)