meilisearch/MeiliSearch
 Watch   
 Star   
 Fork   
8 days ago
MeiliSearch

v1.11.3 🐿️

What's Changed

Full Changelog: https://github.com/meilisearch/meilisearch/compare/v1.11.2...v1.11.3

9 days ago
MeiliSearch

v1.11.2 🐿️

What's Changed

Full Changelog: https://github.com/meilisearch/meilisearch/compare/v1.11.1...v1.11.2

16 days ago
MeiliSearch

v1.11.1 🐿️

What's Changed

Full Changelog: https://github.com/meilisearch/meilisearch/compare/v1.11.0...v1.11.1

2024-10-21 23:08:49
MeiliSearch

v1.11.0 🐿️

Meilisearch v1.11 introduces AI-powered search performance improvements thanks to binary quantization and various usage changes, all of which are steps towards a future stabilization of the feature. We have also improved federated search usage following user feedback.

🧰 All official Meilisearch integrations (including SDKs, clients, and other tools) are compatible with this Meilisearch release. Integration deployment happens between 4 to 48 hours after a new version becomes available.

Some SDKs might not include all new features. Consult the project repository for detailed information. Is a feature you need missing from your chosen SDK? Create an issue letting us know you need it, or, for open-source karma points, open a PR implementing it (we'll love you for that ❤️).

New features and updates 🔥

Experimental - AI-powered search improvements

This release is Meilisearch's first step towards stabilizing AI-powered search and introduces a few breaking changes to its API. Consult the PRD for full usage details.

Done by @dureuill in #4906, #4920, #4892, and #4938.

⚠️ Breaking changes

  • When performing AI-powered searches, hybrid.embedder is now a mandatory parameter in GET and POST /indexes/{:indexUid}/search
  • As a consequence, it is now mandatory to pass hybrid even for pure semantic searches
  • embedder is now a mandatory parameter in GET and POST /indexes/{:indexUid}/similar
  • Meilisearch now ignores semanticRatio and performs a pure semantic search for queries that include vector but not q

Addition & improvements

  • The default model for OpenAI is now text-embedding-3-small instead of text-embedding-ada-002
  • This release introduces a new embedder option: documentTemplateMaxBytes. Meilisearch will truncate a document's template text when it goes over the specified limit
  • Fields in documentTemplate include a new field.is_searchable property. The default document template now filters out both empty fields and fields not in the searchable attributes list:

v1.11:

{% for field in fields %}
  {% if field.is_searchable and not field.value == nil %}
    {{ field.name }}: {{ field.value }}\n
  {% endif %}
{% endfor %}

v1.10:

{% for field in fields %}
  {{ field.name }}: {{ field.value }}\n
{% endfor %}

Embedders using the v1.10 document template will continue working as before. The new default document template will only work with newly created embedders.

Vector database indexing performance improvements

v1.11 introduces a new embedder option, binaryQuantized:

curl \
  -X PATCH 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "embedders": {
      "image2text": {
        "binaryQuantized": true
      }
    }
  }'

Enable binary quantization to convert embeddings of floating point numbers into embeddings of boolean values. This will negatively impact the relevancy of AI-powered searches but significantly improve performance in large collections with more than 100 dimensions.

In our benchmarks, this reduced the size of the database by a factor of 10 and divided the indexing time by a factor of 6 with little impact on search times.

[!WARNING] Enabling this feature will update all of your vectors to contain only 1s or -1s, significantly impacting relevancy.

You cannot revert this option once you enable it. Before setting binaryQuantized to true, Meilisearch recommends testing it in a smaller or duplicate index in a development environment.

Done by @irevoire in #4941.

Federated search improvements

Facet distribution and stats for federated searches

This release adds two new federated search options, facetsByIndex and mergeFacets. These allow you to request a federated search for facet distributions and stats data.

Facet information by index

To obtain facet distribution and stats for each separate index, use facetsByIndex when querying the POST /multi-search endpoint:

POST /multi-search
{
  "federation": {
    "limit": 20,
    "offset": 0,
	"facetsByIndex": {
	  "movies": ["title", "id"],
	  "comics": ["title"],
	}
  },
  "queries": [
    {
      "q": "Batman",
      "indexUid": "movies"
    },
    {
      "q": "Batman",
      "indexUid": "comics"
    }
  ]
}

