diff --git a/modules/manage/assets/images/manage-ui/vectorScreen.png b/modules/manage/assets/images/manage-ui/vectorScreen.png new file mode 100644 index 0000000000..ba2e4be913 Binary files /dev/null and b/modules/manage/assets/images/manage-ui/vectorScreen.png differ diff --git a/modules/manage/assets/images/manage-ui/vectorScreenWithIndexes.png b/modules/manage/assets/images/manage-ui/vectorScreenWithIndexes.png new file mode 100644 index 0000000000..a54c53aff8 Binary files /dev/null and b/modules/manage/assets/images/manage-ui/vectorScreenWithIndexes.png differ diff --git a/modules/manage/assets/images/manage-ui/vectorTab.png b/modules/manage/assets/images/manage-ui/vectorTab.png new file mode 100644 index 0000000000..1df3249120 Binary files /dev/null and b/modules/manage/assets/images/manage-ui/vectorTab.png differ diff --git a/modules/manage/pages/manage-ui/manage-ui.adoc b/modules/manage/pages/manage-ui/manage-ui.adoc index 430488f95a..6c155fa614 100644 --- a/modules/manage/pages/manage-ui/manage-ui.adoc +++ b/modules/manage/pages/manage-ui/manage-ui.adoc @@ -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,7 +501,7 @@ 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 @@ -506,6 +509,51 @@ image:manage-ui/indexesScreenFullyPrepared.png[,700,align=left] 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] + +This brings up the *Vector Indexes* screen: + +[#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. +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 diff --git a/preview/DOC-14331-vector-idx-ui.yml b/preview/DOC-14331-vector-idx-ui.yml new file mode 100644 index 0000000000..eb1a2b4029 --- /dev/null +++ b/preview/DOC-14331-vector-idx-ui.yml @@ -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] +