Synonym configuration

jessejlt · August 19, 2011, 7:03pm

Greetings!

I'm new to ElasticSearch and could use some quick validation of my
configuration.

I installed ES via brew on Lion, so ES is installed at:
/usr/local/Cellar/elasticsearch/0.17.1

My config file lives at:
/usr/local/Cellar/elasticsearch/0.17.1/config/elasticsearch.yml

And I'm launching ES manually via:
elasticsearch -f -D es.config=/usr/local/Cellar/elasticsearch/0.17.1/
config/elasticsearch.yml

Now in my config file (elasticsearch.yml), I have the following index
definition:

index :
analysis :
analyzer :
standard :
type : standard

    tokenizer :
        myTokenizer1 :
            type : standard

    filter :
        myTokenFilter1 :
            type : synonym
            synonyms_path : synonym.txt

And peer to elasticsearch.yml I have created a file named synonym.txt.
A sample of the data in synonym.txt is:

field type, scan type, field dominance

upper field first, uff

After reading the documentation at:
http://www.elasticsearch.org/guide/reference/index-modules/analysis/synonym-tokenfilter.html
It seems to suggest that that:
field type == scan type == field dominance
and
upper field first == off

as in, they're all considered the same thing.

So to test this, I added a new document:

{ "scan type" : "upper field first" }

and then searched for it using:

curl -XGET http://localhost:9200/test/records/_search?q=uff

But I received no hits, but I would have expected that uff would have
translated to "upper field first", which should have received a hit.

So I must be doing something wrong, and this is where I need your
help.

Much thanks!
-jesse

jessejlt · August 19, 2011, 9:48pm

After doing some searches in this group I see that most folks use
gists for this sort of thing, so I've created a gist:

gist.github.com

https://gist.github.com/jessejlt/1158093

elasticsearch.yml


# The cluster name
cluster.name: media

# Path Settings
#path.conf: /path/to/conf
#path.data: /path/to/data
#path.work: /path/to/work
#path.logs: /path/to/logs

This file has been truncated. show original

get from ES

curl -XGET http://localhost:9200/test/records/_search?q=uff | python -m json.tool
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   122  100   122    0     0  16776      0 --:--:-- --:--:-- --:--:-- 40666
{
    "_shards": {
        "failed": 0, 
        "successful": 5, 
        "total": 5
    },

This file has been truncated. show original

push to ES

curl -XPUT http://localhost:9200/test/records/1 -d '{
> "field type": "upper field first"
> }'

> {"ok":true,"_index":"test","_type":"records","_id":"1","_version":1}

There are more than three files. show original

On Aug 19, 12:03 pm, jessejlt jesse...@gmail.com wrote:

Greetings!

I'm new to Elasticsearch and could use some quick validation of my
configuration.

I installed ES via brew on Lion, so ES is installed at:
/usr/local/Cellar/elasticsearch/0.17.1

My config file lives at:
/usr/local/Cellar/elasticsearch/0.17.1/config/elasticsearch.yml

And I'm launching ES manually via:
elasticsearch -f -D es.config=/usr/local/Cellar/elasticsearch/0.17.1/
config/elasticsearch.yml

Now in my config file (elasticsearch.yml), I have the following index
definition:

index :
analysis :
analyzer :
standard :
type : standard
    tokenizer :
        myTokenizer1 :
            type : standard

    filter :
        myTokenFilter1 :
            type : synonym
            synonyms_path : synonym.txt
And peer to elasticsearch.yml I have created a file named synonym.txt.
A sample of the data in synonym.txt is:

field type, scan type, field dominance

upper field first, uff

After reading the documentation at:Elasticsearch Platform — Find real-time answers at scale | Elastic...
It seems to suggest that that:
field type == scan type == field dominance
and
upper field first == off

as in, they're all considered the same thing.

So to test this, I added a new document:

{ "scan type" : "upper field first" }

and then searched for it using:

curl -XGEThttp://localhost:9200/test/records/_search?q=uff

But I received no hits, but I would have expected that uff would have
translated to "upper field first", which should have received a hit.

So I must be doing something wrong, and this is where I need your
help.

Much thanks!
-jesse

Clinton_Gormley · August 20, 2011, 10:17am

Hi Jesse

You had a few issues:

You weren't specifying the analyzer correctly - it should
be a custom analyzer, which includes in its definition your
synonyms token filter
You weren't applying that analyzer to any field
You were searching on the _all field which has its own
analyzer (standard, unless you change that) so even
if your field is analyzed with synonyms, the _all field
wouldn't be.

I've gisted a demo so that you can see how to do this correctly:

gist.github.com

https://gist.github.com/clintongormley/4193a7d63af534d3b0ef

gistfile1.txt

##########################################################################################
# First, create the index, with the analyzer settings, and apply that analyzer to a field:
##########################################################################################

curl -XPUT 'http://127.0.0.1:9200/foo/?pretty=1'  -d '
{
   "mappings" : {
      "bar" : {
         "properties" : {
            "test_field" : {

This file has been truncated. show original

clint

jessejlt · August 22, 2011, 7:19pm

Hey thanks, Clinton!

Does this mean that the _all field cannot have the synonym analyzer
attached to it?

On Aug 20, 3:17 am, Clinton Gormley cl...@traveljury.com wrote:

Hi Jesse

You had a few issues:

You weren't specifying the analyzer correctly - it should
be a custom analyzer, which includes in its definition your
synonyms token filter

You weren't applying that analyzer to any field

You were searching on the _all field which has its own
analyzer (standard, unless you change that) so even
if your field is analyzed with synonyms, the _all field
wouldn't be.

I've gisted a demo so that you can see how to do this correctly:

gist:4193a7d63af534d3b0ef · GitHub

clint

Clinton_Gormley · August 22, 2011, 7:27pm

Hi Jesse

Does this mean that the _all field cannot have the synonym analyzer
attached to it?

The _all field uses the standard analyzer by default, but there is no
reason that you can't change it to use whatever analyzer you like.

However, it will be applied to all terms included in the _all field,
which probably isn't what you want.

clint

jessejlt · August 22, 2011, 10:01pm

Thanks again!

So synonym filters are capable of identifying synonyms for a field's
value, do you know if it's possible to declare synonyms at the field
level? I can do this server-side before touching ES, but before doing
so I figure it's worth seeing if this functionality is already in ES.

So an example of a record:

{
"field-type" : "Upper Field First"
}

Where "field-type" is a synonym for "field-order" and "scan-type".

On Aug 22, 12:27 pm, Clinton Gormley cl...@traveljury.com wrote:

Hi Jesse

Does this mean that the _all field cannot have the synonym analyzer
attached to it?

The _all field uses the standard analyzer by default, but there is no
reason that you can't change it to use whatever analyzer you like.

However, it will be applied to all terms included in the _all field,
which probably isn't what you want.

clint

Clinton_Gormley · August 23, 2011, 8:28am

Hiya

So synonym filters are capable of identifying synonyms for a field's
value, do you know if it's possible to declare synonyms at the field
level? I can do this server-side before touching ES, but before doing
so I figure it's worth seeing if this functionality is already in ES.

So an example of a record:

{
"field-type" : "Upper Field First"
}

Where "field-type" is a synonym for "field-order" and "scan-type".

I don't quite follow what it is you are trying to achieve here.

What ES does have is "multi-fields"

ie you provide the field 'field-type' and in ES, that field actually
consists of several "sub-fields", eg 'field-type.analyzed',
'field-type.not_analyzed', etc

If your search on 'field-type', you would actually be searching on
'field-type.field-type'.

Also, you can set an index_name on any field (including those
sub-fields) which would allow you to refer to eg 'field-type.foo' as
field 'foo'

clint

Topic		Replies	Views
Index configuration Elasticsearch	16	562	July 6, 2017
Unexpected Behavior of OR Match Query With Synonym Graph Elasticsearch	4	183	November 1, 2023
Elasticsearch synonym mappings - illegal_argument_exception Elasticsearch	2	242	July 11, 2023
Elasticsearch 8.10.2 synonyms not working when synonyms_path is used Elasticsearch	2	382	December 11, 2023
Query index from within an AnalysisProvider? Elasticsearch	3	301	April 5, 2023

Synonym configuration

Related Topics