Skip to content
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

change symlink API documents #2741

Merged
merged 7 commits into from
Dec 13, 2024

Conversation

kmrmt
Copy link
Contributor

@kmrmt kmrmt commented Nov 14, 2024

Description

SSIA

Related Issue

Versions

  • Vald Version: v1.7.14
  • Go Version: v1.23.3
  • Rust Version: v1.82.0
  • Docker Version: v27.3.1
  • Kubernetes Version: v1.31.2
  • Helm Version: v3.16.2
  • NGT Version: v2.3.4
  • Faiss Version: v1.9.0

Checklist

Special notes for your reviewer

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced Vald APIs for Flush, Insert, Object, Remove, Search, Update, Upsert, Filter, Index, and Mirror functionalities, enhancing vector management capabilities.
    • Each API includes multiple RPC methods for operations such as adding, updating, removing, and searching vectors.
  • Documentation

    • Comprehensive documentation added for each API, detailing usage, input/output structures, and status codes for better user guidance.
    • New templates and YAML configurations introduced for improved API documentation generation.
    • Enhanced clarity and detail in service documentation, including structured overviews and troubleshooting guidance for all RPC methods.

Copy link
Contributor

coderabbitai bot commented Nov 14, 2024

📝 Walkthrough
📝 Walkthrough
## Walkthrough
This pull request introduces comprehensive documentation for several Vald APIs, including Flush, Insert, Object, Remove, Search, Update, and Upsert services. Each service features multiple RPC methods with specified input and output message structures, detailing their functionalities, status codes, and troubleshooting guidance. The documentation enhances the understanding of how to interact with these APIs, providing clear definitions for requests and responses.

## Changes

| File Path                     | Change Summary                                                                                                                                                                                                 |
|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `apis/docs/v1/flush.md`      | - New service `Flush` added.<br>- New RPC method `Flush` defined.<br>- New message structures `Flush.Request` and `Info.Index.Count` created.                                                                 |
| `apis/docs/v1/insert.md`     | - New service `Insert` added.<br>- RPC methods `Insert`, `StreamInsert`, and `MultiInsert` defined.<br>- New message structures for requests and responses created.                                               |
| `apis/docs/v1/object.md`     | - New service `Object` added.<br>- RPC methods `Exists`, `GetObject`, `StreamGetObject`, `StreamListObject`, and `GetTimestamp` defined.<br>- New message structures for requests and responses created.         |
| `apis/docs/v1/remove.md`     | - New service `Remove` added.<br>- RPC methods `Remove`, `RemoveByTimestamp`, `StreamRemove`, and `MultiRemove` defined.<br>- New message structures for requests and responses created.                           |
| `apis/docs/v1/search.md`     | - New service `Search` added.<br>- Multiple RPC methods defined, including `Search`, `SearchByID`, `StreamSearch`, and others.<br>- New message structures for requests and responses created.                     |
| `apis/docs/v1/update.md`     | - New service `Update` added.<br>- RPC methods `Update`, `StreamUpdate`, `MultiUpdate`, and `UpdateTimestamp` defined.<br>- New message structures for requests and responses created.                            |
| `apis/docs/v1/upsert.md`     | - New service `Upsert` added.<br>- RPC methods `Upsert`, `StreamUpsert`, and `MultiUpsert` defined.<br>- New message structures for requests and responses created.                                                  |
| `Makefile`                   | - New variables added for managing protobuf files and documentation generation.<br>- Enhanced handling of API documentation within the build process.                                                             |
| `Makefile.d/functions.mk`    | - New function `gen-api-document` added to automate API documentation generation.                                                                                                                               |
| `Makefile.d/proto.mk`        | - Modifications to enhance protobuf generation and manage dependencies.<br>- New targets for generating API documentation.                                                                                      |
| `apis/docs/buf.gen.doc.yaml` | - New YAML configuration file created for managing API documentation generation using the Buf tool.                                                                                                            |
| `apis/docs/buf.gen.payload.yaml` | - New YAML configuration file created for managing protocol buffer generation settings.                                                                                                                  |
| `apis/docs/buf.gen.tmpl.yaml` | - New YAML configuration file created for managing protocol buffer generation settings with templates.                                                                                                       |
| `apis/docs/v1/filter.md`     | - New service `Filter` added with multiple RPC methods for object operations documented.                                                                                                                      |
| `apis/docs/v1/index.md`      | - New service `Index` added with RPC methods for index management documented.                                                                                                                                 |
| `apis/docs/v1/mirror.md`     | - New service `Mirror` added with the `Register` RPC method documented.                                                                                                                                       |
| `apis/docs/v1/payload.md.tmpl` | - New template introduced for generating API documentation based on message definitions.                                                                                                                     |
| `apis/proto/v1/mirror/mirror.proto` | - Documentation for the `Mirror` service and `Register` RPC method enhanced.                                                                                                                            |
| `apis/proto/v1/vald/filter.proto` | - Documentation for the `Filter` service methods enhanced.                                                                                                                                                 |
| `apis/proto/v1/vald/flush.proto` | - Documentation for the `Flush` service enhanced.                                                                                                                                                          |
| `apis/proto/v1/vald/index.proto` | - New RPC methods added for index management with improved documentation.                                                                                                                                   |
| `apis/proto/v1/vald/insert.proto` | - Documentation for the `Insert` service methods enhanced.                                                                                                                                                 |
| `apis/proto/v1/vald/object.proto` | - Documentation for the `Object` service methods enhanced.                                                                                                                                                 |
| `apis/proto/v1/vald/remove.proto` | - Documentation for the `Remove` service methods enhanced.                                                                                                                                                 |
| `apis/proto/v1/vald/search.proto` | - Documentation for the `Search` service methods enhanced.                                                                                                                                                 |
| `apis/proto/v1/vald/update.proto` | - Documentation for the `Update` service methods enhanced.                                                                                                                                                 |
| `apis/proto/v1/vald/upsert.proto` | - Documentation for the `Upsert` service methods enhanced.                                                                                                                                                 |

## Possibly related PRs
- **#2665**: This PR focuses on fixing gRPC error handling, which may relate to the error handling aspects of the Flush RPC method introduced in the main PR.
- **#2681**: Similar to #2665, this PR backports changes related to gRPC error handling, which could impact the robustness of the Flush RPC method's error responses.
- **#2691**: This PR involves migrating to Buf v2, which is relevant as the main PR introduces new RPC methods and message structures that may require updated documentation and generation processes.
- **#2695**: This backport of the Buf migration PR is relevant for the same reasons as #2691, ensuring that the new Flush RPC method is properly documented and generated.
- **#2724**: This PR updates the README, which may include references to the new Flush API documentation introduced in the main PR.
- **#2725**: This backport of the README update is relevant for ensuring that the documentation for the new Flush API is consistent across versions.

## Suggested labels
`size/S`, `actions/backport/release/v1.7`

## Suggested reviewers
- kpango
- hlts2

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Experiment)
  • @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.

@vdaas-ci
Copy link
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-deploy - run E2E deploy & integration test

Copy link

cloudflare-workers-and-pages bot commented Nov 14, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: d9ee0a9
Status: ✅  Deploy successful!
Preview URL: https://17afe676.vald.pages.dev
Branch Preview URL: https://documentation-api-change-dir.vald.pages.dev

View logs

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

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

Response response = 1;


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

google.rpc.Status status = 2;


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

Config config = 2;


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

Response response = 1;


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

google.rpc.Status status = 2;


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

Config config = 2;


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

Config config = 2;


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

Config config = 2;


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

Config config = 2;


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

Config config = 2;


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

Response response = 1;


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

google.rpc.Status status = 2;


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

Config config = 2;


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

Response response = 1;


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

google.rpc.Status status = 2;


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

Config config = 2;


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

Config config = 2;


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

Object.Vector vector = 1 [ (validate.rules).repeated .min_items = 2 ];


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

Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1 [ (validate.rules).repeated .min_items = 2 ];


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

Config config = 2;


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

Location location = 1;


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

google.rpc.Status status = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1 [ (validate.rules).repeated .min_items = 2 ];


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

Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_BEGINNING_RULE?lang=en-US
Category: REPETITIONS_STYLE

| location | Object.Location | repeated(Array[Object.Location]) | The list of `Object.Location`. |


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1 [ (validate.rules).repeated .min_items = 2 ];


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

Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It’s the recommended method to upsert a large number of vectors.


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

Object.Vector vector = 1 [ (validate.rules).repeated .min_items = 2 ];


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

Config config = 2;


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

Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1 [ (validate.rules).repeated .min_items = 2 ];


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

Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_BEGINNING_RULE?lang=en-US
Category: REPETITIONS_STYLE

| location | Object.Location | repeated(Array[Object.Location]) | The list of `Object.Location`. |

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: 8

🧹 Outside diff range and nitpick comments (23)
apis/docs/v1/object.md (2)

3-6: Enhance service overview with more context

Consider expanding the overview section to include:

  • The service's role in the Vald ecosystem
  • Common use cases for each RPC method
  • Relationship with other services (Insert, Search, etc.)

1-259: Add usage examples for each RPC method

To improve developer experience, consider adding:

  • Example requests and responses for each RPC method
  • Code snippets in multiple languages (Go, Python, etc.)
  • Common usage patterns and best practices
apis/docs/v1/insert.md (4)

19-19: Fix typo in RPC description

"Inset" should be "Insert"

-Inset RPC is the method to add a new single vector.
+Insert RPC is the method to add a new single vector.

17-118: Consider adding example request/response

The documentation is comprehensive, but adding example request and response payloads would make it more user-friendly and easier to understand.

Consider adding examples like:

### Example

Request:
```json
{
  "vector": {
    "id": "vector1",
    "vector": [0.1, 0.2, 0.3]
  },
  "config": {
    "skip_strict_exist_check": false,
    "timestamp": 1634000000
  }
}

Response:

{
  "name": "agent-1",
  "uuid": "vector1",
  "ips": ["10.0.0.1", "10.0.0.2"]
}

---

`124-124`: **Improve phrasing for clarity**

Consider rephrasing to be more specific or concise.

```diff
-It's the recommended method to insert a large number of vectors.
+It's the recommended method to insert many vectors.
🧰 Tools
🪛 LanguageTool

[style] ~124-~124: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to insert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


249-252: Consider specifying the gRPC message size limit

The warning about gRPC message size limitation would be more helpful if it included the actual size limit.

<div class="notice">
gRPC has a message size limitation.<br>
-Please be careful that the size of the request exceeds the limit.
+The default maximum message size in gRPC is 4MB. Please ensure your request size does not exceed this limit, or configure a custom limit if needed.
</div>
apis/docs/v1/upsert.md (5)

21-123: Consider adding usage examples.

While the documentation is comprehensive, adding practical examples would help developers understand how to use the Upsert RPC effectively. Consider including:

  • A basic example of upserting a single vector
  • An example showing how to use the skip_strict_exist_check option
  • An example demonstrating the use of filters

129-129: Improve clarity in the recommendation.

Replace "large number of vectors" with a more specific or clearer phrase.

-It's the recommended method to upsert a large number of vectors.
+It's the recommended method when upserting numerous vectors (typically thousands or more).
🧰 Tools
🪛 LanguageTool

[style] ~129-~129: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It’s the recommended method to upsert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


124-250: Consider reducing documentation redundancy.

The status codes and troubleshooting sections are identical across all RPC methods. Consider:

  1. Moving these common sections to a shared location
  2. Referencing them from each RPC method's documentation
  3. Only documenting method-specific status codes or troubleshooting steps in the individual sections

This would make the documentation more maintainable and reduce the risk of inconsistencies.

🧰 Tools
🪛 LanguageTool

[style] ~129-~129: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It’s the recommended method to upsert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


255-258: Enhance the gRPC size limitation notice.

The current notice about gRPC message size limitation could be more helpful by including specific details.

<div class="notice">
-gRPC has a message size limitation.<br>
-Please be careful that the size of the request exceeds the limit.
+gRPC has a default message size limitation of 4MB.<br>
+Please ensure your request size doesn't exceed this limit, or configure your gRPC client/server with appropriate maximum message size settings.
</div>

337-337: Improve table description readability.

Rephrase to avoid repetitive sentence beginnings.

-The list of `Object.Location`.
+Contains a collection of `Object.Location` objects.
🧰 Tools
🪛 LanguageTool

[style] ~337-~337: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

apis/docs/v1/update.md (5)

3-6: Enhance the Overview section with more context.

Consider expanding the overview to include:

  • Key differences between Update, StreamUpdate, and MultiUpdate methods
  • When to use each method
  • Any prerequisites or important considerations

113-120: Fix grammar in the troubleshooting table.

Add articles where missing:

  • "Request pair" → "A request pair"
🧰 Tools
🪛 LanguageTool

[grammar] ~119-~119: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)


124-127: Fix wording in StreamUpdate description.

Replace "amount of vectors" with "number of vectors" as it's more appropriate when referring to countable items.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~127-~127: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... recommended method to update the large amount of vectors. ### Input - the scheme of...

(AMOUNTOF_TO_NUMBEROF)


236-249: Consider consolidating duplicate troubleshooting sections.

The troubleshooting sections are identical across all three RPCs. Consider moving this to a common section and referencing it to reduce duplication and maintenance overhead.

🧰 Tools
🪛 LanguageTool

[grammar] ~248-~248: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)


255-258: Enhance the gRPC size limitation notice.

Consider adding:

  • The actual size limitation (typically 4MB by default)
  • How to configure custom message size limits
  • Best practices for handling large updates
apis/docs/v1/remove.md (5)

3-6: Enhance the overview section with method selection guidance.

Consider adding a brief comparison of when to use each RPC method. For example:

  • Remove: For single vector removal
  • RemoveByTimestamp: For time-based batch removal
  • StreamRemove: For high-throughput streaming removal
  • MultiRemove: For batch removal with size constraints

22-119: Add example request/response for better clarity.

Consider adding a practical example showing:

  1. A sample Remove request with actual values
  2. The corresponding successful response
  3. A failed request scenario with error details

179-183: Add examples for timestamp range conditions.

The notice about AND conditions would be clearer with examples. Consider adding:

  1. Single timestamp condition example
  2. Multiple timestamp conditions example showing range deletion
  3. Complex timestamp conditions example

242-246: Add performance guidance for streaming operations.

Consider enhancing the documentation with:

  1. Recommended batch sizes for optimal performance
  2. Error handling strategies in streaming scenarios
  3. Connection management best practices
🧰 Tools
🪛 LanguageTool

[style] ~245-~245: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to remove a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


205-205: Improve language variety and specificity.

Consider these language improvements:

  1. Vary sentence beginnings in the Object.Location sections
  2. Replace "large number" with a specific recommended range

Also applies to: 245-245, 446-446

🧰 Tools
🪛 LanguageTool

[style] ~205-~205: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

apis/docs/v1/search.md (2)

1-43: LGTM! Consider adding version compatibility information.

The overview and service definition are well-structured. Consider adding a section about version compatibility and any breaking changes from previous versions to help users with upgrades.


1-1628: Overall excellent API documentation with room for optimization.

The documentation is comprehensive and well-structured, providing clear information about each RPC method. The consistent format and detailed explanations will help users understand and implement the APIs effectively.

A few architectural suggestions for improving the documentation:

  1. Consider using OpenAPI/Swagger for API documentation to enable automatic generation and testing
  2. Add code examples for each RPC method to demonstrate usage
  3. Include performance considerations and best practices for each method
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9c52696 and 2f26634.

📒 Files selected for processing (7)
  • apis/docs/v1/flush.md (1 hunks)
  • apis/docs/v1/insert.md (1 hunks)
  • apis/docs/v1/object.md (1 hunks)
  • apis/docs/v1/remove.md (1 hunks)
  • apis/docs/v1/search.md (1 hunks)
  • apis/docs/v1/update.md (1 hunks)
  • apis/docs/v1/upsert.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apis/docs/v1/flush.md
🧰 Additional context used
🪛 LanguageTool
apis/docs/v1/insert.md

[style] ~124-~124: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to insert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


[style] ~330-~330: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

apis/docs/v1/remove.md

[style] ~205-~205: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~245-~245: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to remove a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


[style] ~446-~446: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

apis/docs/v1/update.md

[grammar] ~119-~119: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)


[uncategorized] ~127-~127: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... recommended method to update the large amount of vectors. ### Input - the scheme of...

(AMOUNTOF_TO_NUMBEROF)


[grammar] ~248-~248: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)


[style] ~337-~337: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[grammar] ~374-~374: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)

apis/docs/v1/upsert.md

[style] ~129-~129: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It’s the recommended method to upsert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


[style] ~337-~337: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🔇 Additional comments (2)
apis/docs/v1/insert.md (1)

1-366: Documentation is comprehensive and well-structured

The API documentation provides thorough coverage of all RPC methods, including clear schemas, validation rules, status codes, and troubleshooting guidance. The suggested improvements are minor and the documentation is ready for use.

🧰 Tools
🪛 LanguageTool

[style] ~124-~124: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to insert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


[style] ~330-~330: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

apis/docs/v1/upsert.md (1)

1-19: LGTM! Clear and well-structured service definition.

The overview effectively explains the purpose of the Upsert Service, and the service definition clearly outlines the three available RPC methods.

apis/docs/v1/object.md Outdated Show resolved Hide resolved
apis/docs/v1/object.md Show resolved Hide resolved
apis/docs/v1/object.md Outdated Show resolved Hide resolved
apis/docs/v1/update.md Outdated Show resolved Hide resolved
apis/docs/v1/update.md Outdated Show resolved Hide resolved
apis/docs/v1/remove.md Show resolved Hide resolved
apis/docs/v1/search.md Show resolved Hide resolved
apis/docs/v1/search.md Outdated Show resolved Hide resolved
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to insert a large number of vectors.


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Object.ID id = 1;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Remove.Timestamp.Operator operator = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to remove a large number of vectors.


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


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

Remove.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It’s the recommended method to upsert a large number of vectors.


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;

@github-actions github-actions bot removed the size/S label Nov 29, 2024
kmrmt and others added 2 commits November 29, 2024 14:53
* init auto generatation for API documents

* auto-generated API documents

* style: format code with Gofumpt and Prettier

This commit fixes the style issues introduced in 7a36dd8 according to the output
from Gofumpt and Prettier.

Details: #2742

* update

* style: format code with Gofumpt and Prettier

This commit fixes the style issues introduced in 74dc4d6 according to the output
from Gofumpt and Prettier.

Details: #2742

* update

* update

* style: format code with Gofumpt and Prettier

This commit fixes the style issues introduced in 384fc7e according to the output
from Gofumpt and Prettier.

Details: #2742

* update

* fix

* style: format code with Gofumpt and Prettier

This commit fixes the style issues introduced in fa4ba75 according to the output
from Gofumpt and Prettier.

Details: #2742

---------

Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
@kmrmt kmrmt force-pushed the documentation/api/change-directory-structure branch from e3cc4ce to 7d7a044 Compare November 29, 2024 05:53
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to insert a large number of vectors.


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Object.ID id = 1;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Remove.Timestamp.Operator operator = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to remove a large number of vectors.


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


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

Remove.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It’s the recommended method to upsert a large number of vectors.


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;

kmrmt and others added 2 commits December 2, 2024 16:08
This commit fixes the style issues introduced in df4d79e according to the output
from Gofumpt and Prettier.

Details: #2741
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to insert a large number of vectors.


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

rpc Register(payload.v1.Mirror.Targets) returns (payload.v1.Mirror.Targets) {}


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Object.ID id = 1;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Remove.Timestamp.Operator operator = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to remove a large number of vectors.


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


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

Remove.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It’s the recommended method to upsert a large number of vectors.


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to insert a large number of vectors.


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

rpc Register(payload.v1.Mirror.Targets) returns (payload.v1.Mirror.Targets) {}


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Object.ID id = 1;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Remove.Timestamp.Operator operator = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to remove a large number of vectors.


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


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

Remove.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It’s the recommended method to upsert a large number of vectors.


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;

@kmrmt kmrmt changed the title [WIP] copy API documents change symlink API documents Dec 2, 2024
@kmrmt kmrmt requested review from vankichi and datelier December 2, 2024 07:32
@kmrmt kmrmt changed the title change symlink API documents [merge pending] change symlink API documents Dec 4, 2024
@kmrmt kmrmt changed the title [merge pending] change symlink API documents [MERGE PENDING] change symlink API documents Dec 4, 2024
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: 13

🧹 Outside diff range and nitpick comments (28)
apis/proto/v1/mirror/mirror.proto (1)

31-39: Consider enhancing the status code table format.

The documentation content is excellent, but the status code table readability could be improved.

Consider this format for better readability:

  // Overview
  // Register RPC is the method to register other Vald Mirror Gateway targets.
  // ---
  // Status Code
- // |  0   | OK                |
- // |  1   | CANCELLED         |
- // |  3   | INVALID_ARGUMENT  |
- // |  4   | DEADLINE_EXCEEDED |
- // |  13  | INTERNAL          |
+ // | Code | Status            |
+ // |------|-------------------|
+ // |    0 | OK               |
+ // |    1 | CANCELLED        |
+ // |    3 | INVALID_ARGUMENT |
+ // |    4 | DEADLINE_EXCEEDED|
+ // |   13 | INTERNAL         |
apis/docs/v1/doc.tmpl (2)

9-20: Enhance service documentation with additional metadata

Consider enriching the service documentation with:

  • Service version information
  • Deprecation notices (if applicable)
  • Required permissions or authentication details
 # Vald {{ .Name }} APIs
 
 ## Overview
+{{ if hasKey $descs "Version" }}
+## Version
+
+{{ $descs.Version | trim }}
+{{ end }}
+
+{{ if hasKey $descs "Authentication" }}
+## Authentication
+
+{{ $descs.Authentication | trim }}
+{{ end }}

22-64: Consider adding example requests and responses

The method documentation would be more helpful with:

  • Example requests and responses in JSON/YAML format
  • Rate limiting information
  • Common use cases or scenarios
 {{ printf "{{ template \"field:%s\" }}" .ResponseFullType }}
+{{ if hasKey $descs "Examples" }}
+### Examples
+
+{{ pluck "Examples" $descs | first | trim }}
+{{ end }}
+
+{{ if hasKey $descs "Rate Limiting" }}
+### Rate Limiting
+
+{{ pluck "Rate Limiting" $descs | first | trim }}
+{{ end }}
apis/docs/v1/payload.tmpl (2)

6-25: Add inline comments for complex template logic

The logic within the _bfs and bfs templates is quite complex. Adding inline comments to explain the purpose of key variables and the control flow would enhance readability and maintainability for future developers.


38-65: Consider optimizing the dependency traversal

The current implementation of dependency traversal in the templates may have performance implications when processing a large number of messages. Investigate if it's possible to optimize the traversal or cache intermediate results to improve efficiency.

apis/proto/v1/vald/flush.proto (1)

32-41: Correct formatting of status code table

The status code table in the method documentation lacks proper markdown formatting, which may lead to rendering issues in documentation tools. Ensure the table is correctly formatted with headers and separators.

apis/docs/v1/flush.md (2)

5-5: Add missing article for grammatical correctness

In the sentence "Flush Service is responsible for removing...", consider adding "the" before "Flush Service" for grammatical accuracy:

"The Flush Service is responsible for removing all vectors..."


24-28: Ensure consistency in code block languages

The code block for the Flush.Request message uses the rpc language identifier, which may not be recognized. Use protobuf or proto for better syntax highlighting in documentation tools.

Makefile.d/proto.mk (1)

19-21: Consider optimizing target dependencies

The proto/all target could be more efficient by running proto/gen/code and proto/gen/api/docs in parallel since they are independent operations.

 proto/all: \
 	proto/deps \
-	proto/gen/code \
-	proto/gen/api/docs
+	proto/gen/parallel
+
+.PHONY: proto/gen/parallel
+proto/gen/parallel:
+	$(MAKE) -j2 proto/gen/code proto/gen/api/docs
apis/proto/v1/vald/object.proto (2)

113-120: Complete the TODO sections in documentation

The StreamListObject and GetTimestamp methods have incomplete documentation with TODO placeholders for Status Code and Troubleshooting sections. These sections should be completed to maintain consistency with other methods.

Would you like me to help generate the missing documentation sections based on the method implementations?

Also applies to: 125-132


