Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one is helpful, so I think I'd rather keep it, if that's okay.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I said, open to the arguments for keeping them - I'm okay with 1 screenshot for the tricky "this is where the menu is", but 3 felt like overkill :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. The other two didn't really add anything.

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.
25 changes: 19 additions & 6 deletions modules/vector-search/pages/create-vector-search-index-ui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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: Using a sample dataset to create a vector search index with the Couchbase {page-ui-name}.

[abstract]
{description}
Expand Down Expand Up @@ -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 09), 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.
Expand All @@ -58,13 +58,23 @@ 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 [.ui]*only index specified fields* checkbox.
.. Unset the [.ui]*#default* field
Copy link
Contributor

@sarahlwelton sarahlwelton Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. Select the [.ui]*only index specified fields* checkbox.
.. Unset the [.ui]*#default* field
.. Under the collection name, select *only index specified fields*.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RayOffiah Please don't just mark this as resolved and ignore it - why do you want to word it this way?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you at least please remove the [.ui] attribute?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, my mistake; I think I miskeyed; I was going to accept the change, but now I think about, I think I prefer my version.

The reason DOC-13488 was filed in the first place was that the filer(?) thought that the original text was asking him to look a set of specified fields:

Regarding these instructions - it says "Only index specified fields". What fields? Specified where?

I would prefer to make it clear that he's looking for a checkbox.

But I can remove the [.ui] attributes.

+
image::only-index-specified-field-checkbox.png[,50%]
.. 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.
. Create a child field mapping on the new collection type mapping:

.. Using the mouse over, hover over the [.ui]*Field* item, then click on the btn:[{plus}] button.
.. Select menu:insert child field[] from the dropdown menu.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. Select menu:insert child field[] from the dropdown menu.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We covered this in the previous step, this needs to be deleted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeees, I'd rather keep this one, if you don't mind; the UI hides the function until you mouse over it, which confused the fella who submitted the initial Jira request.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also don't refer to dropdowns like this: https://docs.couchbase.com/styleguide/dropdowns.html

In general, I would say this is a menu, which is why I said to use the menu:[] macro to render it as + > insert child field: https://docs.couchbase.com/styleguide/menus.html

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But you're navigating in the menu? We're telling them to do the same thing twice if you leave this as is. Try and rebuild the site with this suggestion in place and you'll see what I mean.

They don't need to click insert child field twice, and this is what it's telling them to do right now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes; got it now.

+
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:
Expand All @@ -82,6 +92,9 @@ 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].

+
image::child-mapping-parameters.png[,50%]
. (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.
Expand Down Expand Up @@ -115,7 +128,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.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
sources:
docs-server:
branches: [release/8.0]
cb-swagger:
branches: [release/8.0]
override:
startPage: server:introduction:intro.adoc