Skip to content

Conversation

@aznszn
Copy link
Contributor

@aznszn aznszn commented Jan 29, 2026

Pull Request

What does this PR do?

Some code samples were missing, adding these makes it easy to follow the guide with the Python SDK

  • Added all missing code samples from the reference section on the meilisearch website

PR checklist

Please check if your PR fulfills the following requirements:

  • Did you use any AI tool while implementing this PR (code, tests, docs, etc.)? If yes, disclose it in the PR description and describe what it was used for. AI usage is allowed when it is disclosed.

I did not use AI

  • 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

  • Documentation
    • Added code examples for negative search queries.
    • Added examples showing hybrid and vector search with explicit embedder usage.
    • Added examples demonstrating retrieval and updating of experimental features.
    • Added examples for embedder management (retrieve, update, reset).
    • Added examples for returning vectors in search results.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 29, 2026

📝 Walkthrough

Walkthrough

Added 10 new code-sample blocks to .code-samples.meilisearch.yaml demonstrating negative search examples, hybrid and vector search with embedder usage, experimental features retrieval/update, and embedders get/update/reset and retrieveVectors usage.

Changes

Cohort / File(s) Summary
Code Samples Documentation
./.code-samples.meilisearch.yaml
Added 10 new code-sample blocks: negative_search_1, negative_search_2, search_parameter_guide_hybrid_1, search_parameter_guide_vector_1, search_parameter_reference_retrieve_vectors_1, get_experimental_features_1, update_experimental_features_1, get_embedders_1, update_embedders_1, reset_embedders_1. Changes are examples and usage patterns only; no API signatures were modified.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 In my burrow I compile and hum,
New samples hop — behold them come!
Vectors, negatives, embedders play,
I nibble docs and dance all day.
Hooray for queries — off they run!

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Added missing code samples' is vague and generic, using a non-descriptive term that doesn't convey what specific functionality or area these samples cover. Consider a more specific title that indicates the main area of the samples being added, such as 'Add code samples for embedders, experimental features, and negative search' or similar.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@aznszn aznszn force-pushed the docs/add-mising-code-samples branch from cdbdf73 to 86c1e11 Compare January 29, 2026 10:21
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: 1

🤖 Fix all issues with AI agents
In @.code-samples.meilisearch.yaml:
- Around line 823-829: The embedder string in the search example
(search_parameter_guide_hybrid_1) is a typo: change the embedder value passed to
client.index('books').search in the "hybrid" block from 'openapi' to 'openai' so
it matches the other examples and the actual embedding provider name.

@aznszn aznszn force-pushed the docs/add-mising-code-samples branch from 86c1e11 to 3ac0fec Compare January 29, 2026 10:27
@aznszn
Copy link
Contributor Author

aznszn commented Jan 30, 2026

@Strift this is ready for review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant