Skip to content
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
e98ae8a
[AV-84497] Rewrite customize-index.adoc as the table structure no lon…
sarahlwelton Aug 22, 2024
0248409
[AV-84497] Changing child-field-options-reference to a . file in case…
sarahlwelton Aug 23, 2024
ee0d0c9
[AV-84497] Turned create-custom-wordlist, create-search-index-alias, …
sarahlwelton Aug 27, 2024
4201482
[AV-94497] Commenting and clearing out more broken links
sarahlwelton Aug 27, 2024
47fe45e
[AV-84497] Adding a couple missing page-aliases from deleted pages.
sarahlwelton Aug 27, 2024
347c95b
[AV-84497] Committing to delete create-custom-wordlist and restored S…
sarahlwelton Aug 28, 2024
54b1849
[AV-84497] Adding new instructions for turning type mappings on/off
sarahlwelton Oct 3, 2024
3b9a560
[AV-84497] Adding missing :description: and increasing page-toclevels
sarahlwelton Oct 4, 2024
f8382e0
[AV-88608] Starting drafting documentation to explain the "formerly k…
sarahlwelton Oct 11, 2024
e7f4e5a
[AV-88608] Updating formatting of tables for explaining "formerly kno…
sarahlwelton Oct 28, 2024
30b60c4
[AV-84497] Quick tweaks based on reviewing UI changes
sarahlwelton Nov 28, 2024
b5ed264
[AV-84497] Simplifying create-search-index-ui back down
sarahlwelton Nov 29, 2024
92e6a5e
[AV-84497] Tweak links
sarahlwelton Nov 29, 2024
bbdbf47
[AV-84497] Fixing some links and language that no longer makes sense…
sarahlwelton Dec 6, 2024
7b8dfd6
Merge branch 'capella' into AV-84497-v3-search-ui
sarahlwelton Dec 6, 2024
f1f46ab
Merge branch 'capella' into AV-84497-v3-search-ui
sarahlwelton Dec 6, 2024
9ad8d4d
[AV-84497] Remove duplicate alias
sarahlwelton Dec 6, 2024
bda72bf
[AV-84497] Adding suggestions from peer review
sarahlwelton Jan 8, 2025
f16f571
[AV-84497] Remove all mentions of Quick Mode for reasons(?)
sarahlwelton Jan 9, 2025
525bc8d
Merge branch 'AV-84497-v3-search-ui' of https://github.com/couchbasel…
sarahlwelton Jan 9, 2025
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
2 changes: 1 addition & 1 deletion modules/n1ql/pages/n1ql-language-reference/searchfun.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ You must also include the xref:search:search-request-params.adoc#fields[fields p

NOTE: From Couchbase Server 7.6 and later, when you use the SEARCH function, you do not need to use the xref:search:default-analyzers-reference.adoc#keyword[keyword analyzer] in your Search index to run a non-analytic query.
You also do not need to match the analyzer in a query to the analyzer in the Search index for an analytic query.
For more information about how to set the analyzer for a Search index, see xref:search:set-advanced-settings.adoc[] or the xref:search:search-index-params.adoc#mapping[Mapping Object].
For more information about how to set the analyzer for a Search index, see xref:search:create-search-index-ui.adoc#default-analyzer[Configure Global Search Index Settings] or the xref:search:search-index-params.adoc#mapping[Mapping Object].

=== Arguments

Expand Down
102 changes: 0 additions & 102 deletions modules/search/pages/child-field-options-reference.adoc

This file was deleted.

63 changes: 0 additions & 63 deletions modules/search/pages/create-child-field.adoc

This file was deleted.

62 changes: 0 additions & 62 deletions modules/search/pages/create-child-mapping.adoc

This file was deleted.

99 changes: 65 additions & 34 deletions modules/search/pages/create-custom-analyzer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,63 +8,94 @@
{description}

NOTE: You must use Advanced Mode to add a custom analyzer to your Search index.
For more information, see xref:create-search-index-ui.adoc[].
For more information, see xref:create-search-indexes.adoc#advanced-mode[Advanced Mode Editing].

For more information, see xref:customize-index.adoc#analyzers[Search Index Features].
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a better way to have both these "For more information..." links? Maybe put line 13 above the admonition?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's try this.


== Prerequisites

* You have the Search Service enabled on a node in your cluster.
For more information about how to change Services on your cluster, see xref:cloud:clusters:modify-database.adoc[].

* You have created an index with xref:create-search-index-ui.adoc[Advanced Mode].
* You have the Search Service enabled on a node in your operational cluster.
For more information about how to change Services on your operational cluster, see xref:cloud:clusters:modify-database.adoc[].

* You have logged in to the Couchbase {page-ui-name}.

== Procedure

To create a custom analyzer with the {page-ui-name} in Advanced Mode:

. On the *Operational Clusters* page, select the cluster that has the Search index you want to edit.
. On the *Operational Clusters* page, select the operational cluster where you want to work with the Search Service.
. Go to menu:Data Tools[Search].
. Click the index where you want to create a custom analyzer.
. Under *Advanced Settings*, expand *Analyzers*.
+
NOTE: Make sure you use *Advanced Mode*.
. Click btn:[Add Analyzer].
. In the *Name* field, enter a name for the new custom analyzer.
. To remove specific characters from search input before tokenizing, in the *Character Filters* list, do one of the following:
.. To add a character filter to your analyzer, click a character filter.
You can select a default character filter or create your own.
+
For more information, see xref:default-character-filters-reference.adoc[] or xref:create-custom-character-filter.adoc[].
.. To remove a character filter from your analyzer, click the *x* on a character filter.
. In the *Tokenizer* list, click the tokenizer you want to use to create tokens from Search input.
You can select a default tokenizer or create your own.
+
For more information, see xref:default-tokenizers-reference.adoc[] or xref:create-custom-tokenizer.adoc[].
. To modify the tokens created by the tokenizer, in the *Token Filters* list, do one of the following:
.. To add a token filter to your analyzer, click a token filter.
You can select a default token filter or create your own.
+
For more information, see xref:default-token-filters-reference.adoc[] or xref:create-custom-token-filter.adoc[].
.. To remove a token filter from your analyzer, click the *x* on a token filter.
. Click btn:[Submit].
. Do one of the following:
.. To work with an existing Search index, click the name of the index where you want to create a custom analyzer.
.. To create a new Search index, click btn:[Create Search Index].
. Make sure to select *Enable Advanced Options*.
. Expand *Global Index Settings*.
. Click btn:[Add Custom Analyzer].
. In the *Analyzer Name* field, enter a name for the new custom analyzer.
. <<configure-components,Configure the components of your analyzer>>.
. Click btn:[Add Custom Analyzer].

=== Configure Analyzer Components

For more information about analyzers and their components, see xref:customize-index.adoc#analyzers[Analyzers].

Add the following components to a custom analyzer to take input text from a document or Search query and convert it into tokens:

. <<tokenizers,Tokenizers>>
. <<character-filters,Character Filters>>
. <<token-filters,Token Filters>>

[#tokenizers]
==== Configure Tokenizers

For more information about tokenizers, see xref:customize-index.adoc#tokenizers[Tokenizers].

To configure the tokenizer for a custom analyzer:

. (Optional) Create a custom tokenizer.
For more information, see xref:create-custom-tokenizer.adoc[].
. In the *Tokenizer* list, select a tokenizer to use in your custom analyzer.
You can choose your custom tokenizer or xref:default-tokenizers-reference.adoc[use a default tokenizer].

[#character-filters]
==== Configure Character Filters

For more information about character filters, see xref:customize-index.adoc#character-filters[Character Filters].

To add a character filter or character filters to a custom analyzer:

. (Optional) Create 1 or more custom character filters.
For more information, see xref:create-custom-character-filter.adoc[].
. In the *Character Filters* list, select 1 or more character filters to use in your custom analyzer.
You can choose your custom character filter or xref:default-character-filters-reference.adoc[use the default character filters].

Remove a character filter from your custom analyzer by clicking the *x* next to a listed filter.

[#token-filters]
==== Configure Token Filters

For more information about token filters, see xref:customize-index.adoc#token-filters[Token Filters].

To add a token filter or token filters to a custom analyzer:

. (Optional) Create 1 or more custom token filters.
For more information, see xref:create-custom-token-filter.adoc[].
. In the *Token Filters* list, select 1 or more token filters to use in your custom analyzer.
You can choose your custom token filter or xref:default-token-filters-reference.adoc[use the default token filters].

Remove a token filter from your custom analyzer by clicking the *x* next to a listed filter.

== Next Steps

After you create a custom analyzer, you can xref:set-advanced-settings.adoc#default-analyzer[set it as the default analyzer] for your Search index.
After you create a custom analyzer, you can xref:create-search-index-ui.adoc#default-analyzer[set it as the default analyzer] for your Search index.

You can also use the custom analyzer when you xref:create-type-mapping.adoc[create a type mapping with Advanced Mode], xref:create-child-mapping.adoc[a child mapping] or xref:create-child-field.adoc[a child field].
You can also use the custom analyzer when you create a type mapping or mapping while you xref:create-search-index-ui.adoc[].

To continue customizing your Search index, you can also:

* xref:set-advanced-settings.adoc[]
* xref:set-type-identifier.adoc[]
* xref:create-type-mapping.adoc[]
* xref:create-custom-character-filter.adoc[]
* xref:create-custom-tokenizer.adoc[]
* xref:create-custom-token-filter.adoc[]
* xref:create-custom-wordlist.adoc[]

To run a search and test the contents of your Search index, see xref:simple-search-ui.adoc[].
Loading