Skip to content

Composite embedders #5343

Closed

Description

@Kerollmops

Related product team resources: PRD (internal only)
Related product discussion:

Motivation

Search speed and latency reduction when using AI and embedders.

Usage

https://meilisearch.notion.site/Composite-embedder-usage-14a4b06b651f81859dc3df21e8cd02a0?pvs=4

TODO

Reminders when modifying the API

  • Update the openAPI file with utoipa:
    • If a new module has been introduced, create a new structure deriving the OpenAPI proc-macro and nest it in the main openAPI structure.
    • If a new route has been introduced, add the path decorator to it and add the route at the top of the file in its openAPI structure.
    • If a structure which is deserialized or serialized in the API has been introduced or modified, it must derive the schema or the IntoParams proc-macro.
      If it's a new structure you must also add it to the big list of structures in the main OpenApi structure.
    • Once everything is done, start Meilisearch with the swagger flag: cargo run --features swagger, open http://localhost:7700/scalar on your browser, and ensure everything works as expected.
    • For more info, refer to this presentation.

Reminders when modifying the Setting API

  • Ensure the new setting route is at least tested by the test_setting_routes macro
  • Ensure Analytics are fully implemented
  • Ensure the dump serializing is consistent with the /settings route serializing, e.g., enums case can be different (camelCase in route and PascalCase in the dump)

Special cases when adding a setting for an experimental feature

  • ⚠️ API stability: The setting does not appear on the main settings route when the feature has never been enabled (e.g. mark it Unset when returned from the index in this situation. See an example)
  • The setting cannot be set when the feature is disabled, either by the main settings route or the subroute (see validate_settings function)
  • If possible, the setting is reset when the feature is disabled (hard if it requires reindexing)

Impacted teams

@meilisearch/docs-team, @meilisearch/integration-team, @meilisearch/cloud-team

Activity

  1. added
    impacts cloudThis issue involves changes for the Meilisearch's cloud team
    impacts docsThis issue involves changes in the Meilisearch's documentation
    impacts integrationsThis issue involves changes in the Meilisearch's integrations
    on Feb 12, 2025
  2. added this to the v1.14.0 milestone on Feb 12, 2025
  3. linked a pull request that will close this issueComposite embedders #5371on Mar 4, 2025
  4. added 2 commits that reference this issue on Mar 5, 2025
    6c83a6c
    3fd86e8
  5. added 2 commits that reference this issue on Mar 11, 2025
    7819ac9
    d0dda78
  6. added
    v1.14.0PRs/issues solved in v1.14.0 released on 2025-04-14
    on Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    impacts cloudThis issue involves changes for the Meilisearch's cloud teamimpacts docsThis issue involves changes in the Meilisearch's documentationimpacts integrationsThis issue involves changes in the Meilisearch's integrationsv1.14.0PRs/issues solved in v1.14.0 released on 2025-04-14

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions