Skip to content

[DOC-12001] Moving some links around to try and resolve the original complaint. #294

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 19, 2024
Merged

[DOC-12001] Moving some links around to try and resolve the original complaint. #294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d3e59b
[DOC-12001] Moving some links around to try and resolve the original …
sarahlwelton Nov 18, 2024
6fd66d7
[DOC-12001] Removing the extra link out after some thought.
sarahlwelton Nov 19, 2024
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
10 changes: 7 additions & 3 deletions modules/vector-search/pages/create-vector-search-index-ui.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,15 @@ You cannot have 2 indexes with the same name inside the same bucket and scope.
. Expand *Customize Index*.
. Select *Use non-default scope/collection(s)*.
.. In the *Scope* list, select the scope that contains the documents you want to include in your index.
. Expand *Mappings* and xref:search:create-type-mapping.adoc[create a new type mapping on a collection]:
. 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*.
.. Click btn:[OK].
. xref:search:create-child-field.adoc[] on the new collection type mapping with the following settings:

+
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.
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
.. In the *Field* field, enter the name of the field in your documents that contains your vector embeddings.
.. In *Field*, enter the name of the field in your documents that contains your vector embeddings.

Copy link
Contributor

Choose a reason for hiding this comment

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

The original sentence is fine. I included this in the review because I wanted to try another option to reduce the number of "fields", but again, just a suggestion!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I considered that, but then it loses parity with the rest of the sentences and feels strange to me.

Copy link
Contributor

Choose a reason for hiding this comment

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

No problem, I'll go approve!

+
Vectors must be represented as an array of floating point numbers.
Expand All @@ -77,9 +80,10 @@ 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) xref:search:create-child-field.adoc[Create another child field] on the new collection type mapping for any additional fields you want to return in your search results.
. (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.
For more information about how to create child fields, see xref:search:create-child-field.adoc[].
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
For more information about how to create child fields, see xref:search:create-child-field.adoc[].

Copy link
Contributor

Choose a reason for hiding this comment

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

I believe this is a repeated sentence? You have this sentence on line 85.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope, I want this here, too, since they need to create another child field in this step, too.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok noted.

. Next to the `default` dynamic type mapping, clear the checkbox.
. Click btn:[Create Index].

Expand Down