-
Notifications
You must be signed in to change notification settings - Fork 19
[DOC-13488]: Feedback on Create a Vector Search Index with the Server Web Console | Couchbase Docs #475
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
RayOffiah
wants to merge
5
commits into
release/8.0
Choose a base branch
from
DOC-13488-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs
base: release/8.0
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
[DOC-13488]: Feedback on Create a Vector Search Index with the Server Web Console | Couchbase Docs #475
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6b56e2c
[DOC-13488]: Feedback on Create a Vector Search Index with the Server…
RayOffiah afe5b83
Update modules/vector-search/pages/create-vector-search-index-ui.adoc
RayOffiah f2e0c7f
Update modules/vector-search/pages/create-vector-search-index-ui.adoc
RayOffiah 89e5b52
Update modules/vector-search/pages/create-vector-search-index-ui.adoc
RayOffiah 0705d26
[DOC-13488]: Feedback on Create a Vector Search Index with the Server…
RayOffiah 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.
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,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 | ||
|
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. Sorry, if we're telling them to "clear the default type mapping" further down, I don't think we need this step. It's the same thing, right? |
||
| .. 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: | ||
RayOffiah marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| .. Point to the collection you just created and go to menu:{plus}[insert child field]. | ||
| + | ||
| image::insert-child-field.png[,50%] | ||
RayOffiah marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| .. 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. | ||
|
|
||
7 changes: 7 additions & 0 deletions
7
...-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs.yml
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,7 @@ | ||
| sources: | ||
| docs-server: | ||
| branches: [release/8.0] | ||
| cb-swagger: | ||
| branches: [release/8.0] | ||
| override: | ||
| startPage: server:introduction:intro.adoc |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove this.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 :)