Skip to content

Vectorize: Add Content to the Best Practices Documentation #21913

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Apr 23, 2025
Merged

Vectorize: Add Content to the Best Practices Documentation #21913

merged 4 commits into from
Apr 23, 2025

Conversation

@nagraham
Copy link
Member

@nagraham nagraham commented Apr 22, 2025

Summary

This change adds a few sections to the Vectorize "Best Practices" page to improve customer usage of the product.

  1. Provide advice on how to increase the throughput of upserting Vectors
  2. Provide advice on how to create Metadata Indexes to optimize for metadata filtering based on query patterns
  3. Try to improve the discoverability that our range queries can enable use cases like "prefix" searching or "starts_with"

Screenshots (optional)

image image

Documentation checklist

@nagraham nagraham requested review from a team, elithrar, mchenco, sejoker and vy-ton as code owners April 22, 2025 23:35
@nagraham nagraham changed the title Update vectorize docs Vectorize: Add Content to the Best Practices Documentation Apr 22, 2025
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 22, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Enhanced the Vectorize documentation by adding best practices for improving performance and discoverability.

  • Added performance tips for filtering by metadata, focusing on cardinality and indexing strategies.
  • Introduced guidance on improving write throughput by batching vector updates.
  • Clarified the use of range queries for prefix searching in metadata fields.

Modified Files

  • src/content/docs/vectorize/best-practices/insert-vectors.mdx
  • src/content/docs/vectorize/reference/metadata-filtering.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions github-actions bot added size/s product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ labels Apr 23, 2025
sejoker
sejoker approved these changes Apr 23, 2025
View reviewed changes
@sejoker sejoker enabled auto-merge (squash) April 23, 2025 08:13
@sejoker sejoker merged commit da4b8bf into cloudflare:production Apr 23, 2025
7 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Apr 23, 2025
@holopin-bot
Copy link

holopin-bot bot commented Apr 23, 2025

Congratulations @nagraham, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm9u2bjlb136080cjufja1hasi

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sejoker sejoker sejoker approved these changes

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@vy-ton vy-ton Awaiting requested review from vy-ton vy-ton is a code owner

@mchenco mchenco Awaiting requested review from mchenco mchenco is a code owner

Assignees

@elithrar elithrar

@sejoker sejoker

@vy-ton vy-ton

@mchenco mchenco

Labels

contribution [Holopin] Recognizes a docs contribution, big or small product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@nagraham @sejoker @elithrar @vy-ton @mchenco @workers-devprod