-
Notifications
You must be signed in to change notification settings - Fork 10.4k
VS-284: Update docs to include Vectorize queryById operation #17591
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -139,6 +139,12 @@ wrangler docs [<COMMAND>] | |
|
|
||
| ## `init` | ||
|
|
||
| :::note | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This warning was removed in #17844 - this should not have been reverted in this unrelated PR. @garvit-gupta @Oxyjun
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hi @emily-shen, I think this change was included when this branch was updated with main. I can remove that warning if you think that would be the appropriate next step.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. hey yeah if you would be able to remove it again that would be great, thanks! |
||
| The `init` command will be removed in a future version. Please use `npm create cloudflare@latest` instead. | ||
|
|
||
| ::: | ||
|
|
||
| Create a new project via the [create-cloudflare-cli (C3) tool](/workers/get-started/guide/#1-create-a-new-worker-project). A variety of web frameworks are available to choose from as well as templates. Dependencies are installed by default, with the option to deploy your project immediately. | ||
|
|
||
| ```txt | ||
|
|
@@ -591,8 +597,10 @@ npx wrangler vectorize query <INDEX_NAME> [OPTIONS] | |
|
|
||
| - `INDEX_NAME` <Type text="string" /> <MetaInfo text="required" /> | ||
| - The name of the Vectorize index to query. | ||
| - `--vector` <Type text="array" /> <MetaInfo text="required" /> | ||
| - Vector against which the Vectorize index is queried. | ||
| - `--vector` <Type text="array" /> <MetaInfo text="optional" /> | ||
| - Vector against which the Vectorize index is queried. Either this or the `vector-id` param must be provided. | ||
| - `--vector-id` <Type text="string" /> <MetaInfo text="optional" /> | ||
| - Identifier for a vector that is already present in the index against which the index is queried. Either this or the `vector` param must be provided. | ||
| - `--top-k` <Type text="number" /> <MetaInfo text="optional" /> | ||
| - The number of vectors to query (default: `5`). | ||
| - `--return-values` <Type text="boolean" /> <MetaInfo text="optional" /> | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.