Docs search sometimes fails to find results that are clearly there

Feedback Type:

  • [x] Bug Report
  • [ ] Feature Request
  • [ ] General Feedback

Feedback Description:
Docs search fails to find results for important search terms, e.g. verbatim API details already documented on docs.edgeimpulse.com.

Context/Use case:
Example 1: in docs.edgeimpulse.com, click on search bar, then enter “trained.savedmodel.zip” (with or without quotes, it doesn’t change much).
(NB. this is a filename mentioned on the “custom-deployment-blocks” page, copied verbatim.)

Example 2: click on search bar, then enter “X_split_test”.
(NB. this is a filename (excl. extension) currently mentioned on the “custom-learning-blocks” page; never mind that it’s incorrect/outdated, that’s what the page currently says.)

Expected behavior: the “custom-deployment-blocks” page (Example 1) or “custom-learning-blocks” page (Example 2) shows up in the list of results.

Observed behavior: the “custom-deployment-blocks” page (Example 1) or “custom-learning-blocks” page (Example 2) does not show up in the list of results. Instead, there’s a bunch of irrelevant fuzzy matches, most (all?) of which do not contain the search term.

Note that certain similar search terms from those pages do return a usable result (e.g. “trained.tflite”), but they generally rank very low (e.g. “trained.tflite” is the last result).

Problem to be Solved:
Docs search is broken.

Proposed Changes:
Fix docs search.

Potential Impact:
[Describe how this feedback will impact the site or user experience]

Related Issues or Feedback:
[List any related issues or feedback]

Additional Information:
Full URLs for docs pages referenced above have been omitted due to new user posting restrictions.

Thanks for the report @jiahsong - we’ll check this out.

cc: @brianmcfadden FYI.

@jiahsong - thanks for reporting. I have taken a look and, you’re right, pages are returned but not the ones that contain an exact match.

Also as you pointed out, adding quotes (which we would expect to represent looking for an exact match) doesn’t change much.

One thing that I noticed is that your first two search terms, trained.savedmodel.zip and X_split_test, that don’t return results only appear in code blocks on those pages, whereas the term you said does show up, trained.tflite, is in a code block and the general text. This leads me to believe the search algorithm is skipping code blocks.

The search algorithm is controlled by our documentation hosting platform. I have reached out to them with info you provided, and linked this forum post as well. Hopefully they can make some improvements.

1 Like