Skip to content

Modules · Veva.Modules.SearchManager

Search the whole site.

The crawler reads your pages, documents, PDFs and Office files into one Lucene index. Search Manager lets you tune the ranking, pin results and see what visitors look for. Press Ctrl K to try it here.

dotnet add package Veva.Modules.SearchManager

What it does

Found on the first try.

A crawler you set up

Set the start address, the CSS selectors to read or skip, depth and threads. It reads HTML, PDF (PDFPig) and Word and Excel files (NPOI), and crawls pages again when they are published.

Search by meaning

Add an embedding package and set the search component to Hybrid Search. It finds the exact words, and pages that say the same in other words or another language.

Ranking you can tune

Boost title, content or address, turn on fuzzy matching, add synonyms and favour newer pages.

Results you choose

Moderated entries are results of your own, with a priority, for the queries that matter.

Search analytics

Top and trending queries, searches without results and click-through, exported as CSV.

Search on your pages

The Web search component shows results in your own design, filtered by category, tags, language or date.

How it works

From a crawl to a result.

  1. 01

    Crawl

    The crawl task reads the site from its start address and sitemap.

    WebsiteCrawlTask
  2. 02

    Read

    Readers turn HTML, PDF, Word and Excel into text to index.

    IDocumentReader
  3. 03

    Index

    Entries go into the search catalog and a Lucene index, and with an embedding package into a semantic index.

    Lucene.Net
  4. 04

    Query

    Queries run with your boosts, fuzzy matching and synonyms.

    ISearchIndexQueryService
  5. 05

    Show

    In the Web search component, or a palette like this site's Ctrl K.

For developers

Query the index from code.

This site's Ctrl K palette is a theme endpoint over ISearchIndexQueryService. The same service gives your own components results by query, tags, category and language.

Extension points

API

Query the index, read new kinds of files, supply synonyms:

  • ISearchIndexQueryService: queries the index
  • ISearchProviderService: runs a search with the site's settings
  • IDocumentReader: reads one kind of file for the crawler
  • ISynonymService: supplies synonyms
SearchManagerSiteSearch.cs
QueryResult? result = _index.Query(       // ISearchIndexQueryService
    request.Query,
    request.WebsiteId,
    Array.Empty<string>(),                // tags
    TagFilterType.Any,
    category: string.Empty,
    documentType: string.Empty,
    origin: string.Empty,
    language: string.Empty,
    pageNr: 1,
    pageSize: request.Take);

// result.Results: PageTitle, Url, MetaDescription, Content, DocumentType

Modules

What it is made of.

Each is a package of its own. Add it, restart, and set it up in the site's settings.

Module library

Search manager

Veva.Modules.SearchManager

The index, ranking, moderated results, search analytics and the Web search component.

Add-on
dotnet add package Veva.Modules.SearchManager

Search crawler

Veva.Modules.SearchCrawler

Crawls the site from its start address and sitemap into the Search manager's index.

Add-on
dotnet add package Veva.Modules.SearchCrawler

PDF files

Veva.Modules.Pdf.PDFPig

Lets the crawler index PDF files, and reads their metadata when they are uploaded to the library.

Add-on
dotnet add package Veva.Modules.Pdf.PDFPig

Word and Excel

Veva.Modules.Office.NPOI

Lets the crawler read and index Word and Excel files.

Add-on
dotnet add package Veva.Modules.Office.NPOI

Semantic search, on the server

Veva.Modules.SearchManager.Embeddings.Onnx

Semantic search with a multilingual embedding model run in the web process, on the CPU or the GPU. Nothing leaves the server.

Add-on
dotnet add package Veva.Modules.SearchManager.Embeddings.Onnx

Semantic search, through an API

Veva.Modules.SearchManager.Embeddings.OpenAiCompatible

Semantic search with an embedding model on another server, through an OpenAI-compatible embeddings API.

Add-on
dotnet add package Veva.Modules.SearchManager.Embeddings.OpenAiCompatible

Icelandic hyphenation

Veva.Modules.Arnastofnun

Hyphenates content on the server by Árnastofnun's Icelandic rules, and can stem Icelandic words in the search catalog.

Add-on
dotnet add package Veva.Modules.Arnastofnun

More of Veva

Explore the other features.

Each one is made of modules. Reference a package, restart, and its components are in the editor.

All features

Page builder

Compose pages from components, then preview and publish

Open

Components and data

Components that show, components that fetch, and the binding between them

Open

Documents

Structured content you list, filter and serve anywhere

Open

Forms

Document forms that save, generic forms that filter or post

Open

PDFs and signing

Form answers made into a PDF, downloaded or sent to be signed

Open

Assets

One media library, with images sized on request

Open

AI and agents

The admin's AI assistant, and the MCP server coding agents connect to

Open

Veva core

BuildVeva(), modules, components, themes and hooks

Open

Tech stack

Plain .NET Blazor: three render modes, standard components

Open

Integrations

Data sources, sign-in, mail, analytics and media

Open

Module library

Every module: what comes with Essentials, and the add-ons

Open

Type to search the docs, components and API.

↑↓ to move ↵ to open Esc to close Search by Veva