feat: enhance search functionality with ID support by shanghaikid · Pull Request #499 · milvus-io/milvus-sdk-node

shanghaikid · 2026-01-19T06:52:41Z

Updated SearchReq and SearchSimpleReq interfaces to include optional ids field for searching by primary keys.
Modified buildSearchRequest function to handle ID-based searches, including validation for primary key types.
Added tests to validate search functionality using IDs, ensuring correct error handling for type mismatches and missing primary keys.

- Updated SearchReq and SearchSimpleReq interfaces to include optional `ids` field for searching by primary keys. - Modified buildSearchRequest function to handle ID-based searches, including validation for primary key types. - Added tests to validate search functionality using IDs, ensuring correct error handling for type mismatches and missing primary keys. Signed-off-by: ryjiang <jiangruiyi@gmail.com>

sre-ci-robot · 2026-01-19T06:52:50Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: shanghaikid

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

gemini-code-assist · 2026-01-19T06:53:04Z

Summary of Changes

Hello @shanghaikid, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the search capabilities by introducing the ability to perform searches directly using primary keys. This allows users to retrieve specific data points by their unique identifiers, complementing the existing vector-based search methods. The changes ensure data integrity through robust validation of ID types against the collection's primary key schema, making the search API more versatile and user-friendly.

Highlights

Enhanced Search Functionality: The search functionality has been extended to allow searching by primary keys (IDs) in addition to vector-based searches. This provides more flexible query options for users.
Interface Updates: The SearchReq and SearchSimpleReq interfaces now include an optional ids field, which accepts an array of numbers or strings for primary key-based searches. Correspondingly, the vectors and data fields have been made optional to support ID-only searches.
Robust ID Validation: The buildSearchRequest function has been updated to handle ID-based searches, including comprehensive validation for primary key types (Int64 and VarChar). It ensures that the provided IDs match the primary key's data type and throws errors for type mismatches, unsupported primary key types, or missing primary keys when IDs are used.
Comprehensive Testing: New test cases have been added to validate the ID-based search functionality, covering successful searches, error handling for invalid ID types, unsupported primary key types, and scenarios where neither IDs nor vector data are provided.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a valuable enhancement by enabling search functionality using primary key IDs. The implementation is mostly solid, with good test coverage for the new logic. However, I've identified a critical bug concerning the handling of Int64 IDs that could lead to runtime errors. Additionally, I've included several suggestions to improve code quality and the developer experience by simplifying logic, reducing redundancy, and refining the API design to make anns_field optional for ID-based searches. Addressing these points will make the new feature more robust and easier to use.

gemini-code-assist · 2026-01-19T06:54:56Z

milvus/utils/Search.ts

+    if (ids && ids.length > 0) {
+      const pkDataType = pkField!.dataType || DataTypeMap[pkField!.data_type];
+      if (pkDataType === DataType.Int64) {
+        request.ids = { int_id: { data: ids as number[] } };


There's a critical type mismatch here. The validation for Int64 primary keys allows ids to be an array of strings representing numbers. However, this line performs a direct cast ids as number[] without converting the string values to numbers. This will cause a runtime error or send incorrect data to Milvus if ids contains strings. You must map the values to numbers before assigning them.

Suggested change

request.ids = { int_id: { data: ids as number[] } };

request.ids = { int_id: { data: (ids as (string | number)[]).map(Number) } };

gemini-code-assist · 2026-01-19T06:54:56Z

milvus/utils/Search.ts

+  let pkField: FieldSchema | undefined;
+  for (let i = 0; i < collectionInfo.schema.fields.length; i++) {
+    const f = collectionInfo.schema.fields[i];
+    if (f.is_primary_key) {
+      pkField = f;
+      break;
+    }
+  }


This for loop to find the primary key field can be made more concise and idiomatic by using the Array.prototype.find() method.

Suggested change

let pkField: FieldSchema | undefined;

for (let i = 0; i < collectionInfo.schema.fields.length; i++) {

const f = collectionInfo.schema.fields[i];

if (f.is_primary_key) {

pkField = f;

break;

}

}

const pkField = collectionInfo.schema.fields.find(f => f.is_primary_key);

gemini-code-assist · 2026-01-19T06:54:56Z

milvus/utils/Search.ts

    };

+    if (ids && ids.length > 0) {
+      const pkDataType = pkField!.dataType || DataTypeMap[pkField!.data_type];


The primary key data type (pkDataType) is calculated here and also earlier in the validation logic (line 294). This code duplication can be avoided by calculating it once and reusing the variable. Consider refactoring to define pkDataType a single time.

Signed-off-by: ryjiang <jiangruiyi@gmail.com>

codecov · 2026-01-19T06:55:12Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.29%. Comparing base (07cb4f0) to head (d4dee9a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #499      +/-   ##
==========================================
+ Coverage   97.19%   97.29%   +0.10%     
==========================================
  Files          52       52              
  Lines        3674     3700      +26     
  Branches      978      996      +18     
==========================================
+ Hits         3571     3600      +29     
+ Misses         98       95       -3     
  Partials        5        5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…h utility.

Signed-off-by: ryjiang <jiangruiyi@gmail.com>

sre-ci-robot added the size/L label Jan 19, 2026

gemini-code-assist bot reviewed Jan 19, 2026

View reviewed changes

update docs

ee0850c

Signed-off-by: ryjiang <jiangruiyi@gmail.com>

sre-ci-robot added size/XL and removed size/L labels Jan 19, 2026

refactor: Consolidate primary key field and data type lookup in searc…

21c912c

…h utility.

sre-ci-robot added size/L and removed size/XL labels Jan 19, 2026

test: add tests for searching with string IDs and VarChar primary keys

06a3a8c

Signed-off-by: ryjiang <jiangruiyi@gmail.com>

sre-ci-robot added size/XL and removed size/L labels Jan 19, 2026

test: add test case for formatting search results with dynamic fields

d4dee9a

Signed-off-by: ryjiang <jiangruiyi@gmail.com>

shanghaikid merged commit 9f5bca0 into main Jan 19, 2026
4 of 5 checks passed

shanghaikid deleted the feat/search-by-ids branch January 19, 2026 07:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enhance search functionality with ID support#499

feat: enhance search functionality with ID support#499
shanghaikid merged 5 commits intomainfrom
feat/search-by-ids

shanghaikid commented Jan 19, 2026

Uh oh!

sre-ci-robot commented Jan 19, 2026

Uh oh!

gemini-code-assist bot commented Jan 19, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Jan 19, 2026

Uh oh!

gemini-code-assist bot Jan 19, 2026

Uh oh!

gemini-code-assist bot Jan 19, 2026

Uh oh!

codecov bot commented Jan 19, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	request.ids = { int_id: { data: ids as number[] } };
	request.ids = { int_id: { data: (ids as (string \| number)[]).map(Number) } };

Conversation

shanghaikid commented Jan 19, 2026

Uh oh!

sre-ci-robot commented Jan 19, 2026

Uh oh!

gemini-code-assist bot commented Jan 19, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Jan 19, 2026 •

edited

Loading