Index fields marked Facetable not appearing as Facet Sources in Drupal UI

Created on 17 August 2024, about 1 year ago

Thank you for creating this great module!

Problem/Motivation

I am attempting to use this module to load faceted results from Azure AI Search resources. I am able to manually load defined facets via manually modifying the facets parameter. It seems this module does not yet support requesting facets nor displaying facet options. I will work around this issue, near term, with custom module code. I will try to propose patches, when possible.

Steps to reproduce

Define an Azure AI Search server & index with at least one Facetable field. Ensure the `facets` module is installed. Create a View that loads results from the defined Azure AI Search index. Visit `/admin/config/search/facets`. Note that the Facets module fails to find any facet sources.

Proposed resolution

When setting a field as Facetable in an index, it should automatically appear as a Facet Source & allow typical Facet configuration options. Queries sent to Azure AI Search should automatically include users' facet choices based on relevant Facets configuration.

Remaining tasks

Determine whether this functionality should be available by default, provided via a sub-module or another contrib module.

User interface changes

UI provided by Facets module should be positively affected based on automatic registration of Facet Sources by this module. If Facet Sources become available, users will be able to use Facets module to configure facets on Views pages reliant on Azure AI Search.

API changes

Query parameters will need to be modified to pass along built facet query strings.
See this documentation page for more information.

Data model changes

Data model changes will not be necessary.

πŸ› Bug report
Status

Active

Version

1.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States yesnoio

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @yesnoio
  • πŸ‡§πŸ‡ͺBelgium interx Flanders

    Thanks for your report. We have put it on the roadmap, the goal is indeed to also support facet API in one of the next releases.

  • πŸ‡§πŸ‡ͺBelgium interx Flanders
  • πŸ‡§πŸ‡ͺBelgium interx Flanders

    We have added basic support for facets in the 1.x branch. It should support the basic facets. It will be included in the upcoming release if no issues arise.

    Could you test it with your facets and see if everything still works without custom code? Some more special facets might need a different filter query syntax, but those cases can be added later.

  • πŸ‡ΊπŸ‡ΈUnited States sachit.thapa

    sachit.thapa β†’ made their first commit to this issue’s fork.

  • Assigned to interx
  • Status changed to Needs review 5 months ago
  • πŸ‡ΊπŸ‡ΈUnited States sachit.thapa

    sachit.thapa β†’ changed the visibility of the branch 3468697-index-fields-marked to hidden.

  • πŸ‡ΊπŸ‡ΈUnited States sachit.thapa

    @interx I tested with 1.x branch, and it failed to find the Views (created using Azure AI Search index) under the Facets.

  • πŸ‡ΊπŸ‡ΈUnited States adanielyan

    Can confirm the View with Azure AI Search index does not appear in the list of views on the Facets configuration page. Are there any additional steps one should take to make them appear?

  • First commit to issue fork.
  • Added a commit to the fork for setting search_api_facets as a supported feature in the backend class. With this, I was able to add a basic facet with the other changes.

  • @jacobsaw opened merge request.
Production build 0.71.5 2024