Add code samples instead of raw examples with curl only#3473
Merged
Conversation
curquiza
added
tooling and maintenance
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughReplaced many inline curl examples with reusable MDX code-sample components across docs, added numerous new MDX/YAML code samples for embedders, embeddings, multimodal, chat, federated search and experimental flags, and normalized HTTP header casing in several snippets. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
snippets/generated-code-samples/code_samples_date_guide_index_1.mdx (2)
31-31:⚠️ Potential issue | 🟡 MinorInvalid Java import syntax
import com.meilisearch.sdk;is not valid Java — you must import a specific class or use a wildcard.🐛 Proposed fix
-import com.meilisearch.sdk; +import com.meilisearch.sdk.*;🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx` at line 31, The import statement `import com.meilisearch.sdk;` is invalid Java; replace it with a proper class or wildcard import such as `import com.meilisearch.sdk.*;` or import the specific class you need (e.g., `import com.meilisearch.sdk.Client;`) so the compiler can resolve types used in this file.
62-64:⚠️ Potential issue | 🟡 MinorC# snippet deserializes into
Moviefor agamescollection
JsonSerializer.Deserialize<IEnumerable<Movie>>andAddDocumentsAsync<Movie>appear to be copy-pasted from a movies example. The type should match thegamesdomain used throughout this snippet.🐛 Proposed fix
-var games = JsonSerializer.Deserialize<IEnumerable<Movie>>(jsonString, options); -var index = client.Index("games"); -await index.AddDocumentsAsync<Movie>(games); +var games = JsonSerializer.Deserialize<IEnumerable<Game>>(jsonString, options); +var index = client.Index("games"); +await index.AddDocumentsAsync<Game>(games);🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx` around lines 62 - 64, The snippet deserializes and indexes the wrong type: replace usages of the Movie type with the correct games domain type (e.g., Game) so the deserialization and indexing match; update JsonSerializer.Deserialize<IEnumerable<Movie>>(jsonString, options) to JsonSerializer.Deserialize<IEnumerable<Game>>(...) and change AddDocumentsAsync<Movie>(games) to AddDocumentsAsync<Game>(games) (locate the calls to JsonSerializer.Deserialize, the Movie symbol, and AddDocumentsAsync on the index obtained via client.Index("games") and swap Movie -> Game).
🧹 Nitpick comments (4)
snippets/generated-code-samples/code_samples_chat_completions_1.mdx (1)
16-31: Consider aligning tool definitions with the official tooling reference.The official Meilisearch chat tooling reference shows
_meiliSearchSourceswith aparametersschema (includingcall_idanddocumentsproperties). The docs instruct users to "include these tools in your request's tools array to enable enhanced functionality," so the server accepts the simplified form shown here. However, omittingparametersfrom both tools while the official reference includes them for_meiliSearchSourcesmay cause confusion for readers cross-referencing the docs.If the intent is to keep the sample minimal, that's fine. Otherwise, consider adding the
parametersblock to_meiliSearchSourcesto match the reference docs.✏️ Proposed update to align with the official tooling reference
{ "type": "function", "function": { "name": "_meiliSearchSources", - "description": "Provides sources and references for the information" + "description": "Provides sources and references for the information", + "parameters": { + "type": "object", + "properties": { + "call_id": { + "type": "string", + "description": "The call ID to track the original search associated to those sources" + }, + "documents": { + "type": "object", + "description": "The documents associated with the search (call_id)" + } + } + } } }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_chat_completions_1.mdx` around lines 16 - 31, The sample's tools array omits the parameters schema for _meiliSearchSources, which differs from the Meilisearch chat tooling reference; update the tool definition for "_meiliSearchSources" (in the "tools" array) to include a "parameters" object matching the reference (e.g., properties like call_id and documents with appropriate types and required fields) so the example aligns with the official docs while keeping _meiliSearchProgress minimal if desired.snippets/generated-code-samples/code_samples_user_provided_embeddings_settings_1.mdx (1)
3-14: Prefer an index placeholder for reuse across docs.Hard-coding
moviesmakes the snippet less portable.♻️ Suggested tweak
- -X PATCH 'MEILISEARCH_URL/indexes/movies/settings' \ + -X PATCH 'MEILISEARCH_URL/indexes/INDEX_NAME/settings' \🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_user_provided_embeddings_settings_1.mdx` around lines 3 - 14, Replace the hard-coded index name "movies" in the curl PATCH URL with a reusable placeholder (e.g., {INDEX_NAME} or INDEX_NAME) so the snippet is portable; update the request URL 'MEILISEARCH_URL/indexes/movies/settings' to use that placeholder and leave EMBEDDER_NAME and MODEL_DIMENSIONS as-is to indicate variables that users must substitute. Ensure the example still shows the embedders block with "source": "userProvided" and "dimensions": MODEL_DIMENSIONS so readers understand which parts to replace.snippets/generated-code-samples/code_samples_image_search_user_embeddings_search_1.mdx (1)
3-10: Use a generic index placeholder and a concrete vector example for quick copy/paste.This keeps the snippet reusable across docs and immediately runnable.
♻️ Suggested tweak
- -X POST 'MEILISEARCH_URL/indexes/products/search' \ + -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \ -H 'Content-Type: application/json' \ --data-binary '{ - "vector": VECTORIZED_QUERY, + "vector": [0.12, 0.98], "hybrid": { "embedder": "EMBEDDER_NAME" } }'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_image_search_user_embeddings_search_1.mdx` around lines 3 - 10, Replace the hard-coded "products" index and abstract VECTORIZED_QUERY with a generic index placeholder and a concrete numeric vector so the snippet is copy/paste runnable; specifically, change the URL fragment that currently contains "indexes/products/search" to use a placeholder like "indexes/INDEX_NAME/search", and replace the "vector": VECTORIZED_QUERY and "hybrid": { "embedder": "EMBEDDER_NAME" } values with a concrete example numeric array (e.g., [0.01, 0.23, ...]) and keep EMBEDDER_NAME as a clear placeholder so users can run the curl immediately while still substituting their embedder..code-samples.meilisearch.yaml (1)
1736-1745:chat_get_settings_1/chat_patch_settings_1use double quotes for-Hargs; every other sample uses single quotes.Lines 1739 and 1743–1744 use
"Authorization: Bearer ..."/"Content-Type: ..."with double quotes, while the entire rest of the file uses single quotes for-Harguments. Both forms work, but the inconsistency is noticeable.♻️ Proposed normalisation
chat_get_settings_1: |- curl \ -X GET 'MEILISEARCH_URL/chats/WORKSPACE_NAME/settings' \ - -H "Authorization: Bearer MEILISEARCH_KEY" + -H 'Authorization: Bearer MEILISEARCH_KEY' chat_patch_settings_1: |- curl \ -X PATCH 'MEILISEARCH_URL/chats/WORKSPACE_NAME/settings' \ - -H "Authorization: Bearer MEILISEARCH_KEY" \ - -H "Content-Type: application/json" \ + -H 'Authorization: Bearer MEILISEARCH_KEY' \ + -H 'Content-Type: application/json' \ --data-binary '{ "apiKey": "your-valid-api-key" }'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.code-samples.meilisearch.yaml around lines 1736 - 1745, The samples chat_get_settings_1 and chat_patch_settings_1 use double quotes for the -H header args while the rest of the file uses single quotes; update the header flags in these two snippets to use single quotes (e.g., change "Authorization: Bearer MEILISEARCH_KEY" and "Content-Type: application/json" to use single quotes) so the header quoting is consistent across the file.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.code-samples.meilisearch.yaml:
- Around line 1838-1849: The PATCH curl sample for
ai_search_getting_started_embedders_1 contains an invalid attempt to embed
single quotes around {{doc.name}} using '' inside a single-quoted --data-binary
string; fix by using a proper bash escape for a single quote (replace '' with
'\''), or switch the payload to a here-doc or double-quoted string and escape
accordingly so the JSON field documentTemplate ends up containing literal quotes
around {{doc.name}}; update the curl command payload in
ai_search_getting_started_embedders_1 and the documentTemplate value to use the
chosen escaping method.
- Around line 1256-1260: The curl example under date_guide_index_1 uses the
proxy flag "-x POST" instead of the HTTP method flag "-X POST"; update the curl
invocation in the date_guide_index_1 block so the option is "-X POST"
(preserving the surrounding URL, headers, and --data-binary `@games.json`) to
ensure the command performs an HTTP POST rather than setting a proxy named
"POST".
In `@learn/chat/chat_tooling_reference.md`:
- Line 6: The file chat_tooling_reference.md contains an ES module import (e.g.,
"import CodeSamplesUpdateExperimentalFeaturesChat1 ...") which requires an .mdx
extension; rename chat_tooling_reference.md to chat_tooling_reference.mdx,
update any references to that filename elsewhere in the repo (links, imports, or
navigation) so they point to the new .mdx name, and ensure the import statement
remains unchanged inside the renamed file so Mintlify can process the component
import correctly.
In `@learn/security/generate_tenant_token_scratch.mdx`:
- Line 7: The file imports the wrong component (CodeSamplesAuthorizationHeader1)
but renders <CodeSamplesTenantTokenGuideGetKey1 />; update the import so the
component used in the JSX is actually imported — replace or add the import for
CodeSamplesTenantTokenGuideGetKey1 (the same component used in
generate_tenant_token_sdk.mdx) so the rendered
<CodeSamplesTenantTokenGuideGetKey1 /> has a matching import.
In `@snippets/generated-code-samples/code_samples_chat_completions_1.mdx`:
- Around line 16-31: Add the required "parameters" objects to both tool
definitions so they pass Meilisearch's strict schema validation: for the tool
named "_meiliSearchProgress" add a parameters schema requiring "call_id"
(string), "function_name" (string), and "function_parameters" (string); for the
tool named "_meiliSearchSources" add a parameters schema requiring "call_id"
(string) and "documents" (object). Ensure each parameters object declares the
required property names and their types and sets additionalProperties: false so
only those fields are allowed.
In `@snippets/generated-code-samples/code_samples_chat_patch_settings_1.mdx`:
- Around line 5-8: The Authorization header in the PATCH example uses a literal
placeholder "Authorization: Bearer MEILISEARCH_KEY" which triggers secret
scanners; update the example to reference an environment variable (e.g., use an
env placeholder like MEILISEARCH_API_KEY) and add an allowlist/no-scan inline
comment so CI scanners ignore it; specifically change the header in the curl
PATCH example and include a short allowlist comment (e.g., nosec/allowlist)
adjacent to the header to prevent false positives while keeping the env-var
pattern clear.
In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx`:
- Line 5: The curl example uses the proxy flag "-x" instead of the
request-method flag, so change the "-x POST
'MEILISEARCH_URL/indexes/games/documents' \\" occurrence to use "-X" (i.e.,
replace "-x POST" with "-X POST") so the HTTP method is set correctly when
calling the endpoint in the generated-code-samples snippet; locate the line
containing "-x POST 'MEILISEARCH_URL/indexes/games/documents' \\" and update the
flag accordingly.
In
`@snippets/generated-code-samples/code_samples_image_search_multimodal_settings_1.mdx`:
- Around line 3-7: The cURL example for the PATCH /indexes/INDEX_NAME/settings
request is missing the required Authorization header causing a 401; update the
snippet that issues the curl PATCH 'MEILISEARCH_URL/indexes/INDEX_NAME/settings'
to include the Authorization: Bearer MEILISEARCH_KEY header (matching the
companion code_samples_chat_index_settings_1.mdx) so the request authenticates
correctly.
In
`@snippets/generated-code-samples/code_samples_search_parameter_reference_retrieve_vectors_1.mdx`:
- Line 5: The PHP example in the MDX snippet uses invalid array syntax (uses ":"
instead of the PHP array key operator), so update the PHP associative arrays to
use "=>" for key/value pairs (e.g., replace 'key': 'value' with 'key' =>
'value') for all PHP arrays in the snippet (including the other occurrences
referenced), ensure commas and string quoting remain valid, and re-run the
snippet to verify it parses and runs as valid PHP.
---
Outside diff comments:
In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx`:
- Line 31: The import statement `import com.meilisearch.sdk;` is invalid Java;
replace it with a proper class or wildcard import such as `import
com.meilisearch.sdk.*;` or import the specific class you need (e.g., `import
com.meilisearch.sdk.Client;`) so the compiler can resolve types used in this
file.
- Around line 62-64: The snippet deserializes and indexes the wrong type:
replace usages of the Movie type with the correct games domain type (e.g., Game)
so the deserialization and indexing match; update
JsonSerializer.Deserialize<IEnumerable<Movie>>(jsonString, options) to
JsonSerializer.Deserialize<IEnumerable<Game>>(...) and change
AddDocumentsAsync<Movie>(games) to AddDocumentsAsync<Game>(games) (locate the
calls to JsonSerializer.Deserialize, the Movie symbol, and AddDocumentsAsync on
the index obtained via client.Index("games") and swap Movie -> Game).
---
Nitpick comments:
In @.code-samples.meilisearch.yaml:
- Around line 1736-1745: The samples chat_get_settings_1 and
chat_patch_settings_1 use double quotes for the -H header args while the rest of
the file uses single quotes; update the header flags in these two snippets to
use single quotes (e.g., change "Authorization: Bearer MEILISEARCH_KEY" and
"Content-Type: application/json" to use single quotes) so the header quoting is
consistent across the file.
In `@snippets/generated-code-samples/code_samples_chat_completions_1.mdx`:
- Around line 16-31: The sample's tools array omits the parameters schema for
_meiliSearchSources, which differs from the Meilisearch chat tooling reference;
update the tool definition for "_meiliSearchSources" (in the "tools" array) to
include a "parameters" object matching the reference (e.g., properties like
call_id and documents with appropriate types and required fields) so the example
aligns with the official docs while keeping _meiliSearchProgress minimal if
desired.
In
`@snippets/generated-code-samples/code_samples_image_search_user_embeddings_search_1.mdx`:
- Around line 3-10: Replace the hard-coded "products" index and abstract
VECTORIZED_QUERY with a generic index placeholder and a concrete numeric vector
so the snippet is copy/paste runnable; specifically, change the URL fragment
that currently contains "indexes/products/search" to use a placeholder like
"indexes/INDEX_NAME/search", and replace the "vector": VECTORIZED_QUERY and
"hybrid": { "embedder": "EMBEDDER_NAME" } values with a concrete example numeric
array (e.g., [0.01, 0.23, ...]) and keep EMBEDDER_NAME as a clear placeholder so
users can run the curl immediately while still substituting their embedder.
In
`@snippets/generated-code-samples/code_samples_user_provided_embeddings_settings_1.mdx`:
- Around line 3-14: Replace the hard-coded index name "movies" in the curl PATCH
URL with a reusable placeholder (e.g., {INDEX_NAME} or INDEX_NAME) so the
snippet is portable; update the request URL
'MEILISEARCH_URL/indexes/movies/settings' to use that placeholder and leave
EMBEDDER_NAME and MODEL_DIMENSIONS as-is to indicate variables that users must
substitute. Ensure the example still shows the embedders block with "source":
"userProvided" and "dimensions": MODEL_DIMENSIONS so readers understand which
parts to replace.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (48)
.code-samples.meilisearch.yamllearn/ai_powered_search/configure_rest_embedder.mdxlearn/ai_powered_search/getting_started_with_ai_search.mdxlearn/ai_powered_search/image_search_with_multimodal_embeddings.mdxlearn/ai_powered_search/image_search_with_user_provided_embeddings.mdxlearn/ai_powered_search/search_with_user_provided_embeddings.mdxlearn/async/task_webhook.mdxlearn/chat/chat_tooling_reference.mdlearn/chat/getting_started_with_chat.mdxlearn/engine/datatypes.mdxlearn/filtering_and_sorting/filter_expression_reference.mdxlearn/indexing/optimize_indexing_performance.mdxlearn/multi_search/performing_federated_search.mdxlearn/personalization/making_personalized_search_queries.mdxlearn/security/basic_security.mdxlearn/security/generate_tenant_token_scratch.mdxlearn/security/generate_tenant_token_sdk.mdxlearn/security/generate_tenant_token_third_party.mdxlearn/update_and_migration/migrating_cloud.mdxlearn/update_and_migration/updating.mdxsnippets/generated-code-samples/code_samples_ai_search_getting_started_embedders_1.mdxsnippets/generated-code-samples/code_samples_ai_search_getting_started_search_1.mdxsnippets/generated-code-samples/code_samples_ai_search_user_embeddings_documents_1.mdxsnippets/generated-code-samples/code_samples_ai_search_user_embeddings_search_vector_filter_1.mdxsnippets/generated-code-samples/code_samples_authorization_header_1.mdxsnippets/generated-code-samples/code_samples_basic_security_tutorial_listing_1.mdxsnippets/generated-code-samples/code_samples_chat_completions_1.mdxsnippets/generated-code-samples/code_samples_chat_create_key_1.mdxsnippets/generated-code-samples/code_samples_chat_get_settings_1.mdxsnippets/generated-code-samples/code_samples_chat_index_settings_1.mdxsnippets/generated-code-samples/code_samples_chat_patch_settings_1.mdxsnippets/generated-code-samples/code_samples_configure_rest_embedder_1.mdxsnippets/generated-code-samples/code_samples_date_guide_index_1.mdxsnippets/generated-code-samples/code_samples_federated_search_multi_search_1.mdxsnippets/generated-code-samples/code_samples_federated_search_multi_search_weight_1.mdxsnippets/generated-code-samples/code_samples_image_search_multimodal_search_image_1.mdxsnippets/generated-code-samples/code_samples_image_search_multimodal_search_text_1.mdxsnippets/generated-code-samples/code_samples_image_search_multimodal_settings_1.mdxsnippets/generated-code-samples/code_samples_image_search_user_embeddings_search_1.mdxsnippets/generated-code-samples/code_samples_image_search_user_embeddings_search_q_1.mdxsnippets/generated-code-samples/code_samples_personalization_search_1.mdxsnippets/generated-code-samples/code_samples_search_parameter_guide_hybrid_1.mdxsnippets/generated-code-samples/code_samples_search_parameter_guide_vector_1.mdxsnippets/generated-code-samples/code_samples_search_parameter_reference_retrieve_vectors_1.mdxsnippets/generated-code-samples/code_samples_update_experimental_features_chat_1.mdxsnippets/generated-code-samples/code_samples_update_experimental_features_contains_1.mdxsnippets/generated-code-samples/code_samples_update_experimental_features_multimodal_1.mdxsnippets/generated-code-samples/code_samples_user_provided_embeddings_settings_1.mdx
💤 Files with no reviewable changes (2)
- snippets/generated-code-samples/code_samples_authorization_header_1.mdx
- snippets/generated-code-samples/code_samples_basic_security_tutorial_listing_1.mdx
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
learn/chat/chat_tooling_reference.mdx (1)
145-145:⚠️ Potential issue | 🟡 MinorTypo in
roleproperty description —roleshould beuser.The description reads
"either \role` or `assistant`", butroleis the property *name*, not a valid value. Per line 60 of the same file, the valid values are"user"and"assistant"`.✏️ Proposed fix
- "description": "The role of the messages author, either `role` or `assistant`" + "description": "The role of the messages author, either `user` or `assistant`"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@learn/chat/chat_tooling_reference.mdx` at line 145, The description for the message object's role currently says "either `role` or `assistant`" which incorrectly uses the property name; update the description for the `role` property (the string shown in the diff: "description": "The role of the messages author, either `role` or `assistant`") to list the actual valid values "user" and "assistant" (e.g., "The role of the message's author, either `user` or `assistant`") so it matches the valid values referenced earlier.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@learn/chat/chat_tooling_reference.mdx`:
- Line 145: The description for the message object's role currently says "either
`role` or `assistant`" which incorrectly uses the property name; update the
description for the `role` property (the string shown in the diff:
"description": "The role of the messages author, either `role` or `assistant`")
to list the actual valid values "user" and "assistant" (e.g., "The role of the
message's author, either `user` or `assistant`") so it matches the valid values
referenced earlier.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
snippets/generated-code-samples/code_samples_date_guide_index_1.mdx (3)
99-103:⚠️ Potential issue | 🟡 MinorCommented-out required imports make the Dart snippet non-functional as written.
Filerequiresdart:io. If these are intentionally commented out as guidance hints, they should at minimum be uncommented so readers can copy-paste and run the snippet without modification.🐛 Proposed fix
-//import 'dart:io'; -//import 'dart:convert'; +import 'dart:io'; +import 'dart:convert';🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx` around lines 99 - 103, Uncomment the required Dart imports so the example runs as-is: restore the dart:io and dart:convert imports at the top of the snippet so File and JSON handling work (e.g., make sure the File(...) call and `json` variable usage, and the `client.index('games').addDocumentsJson(json)` line, have the necessary imports available). Ensure the snippet includes the two imports instead of commented lines so readers can copy-paste and execute it directly.
62-64:⚠️ Potential issue | 🟠 MajorWrong type —
Movieused in a games example (copy-paste error).Both the deserialization and
AddDocumentsAsyncuseMovie, but this snippet is for a games index. The Rust block in the same file usesGameas the document type, which is consistent with the context.🐛 Proposed fix
-var games = JsonSerializer.Deserialize<IEnumerable<Movie>>(jsonString, options); +var games = JsonSerializer.Deserialize<IEnumerable<Game>>(jsonString, options); var index = client.Index("games"); -await index.AddDocumentsAsync<Movie>(games); +await index.AddDocumentsAsync<Game>(games);🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx` around lines 62 - 64, The snippet incorrectly uses the Movie type for a games index: update the deserialization and add-call to use Game instead of Movie by changing JsonSerializer.Deserialize<IEnumerable<Movie>>(jsonString, options) to JsonSerializer.Deserialize<IEnumerable<Game>>(jsonString, options) and index.AddDocumentsAsync<Movie>(games) to index.AddDocumentsAsync<Game>(games) so the document type (Game) matches the games index and the Rust example.
31-31:⚠️ Potential issue | 🔴 CriticalFix invalid Java import syntax — code will not compile.
import com.meilisearch.sdk;is not valid Java. You cannot import a package directly; use either a wildcard import or import specific classes. The code snippet also uses theIndexclass without importing it.Proposed fix
-import com.meilisearch.sdk; +import com.meilisearch.sdk.*;🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx` at line 31, The import statement `import com.meilisearch.sdk;` is invalid Java and prevents compilation; replace it with proper class or wildcard imports (e.g., import the Client and Index classes or use import com.meilisearch.sdk.*;) so the code references to Index (and any other SDK classes) resolve correctly, and ensure any fully-qualified usages are updated to rely on the imported types (look for symbols: Index, Client, etc.).
🧹 Nitpick comments (1)
snippets/generated-code-samples/code_samples_date_guide_index_1.mdx (1)
18-20: File handlejson_fileis never closed.Using a bare
open()without awithblock leaves the file handle open until garbage collection. Prefer a context manager.♻️ Proposed fix
-json_file = open('./games.json', encoding='utf-8') -games = json.load(json_file) -client.index('games').add_documents(games) +with open('./games.json', encoding='utf-8') as json_file: + games = json.load(json_file) +client.index('games').add_documents(games)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx` around lines 18 - 20, The file handle opened as json_file when loading './games.json' is never closed; wrap the open call in a context manager so the handle is closed automatically: use a with open('./games.json', encoding='utf-8') as json_file: block, load games via json.load(json_file), then call client.index('games').add_documents(games) inside/after that block to preserve behavior while ensuring the file is closed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx`:
- Around line 99-103: Uncomment the required Dart imports so the example runs
as-is: restore the dart:io and dart:convert imports at the top of the snippet so
File and JSON handling work (e.g., make sure the File(...) call and `json`
variable usage, and the `client.index('games').addDocumentsJson(json)` line,
have the necessary imports available). Ensure the snippet includes the two
imports instead of commented lines so readers can copy-paste and execute it
directly.
- Around line 62-64: The snippet incorrectly uses the Movie type for a games
index: update the deserialization and add-call to use Game instead of Movie by
changing JsonSerializer.Deserialize<IEnumerable<Movie>>(jsonString, options) to
JsonSerializer.Deserialize<IEnumerable<Game>>(jsonString, options) and
index.AddDocumentsAsync<Movie>(games) to index.AddDocumentsAsync<Game>(games) so
the document type (Game) matches the games index and the Rust example.
- Line 31: The import statement `import com.meilisearch.sdk;` is invalid Java
and prevents compilation; replace it with proper class or wildcard imports
(e.g., import the Client and Index classes or use import com.meilisearch.sdk.*;)
so the code references to Index (and any other SDK classes) resolve correctly,
and ensure any fully-qualified usages are updated to rely on the imported types
(look for symbols: Index, Client, etc.).
---
Nitpick comments:
In `@snippets/generated-code-samples/code_samples_date_guide_index_1.mdx`:
- Around line 18-20: The file handle opened as json_file when loading
'./games.json' is never closed; wrap the open call in a context manager so the
handle is closed automatically: use a with open('./games.json',
encoding='utf-8') as json_file: block, load games via json.load(json_file), then
call client.index('games').add_documents(games) inside/after that block to
preserve behavior while ensuring the file is closed.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
snippets/generated-code-samples/code_samples_ai_search_getting_started_embedders_1.mdxsnippets/generated-code-samples/code_samples_date_guide_index_1.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- snippets/generated-code-samples/code_samples_ai_search_getting_started_embedders_1.mdx
curquiza
force-pushed
the
create-code-samples
branch
from
8d8b62e to
b1ac4b1
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@snippets/generated-code-samples/code_samples_image_search_user_embeddings_search_q_1.mdx`:
- Around line 7-11: The JSON payload contains an invalid placeholder for the
"vector" field ("vector": VECTORIZED_QUERY) which breaks copy/paste; replace
that placeholder with a JSON-valid value (e.g., a numeric array placeholder or a
concrete example vector) so the request body is valid JSON while keeping the
"hybrid" and "q" fields unchanged; update the snippet around the "vector" key to
use a syntactically valid JSON array or value instead of the bare identifier.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.code-samples.meilisearch.yamlsnippets/generated-code-samples/code_samples_image_search_user_embeddings_search_1.mdxsnippets/generated-code-samples/code_samples_image_search_user_embeddings_search_q_1.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- snippets/generated-code-samples/code_samples_image_search_user_embeddings_search_1.mdx
curquiza
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Create code samples to be able to display examples with different SDKs examples
Summary by CodeRabbit