[Vectorize] update docs for Vectorize V2 #15916
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sejoker
requested review from
elithrar,
vy-ton,
pdwittig,
kodster28 and
a team
as code owners
github-actions
bot
added
the
product:vectorize
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Deploying cloudflare-docs with
|
| Latest commit: |
69d4345
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c69348b7.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://vectorize-v2.cloudflare-docs-7ou.pages.dev |
netgusto
reviewed
Jul 31, 2024
| @@ -117,6 +117,11 @@ Refer to [Vectorize API](/vectorize/reference/client-api/) for additional exampl | |||
|
|
|||
| ### wrangler CLI | |||
|
|
|||
| {{<Aside type="note" header="Cloudflare API rate limit">}} | |||
|
|
|||
| Please use a maximum of 5000 vectors per embeddings.ndjson file to prevent the global [rate limit](/fundamentals/api/reference/limits/) for the Cloudflare API. | |||
There was a problem hiding this comment.
I think wrangler can read a bigger file, but will batch lines up to 5K
There was a problem hiding this comment.
That would be correct. Wrangler can split a large file into batches of 5000 for Vectorize V2 and process each batch as a separate insert request. Each batch however must be less than 5000 vectors and less than 128 MB for the insert request to succeed.
kodster28
approved these changes
Jul 31, 2024
| To continue: | ||
| {{<Aside type="note" header="Workers Paid plan required">}} | ||
|
|
||
| Hyperdrive is available to all users on the [Workers Paid plan](/workers/platform/pricing/#workers). |
There was a problem hiding this comment.
Suggested change
| Hyperdrive is available to all users on the [Workers Paid plan](/workers/platform/pricing/#workers). | |
| Vectorize is available to all users on the [Workers Paid plan](/workers/platform/pricing/#workers). |
| {{<Aside type="note" header="Enable metadata filtering">}} | ||
|
|
||
| Vectorize V2 requires to define metadata properties that will support filtering. Please refer to [Vectorize API](/vectorize/reference/client-api/#create-metadata-index) for details. | ||
| [Namespaces](/vectorize/best-practices/insert-vectors/#namespaces) support metadata filtering out of the box. |
There was a problem hiding this comment.
Suggested change
| [Namespaces](/vectorize/best-practices/insert-vectors/#namespaces) support metadata filtering out of the box. | |
| [Namespaces](/vectorize/best-practices/insert-vectors/#namespaces) support metadata filtering by default. |
| @@ -86,6 +86,46 @@ const details = await env.YOUR_INDEX.describe(); | |||
|
|
|||
| Retrieves the configuration of a given index directly, including its configured `dimensions` and distance `metric`. | |||
|
|
|||
| ### Create Metadata Index | |||
There was a problem hiding this comment.
Should we include the index info command too?
There was a problem hiding this comment.
Should we include the index info command too?
added.
10 tasks
netgusto
reviewed
Jul 31, 2024
sejoker
changed the title
sejoker
requested review from
kristianfreeman,
pedrosousa,
haleycode,
GregBrimble and
KianNH
as code owners
github-actions
bot
added
size/xl
and removed
size/s
product:vectorize
github-actions
bot
added
the
product:vectorize
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Vectorize V2 changes: