Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Fix IndexStats returning attribute names instead of values #1095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
2mal3 wants to merge 3 commits into meilisearch:main
base: main
Choose a base branch
Loading
from BytezoTeam:index-stats-fix

Conversation

@2mal3
Copy link

@2mal3 2mal3 commented Apr 9, 2025 •
edited by coderabbitai bot
Loading

Related issue

Fixes #1094

What does this PR do?

  • make the __getattr__ method of the IndexStats class return the attribute value not its name
  • update incorrect tests for this behavior

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Summary by CodeRabbit

  • New Features

    • Added support for multiple new embedders, including OpenAI, HuggingFace, Ollama, REST-based, and user-provided embedders, allowing for flexible configuration of embedding sources.

  • Bug Fixes

    • Fixed an issue with attribute access in index statistics to correctly return the attribute value.

  • Tests

    • Updated tests to verify correct attribute access behavior in index statistics.

Copy link
Contributor

coderabbitai bot commented May 25, 2025 •
edited
Loading

"""

Walkthrough

The __getattr__ method in the IndexStats class was corrected to return attribute values from the internal dictionary, fixing attribute access. Several new embedder-related classes were introduced, each with specific configuration fields, along with an Embedders container class. Corresponding tests were updated to match the corrected __getattr__ behavior.

Changes

File(s) Change Summary
meilisearch/models/index.py Fixed IndexStats.__getattr__ to return attribute values; added OpenAiEmbedder, HuggingFaceEmbedder, OllamaEmbedder, RestEmbedder, UserProvidedEmbedder, and Embedders classes for embedder configuration.
tests/models/test_index.py Updated test to expect correct value from IndexStats.__getattr__ instead of attribute name.

Assessment against linked issues

Objective Addressed Explanation
__getattr__ of IndexStats returns attribute value, not the attribute name (#1094) ✅

Poem

In the burrow where code bunnies dwell,
We fixed a bug that users know well.
Now stats return true, not just a name—
And embedders hop in, each with their fame.
With fields and configs, our models expand,
A carrot for every coder in the land! 🥕
"""

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d0fc039 and d05426f.