The multi-search response will include a new field, facetsByIndex with facet data separated per index:

{
  "hits": [],
  
  "facetsByIndex": {
      "movies": {
        "distribution": {
          "title": {
            "Batman returns": 1
          },
          "id": {
            "42": 1
          }
        },
        "stats": {
          "id": {
            "min": 42,
            "max": 42
          }
        }
      },}
}

Merged facet information

To obtain facet distribution and stats for all indexes merged into a single, use both facetsByIndex and mergeFacets when querying the POST /multi-search endpoint:

POST /multi-search
{

  "federation": {
    "limit": 20,
    "offset": 0,
	  "facetsByIndex": {
	    "movies": ["title", "id"],
	    "comics": ["title"],
	  },
	  "mergeFacets": {
	    "maxValuesPerFacet": 10,
	  }
  }
  "queries": [
    {
      "q": "Batman",
      "indexUid": "movies"
    },
    {
      "q": "Batman",
      "indexUid": "comics"
    }
  ]
}

The response includes two new fields, facetDistribution and facetStarts:

{
  "hits": [],
  
  "facetDistribution": {
    "title": {
      "Batman returns": 1
      "Batman: the killing joke":
    },
    "id": {
      "42": 1
    }
  },
  "facetStats": {
    "id": {
      "min": 42,
      "max": 42
    }
  }
}

Done by @dureuill in #4929.

Experimental — New STARTS WITH filter operator

Enable the experimental feature to use the STARTS WITH filter operator:

curl \
  -X PATCH 'http://localhost:7700/experimental-features/' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "containsFilter": true
  }'

Use the STARTS WITH operator when filtering:

curl \
  -X POST http://localhost:7700/indexes/movies/search \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "filter": "hero STARTS WITH spider"
  }'

🗣️ This is an experimental feature, and we need your help to improve it! Share your thoughts and feedback on this GitHub discussion.

Done by @Kerollmops in #4939.

Other improvements

  • Language support and localizedAttributes settings by @ManyTheFish in #4937
    • Add ISO-639-1 variants
    • Convert ISO-639-1 into ISO-639-3
  • Add a German language tokenizer by @luflow in meilisearch/charabia#303 and in #4945
  • Improve Turkish language support by @tkhshtsh0917 in meilisearch/charabia#305 and in #4957
  • Upgrade "batch failed" log to error level in #4955 by @dureuill.
  • Update the search UI: remove the forced capitalized fields, by @curquiza in #4993

Fixes 🐞

  • ⚠️ When using federated search, query.facets was silently ignored at the query level, but should not have been. It now returns the appropriate error. Use federation.facetsByIndex instead if you want facets to be applied during federated search.
  • Prometheus /metrics return the route pattern instead of the real route when returning the HTTP requests total by @irevoire in #4839
  • Truncate values at the end of a list of facet values when the number of facet values is larger than maxValuesPerFacet. For example, setting maxValuesPerFacet to 2 could result in ["blue", "red", "yellow"], being truncated to ["blue", "yellow"] instead of ["blue", "red"]`. By @dureuill in #4929
  • Improve the task cancellation when vectors are used, by @irevoire in #4971
  • Swedish support: the characters å, ä, ö are no longer normalized to a and o. By @ManyTheFish in #4945
  • Update rhai to fix an internal error when updating documents with a function (experimental) by @irevoire in #4960
  • Fix the bad experimental search queue size by @irevoire in #4992
  • Do not send empty edit document by function by @irevoire in #5001
  • Display vectors when no custom vectors were ever provided by @dureuill in #5008

Misc

  • Dependencies updates
    • Security dependency upgrade: bump quinn-proto from 0.11.3 to 0.11.8 by @dependabot in #4911
  • CIs and tests
    • Make the tests run faster by @irevoire in #4808
  • Documentation
    • Fix broken links in README by @iornstein in #4943
  • Misc
    • Allow Meilitool to upgrade from v1.9 to v1.10 without a dump in some conditions, by @dureuill in #4912
    • Fix bench by adding embedder by @dureuill in #4954
    • Revamp analytics by @irevoire in #5011

❤️ Thanks again to our external contributors:

2024-10-21 23:08:49
MeiliSearch

v1.11.0-rc.3 🐿️

[!WARNING] Since this is a release candidate (RC), we do NOT recommend using it in a production environment. Is something not working as expected? We welcome bug reports and feedback about new features.

Maintenance

2024-10-15 21:08:47
MeiliSearch

v1.11.0-rc.2 🐿️

[!WARNING] Since this is a release candidate (RC), we do NOT recommend using it in a production environment. Is something not working as expected? We welcome bug reports and feedback about new features.

Bugs Fixes

Experimental Features

See the release note of the v1.10.3 for more information about the two experimental cli flags that are being introduced in this RC.

Misc

Full Changelog: https://github.com/meilisearch/meilisearch/compare/v1.11.0-rc.1...v1.11.0-rc.2

2024-10-10 21:25:55
MeiliSearch

v1.10.3

Search improvements

This PR lets you configure two behaviors of the engine through experimental cli flags:

Done by @irevoire in https://github.com/meilisearch/meilisearch/pull/5000

Full Changelog: https://github.com/meilisearch/meilisearch/compare/v1.10.2...v1.10.3

2024-10-02 17:23:55
MeiliSearch

v1.11.0-rc.1 🐿️

[!WARNING] Since this is a release candidate (RC), we do NOT recommend using it in a production environment. Is something not working as expected? We welcome bug reports and feedback about new features.

What's Changed

Misc

Full Changelog: https://github.com/meilisearch/meilisearch/compare/v1.11.0-rc.0...v1.11.0-rc.1

2024-09-24 00:19:53
MeiliSearch

v1.10.2 🦩

Fixes 🦋

Activate the Swedish tokenization Pipeline

The Swedish tokenization pipeline were deactivated in the previous versions, now it is activated when specifying the index Language in the settings:

PATCH /indexes/:index-name/settings

{
  "localizedAttributes": [ { "locales": ["swe"], "attributePatterns": ["*"] } ]
}

related PR: #4949

2024-09-20 03:22:04
MeiliSearch

v1.11.0

[!WARNING] Since this is a release candidate (RC), we do NOT recommend using it in a production environment. Is something not working as expected? We welcome bug reports and feedback about new features.

Meilisearch v1.11 introduces several changes about hybrid search: usage improvements to prepare a future stabilization of the feature, but also a huge impact on the performance thanks to the binary quantization. Finally, according to your feedback, we improved the federated search usage.

New features and updates 🔥

Experimental - Hybrid search improvements

For a future stabilization, multiple changes have been applied to hybrid search features.

📖 More details about the usage in this page.

Done by @dureuill in #4906, #4920, #4892, and #4938.

⚠️ Breaking changes

  • When using the semantic or the hybrid search, hybrid.embedder is now a mandatory parameter in GET and POST /indexes/{:indexUid}/search
  • As a consequence, it is now mandatory to pass hybrid even for full-vector search (with only vector and not q)
  • embedder is now a mandatory parameter in GET and POST /indexes/{:indexUid}/similar
  • Ignore non-zero semanticRatio when vector is passed but not q: a semantic search will be performed.

Addition & improvements

  • The default model for OpenAI is now text-embedding-3-small instead of text-embedding-ada-002.
  • Limit the maximum length of a rendered document template: when the source of an embedder is set to huggingFace, openAi, rest or ollama, then documentTemplateMaxBytes is now available as an optional parameter. This parameter describes the number of bytes in which the rendered document template text should fit when trying to embed a document. Longer texts are truncated to fit.
  • Add the ability to query whether a field is searchable in documentTemplate: use field.is_searchable: true if the field is a searchable attribute, otherwise false.
  • The new document template changed to
    • filter out fields that are not searchable
    • filter out fields that are nil or missing for the current document

v1.10 and before:

{% for field in fields %}
{{ field.name }}: {{ field.value }}\n
{% endfor %}

From v1.11:

{% for field in fields %}
{% if field.is_searchable and not field.value == nil %}
{{ field.name }}: {{ field.value }}\n
{% endif %}
{% endfor %}

This last change is backward compatible. Embedders that use the v1.10 document template will keep using it. The new default document template will only be applied to newly added embedders.

Speed up indexing of your vector database with binary quantization

The binary quantization converts your embeddings of floating point numbers (using 32 bits) into embeddings of boolean values (using 1 bit). In our benchmarks, it reduced the size of the database by a factor of 10, and divided the indexing time by a factor of 6 without much impact on the search time.

[!WARNING] Enabling this feature will update all of your vectors to contain only 1s or -1s, impacting the relevancy significantly. Once enabled, there is no coming back. Before trying it out on your main index, you should try the feature on a smaller index to ensure it fits your use case.

Although this feature degrades the relevancy of the semantic searches, it showed great results on collections with many dimensions (> 1300) and many points (more than 100000).

Enable the binary quantization by updating the settings of your embedder with:

curl \
  -X PATCH 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "embedders": {
      "image2text": {
        "binaryQuantized": true
      }
    }
  }'

Done by @irevoire in #4941.

Federated search improvements

Request by-index facet distribution and stats

Request facet distributions and facet stats in your federated search, by using federation.facetsByIndex in the POST POST /multi-search route.

By default the distribution and stats are returned for each index that participates in the federated search.

POST /multi-search
{
  "federation": {
    "limit": 20,
    "offset": 0,
	"facetsByIndex": {
	  "movies": ["title", "id"],
	  "comics": ["title"],
	}
  },
  "queries": [
    {
      "q": "Batman",
      "indexUid": "movies"
    },
    {
      "q": "Batman",
      "indexUid": "comics"
    }
  ]
}

Request merged facet distribution and stats

Merge the returned facets in a single facet distribution and stats that is global to the entire request, by using federation.mergeFacets in the POST POST /multi-search route.

The number of returned values can be limited for all facets with federation.mergeFacets.maxValuesPerFacet.

POST /multi-search
{

  "federation": {
    "limit": 20,
    "offset": 0,
	  "facetsByIndex": {
	    "movies": ["title", "id"],
	    "comics": ["title"],
	  },
	  "mergeFacets": {
	    "maxValuesPerFacet": 10,
	  }
  }
  "queries": [
    {
      "q": "Batman",
      "indexUid": "movies"
    },
    {
      "q": "Batman",
      "indexUid": "comics"
    }
  ]
}

Done by @dureuill in #4929.

Experimental - STARTS_WITH operator during search

Enable the experimental feature to use the STARTS_WITH filter operator:

curl \
  -X PATCH 'http://localhost:7700/experimental-features/' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "containsFilter": true
  }'

Use the STARTS_WITH operator when filtering:

curl \
  -X POST http://localhost:7700/indexes/movies/search \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "filter": "hero STARTS_WITH spider"
  }'

🗣️ This is an experimental feature, and we need your help to improve it! Share your thoughts and feedback on this GitHub discussion.

Done by @Kerollmops in #4939.

Other improvements

Fixes 🐞

  • ⚠️ When using federated search, query.facets was silently ignored at the query level, but should not have been. It now returns the appropriate error. Use federation.facetsByIndex instead if you want facets to be applied during federated search.
  • In prometheus metrics return the route pattern instead of the real route when returning the HTTP requests total by @irevoire in #4839
  • Always truncate values at the end of the list of facet values when the number of facet values is larger than the index setting faceting.maxValuesPerFacet. For example, for the facet values ordered alphabetically ["blue", "red", "yellow"], setting faceting.maxValuesPerFacet sometimes resulted in ["blue", "yellow"] instead of ["blue", "red"]`. By @dureuill in #4929
  • Fix Swedish support: the characters å/ä/ö are not normalized like the a/o characters anymore. By @ManyTheFish in #4945

Misc

  • Dependencies updates
    • Security dependency upgrade: bump quinn-proto from 0.11.3 to 0.11.8 by @dependabot in #4911
  • CIs and tests
    • Make the tests run faster by @irevoire in #4808
  • Documentation
    • Fix broken links in README by @iornstein in #4943
  • Misc
    • Allow Meilitool to dumplessly, offline upgrade v1.9 -> v1.10 in some conditions by @dureuill in #4912

❤️ Thanks again to our external contributors: