Skip to content

Mark protected words as keywords #13

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

Draft
wants to merge 10 commits into
base: 5.4.2
Choose a base branch
from
Draft

Mark protected words as keywords #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fbfce67
Update plugin for ElasticSearch v7.x
Jun 2, 2020
d4a8382
Change version to 7.7.0.1-SNAPSHOT
Jun 2, 2020
bfaa6c0
Update README and POM developers
Jun 4, 2020
19a5975
[maven-release-plugin] prepare release v7.7.0.1
Jun 8, 2020
78b6975
[maven-release-plugin] prepare for next development iteration
Jun 8, 2020
043d146
Update maintainers
Dec 20, 2021
bb258d7
Bump log4j version to 2.17.0
Dec 20, 2021
a289b1e
[maven-release-plugin] prepare release v7.7.0.2
Dec 20, 2021
546a2fd
[maven-release-plugin] prepare for next development iteration
Dec 20, 2021
533a363
[WIP] Mark protected words as keywords
ptheof Jan 20, 2023
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
322 changes: 163 additions & 159 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Versions

Dynamic Word Delimiter Plugin | ElasticSearch | Branch |
------------------------------|---------------|--------|
7.7.0.2 | 7.7.0 | 7.7.0 |
7.7.0.1 | 7.7.0 | 7.7.0 |
5.4.2.2 | 5.4.2 | 5.4.2 |
5.4.2.1 | 5.4.2 | 5.4.2 |
5.4.0.1 | 5.4.0 | 5.4.0 |
Expand All @@ -38,15 +40,11 @@ To list all plugins in current installation:

sudo bin/elasticsearch-plugin list

In order to install the latest version of the plugin, simply run:
In order to install the the appropriate version of the plugin, simply run:

sudo bin/elasticsearch-plugin install gr.skroutz:elasticsearch-dynamic-word-delimiter:5.4.2.2
sudo bin/elasticsearch-plugin install gr.skroutz:elasticsearch-dynamic-word-delimiter:<plugin-version>

In order to install a previous (1.x.x) version of the plugin, simply run:

sudo bin/plugin -install gr.skroutz/elasticsearch-dynamic-word-delimiter/1.0.1

To remove a plugin (5.x.x):
To remove the plugin:

sudo bin/elasticsearch-plugin remove <plugin_name>

Expand All @@ -55,7 +53,7 @@ To remove a plugin (5.x.x):
There are three available settings that you can override:

- `protected_words_index` (index name),
- `protected_words_type` (index type),
- `protected_words_type` (index type) **obsolete for the 7.x versions**,
- `refresh_interval` (interval for updating the list of dynamic protected words)

Add the settings below in your `elasticsearch.yml` config file.
Expand All @@ -71,162 +69,166 @@ be out of sync for the maximum amount in `refresh_interval`.

Example Usage
-------------

> This example shows usages for versions prior to 7.x, as ES7 removes the concept of types.
> To run this example on ES7, replace the `word` type with `_doc`.

```bash
# Create the protected_words index
$ curl -XPUT 'http://localhost:9200/protected_words/'
{"acknowledged":true}

# Index a few protected words (view the Notes section on why we index both lowercase/uppercase form)
$ curl -XPOST 'http://localhost:9200/protected_words/word' -d '{"word": "4g"}'
{"_index":"protected_words","_type":"word","_id":"AViHOwEsHo94o8jBG6vN","_version":1,"created":true}

$ curl -XPOST 'http://localhost:9200/protected_words/word' -d '{"word": "4G"}'
{"_index":"protected_words","_type":"word","_id":"AViHO5pxHo94o8jBG6vO","_version":1,"created":true}

# View the documents on our index
$ curl 'http://localhost:9200/protected_words/word/_search?pretty=true' -d '{"query": {"match_all": {}}}'
{
"took" : 1,
"timed_out" : false,
"_shards" : {
"total" : 1,
"successful" : 1,
"failed" : 0
# Create the protected_words index
$ curl -XPUT 'http://localhost:9200/protected_words/'
{"acknowledged":true}

# Index a few protected words (view the Notes section on why we index both lowercase/uppercase form)
$ curl -XPOST 'http://localhost:9200/protected_words/word' -d '{"word": "4g"}'
{"_index":"protected_words","_type":"word","_id":"AViHOwEsHo94o8jBG6vN","_version":1,"created":true}

$ curl -XPOST 'http://localhost:9200/protected_words/word' -d '{"word": "4G"}'
{"_index":"protected_words","_type":"word","_id":"AViHO5pxHo94o8jBG6vO","_version":1,"created":true}

# View the documents on our index
$ curl 'http://localhost:9200/protected_words/word/_search?pretty=true' -d '{"query": {"match_all": {}}}'
{
"took" : 1,
"timed_out" : false,
"_shards" : {
"total" : 1,
"successful" : 1,
"failed" : 0
},
"hits" : {
"total" : 2,
"max_score" : 1.0,
"hits" : [ {
"_index" : "protected_words",
"_type" : "word",
"_id" : "AViHOwEsHo94o8jBG6vN",
"_score" : 1.0,
"_source":{"word": "4g"}
}, {
"_index" : "protected_words",
"_type" : "word",
"_id" : "AViHO5pxHo94o8jBG6vO",
"_score" : 1.0,
"_source":{"word": "4G"}
} ]
}
}

# Create a test index with the new dynamic word delimiter filter
$ curl -XPUT 'http://localhost:9200/test_index' -d '{
"settings": {
"analysis": {
"analyzer": {
"query_analyzer": {
"type": "custom",
"tokenizer": "standard",
"filter": ["query_splitter"]
}
},
"hits" : {
"total" : 2,
"max_score" : 1.0,
"hits" : [ {
"_index" : "protected_words",
"_type" : "word",
"_id" : "AViHOwEsHo94o8jBG6vN",
"_score" : 1.0,
"_source":{"word": "4g"}
}, {
"_index" : "protected_words",
"_type" : "word",
"_id" : "AViHO5pxHo94o8jBG6vO",
"_score" : 1.0,
"_source":{"word": "4G"}
} ]
}
}

# Create a test index with the new dynamic word delimiter filter
$ curl -XPUT 'http://localhost:9200/test_index' -d '{
"settings": {
"analysis": {
"analyzer": {
"query_analyzer": {
"type": "custom",
"tokenizer": "standard",
"filter": ["query_splitter"]
}
},
"filter": {
"query_splitter": {
"type": "dynamic_word_delimiter",
"generate_word_parts": true,
"generate_number_parts": true,
"catenate_words": false,
"catenate_numbers": false,
"catenate_all": false,
"preserve_original": false,
"split_on_case_change": false,
"split_on_numerics": true,
"stem_english_possesive": true
}
}
"filter": {
"query_splitter": {
"type": "dynamic_word_delimiter",
"generate_word_parts": true,
"generate_number_parts": true,
"catenate_words": false,
"catenate_numbers": false,
"catenate_all": false,
"preserve_original": false,
"split_on_case_change": false,
"split_on_numerics": true,
"stem_english_possesive": true
}
}
}'
{"acknowledged":true}

# Test token filter

# Output before indexing '4g'
$ curl 'http://localhost:9200/test_index/_analyze?analyzer=query_analyzer&pretty=true' -d '4g connection'
{
"tokens" : [ {
"token" : "4",
"start_offset" : 0,
"end_offset" : 1,
"type" : "<ALPHANUM>",
"position" : 1
}, {
"token" : "g",
"start_offset" : 1,
"end_offset" : 2,
"type" : "<ALPHANUM>",
"position" : 2
}, {
"token" : "connection",
"start_offset" : 3,
"end_offset" : 13,
"type" : "<ALPHANUM>",
"position" : 3
} ]
}

# Output after indexing '4g' as a protected word
$ curl 'http://localhost:9200/test_index/_analyze?analyzer=query_analyzer&pretty=true' -d '4g connection'
{
"tokens" : [ {
"token" : "4g",
"start_offset" : 0,
"end_offset" : 2,
"type" : "<ALPHANUM>",
"position" : 1
}, {
"token" : "connection",
"start_offset" : 3,
"end_offset" : 13,
"type" : "<ALPHANUM>",
"position" : 2
} ]
}

# Output before indexing '4G'
$ curl 'http://localhost:9200/test_index/_analyze?analyzer=query_analyzer&pretty=true' -d 'router 4G'
{
"tokens" : [ {
"token" : "router",
"start_offset" : 0,
"end_offset" : 6,
"type" : "<ALPHANUM>",
"position" : 1
}, {
"token" : "4",
"start_offset" : 7,
"end_offset" : 8,
"type" : "<ALPHANUM>",
"position" : 2
}, {
"token" : "G",
"start_offset" : 8,
"end_offset" : 9,
"type" : "<ALPHANUM>",
"position" : 3
} ]
}

# Output after indexing '4G' as a protected word
$ curl 'http://localhost:9200/test_index/_analyze?analyzer=query_analyzer&pretty=true' -d 'router 4G'
{
"tokens" : [ {
"token" : "router",
"start_offset" : 0,
"end_offset" : 6,
"type" : "<ALPHANUM>",
"position" : 1
}, {
"token" : "4G",
"start_offset" : 7,
"end_offset" : 9,
"type" : "<ALPHANUM>",
"position" : 2
} ]
}
}
}'
{"acknowledged":true}

# Test token filter

# Output before indexing '4g'
$ curl 'http://localhost:9200/test_index/_analyze?analyzer=query_analyzer&pretty=true' -d '4g connection'
{
"tokens" : [ {
"token" : "4",
"start_offset" : 0,
"end_offset" : 1,
"type" : "<ALPHANUM>",
"position" : 1
}, {
"token" : "g",
"start_offset" : 1,
"end_offset" : 2,
"type" : "<ALPHANUM>",
"position" : 2
}, {
"token" : "connection",
"start_offset" : 3,
"end_offset" : 13,
"type" : "<ALPHANUM>",
"position" : 3
} ]
}

# Output after indexing '4g' as a protected word
$ curl 'http://localhost:9200/test_index/_analyze?analyzer=query_analyzer&pretty=true' -d '4g connection'
{
"tokens" : [ {
"token" : "4g",
"start_offset" : 0,
"end_offset" : 2,
"type" : "<ALPHANUM>",
"position" : 1
}, {
"token" : "connection",
"start_offset" : 3,
"end_offset" : 13,
"type" : "<ALPHANUM>",
"position" : 2
} ]
}

# Output before indexing '4G'
$ curl 'http://localhost:9200/test_index/_analyze?analyzer=query_analyzer&pretty=true' -d 'router 4G'
{
"tokens" : [ {
"token" : "router",
"start_offset" : 0,
"end_offset" : 6,
"type" : "<ALPHANUM>",
"position" : 1
}, {
"token" : "4",
"start_offset" : 7,
"end_offset" : 8,
"type" : "<ALPHANUM>",
"position" : 2
}, {
"token" : "G",
"start_offset" : 8,
"end_offset" : 9,
"type" : "<ALPHANUM>",
"position" : 3
} ]
}

# Output after indexing '4G' as a protected word
$ curl 'http://localhost:9200/test_index/_analyze?analyzer=query_analyzer&pretty=true' -d 'router 4G'
{
"tokens" : [ {
"token" : "router",
"start_offset" : 0,
"end_offset" : 6,
"type" : "<ALPHANUM>",
"position" : 1
}, {
"token" : "4G",
"start_offset" : 7,
"end_offset" : 9,
"type" : "<ALPHANUM>",
"position" : 2
} ]
}
```

Notes
Expand All @@ -240,6 +242,8 @@ before the `lowercase` filter.

* [Bill Kolokithas](https://github.com/freestyl3r)
* [Peter Markou](https://github.com/m-Peter)
* [Spyridon Pagkalos](https://github.com/enderian)
* [Panagiotis Theofilopoulos](https://github.com/ptheof)

## License

Expand Down
Loading