[MERGE PENDING] change symlink API documents #2741

kmrmt · 2024-11-14T06:01:52Z

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

I have read the CONTRIBUTING document and completed our CLA agreement.
I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

Release Notes

New Features
- Introduced Vald APIs for Flush, Insert, Object, Remove, Search, Update, and Upsert 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.

coderabbitai · 2024-11-14T06:01:59Z

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (3)

WIP
DO NOT MERGE
DNM

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

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

📝 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. - New RPC method `Flush` defined. - New message structures `Flush.Request` and `Object.Info_Index_Count` created.
`apis/docs/v1/insert.md`	- New service `Insert` added. - RPC methods `Insert`, `StreamInsert`, and `MultiInsert` defined. - New message structures for requests and responses created.
`apis/docs/v1/object.md`	- New service `Object` added. - RPC methods `Exists`, `GetObject`, and `StreamGetObject` defined. - New message structures for requests and responses created.
`apis/docs/v1/remove.md`	- New service `Remove` added. - RPC methods `Remove`, `RemoveByTimestamp`, `StreamRemove`, and `MultiRemove` defined. - New message structures for requests and responses created.
`apis/docs/v1/search.md`	- New service `Search` added. - Multiple RPC methods defined, including `Search`, `SearchByID`, `StreamSearch`, and others. - New message structures for requests and responses created.
`apis/docs/v1/update.md`	- New service `Update` added. - RPC methods `Update`, `StreamUpdate`, and `MultiUpdate` defined. - New message structures for requests and responses created.
`apis/docs/v1/upsert.md`	- New service `Upsert` added. - RPC methods `Upsert`, `StreamUpsert`, and `MultiUpsert` defined. - New message structures for requests and responses created.

Possibly related PRs

Feature/meta/save metadata #2624: Introduces a new feature for saving metadata, potentially related to the Flush API documentation.
Buf CLI migrate to v2 #2691: Focuses on migrating the project to Buf version 2, which could impact API documentation structure.
Backport PR #2691 to release/v1.7 for Buf CLI migrate to v2 #2695: Backport PR related to the migration to Buf version 2, affecting API documentation.
Update README.md #2724: Updates the README.md, possibly including references to the Flush API documentation.
Backport PR #2724 to release/v1.7 for Update README.md #2725: Backport PR ensuring consistency in README.md updates related to the Flush API documentation.

Suggested labels

type/feature, size/XXXL, area/index/job/creation

Suggested reviewers

hlts2
kpango
vankichi

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 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 · 2024-11-14T06:02:03Z

[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

cloudflare-workers-and-pages · 2024-11-14T06:02:30Z

Deploying vald with Cloudflare Pages

Latest commit:	`32fb34c`
Status:	✅ Deploy successful!
Preview URL:	https://5c7e23e2.vald.pages.dev
Branch Preview URL:	https://documentation-api-change-dir.vald.pages.dev

View logs

github-actions

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

[MERGE PENDING] change symlink API documents #2741

Are you sure you want to change the base?

[MERGE PENDING] change symlink API documents #2741

Conversation

kmrmt commented Nov 14, 2024 • edited by coderabbitai bot Loading

Description

Related Issue

Versions

Checklist

Special notes for your reviewer

Summary by CodeRabbit

Release Notes

coderabbitai bot commented Nov 14, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

vdaas-ci commented Nov 14, 2024

cloudflare-workers-and-pages bot commented Nov 14, 2024 • edited Loading

Deploying vald with Cloudflare Pages

github-actions bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

kmrmt commented Nov 14, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 14, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

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

edited

Loading