Highlight Search Results

// Make a full-text search dynamic query:
// ======================================
List<Employee> employeesResults = await asyncSession
     // Make a dynamic query on 'Employees' collection
    .Query<Employee>()
     // Search for documents containing the term 'sales' in their 'Notes' field
    .Search(x => x.Notes, "sales")
     // Request to highlight the searched term by calling 'Highlight'
    .Highlight(
        x => x.Notes, // The document-field name in which we search
        35,           // Max length of each text fragment
        4,            // Max number of fragments to return per document
        out Highlightings salesHighlights) // An out param for getting the highlighted text fragments
     // Execute the query
    .ToListAsync();

// Make a full-text search dynamic DocumentQuery:
// ==============================================
List<Employee> employeesResults = session.Advanced
     // Make a dynamic documentQuery on 'Employees' collection
    .DocumentQuery<Employee>()
     // Search for documents containing the term 'sales' in their 'Notes' field
    .Search(x => x.Notes, "sales")
     // Request to highlight the searched term by calling 'Highlight'
    .Highlight(
        x => x.Notes, // The document-field name in which we search
        35,           // Max length of each text fragment
        4,            // Max number of fragments to return per document
        out Highlightings salesHighlights) // An out param for getting the highlighted text fragments
     // Execute the documentQuery
    .ToList();

from "Employees"
where search(Notes, "sales")
include highlight(Notes, 35, 4)

// Define customized tags to use for highlighting the searched terms
// =================================================================
HighlightingOptions tagsToUse = new HighlightingOptions
{
    // Provide strings of your choice to 'PreTags' & 'PostTags', e.g.:
    // The first term searched for will be wrapped with '+++'
    // the second term searched for will be wrapped with '<<<' & '>>>'
    PreTags = new[] { "+++", "<<<" },
    PostTags = new[] { "+++", ">>>" }
};

// Make a full-text search dynamic query:
// ======================================
List<Employee> employeesResults = await asyncSession
    .Query<Employee>()
     // Search for:
     //   * documents containing the term 'sales' in their 'Notes' field
     //   * OR for documents containing the term 'manager' in their 'Title' field
    .Search(x => x.Notes, "sales")
    .Search(x => x.Title, "manager")
     // Call 'Highlight' for each field searched
     // Pass 'tagsToUse' to OVERRIDE the default tags used 
    .Highlight(x => x.Notes, 35, 1, tagsToUse, out Highlightings salesHighlights)
    .Highlight(x => x.Title, 35, 1, tagsToUse, out Highlightings managerHighlights)
    .ToListAsync();

from "Employees"
where (search(Notes, "sales") or search(Title, "manager"))
include highlight(Notes, 35, 1, $p0), highlight(Title, 35, 1, $p1)
{
"p0":{"PreTags":["+++","<<<"],"PostTags":["+++",">>>"]},
"p1":{"PreTags":["+++","<<<"],"PostTags":["+++",">>>"]}
}

// Make a full-text search dynamic query & project results:
// ========================================================
var employeesProjectedResults = await asyncSession
    .Query<Employee>()
     // Search for documents containing 'sales' or 'german' in their 'Notes' field
    .Search(x => x.Notes, "manager german")
     // Request to highlight the searched terms from the 'Notes' field 
    .Highlight(x => x.Notes, 35, 2, out Highlightings termsHighlights)
     // Define the projection
    .Select(x => new
    {
        // These fields will be returned instead of the whole document
        // Note: it is Not mandatory to return the field in which we search for the highlights 
        Name = $"{x.FirstName} {x.LastName}",
        x.Title
    })
    .ToListAsync();

from "Employees" as x
where search(x.Notes, "manager german")
select { Name : "{0} {1}".format(x.FirstName, x.LastName), Title : x.Title }
include highlight(Notes, 35, 2)