📒 Files selected for processing (1)
  • meilisearch/models/index.py (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • meilisearch/models/index.py
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3f787ce and d0fc039.

📒 Files selected for processing (2)
  • meilisearch/models/index.py (2 hunks)
  • tests/models/test_index.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
meilisearch/models/index.py (1)
meilisearch/models/embedders.py (6)
  • OpenAiEmbedder (23-56)
  • HuggingFaceEmbedder (59-92)
  • OllamaEmbedder (95-128)
  • RestEmbedder (131-170)
  • UserProvidedEmbedder (173-191)
  • Embedders (204-213)
🪛 Ruff (0.11.9)
meilisearch/models/index.py

123-123: Undefined name Union

(F821)

🔇 Additional comments (2)
meilisearch/models/index.py (1)

22-25: LGTM! Core bug fix implemented correctly.

The fix properly returns the attribute value from self.__dict[attr] instead of returning the attribute name string. This addresses the main issue described in the PR objectives.

🧰 Tools
🪛 Ruff (0.11.9)

23-23: Use key in dict instead of key in dict.keys()

Remove .keys()

(SIM118)

tests/models/test_index.py (1)

8-10: Test correctly updated to match fixed behavior.

The test assertion now properly verifies that __getattr__("field1") returns the actual value "test 1" instead of the attribute name "field1". This aligns with the corrected IndexStats.__getattr__ implementation.

Comment on lines 67 to 124
class OpenAiEmbedder(CamelBase):
source: str = "openAi"
url: Optional[str] = None
model: Optional[str] = None # Defaults to text-embedding-3-small
dimensions: Optional[int] = None # Uses the model default
api_key: Optional[str] = None # Can be provided through a CLI option or environment variable
document_template: Optional[str] = None
document_template_max_bytes: Optional[int] = None # Default to 400
distribution: Optional[EmbedderDistribution] = None
binary_quantized: Optional[bool] = None


class HuggingFaceEmbedder(CamelBase):
source: str = "huggingFace"
model: Optional[str] = None # Defaults to BAAI/bge-base-en-v1.5
revision: Optional[str] = None
document_template: Optional[str] = None
document_template_max_bytes: Optional[int] = None # Default to 400
distribution: Optional[EmbedderDistribution] = None
binary_quantized: Optional[bool] = None


class OllamaEmbedder(CamelBase):
source: str = "ollama"
url: Optional[str] = None
api_key: Optional[str] = None
model: str
document_template: Optional[str] = None
document_template_max_bytes: Optional[int] = None # Default to 400
distribution: Optional[EmbedderDistribution] = None
binary_quantized: Optional[bool] = None


class RestEmbedder(CamelBase):
source: str = "rest"
url: str
api_key: Optional[str] # required for protected APIs
document_template: Optional[str] = None
document_template_max_bytes: Optional[int] = None # Default to 400
request: Dict[str, Any]
response: Dict[str, Any]
distribution: Optional[EmbedderDistribution] = None
headers: Optional[Dict[str, Any]] = None
binary_quantized: Optional[bool] = None


class UserProvidedEmbedder(CamelBase):
source: str = "userProvided"
dimensions: int
distribution: Optional[EmbedderDistribution] = None
binary_quantized: Optional[bool] = None


class Embedders(CamelBase):
embedders: Dict[
str,
Union[OpenAiEmbedder, HuggingFaceEmbedder, OllamaEmbedder, RestEmbedder, UserProvidedEmbedder],
]
Copy link
Contributor

@coderabbitai coderabbitai bot May 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Potential code duplication with existing embedder classes.

The embedder classes defined here (OpenAiEmbedder, HuggingFaceEmbedder, OllamaEmbedder, RestEmbedder, UserProvidedEmbedder, Embedders) appear to duplicate functionality that already exists in meilisearch/models/embedders.py based on the relevant code snippets provided. This could lead to maintenance issues and confusion about which classes to use.

Please verify if these classes are intended to replace the existing ones or if there's a different purpose for having them in both locations:

🏁 Script executed:

#!/bin/bash
# Description: Check for duplicate embedder class definitions across the codebase
# Expected: Find if these classes exist in multiple files
echo "Searching for embedder class definitions..."
rg -A 2 "class.*Embedder.*CamelBase" 
echo -e "\nSearching for Embedders container class..."
rg -A 2 "class Embedders"

Length of output: 2856

Consolidate duplicate embedder definitions
The OpenAiEmbedder, HuggingFaceEmbedder, OllamaEmbedder, RestEmbedder, UserProvidedEmbedder and Embedders classes live in both:

  • meilisearch/models/index.py (lines 67–124)
  • meilisearch/models/embedders.py

Maintaining two copies will lead to drift and confusion. Please remove or de-duplicate one set of definitions—ideally centralizing all embedder models in meilisearch/models/embedders.py (or vice versa)—and update any imports accordingly.

🧰 Tools
🪛 Ruff (0.11.9)

123-123: Undefined name Union

(F821)

🤖 Prompt for AI Agents 
In meilisearch/models/index.py around lines 67 to 124, the embedder classes
OpenAiEmbedder, HuggingFaceEmbedder, OllamaEmbedder, RestEmbedder,
UserProvidedEmbedder, and Embedders are duplicated from
meilisearch/models/embedders.py. To fix this, remove these class definitions
from index.py and update all imports in the codebase to reference the
centralized definitions in embedders.py, ensuring no duplicate embedder classes
remain.

Copy link
Member

@brunoocasali brunoocasali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there!

Can you remove the types you added in the models/index.py? We have a file exclusively made to hold those types.

And please next time, allow the maintainers to edit the PR :)

Thanks a lot!

@brunoocasali brunoocasali added the enhancement New feature or request label Jun 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@brunoocasali brunoocasali brunoocasali requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Stats of IndexStats Class not Accessible

AltStyle によって変換されたページ (->オリジナル) /