Skip to content

feat/apis: add algorithm-specific payload options - #3588

Closed
Matts966 wants to merge 1 commit into
mainfrom
feature/grpc-common-zvec-interface
Closed

feat/apis: add algorithm-specific payload options#3588
Matts966 wants to merge 1 commit into
mainfrom
feature/grpc-common-zvec-interface

Conversation

@Matts966

@Matts966 Matts966 commented Aug 5, 2026

Copy link
Copy Markdown
Member

Summary

  • extract the shared gRPC/protobuf interface changes from feature/agent/zvec-any-options
  • add algorithm-specific google.protobuf.Any options to the payload API
  • include regenerated Go, Rust, Swagger, and API documentation artifacts
  • exclude the zvec runtime implementation, Helm configuration, and CI changes

Verification

  • ran make proto/all
  • buf generate completed successfully
  • applied the repository proto/replace transformations in smaller batches because macOS xargs exceeded its command-line length limit

Stacked PR

feature/agent/zvec-any-options is based on this branch.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 7d86bc64-68f4-4132-8c5f-00b464f6acba

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@vdaas-ci

vdaas-ci commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • 🔚 2️⃣ 🔚 /label actions/e2e-v2 - run E2E deploy & integration test (tests/v2/e2e)

Comment thread apis/docs/v1/docs.md
<a name="payload-v1-Info-Index-UUID"></a>
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| counts | [Info.Index.Detail.CountsEntry](#payload-v1-Info-Index-Detail-CountsEntry) | repeated | count infos for each agents |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
The noun should probably be in the singular form. (EVERY_EACH_SINGULAR[1])
Suggestions: agent
URL: https://languagetool.org/insights/post/word-choice-each-and-every/
Rule: https://community.languagetool.org/rule/show/EVERY_EACH_SINGULAR?lang=en-US&subId=1
Category: GRAMMAR

Comment thread apis/docs/v1/docs.md

<a name="payload-v1-Info-Nodes"></a>
### Info.Index.PropertyDetail
Represents index Properties for each Agents

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
The noun should probably be in the singular form. (EVERY_EACH_SINGULAR[1])
Suggestions: Agent
URL: https://languagetool.org/insights/post/word-choice-each-and-every/
Rule: https://community.languagetool.org/rule/show/EVERY_EACH_SINGULAR?lang=en-US&subId=1
Category: GRAMMAR

Comment thread apis/docs/v1/docs.md

<a name="payload-v1-Insert"></a>
### Info.Index.StatisticsDetail
Represents index Statistics for each Agents

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
The noun should probably be in the singular form. (EVERY_EACH_SINGULAR[1])
Suggestions: Agent
URL: https://languagetool.org/insights/post/word-choice-each-and-every/
Rule: https://community.languagetool.org/rule/show/EVERY_EACH_SINGULAR?lang=en-US&subId=1
Category: GRAMMAR

Comment thread apis/docs/v1/docs.md
Insert related messages.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| details | [Info.Index.StatisticsDetail.DetailsEntry](#payload-v1-Info-Index-StatisticsDetail-DetailsEntry) | repeated | count infos for each agents |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
The noun should probably be in the singular form. (EVERY_EACH_SINGULAR[1])
Suggestions: agent
URL: https://languagetool.org/insights/post/word-choice-each-and-every/
Rule: https://community.languagetool.org/rule/show/EVERY_EACH_SINGULAR?lang=en-US&subId=1
Category: GRAMMAR

Comment thread apis/docs/v1/docs.md

<a name="payload-v1-Insert"></a>

### Insert

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Insert
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

Comment thread apis/docs/v1/docs.md

<a name="payload-v1-Search-Response"></a>
### ZVec

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: ZVec
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

Comment thread apis/docs/v1/docs.md

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| resource_type | [string](#string) | | A name for the type of resource being accessed, e.g. &#34;sql table&#34;, &#34;cloud storage bucket&#34;, &#34;file&#34;, &#34;Google calendar&#34;; or the type URL of the resource: e.g. &#34;type.googleapis.com/google.pubsub.v1.Topic&#34;. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible spelling mistake found. (EN_MULTITOKEN_SPELLING_TWO[2])
Suggestions: Google Calendar
Rule: https://community.languagetool.org/rule/show/EN_MULTITOKEN_SPELLING_TWO?lang=en-US&subId=2
Category: MULTITOKEN_SPELLING

Comment thread apis/docs/v1/docs.md
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| IndexInfo | [.payload.v1.Empty](#payload-v1-Empty) | [.payload.v1.Info.Index.Count](#payload-v1-Info-Index-Count) | Overview Represent the RPC to get the index information. |
| IndexDetail | [.payload.v1.Empty](#payload-v1-Empty) | [.payload.v1.Info.Index.Detail](#payload-v1-Info-Index-Detail) | Overview Represent the RPC to get the index information for each agents. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
The noun should probably be in the singular form. (EVERY_EACH_SINGULAR[1])
Suggestions: agent
URL: https://languagetool.org/insights/post/word-choice-each-and-every/
Rule: https://community.languagetool.org/rule/show/EVERY_EACH_SINGULAR?lang=en-US&subId=1
Category: GRAMMAR

Comment thread apis/docs/v1/docs.md
| IndexInfo | [.payload.v1.Empty](#payload-v1-Empty) | [.payload.v1.Info.Index.Count](#payload-v1-Info-Index-Count) | Overview Represent the RPC to get the index information. |
| IndexDetail | [.payload.v1.Empty](#payload-v1-Empty) | [.payload.v1.Info.Index.Detail](#payload-v1-Info-Index-Detail) | Overview Represent the RPC to get the index information for each agents. |
| IndexStatistics | [.payload.v1.Empty](#payload-v1-Empty) | [.payload.v1.Info.Index.Statistics](#payload-v1-Info-Index-Statistics) | Overview Represent the RPC to get the index statistics. |
| IndexStatisticsDetail | [.payload.v1.Empty](#payload-v1-Empty) | [.payload.v1.Info.Index.StatisticsDetail](#payload-v1-Info-Index-StatisticsDetail) | Overview Represent the RPC to get the index statistics for each agents. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
The noun should probably be in the singular form. (EVERY_EACH_SINGULAR[1])
Suggestions: agent
URL: https://languagetool.org/insights/post/word-choice-each-and-every/
Rule: https://community.languagetool.org/rule/show/EVERY_EACH_SINGULAR?lang=en-US&subId=1
Category: GRAMMAR

Comment thread apis/docs/v1/index.md
| live_agents | uint32 | | live agent replica of vald cluster |
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| counts | Info.Index.Detail.CountsEntry | repeated | count infos for each agents |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
The noun should probably be in the singular form. (EVERY_EACH_SINGULAR[1])
Suggestions: agent
URL: https://languagetool.org/insights/post/word-choice-each-and-every/
Rule: https://community.languagetool.org/rule/show/EVERY_EACH_SINGULAR?lang=en-US&subId=1
Category: GRAMMAR

@Matts966

Matts966 commented Aug 5, 2026

Copy link
Copy Markdown
Member Author

Superseded by #3589 after renaming the head branch to feature/grpc/common-any-args.

@Matts966 Matts966 closed this Aug 5, 2026
@Matts966
Matts966 deleted the feature/grpc-common-zvec-interface branch August 5, 2026 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment