diff --git a/modules/vector-search/images/insert-child-field.png b/modules/vector-search/images/insert-child-field.png new file mode 100644 index 000000000..211e52ef9 Binary files /dev/null and b/modules/vector-search/images/insert-child-field.png differ diff --git a/modules/vector-search/pages/create-vector-search-index-ui.adoc b/modules/vector-search/pages/create-vector-search-index-ui.adoc index 787f849e0..1703f30a1 100644 --- a/modules/vector-search/pages/create-vector-search-index-ui.adoc +++ b/modules/vector-search/pages/create-vector-search-index-ui.adoc @@ -3,7 +3,7 @@ :page-ui-name: {ui-name} :page-product-name: {product-name} :page-toclevels: 2 -:description: You can create a Search Vector Index with the Couchbase {page-ui-name}. +:description: Use a sample dataset to create a vector search index with the Couchbase {page-ui-name}. [abstract] {description} @@ -45,7 +45,7 @@ To create a Search Vector Index with the Couchbase {page-ui-name}: + [NOTE] ==== -Your index name must start with an alphabetic character (a-z or A-Z). It can only contain alphanumeric characters (a-z, A-Z, or 0-9), hyphens (-), or underscores (_). +Your index name must start with an alphabetic character (a-z or A-Z). It can only contain alphanumeric characters (a-z, A-Z, or 0–9), hyphens (-), or underscores (_). For Couchbase Server version 7.6 and later, your index name must be unique inside your selected bucket and scope. You cannot have 2 indexes with the same name inside the same bucket and scope. @@ -58,13 +58,20 @@ You cannot have 2 indexes with the same name inside the same bucket and scope. . Expand *Mappings* and create a new type mapping on a collection: .. Click btn:[Add Type Mapping]. .. In the *Collection* list, select the collection that contains the documents you want to include in your index. -.. Select *Only index specified fields*. +.. Select the *only index specified fields* checkbox. +.. Unset the *#default* field .. Click btn:[OK]. + For more information about how to create type mappings, see xref:search:create-type-mapping.adoc[]. -. Create a child field mapping on the new collection type mapping: -.. In the *Field* field, enter the name of the field in your documents that contains your vector embeddings. +. Next to the *#default* type mapping, clear the checkbox. +. Create a child field mapping on the new collection type mapping: + +.. Point to the collection you just created and go to menu:{plus}[insert child field]. ++ +image::insert-child-field.png[,50%] + +.. Enter the name of the field in your documents that contains your vector embeddings. + Vectors must be represented as an array of floating point numbers. .. In the *Type* list, do one of the following: @@ -82,6 +89,8 @@ For more information, see xref:search:child-field-options-reference.adoc[]. For more information, see xref:search:child-field-options-reference.adoc[]. .. Select *Index*. .. Click btn:[OK]. + ++ . (Optional) Create another child field on the new collection type mapping for any additional fields you want to return in your search results. + For example, you could add the text field that you used to generate your vector embeddings. @@ -115,7 +124,7 @@ If you choose to add additional child fields and enable *Include in search resul For more information about how to add additional child fields to your index, see xref:search:create-quick-index.adoc[] or xref:search:create-child-field.adoc[]. -For example, if you used the Vector Search sample data, you might want to add another child field for the *color* string field to your Search Vector Index, to return color names with your Search query. +For example, if you used the Vector Search sample data, you might want to add another child field for the *color* string field to your Search Vector Index to return color names with your Search query. For more information about how to add additional child fields to your index, see xref:search:create-child-field.adoc[]. You can customize your Search Vector Index like any other Search index to add additional data and improve search results. diff --git a/preview/DOC-13488-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs.yml b/preview/DOC-13488-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs.yml new file mode 100644 index 000000000..85d2cff0d --- /dev/null +++ b/preview/DOC-13488-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs.yml @@ -0,0 +1,7 @@ +sources: + docs-server: + branches: [release/8.0] + cb-swagger: + branches: [release/8.0] +override: + startPage: server:introduction:intro.adoc \ No newline at end of file