31-31: Consider following protobuf naming conventions

As per the static analysis tool, the service name should follow the standard naming convention by adding a "Service" suffix.

-service Object {
+service ObjectService {
🧰 Tools
🪛 buf (1.47.2)

31-31: Service name "Object" should be suffixed with "Service".

(SERVICE_SUFFIX)

apis/proto/v1/vald/filter.proto (1)

73-76: Standardize gRPC message size limitation notices

The warning about gRPC message size limitations appears in different formats across multiple methods. Consider standardizing the notice across all methods.

Use this consistent format for all size limitation notices:

  // <div class="notice">
- // gRPC has a message size limitation.<br>
- // Please be careful that the size of the request exceeds the limit.
+ // Warning: gRPC has a message size limitation of 4MB by default.<br>
+ // Please ensure your request size does not exceed this limit or configure your client/server accordingly.
  // </div>

Also applies to: 172-175, 224-227

apis/proto/v1/vald/insert.proto (1)

29-31: Consider renaming service to follow naming convention.

The service name should be suffixed with "Service" to follow protobuf naming conventions.

-service Insert {
+service InsertService {
🧰 Tools
🪛 buf (1.47.2)

31-31: Service name "Insert" should be suffixed with "Service".

(SERVICE_SUFFIX)

apis/proto/v1/vald/remove.proto (1)

63-89: Add missing documentation for RemoveByTimestamp RPC

The documentation for RemoveByTimestamp RPC should include:

  • Example usage with multiple timestamps
  • Specific timestamp format requirements
  • Performance implications when using multiple timestamps
Makefile.d/functions.mk (1)

467-473: Enhance gen-api-document function robustness

The function should include:

  1. Error handling for buf commands
  2. Documentation of function parameters
  3. Cleanup in case of intermediate failures
 define gen-api-document
-	buf generate --template=apis/docs/buf.gen.tmpl.yaml --path $2
-	cat apis/docs/v1/payload.md.tmpl apis/docs/v1/_doc.md.tmpl > apis/docs/v1/doc.md.tmpl; \
-	buf generate --template=apis/docs/buf.gen.doc.yaml --path $2; \
-	mv $(ROOTDIR)/apis/docs/v1/doc.md $1; \
-	rm apis/docs/v1/*doc.md.tmpl
+	@echo "Generating API documentation for path: $2"
+	if ! buf generate --template=apis/docs/buf.gen.tmpl.yaml --path $2; then \
+		echo "Error: Failed to generate initial documentation" >&2; \
+		exit 1; \
+	fi
+	if ! cat apis/docs/v1/payload.md.tmpl apis/docs/v1/_doc.md.tmpl > apis/docs/v1/doc.md.tmpl; then \
+		echo "Error: Failed to concatenate template files" >&2; \
+		rm -f apis/docs/v1/doc.md.tmpl; \
+		exit 1; \
+	fi
+	if ! buf generate --template=apis/docs/buf.gen.doc.yaml --path $2; then \
+		echo "Error: Failed to generate final documentation" >&2; \
+		rm -f apis/docs/v1/doc.md.tmpl; \
+		exit 1; \
+	fi
+	if ! mv $(ROOTDIR)/apis/docs/v1/doc.md $1; then \
+		echo "Error: Failed to move documentation to target location" >&2; \
+		rm -f apis/docs/v1/doc.md.tmpl; \
+		exit 1; \
+	fi
+	rm -f apis/docs/v1/*doc.md.tmpl
apis/docs/v1/remove.md (2)

19-19: Fix typo in RPC description

"Inset" should be "Insert"

-Inset RPC is the method to add a new single vector.
+Insert RPC is the method to add a new single vector.

225-225: Provide specific batch size recommendations

Replace the vague "large number" with specific recommendations for optimal batch sizes based on typical use cases.

-It's the recommended method to remove a large number of vectors.
+It's the recommended method to remove vectors in bulk (recommended batch size: 1000-10000 vectors).
🧰 Tools
🪛 LanguageTool

[style] ~225-~225: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to remove a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)

apis/docs/v1/index.md (1)

63-63: Fix grammar in agent-related descriptions

The word "agent" should be singular when used with "each".

-for each agents
+for each agent

Apply this change to all four instances in the file.

Also applies to: 109-109, 231-231, 304-304

🧰 Tools
🪛 LanguageTool

[grammar] ~63-~63: The noun should probably be in the singular form.
Context: ...C to get the index information for each agents. ### Input - the scheme of `payload.v...

(EVERY_EACH_SINGULAR)

apis/docs/v1/insert.md (1)

143-143: Standardize batch size recommendations across documentation

Use consistent and specific batch size recommendations across all streaming RPC documentation.

-It's the recommended method to insert a large number of vectors.
+It's the recommended method to insert vectors in bulk (recommended batch size: 1000-10000 vectors).
🧰 Tools
🪛 LanguageTool

[style] ~143-~143: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to insert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)

apis/proto/v1/vald/search.proto (1)

29-31: Follow gRPC service naming convention.

According to the buf linter, the service name should be suffixed with "Service" to follow gRPC naming conventions.

- service Search {
+ service SearchService {
🧰 Tools
🪛 buf (1.47.2)

31-31: Service name "Search" should be suffixed with "Service".

(SERVICE_SUFFIX)

apis/docs/v1/search.md (1)

1-6: Enhance API documentation with examples and performance considerations.

Consider adding:

  1. Code examples for common use cases
  2. Performance best practices and recommendations
  3. Benchmarks or performance characteristics for different search methods
apis/proto/v1/vald/upsert.proto (1)

99-102: Add warning about gRPC message size limit.

Consider adding a warning about gRPC message size limitations in the HTML notice div, similar to the one in MultiUpsert (lines 99-102), as this is also relevant for single vector operations.

apis/docs/v1/upsert.md (3)

397-399: Add missing description for locations field.

The description for the locations field in the Object.Locations message is empty. Consider adding a description like "List of vector locations."


72-72: Fix code block style inconsistencies.

Use fenced code blocks consistently throughout the document instead of indented code blocks.

Apply this format:

-        | field | type | label | description |
-        | :---: | :--- | :---- | :---------- |
+```markdown
+| field | type | label | description |
+| :---: | :--- | :---- | :---------- |
+```

Also applies to: 202-202, 356-356

🧰 Tools
🪛 Markdownlint (0.35.0)

72-72: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


149-149: Improve clarity in phrasing.

Consider revising "large number of" to be more specific or use "many"/"numerous" for better clarity.

Example: "It's the recommended method to upsert numerous vectors."

🧰 Tools
🪛 LanguageTool

[style] ~149-~149: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It’s the recommended method to upsert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)

apis/docs/v1/update.md (3)

151-151: Fix grammar in StreamUpdate description.

Replace "amount of" with "number of" for better grammar when referring to countable items.

-It's the recommended method to update the large amount of vectors.
+It's the recommended method to update the large number of vectors.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~151-~151: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... recommended method to update the large amount of vectors. ### Input - the scheme of...

(AMOUNTOF_TO_NUMBEROF)


143-143: Fix grammar in ALREADY_EXISTS error description.

Add missing article "a" before "Request pair" in multiple error descriptions.

-Request pair of ID and vector is already inserted.
+A request pair of ID and vector is already inserted.

Also applies to: 286-286, 439-439

🧰 Tools
🪛 LanguageTool

[grammar] ~143-~143: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)


73-73: Fix markdown code block style.

Use fenced code blocks instead of indented code blocks for consistent formatting.

The table formatting in these sections should use consistent indentation and fenced code blocks (```) instead of indented blocks.

Also applies to: 204-204, 359-359

🧰 Tools
🪛 Markdownlint (0.35.0)

73-73: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2f26634 and 252a0cd.

📒 Files selected for processing (29)
  • Makefile (1 hunks)
  • Makefile.d/functions.mk (1 hunks)
  • Makefile.d/proto.mk (2 hunks)
  • apis/docs/buf.gen.doc.yaml (1 hunks)
  • apis/docs/buf.gen.payload.yaml (1 hunks)
  • apis/docs/buf.gen.tmpl.yaml (1 hunks)
  • apis/docs/v1/doc.tmpl (1 hunks)
  • apis/docs/v1/filter.md (1 hunks)
  • apis/docs/v1/flush.md (1 hunks)
  • apis/docs/v1/index.md (1 hunks)
  • apis/docs/v1/insert.md (1 hunks)
  • apis/docs/v1/mirror.md (1 hunks)
  • apis/docs/v1/object.md (1 hunks)
  • apis/docs/v1/payload.md.tmpl (1 hunks)
  • apis/docs/v1/payload.tmpl (1 hunks)
  • apis/docs/v1/remove.md (1 hunks)
  • apis/docs/v1/search.md (1 hunks)
  • apis/docs/v1/update.md (1 hunks)
  • apis/docs/v1/upsert.md (1 hunks)
  • apis/proto/v1/mirror/mirror.proto (1 hunks)
  • apis/proto/v1/vald/filter.proto (1 hunks)
  • apis/proto/v1/vald/flush.proto (1 hunks)
  • apis/proto/v1/vald/index.proto (1 hunks)
  • apis/proto/v1/vald/insert.proto (1 hunks)
  • apis/proto/v1/vald/object.proto (1 hunks)
  • apis/proto/v1/vald/remove.proto (1 hunks)
  • apis/proto/v1/vald/search.proto (1 hunks)
  • apis/proto/v1/vald/update.proto (1 hunks)
  • apis/proto/v1/vald/upsert.proto (1 hunks)
✅ Files skipped from review due to trivial changes (4)
  • apis/docs/buf.gen.doc.yaml
  • apis/docs/buf.gen.payload.yaml
  • apis/docs/buf.gen.tmpl.yaml
  • apis/docs/v1/mirror.md
🧰 Additional context used
🪛 buf (1.47.2)
apis/proto/v1/vald/flush.proto

31-31: Service name "Flush" should be suffixed with "Service".

(SERVICE_SUFFIX)

apis/proto/v1/mirror/mirror.proto

30-30: Service name "Mirror" should be suffixed with "Service".

(SERVICE_SUFFIX)

apis/proto/v1/vald/upsert.proto

31-31: Service name "Upsert" should be suffixed with "Service".

(SERVICE_SUFFIX)


57-62: "payload.v1.Upsert.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


57-57: RPC request type "Request" should be named "UpsertRequest" or "UpsertUpsertRequest".

(RPC_REQUEST_STANDARD_NAME)


57-57: RPC response type "Location" should be named "UpsertResponse" or "UpsertUpsertResponse".

(RPC_RESPONSE_STANDARD_NAME)


92-92: "payload.v1.Upsert.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


92-92: RPC request type "Request" should be named "StreamUpsertRequest" or "UpsertStreamUpsertRequest".

(RPC_REQUEST_STANDARD_NAME)


92-92: RPC response type "StreamLocation" should be named "StreamUpsertResponse" or "UpsertStreamUpsertResponse".

(RPC_RESPONSE_STANDARD_NAME)

apis/proto/v1/vald/object.proto

31-31: Service name "Object" should be suffixed with "Service".

(SERVICE_SUFFIX)


55-57: RPC "Exists" has the same type "payload.v1.Object.ID" for the request and response.

(RPC_REQUEST_RESPONSE_UNIQUE)


55-55: RPC request type "ID" should be named "ExistsRequest" or "ObjectExistsRequest".

(RPC_REQUEST_STANDARD_NAME)


55-55: RPC response type "ID" should be named "ExistsResponse" or "ObjectExistsResponse".

(RPC_RESPONSE_STANDARD_NAME)


82-84: "payload.v1.Object.VectorRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


82-82: RPC request type "VectorRequest" should be named "GetObjectRequest" or "ObjectGetObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


82-82: RPC response type "Vector" should be named "GetObjectResponse" or "ObjectGetObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


111-111: "payload.v1.Object.VectorRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


111-111: RPC request type "VectorRequest" should be named "StreamGetObjectRequest" or "ObjectStreamGetObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


111-111: RPC response type "StreamVector" should be named "StreamGetObjectResponse" or "ObjectStreamGetObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


121-121: RPC request type "Request" should be named "StreamListObjectRequest" or "ObjectStreamListObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


121-121: RPC response type "Response" should be named "StreamListObjectResponse" or "ObjectStreamListObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)

apis/proto/v1/vald/index.proto

31-31: Service name "Index" should be suffixed with "Service".

(SERVICE_SUFFIX)


34-36: "payload.v1.Empty" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


34-34: RPC request type "Empty" should be named "IndexInfoRequest" or "IndexIndexInfoRequest".

(RPC_REQUEST_STANDARD_NAME)


34-34: RPC response type "Count" should be named "IndexInfoResponse" or "IndexIndexInfoResponse".

(RPC_RESPONSE_STANDARD_NAME)


40-42: "payload.v1.Empty" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


40-40: RPC request type "Empty" should be named "IndexDetailRequest" or "IndexIndexDetailRequest".

(RPC_REQUEST_STANDARD_NAME)


40-40: RPC response type "Detail" should be named "IndexDetailResponse" or "IndexIndexDetailResponse".

(RPC_RESPONSE_STANDARD_NAME)


46-48: "payload.v1.Empty" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


46-46: RPC request type "Empty" should be named "IndexStatisticsRequest" or "IndexIndexStatisticsRequest".

(RPC_REQUEST_STANDARD_NAME)


46-46: RPC response type "Statistics" should be named "IndexStatisticsResponse" or "IndexIndexStatisticsResponse".

(RPC_RESPONSE_STANDARD_NAME)


52-54: "payload.v1.Empty" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


52-52: RPC request type "Empty" should be named "IndexStatisticsDetailRequest" or "IndexIndexStatisticsDetailRequest".

(RPC_REQUEST_STANDARD_NAME)


52-52: RPC response type "StatisticsDetail" should be named "IndexStatisticsDetailResponse" or "IndexIndexStatisticsDetailResponse".

(RPC_RESPONSE_STANDARD_NAME)

apis/proto/v1/vald/insert.proto

31-31: Service name "Insert" should be suffixed with "Service".

(SERVICE_SUFFIX)


55-60: "payload.v1.Insert.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


55-55: RPC request type "Request" should be named "InsertRequest" or "InsertInsertRequest".

(RPC_REQUEST_STANDARD_NAME)


55-55: RPC response type "Location" should be named "InsertResponse" or "InsertInsertResponse".

(RPC_RESPONSE_STANDARD_NAME)


89-89: "payload.v1.Insert.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


89-89: RPC request type "Request" should be named "StreamInsertRequest" or "InsertStreamInsertRequest".

(RPC_REQUEST_STANDARD_NAME)


89-89: RPC response type "StreamLocation" should be named "StreamInsertResponse" or "InsertStreamInsertResponse".

(RPC_RESPONSE_STANDARD_NAME)

apis/proto/v1/vald/update.proto

31-31: Service name "Update" should be suffixed with "Service".

(SERVICE_SUFFIX)


58-63: "payload.v1.Object.Location" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


58-63: "payload.v1.Update.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


58-58: RPC request type "Request" should be named "UpdateRequest" or "UpdateUpdateRequest".

(RPC_REQUEST_STANDARD_NAME)


58-58: RPC response type "Location" should be named "UpdateResponse" or "UpdateUpdateResponse".

(RPC_RESPONSE_STANDARD_NAME)


94-94: "payload.v1.Update.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


94-94: RPC request type "Request" should be named "StreamUpdateRequest" or "UpdateStreamUpdateRequest".

(RPC_REQUEST_STANDARD_NAME)


94-94: RPC response type "StreamLocation" should be named "StreamUpdateResponse" or "UpdateStreamUpdateResponse".

(RPC_RESPONSE_STANDARD_NAME)


127-127: RPC request type "MultiRequest" should be named "MultiUpdateRequest" or "UpdateMultiUpdateRequest".

(RPC_REQUEST_STANDARD_NAME)


127-127: RPC response type "Locations" should be named "MultiUpdateResponse" or "UpdateMultiUpdateResponse".

(RPC_RESPONSE_STANDARD_NAME)

apis/proto/v1/vald/remove.proto

31-31: Service name "Remove" should be suffixed with "Service".

(SERVICE_SUFFIX)


56-61: "payload.v1.Remove.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


56-56: RPC request type "Request" should be named "RemoveRequest" or "RemoveRemoveRequest".

(RPC_REQUEST_STANDARD_NAME)


56-56: RPC response type "Location" should be named "RemoveResponse" or "RemoveRemoveResponse".

(RPC_RESPONSE_STANDARD_NAME)


90-95: "payload.v1.Object.Locations" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


90-90: RPC request type "TimestampRequest" should be named "RemoveByTimestampRequest" or "RemoveRemoveByTimestampRequest".

(RPC_REQUEST_STANDARD_NAME)


90-90: RPC response type "Locations" should be named "RemoveByTimestampResponse" or "RemoveRemoveByTimestampResponse".

(RPC_RESPONSE_STANDARD_NAME)


126-126: "payload.v1.Remove.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


126-126: RPC request type "Request" should be named "StreamRemoveRequest" or "RemoveStreamRemoveRequest".

(RPC_REQUEST_STANDARD_NAME)


126-126: RPC response type "StreamLocation" should be named "StreamRemoveResponse" or "RemoveStreamRemoveResponse".

(RPC_RESPONSE_STANDARD_NAME)

apis/proto/v1/vald/filter.proto

33-33: Service name "Filter" should be suffixed with "Service".

(SERVICE_SUFFIX)


44-49: "payload.v1.Search.ObjectRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


44-44: RPC request type "ObjectRequest" should be named "SearchObjectRequest" or "FilterSearchObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


44-44: RPC response type "Response" should be named "SearchObjectResponse" or "FilterSearchObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


63-63: RPC request type "MultiObjectRequest" should be named "MultiSearchObjectRequest" or "FilterMultiSearchObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


63-63: RPC response type "Responses" should be named "MultiSearchObjectResponse" or "FilterMultiSearchObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


85-85: "payload.v1.Search.ObjectRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


85-85: RPC request type "ObjectRequest" should be named "StreamSearchObjectRequest" or "FilterStreamSearchObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


85-85: RPC response type "StreamResponse" should be named "StreamSearchObjectResponse" or "FilterStreamSearchObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


97-102: "payload.v1.Insert.ObjectRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


97-102: "payload.v1.Object.Location" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


97-97: RPC request type "ObjectRequest" should be named "InsertObjectRequest" or "FilterInsertObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


97-97: RPC response type "Location" should be named "InsertObjectResponse" or "FilterInsertObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


118-118: "payload.v1.Insert.ObjectRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


118-118: "payload.v1.Object.StreamLocation" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


118-118: RPC request type "ObjectRequest" should be named "StreamInsertObjectRequest" or "FilterStreamInsertObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


118-118: RPC response type "StreamLocation" should be named "StreamInsertObjectResponse" or "FilterStreamInsertObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


130-135: "payload.v1.Object.Locations" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


130-130: RPC request type "MultiObjectRequest" should be named "MultiInsertObjectRequest" or "FilterMultiInsertObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


130-130: RPC response type "Locations" should be named "MultiInsertObjectResponse" or "FilterMultiInsertObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


147-152: "payload.v1.Object.Location" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


147-152: "payload.v1.Update.ObjectRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


147-147: RPC request type "ObjectRequest" should be named "UpdateObjectRequest" or "FilterUpdateObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


147-147: RPC response type "Location" should be named "UpdateObjectResponse" or "FilterUpdateObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


167-167: "payload.v1.Object.StreamLocation" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


167-167: "payload.v1.Update.ObjectRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


167-167: RPC request type "ObjectRequest" should be named "StreamUpdateObjectRequest" or "FilterStreamUpdateObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


167-167: RPC response type "StreamLocation" should be named "StreamUpdateObjectResponse" or "FilterStreamUpdateObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


185-190: "payload.v1.Object.Locations" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


185-185: RPC request type "MultiObjectRequest" should be named "MultiUpdateObjectRequest" or "FilterMultiUpdateObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


185-185: RPC response type "Locations" should be named "MultiUpdateObjectResponse" or "FilterMultiUpdateObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


202-207: "payload.v1.Object.Location" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


202-207: "payload.v1.Upsert.ObjectRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


202-202: RPC request type "ObjectRequest" should be named "UpsertObjectRequest" or "FilterUpsertObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


202-202: RPC response type "Location" should be named "UpsertObjectResponse" or "FilterUpsertObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)


219-219: "payload.v1.Object.StreamLocation" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


219-219: "payload.v1.Upsert.ObjectRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


219-219: RPC request type "ObjectRequest" should be named "StreamUpsertObjectRequest" or "FilterStreamUpsertObjectRequest".

(RPC_REQUEST_STANDARD_NAME)


219-219: RPC response type "StreamLocation" should be named "StreamUpsertObjectResponse" or "FilterStreamUpsertObjectResponse".

(RPC_RESPONSE_STANDARD_NAME)

apis/proto/v1/vald/search.proto

31-31: Service name "Search" should be suffixed with "Service".

(SERVICE_SUFFIX)


56-61: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


56-61: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


56-56: RPC request type "Request" should be named "SearchRequest" or "SearchSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


56-56: RPC response type "Response" should be named "SearchResponse" or "SearchSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


88-93: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


88-93: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


88-88: RPC request type "IDRequest" should be named "SearchByIDRequest" or "SearchSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


88-88: RPC response type "Response" should be named "SearchByIDResponse" or "SearchSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


121-121: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


121-121: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


121-121: RPC request type "Request" should be named "StreamSearchRequest" or "SearchStreamSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


121-121: RPC response type "StreamResponse" should be named "StreamSearchResponse" or "SearchStreamSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


149-149: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


149-149: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


149-149: RPC request type "IDRequest" should be named "StreamSearchByIDRequest" or "SearchStreamSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


149-149: RPC response type "StreamResponse" should be named "StreamSearchByIDResponse" or "SearchStreamSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


180-185: "payload.v1.Search.MultiRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


180-185: "payload.v1.Search.Responses" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


180-180: RPC request type "MultiRequest" should be named "MultiSearchRequest" or "SearchMultiSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


180-180: RPC response type "Responses" should be named "MultiSearchResponse" or "SearchMultiSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


216-221: "payload.v1.Search.MultiIDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


216-221: "payload.v1.Search.Responses" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


216-216: RPC request type "MultiIDRequest" should be named "MultiSearchByIDRequest" or "SearchMultiSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


216-216: RPC response type "Responses" should be named "MultiSearchByIDResponse" or "SearchMultiSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


247-252: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


247-252: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


247-247: RPC request type "Request" should be named "LinearSearchRequest" or "SearchLinearSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


247-247: RPC response type "Response" should be named "LinearSearchResponse" or "SearchLinearSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


280-285: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


280-285: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


280-280: RPC request type "IDRequest" should be named "LinearSearchByIDRequest" or "SearchLinearSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


280-280: RPC response type "Response" should be named "LinearSearchByIDResponse" or "SearchLinearSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


313-313: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


313-313: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


313-313: RPC request type "Request" should be named "StreamLinearSearchRequest" or "SearchStreamLinearSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


313-313: RPC response type "StreamResponse" should be named "StreamLinearSearchResponse" or "SearchStreamLinearSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


341-341: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


341-341: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


341-341: RPC request type "IDRequest" should be named "StreamLinearSearchByIDRequest" or "SearchStreamLinearSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


341-341: RPC response type "StreamResponse" should be named "StreamLinearSearchByIDResponse" or "SearchStreamLinearSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


372-377: "payload.v1.Search.MultiRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


372-377: "payload.v1.Search.Responses" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


372-372: RPC request type "MultiRequest" should be named "MultiLinearSearchRequest" or "SearchMultiLinearSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


372-372: RPC response type "Responses" should be named "MultiLinearSearchResponse" or "SearchMultiLinearSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)

🪛 LanguageTool
apis/docs/v1/flush.md

[uncategorized] ~4-~4: You might be missing the article “the” here.
Context: # Vald Flush APIs ## Overview Flush Service is responsible for removing all...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

apis/docs/v1/update.md

[grammar] ~143-~143: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)


[uncategorized] ~151-~151: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... recommended method to update the large amount of vectors. ### Input - the scheme of...

(AMOUNTOF_TO_NUMBEROF)


[grammar] ~286-~286: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)


[grammar] ~439-~439: An article may be missing.
Context: ... | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. ...

(BUNCH_OF)

apis/docs/v1/upsert.md

[style] ~149-~149: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It’s the recommended method to upsert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)

apis/docs/v1/insert.md

[style] ~143-~143: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to insert a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)

apis/docs/v1/index.md

[grammar] ~63-~63: The noun should probably be in the singular form.
Context: ...C to get the index information for each agents. ### Input - the scheme of `payload.v...

(EVERY_EACH_SINGULAR)


[grammar] ~109-~109: The noun should probably be in the singular form.
Context: ...Entry | repeated | count infos for each agents | | replica | uint32 ...

(EVERY_EACH_SINGULAR)


[grammar] ~231-~231: The noun should probably be in the singular form.
Context: ...PC to get the index statistics for each agents. ### Input - the scheme of `payload.v...

(EVERY_EACH_SINGULAR)


[grammar] ~304-~304: The noun should probably be in the singular form.
Context: ...Entry | repeated | count infos for each agents | - Info.Index.StatisticsDetail.Deta...

(EVERY_EACH_SINGULAR)

apis/docs/v1/filter.md

[style] ~567-~567: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to insert a large number of objects. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)


[uncategorized] ~927-~927: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... recommended method to update the large amount of objects. ### Input - the scheme of...

(AMOUNTOF_TO_NUMBEROF)

apis/docs/v1/remove.md

[style] ~225-~225: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to remove a large number of vectors. ### Input - the scheme of `p...

(LARGE_NUMBER_OF)

🪛 Markdownlint (0.35.0)
apis/docs/v1/update.md

73-73: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


204-204: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


359-359: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)

apis/docs/v1/upsert.md

72-72: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


202-202: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


356-356: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)

apis/docs/v1/filter.md

866-866: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


980-980: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


1118-1118: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


1239-1239: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


1350-1350: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)


1488-1488: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)

apis/docs/v1/remove.md

149-149: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)

🔇 Additional comments (14)
apis/proto/v1/mirror/mirror.proto (2)

28-29: LGTM! Clear and well-structured service documentation.

The overview section effectively describes the Mirror service's responsibility and follows the project's documentation standards.


30-30: Verify service naming convention across the project.

Static analysis suggests that the service name "Mirror" should be suffixed with "Service" according to protobuf best practices.

Let's check if this naming convention is consistently applied across other services in the project:

🧰 Tools
🪛 buf (1.47.2)

30-30: Service name "Mirror" should be suffixed with "Service".

(SERVICE_SUFFIX)

apis/docs/v1/doc.tmpl (2)

1-8: Consider adding validation for malformed documentation sections

The template assumes well-formed documentation with proper "---" delimiters. Consider adding validation or error handling for:

  • Empty documentation sections
  • Malformed section headers
  • Missing required sections

38-40: Verify referenced template definitions exist

The template references external templates for schemes and fields. Please ensure these templates exist and are properly defined:

  • scheme:*
  • field:*

Also applies to: 46-48

✅ Verification successful

Template definitions are properly structured and available

The template system is correctly set up with all necessary template definitions:

  • The scheme:* and field:* templates are defined in payload.md.tmpl
  • Each template has a corresponding underscore-prefixed implementation (e.g. scheme:foo calls _scheme:foo)
  • The template hierarchy is complete and consistent
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for referenced template definitions
rg -l 'define "scheme:' .
rg -l 'define "field:' .

Length of output: 116


Script:

#!/bin/bash
# Check the actual template definitions in payload.md.tmpl
rg 'define "(?:scheme|field):' -A 5 ./apis/docs/v1/payload.md.tmpl

Length of output: 37572


Script:

#!/bin/bash
# Check for the referenced underscore templates that are being used
rg 'template "_(?:scheme|field):' -A 1 ./apis/docs/v1/payload.md.tmpl

Length of output: 29647


Script:

#!/bin/bash
# Check for the definition of underscore templates
rg 'define "_(?:scheme|field):' ./apis/docs/v1/

Length of output: 17056

Makefile.d/proto.mk (1)

74-77: 🛠️ Refactor suggestion

Add error handling for template generation

The template generation process should handle potential errors when the template file is missing or invalid.

 proto/gen/api/docs/payload: $(ROOTDIR)/apis/docs/v1/payload.md.tmpl
+	@if [ ! -f "$(ROOTDIR)/apis/docs/v1/payload.md.tmpl" ]; then \
+		echo "Error: Template file not found"; \
+		exit 1; \
+	fi

Likely invalid or redundant comment.

apis/docs/v1/object.md (1)

191-191: ⚠️ Potential issue

Fix incorrect reference in StreamGetObject documentation

The documentation incorrectly refers to "Upsert" instead of "GetObject".

-Each Upsert request and response are independent.
+Each GetObject request and response are independent.

Likely invalid or redundant comment.

apis/docs/v1/remove.md (1)

333-336: Enhance the gRPC message size limitation notice

The notice should include specific details about:

  1. Default gRPC message size limit
  2. Recommended maximum number of vectors per request
  3. How to configure custom message size limits
apis/docs/v1/insert.md (1)

279-282: Enhance the gRPC message size limitation notice

The notice should include specific details about:

  1. Default gRPC message size limit
  2. Recommended maximum number of vectors per request
  3. How to configure custom message size limits
apis/proto/v1/vald/search.proto (2)

32-166: Reduce documentation duplication.

The status codes and troubleshooting sections are identical across all RPC methods. Consider consolidating these common sections into a shared documentation area.

🧰 Tools
🪛 buf (1.47.2)

56-61: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


56-61: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


56-56: RPC request type "Request" should be named "SearchRequest" or "SearchSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


56-56: RPC response type "Response" should be named "SearchResponse" or "SearchSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


88-93: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


88-93: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


88-88: RPC request type "IDRequest" should be named "SearchByIDRequest" or "SearchSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


88-88: RPC response type "Response" should be named "SearchByIDResponse" or "SearchSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


121-121: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


121-121: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


121-121: RPC request type "Request" should be named "StreamSearchRequest" or "SearchStreamSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


121-121: RPC response type "StreamResponse" should be named "StreamSearchResponse" or "SearchStreamSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


149-149: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


149-149: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


149-149: RPC request type "IDRequest" should be named "StreamSearchByIDRequest" or "SearchStreamSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


149-149: RPC response type "StreamResponse" should be named "StreamSearchByIDResponse" or "SearchStreamSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


Line range hint 627-630: Enhance gRPC message size limitation notice.

The notice about gRPC message size limitations lacks specific details that would help developers.

🧰 Tools
🪛 buf (1.47.2)

31-31: Service name "Search" should be suffixed with "Service".

(SERVICE_SUFFIX)


56-61: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


56-61: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


56-56: RPC request type "Request" should be named "SearchRequest" or "SearchSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


56-56: RPC response type "Response" should be named "SearchResponse" or "SearchSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


88-93: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


88-93: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


88-88: RPC request type "IDRequest" should be named "SearchByIDRequest" or "SearchSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


88-88: RPC response type "Response" should be named "SearchByIDResponse" or "SearchSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


121-121: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


121-121: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


121-121: RPC request type "Request" should be named "StreamSearchRequest" or "SearchStreamSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


121-121: RPC response type "StreamResponse" should be named "StreamSearchResponse" or "SearchStreamSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


149-149: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


149-149: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


149-149: RPC request type "IDRequest" should be named "StreamSearchByIDRequest" or "SearchStreamSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


149-149: RPC response type "StreamResponse" should be named "StreamSearchByIDResponse" or "SearchStreamSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


180-185: "payload.v1.Search.MultiRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


180-185: "payload.v1.Search.Responses" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


180-180: RPC request type "MultiRequest" should be named "MultiSearchRequest" or "SearchMultiSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


180-180: RPC response type "Responses" should be named "MultiSearchResponse" or "SearchMultiSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


216-221: "payload.v1.Search.MultiIDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


216-221: "payload.v1.Search.Responses" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


216-216: RPC request type "MultiIDRequest" should be named "MultiSearchByIDRequest" or "SearchMultiSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


216-216: RPC response type "Responses" should be named "MultiSearchByIDResponse" or "SearchMultiSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


247-252: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


247-252: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


247-247: RPC request type "Request" should be named "LinearSearchRequest" or "SearchLinearSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


247-247: RPC response type "Response" should be named "LinearSearchResponse" or "SearchLinearSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


280-285: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


280-285: "payload.v1.Search.Response" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


280-280: RPC request type "IDRequest" should be named "LinearSearchByIDRequest" or "SearchLinearSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


280-280: RPC response type "Response" should be named "LinearSearchByIDResponse" or "SearchLinearSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


313-313: "payload.v1.Search.Request" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


313-313: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


313-313: RPC request type "Request" should be named "StreamLinearSearchRequest" or "SearchStreamLinearSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


313-313: RPC response type "StreamResponse" should be named "StreamLinearSearchResponse" or "SearchStreamLinearSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


341-341: "payload.v1.Search.IDRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


341-341: "payload.v1.Search.StreamResponse" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


341-341: RPC request type "IDRequest" should be named "StreamLinearSearchByIDRequest" or "SearchStreamLinearSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


341-341: RPC response type "StreamResponse" should be named "StreamLinearSearchByIDResponse" or "SearchStreamLinearSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)


372-377: "payload.v1.Search.MultiRequest" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


372-377: "payload.v1.Search.Responses" is used as the request or response type for multiple RPCs.

(RPC_REQUEST_RESPONSE_UNIQUE)


372-372: RPC request type "MultiRequest" should be named "MultiLinearSearchRequest" or "SearchMultiLinearSearchRequest".

(RPC_REQUEST_STANDARD_NAME)


372-372: RPC response type "Responses" should be named "MultiLinearSearchResponse" or "SearchMultiLinearSearchResponse".

(RPC_RESPONSE_STANDARD_NAME)


408-408: RPC request type "MultiIDRequest" should be named "MultiLinearSearchByIDRequest" or "SearchMultiLinearSearchByIDRequest".

(RPC_REQUEST_STANDARD_NAME)


408-408: RPC response type "Responses" should be named "MultiLinearSearchByIDResponse" or "SearchMultiLinearSearchByIDResponse".

(RPC_RESPONSE_STANDARD_NAME)

apis/docs/v1/filter.md (1)

1-8: Documentation follows consistent structure.

The documentation maintains consistency with other API docs, which is good for maintainability and usability.

apis/proto/v1/vald/upsert.proto (2)

29-30: LGTM! Clear service overview.

The service overview effectively describes the dual responsibility of the Upsert service (update existing vectors or insert new ones).


32-57: LGTM! Comprehensive method documentation.

The Upsert method documentation is well-structured with:

  • Clear overview
  • Detailed status code table
  • Practical troubleshooting guidance
🧰 Tools
🪛 buf (1.47.2)

57-57: RPC request type "Request" should be named "UpsertRequest" or "UpsertUpsertRequest".

(RPC_REQUEST_STANDARD_NAME)


57-57: RPC response type "Location" should be named "UpsertResponse" or "UpsertUpsertResponse".

(RPC_RESPONSE_STANDARD_NAME)

Makefile (1)

156-159: LGTM! Well-structured protobuf documentation variables.

The new variables are well-organized and follow consistent naming patterns:

  • PROTO_VALD_APIS: Correctly filters protobuf files from vald directory
  • PROTO_VALD_API_DOCS: Properly maps proto files to documentation paths
  • PROTO_MIRROR_APIS: Correctly filters protobuf files from mirror directory
  • PROTO_MIRROR_API_DOCS: Properly maps proto files to documentation paths

apis/docs/v1/payload.md.tmpl Show resolved Hide resolved
apis/docs/v1/payload.md.tmpl Show resolved Hide resolved
apis/proto/v1/vald/flush.proto Show resolved Hide resolved
apis/proto/v1/vald/index.proto Show resolved Hide resolved
apis/proto/v1/vald/index.proto Show resolved Hide resolved
apis/docs/v1/object.md Show resolved Hide resolved
apis/proto/v1/vald/update.proto Show resolved Hide resolved
apis/docs/v1/update.md Show resolved Hide resolved
apis/docs/v1/update.md Show resolved Hide resolved
apis/docs/v1/update.md Show resolved Hide resolved
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to insert a large number of vectors.


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

rpc Register(payload.v1.Mirror.Targets) returns (payload.v1.Mirror.Targets) {}


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Object.ID id = 1;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Remove.Timestamp.Operator operator = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to remove a large number of vectors.


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


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

Remove.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It’s the recommended method to upsert a large number of vectors.


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;

@kmrmt kmrmt changed the title [MERGE PENDING] change symlink API documents change symlink API documents Dec 10, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to insert a large number of vectors.


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

rpc Register(payload.v1.Mirror.Targets) returns (payload.v1.Mirror.Targets) {}


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Object.ID id = 1;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Remove.Timestamp.Operator operator = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to remove a large number of vectors.


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


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

Remove.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It’s the recommended method to upsert a large number of vectors.


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to insert a large number of vectors.


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Insert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

rpc Register(payload.v1.Mirror.Targets) returns (payload.v1.Mirror.Targets) {}


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Object.ID id = 1;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Remove.Timestamp.Operator operator = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It's the recommended method to remove a large number of vectors.


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

Object.ID id = 1;


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

Remove.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.ID id = 1;


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

Remove.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Response response = 1;


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

google.rpc.Status status = 2;


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

Search.Config config = 2;


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

Search.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


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

Object.Vector vector = 1;


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

Update.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
An article may be missing. (BUNCH_OF[6])
Suggestions: a pair of
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=6
Category: GRAMMAR

| ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. |


[LanguageTool] reported by reviewdog 🐶
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


[LanguageTool] reported by reviewdog 🐶
Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF[1])
Suggestions: many, numerous
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/LARGE_NUMBER_OF?lang=en-US&subId=1
Category: REDUNDANCY

It’s the recommended method to upsert a large number of vectors.


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;


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

Object.Location location = 1;


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

google.rpc.Status status = 2;


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

Object.Vector vector = 1;


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

Upsert.Config config = 2;

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: 0

🧹 Outside diff range and nitpick comments (1)
Makefile (1)

156-159: LGTM! Consider adding documentation.

The implementation of the new protobuf documentation variables is correct and follows the established patterns. Consider adding a comment block above these variables explaining their purpose for better maintainability.

+# Variables for API documentation generation
+# PROTO_VALD_APIS: List of protobuf files from vald API directory
+# PROTO_VALD_API_DOCS: Generated documentation paths for vald APIs
+# PROTO_MIRROR_APIS: List of protobuf files from mirror API directory
+# PROTO_MIRROR_API_DOCS: Generated documentation paths for mirror APIs
 PROTO_VALD_APIS := $(eval PROTO_VALD_APIS := $(filter $(ROOTDIR)/apis/proto/v1/vald/%.proto,$(PROTOS)))$(PROTO_VALD_APIS)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 252a0cd and d9ee0a9.

📒 Files selected for processing (2)
  • Makefile (1 hunks)
  • Makefile.d/functions.mk (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Makefile.d/functions.mk
🔇 Additional comments (1)
Makefile (1)

156-159: Verify usage in included makefiles.

Let's verify how these new variables are used in the included makefiles to ensure proper integration.

✅ Verification successful

The variables are properly integrated and used in the Makefile system

The verification shows that PROTO_VALD_API_DOCS and PROTO_MIRROR_API_DOCS are correctly used in Makefile.d/proto.mk as dependencies for the proto/gen/api/docs target, which is part of the main protobuf generation workflow. The variables are used alongside corresponding pattern rules that handle the document generation for both Vald and Mirror APIs.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check usage of the new proto documentation variables in included makefiles

# Search for variable usage in Makefile.d/*.mk files
echo "Checking usage in Makefile.d/*.mk files:"
rg -A 5 "PROTO_(VALD|MIRROR)_(APIS|API_DOCS)" Makefile.d/

# Specifically check proto.mk since it's most likely to use these variables
echo "Checking proto.mk specifically:"
cat Makefile.d/proto.mk

Length of output: 4579

@vankichi vankichi merged commit 3d74ef5 into main Dec 13, 2024
209 of 210 checks passed
@vankichi vankichi deleted the documentation/api/change-directory-structure branch December 13, 2024 05:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants