-
Notifications
You must be signed in to change notification settings - Fork 182
DOC-14331: Document Vector Index UI in Server #4144
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
Open
simon-dew
wants to merge
5
commits into
release/8.1
Choose a base branch
from
DOC-14331-vector-idx-ui
base: release/8.1
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,6 +3,9 @@ | |||||
| :description: The features of Couchbase Server can be managed by means of Couchbase Web Console. | ||||||
| // :page-aliases: c-sdk:ROOT:webui-cli-access.adoc,dotnet-sdk:ROOT:webui-cli-access.adoc,go-sdk:ROOT:webui-cli-access.adoc,java-sdk:ROOT:webui-cli-access.adoc,nodejs-sdk:ROOT:webui-cli-access.adoc,php-sdk:ROOT:webui-cli-access.adoc,python-sdk:ROOT:webui-cli-access.adoc, | ||||||
|
|
||||||
| // TEMP | ||||||
| :totoro: the next major release of Couchbase Server | ||||||
|
|
||||||
| [abstract] | ||||||
| {description} | ||||||
|
|
||||||
|
|
@@ -498,14 +501,59 @@ image::manage-ui/indexScreenWithIndexes.png[,700,align=left] | |||||
| Note that initially, the *status* column provides ongoing figures for *mutations remaining*: this indicates that the indexes for the bucket are still being prepared. | ||||||
| When the indexes have been fully prepared, the *mutations remaining* notifications are no longer displayed: | ||||||
|
|
||||||
| image:manage-ui/indexesScreenFullyPrepared.png[,700,align=left] | ||||||
| image::manage-ui/indexesScreenFullyPrepared.png[,700,align=left] | ||||||
|
|
||||||
| [#indexes-define-and-manage] | ||||||
| === Indexes: Define and Manage | ||||||
|
|
||||||
| For a detailed explanation of indexes, see xref:indexes:indexing-overview.adoc[]. | ||||||
| Information on how to manage indexes is given in xref:manage:manage-indexes/manage-indexes.adoc[Manage Indexes]. | ||||||
|
|
||||||
| [#console-vectors] | ||||||
| == Vector Indexes | ||||||
|
|
||||||
| [.labels] | ||||||
| [.status]#{totoro}# | ||||||
|
|
||||||
| To access vector indexes, left-click the *Vectors* tab in the left-hand navigation bar: | ||||||
|
|
||||||
| [#console-vectors-tab] | ||||||
| image::manage-ui/vectorTab.png["Vectors tab with mouse pointer.",100,align=left] | ||||||
|
simon-dew marked this conversation as resolved.
|
||||||
|
|
||||||
| This brings up the *Vector Indexes* screen: | ||||||
|
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. We're not suppose to have these lead-in sentences that just introduce a screenshot. I'd move the sentence after the screenhot up:
Suggested change
|
||||||
|
|
||||||
| [#console-vectors-screen] | ||||||
| image::manage-ui/vectorScreen.png["Vector Indexes screen with no indexes",700,align=left] | ||||||
|
|
||||||
| The screen is initially blank, since no vector indexes have yet been added. | ||||||
|
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.
Suggested change
|
||||||
| Vector indexes are not included in the sample data provided with Couchbase Server. | ||||||
|
|
||||||
| To create a vector index, click btn:[Add Vector Index]. | ||||||
|
|
||||||
| * For more information about creating a Hyperscale Vector Index, see xref:vector-index:hyperscale-vector-index.adoc[]. | ||||||
|
|
||||||
| * For more information about creating a Composite Vector Index, see xref:vector-index:composite-vector-index.adoc[]. | ||||||
|
|
||||||
| * For more information about creating a Search Vector Index, see xref:vector-search:create-vector-search-index-ui.adoc[]. | ||||||
|
|
||||||
| [#vectors-learn-and-manage] | ||||||
| === Vector Indexes: Learn and Manage | ||||||
|
|
||||||
| If you have created any vector indexes, they're listed in the *Vector Indexes* screen: | ||||||
|
|
||||||
| image::manage-ui/vectorScreenWithIndexes.png["Vector Indexes screen with 3 indexes",700,align=left] | ||||||
|
|
||||||
| For each vector index in the Vector Indexes screen, the following options are available: | ||||||
|
|
||||||
| * Click the vector index name to edit the vector index. | ||||||
| (For Hyperscale Vector Indexes and Composite Vector Indexes, you can only edit the number of index replicas.) | ||||||
|
|
||||||
| * Click btn:[Search] to run a query or search using that vector index. | ||||||
|
|
||||||
| * Click btn:[⋮] to display a menu which enables you to copy the vector index definition, download the vector index definition, or delete the vector index. | ||||||
|
|
||||||
| For a detailed explanation of vector indexes, see xref:vector-index:vectors-and-indexes-overview.adoc[]. | ||||||
|
|
||||||
| [#console-search] | ||||||
| == Search | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| sources: | ||
| docs-devex: | ||
| branches: DOC-14050-sparse-vector-concept | ||
|
|
||
| # docs-analytics: | ||
| # branches: release/8.0 | ||
|
|
||
| couchbase-cli: | ||
| url: https://github.com/couchbaselabs/couchbase-cli-doc | ||
| branches: master | ||
| startPaths: docs/ | ||
|
|
||
| # backup: | ||
| # branches: master | ||
| # startPaths: docs/ | ||
|
|
||
| cb-swagger: | ||
| url: https://github.com/couchbaselabs/cb-swagger | ||
| branches: release/8.1 | ||
| start_path: docs | ||
|
|
||
| # Minimal SDK build | ||
| # docs-sdk-common: | ||
| # branches: [release/8.0] | ||
| # docs-sdk-java: | ||
| # branches: [3.11] | ||
|
|
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.
Uh oh!
There was an error while loading. Please reload this page.