If nobody has a better approach, I think I can extract a zip-file from my solution and share with you outside of my working hours.

https://github.com/nzdev/Examine/blob/v4/feature/v3-v4-api-compat/docs/v2/articles/configuration.md for docs

The fielddefintion specific to facets does need to be used. See https://github.com/nzdev/Examine/blob/v4/feature/v3-v4-api-compat/docs/v2/articles/configuration.md#facets-configuration the table

The config only needs to be on the index it's used for

// Create a config var facetsConfig = new FacetsConfig(); // Set field to be able to contain multiple values (This is default for a field in Examine. But you only need this if you are actually using multiple values for a single field) facetsConfig.SetMultiValued("MultiIdField", true); services.AddExamineLuceneIndex("MyIndex", // Set the indexing of your fields to use the facet type fieldDefinitions: new FieldDefinitionCollection( new FieldDefinition("Timestamp", FieldDefinitionTypes.FacetDateTime), new FieldDefinition("MultiIdField", FieldDefinitionTypes.FacetFullText) ), // Pass your config facetsConfig: facetsConfig );

I would raise a PR to umbraco, however I'm waiting on v4 being released.

gist is though to set your own directory factory in the lucene config with one of https://github.com/Shazwazza/Examine/blob/release/4.0/src/Examine.Lucene/Directories/SyncedFileSystemDirectoryFactory.cs or https://github.com/Shazwazza/Examine/blob/release/4.0/src/Examine.Lucene/Directories/TempEnvFileSystemDirectoryFactory.cs

That can be done without modifying umbraco

That overload will let you pass in the type for the directoryfactory

You are welcome

I eagerly await the blog post to make this simple for others 🙂

Now, I just need to figure out how - think I'm going to do a smaller example on one of the starter kits, and write a blog post 🙂

How would I go about searching for more than one facet? If I add

.GroupedOr(new [] { "myFacetField"}, new[] { "Facet1", "facet2" }).WithFacets(facets => facets.FacetString("myFacetField"))

I only get the already selected facets back on

result.GetFacet("myFacetField")

I'm speculating though

If anyone else is trying out faceted search with Examine, and is running into issues with not getting a full list of facets - be aware that by default it is set to only return the top 10 facets. This can however be configured by passing it along in the query:

query.WithFacets(facets => facets.FacetString($"productMarkings_{culture}", c => c.MaxCount(200)));

I swapped to the NuGet package on a project and reindexed. I still get the same facets and same search results - did you have anything more specific I should test? 🙂

It seems the method previously was named

Facet()

https://github.com/Shazwazza/Examine/pull/311/files#diff-fb375fe299a36165510b574c9ccb6e287eb49ccafcc5b2e05df0d367d5425df0 But now

FacetString()

,

FacetDoubleRange()

,

FacetFloatRange()

and

FacetLongRange()

.

I tried the v4 beta package on Umbraco Commerce demostore. https://github.com/umbraco/Umbraco.Commerce.DemoStore I can get facets of "price" field, but I think I need to configure the facet config in the indexing as well to make it work.

You will need to configure all fields that need to be used faceting on otherwise the indexing process won't index the facets. See https://github.com/Shazwazza/Examine/blob/release/4.0/docs/v2/articles/configuration.md

It would be great with Example how to enable facets for an existing index like

ExternalIndex

I think it is something like this, but when I set

UseTaxonomyIndex

here, it fails on startup.

I included this in

TransformIndexValues

:

if (e.ValueSet.Values.ContainsKey("price"))
{
    var prices = JsonConvert.DeserializeObject<Dictionary<Guid, string>>(e.ValueSet.GetValue("price").ToString());

    foreach (var price in prices)
    {
        var currency = _currencyService.GetCurrency(price.Key);

        values.Add($"price_{currency.Code}", new[] { price.Value });
    }
}

and updated to this:

public void Configure(string name, LuceneDirectoryIndexOptions options)
{
    switch (name)
    {
        case "ExternalIndex":

            var priceFields = new List<string>
            {
                "price_GBP"
            };

            // Create a config
            var facetsConfig = new FacetsConfig();

            foreach (var field in priceFields)
            {
                options.FieldDefinitions.AddOrUpdate(new FieldDefinition(field, FieldDefinitionTypes.FacetDouble));
                facetsConfig.SetIndexFieldName(field, $"facet_{field}");
            }

            options.FacetsConfig = facetsConfig;
            //options.UseTaxonomyIndex = true;

            break;
    }
}

Is it expected the

Value

property to has value 0 here?

The directory factories also need to be the new ones from examine 4, the ones in umbraco won't work with the taxonomy index

This is covered in the documentation

Facet ranges are also available as int64range and double range

Makes sense regarding taxonomy and the taxonomyfacet field types. Currently I am just playing with in in Umbraco Commerce demostore, which use the

ExternalIndex

by default as the products are based on Umbraco nodes. I think the price fields need to be splitted into separate fields to make it work with facets: https://github.com/umbraco/Umbraco.Commerce.DemoStore/pull/2

Regarding e.g.

DoubleRange()

.. should

minInclusive

and

maxInclusive

be

true

be default like it is with

RangeQuery<T>()

?

query.And().RangeQuery<long>(new[] { "myField" }, 0, 10);

I get some hits in facets now... I forgot to change the field name after extracting the fields from the original "price" field in Umbraco Commerce.

public sealed class ConfigureIndexOptions : IConfigureNamedOptions<LuceneDirectoryIndexOptions>
{
    public void Configure(string name, LuceneDirectoryIndexOptions options)
    {
        switch (name)
        {
            case Constants.UmbracoIndexes.ExternalIndexName:

                var priceFields = new List<string>
                {
                    "price_GBP"
                };

                // Create a config
                var facetsConfig = new FacetsConfig();

                foreach (var field in priceFields)
                {
                    options.FieldDefinitions.TryAdd(new FieldDefinition(field, FieldDefinitionTypes.FacetDouble));
                    facetsConfig.SetIndexFieldName(field, $"facet_{field}");
                }

                options.FacetsConfig = facetsConfig;
                //options.UseTaxonomyIndex = true;

                break;
        }
    }

    public void Configure(LuceneDirectoryIndexOptions options)
        => Configure(string.Empty, options);
}

Used Microsoft.CodeAnalysis.PublicApiAnalyzers to track compatibilty. Pretty neat.

gist is though to set your own directory factory in the lucene config with one of https://github.com/Shazwazza/Examine/blob/release/4.0/src/Examine.Lucene/Directories/SyncedFileSystemDirectoryFactory.cs or https://github.com/Shazwazza/Examine/blob/release/4.0/src/Examine.Lucene/Directories/TempEnvFileSystemDirectoryFactory.cs. This will allow Taxonomy mode to work

Might make sense to get Umbraco docs updated for how to do this as the Examine docs are generic to Examine.

Examine docs are way easy to contribute to now that they are on docfx. I'd encourage those in the thread to consider adding to the docs, easy as clicking the "Improve this doc" link on each page top right and clicking the pencil in github, make an edit and raise a pr

It would really help to have more examples of these faceting issues that have appeared in this thread documented.

From

FacetResult

is there any way to get the label/field/alias?

var results = query.OrderBy(new SortableField("name", SortType.String))
    .WithFacets(facets => facets
        .FacetLongRange("isGiftCard", new Int64Range[] {
            new Int64Range("no", 0, true, 1, false),
            new Int64Range("yes", 0, false, 1, true)
        })
        .FacetDoubleRange("price_GBP", new DoubleRange[] {
            new DoubleRange("0-10", 0, true, 10, true),
            new DoubleRange("11-20", 11, true, 20, true),
            new DoubleRange("20-30", 21, true, 30, true)
        })) // Get facets of the price field
    .Execute(QueryOptions.SkipTake(pageSize * (page - 1), pageSize));

IEnumerable<IFacetResult> facets = results.GetFacets();

In the model it cast to `IEnumerable`:

E.g. mapping the facets to facet groups. with the values. In a UCommerce project, we had something like this:

private IEnumerable<SearchFacetGroup> MapFacets(IList<Ucommerce.Search.Facets.Facet> facets)
{
    var mappedFacets = facets
        .Select(x => new SearchFacetGroup()
        {
            Name = GetFacetName(x),
            Facets = x.FacetValues.Select(f => new SearchFacet()
            {
                Count = f.Count,
                Name = f.Value
            })
            .OrderBy(f => f.Name)
        });
    return mappedFacets;
}

From

FacetResult

it doesn't seem we can tell which field it is related to? Or am I missing something? 😄

FYI I have something like this: https://github.com/umbraco/Umbraco.Commerce.DemoStore/pull/3 But using

GetFacets()

it seems I can't find which are related to

isGiftCard

and

price_GBP

... except I maybe can rely on index in collection?

I also noticed the

Value

property on

IFacetValue

which is the occurrence, but wouldn't

Hits

or

Count

make more sense? Not sure if there's a specific reason the type is

float

(decimal value) instead of

int

(without decimals)?

You should be able to enumerate the FacetResult by default without casting it https://github.com/Shazwazza/Examine/blob/release/4.0/src/Examine.Core/Search/FacetResult.cs#L26

But you are properly right there should be a way to get the name of the field the facets are on. One way to go about it is to use this method on the search result then you know exactly what values comes from what field: https://github.com/Shazwazza/Examine/blob/release/4.0/src/Examine.Lucene/FacetExtensions.cs#L16

So it needs to ensure the field exists on document, in this case I just needed to re-publish these product nodes.

@nzdev Would it be possible to use taxonomy faceting with e.g. existing

ExternalIndex

with eventually changes in Umbraco core? Sure we can add a new index, but it would basically be the same data which already exists in

ExternalIndex

and since Umbraco Commerce is based on product/content nodes and therefore use

ExternalIndex

. Also if one wanted to use taxonomy faceting on data in content tree, e.g. employees... or it could be media listed on a Press page with options to filter these.

Should be possible already

Hey, I am interested in your raw lucene approach! If you could share some details about it it would be great! 🙂

I found it: https://shazwazza.github.io/Examine/articles/configuration.html also info in Searching section