SearchIndexDocument Pennington.Search

A single document entry in the search index.

Properties

Body string: Plain-text body used for full-text matching.
Description string?: Default: null
Front-matter description; boosted relative to body.
Headings string: Space-joined H1–H6 text from the rendered page; boosted relative to body.
Locale string: Locale code this document belongs to.
Priority int: Default: 0
Relative weight used to rank results; higher wins.
SectionLabel string?: Default: null
Optional section label shown in results.
Title string: Document title.
Url string: Canonical URL for the document.

Constructors

.ctor

public record SearchIndexDocument(
    string Title,
    string? Description,
    string Headings,
    string Body,
    string Url,
    string? SectionLabel,
    string Locale,
    int Priority
);

A single document entry in the search index.

Parameters

Title string: Document title.
Description string?: Front-matter description; boosted relative to body.
Headings string: Space-joined H1–H6 text from the rendered page; boosted relative to body.
Body string: Plain-text body used for full-text matching.
Url string: Canonical URL for the document.
SectionLabel string?: Optional section label shown in results.
Locale string: Locale code this document belongs to.
Priority int: Relative weight used to rank results; higher wins.

Pennington.Search.SearchIndexDocument

namespace Pennington.Search;

/// A single document entry in the search index.
public record SearchIndexDocument
{
    /// A single document entry in the search index.
    public record SearchIndexDocument(
    string Title,
    string? Description,
    string Headings,
    string Body,
    string Url,
    string? SectionLabel,
    string Locale,
    int Priority
);

    /// Plain-text body used for full-text matching.
    string Body;

    /// Front-matter description; boosted relative to body.
    string? Description;

    /// Space-joined H1–H6 text from the rendered page; boosted relative to body.
    string Headings;

    /// Locale code this document belongs to.
    string Locale;

    /// Relative weight used to rank results; higher wins.
    int Priority;

    /// Optional section label shown in results.
    string? SectionLabel;

    /// Document title.
    string Title;

    /// Canonical URL for the document.
    string Url;
}