UAX URL email tokenizer

UAX URL email tokenizer

The uax_url_email tokenizer is like the standard tokenizer except that it recognises URLs and email addresses as single tokens.

Example output

  1. resp = client.indices.analyze(
  2.     tokenizer="uax_url_email",
  3.     text="Email me at john.smith@global-international.com",
  4. )
  5. print(resp)
  1. response = client.indices.analyze(
  2.   body: {
  3.     tokenizer: 'uax_url_email',
  4.     text: 'Email me at john.smith@global-international.com'
  5.   }
  6. )
  7. puts response
  1. const response = await client.indices.analyze({
  2.   tokenizer: "uax_url_email",
  3.   text: "Email me at john.smith@global-international.com",
  4. });
  5. console.log(response);
  1. POST _analyze
  2. {
  3.   "tokenizer": "uax_url_email",
  4.   "text": "Email me at john.smith@global-international.com"
  5. }

The above sentence would produce the following terms:

  1. [ Email, me, at, john.smith@global-international.com ]

while the standard tokenizer would produce:

  1. [ Email, me, at, john.smith, global, international.com ]

Configuration

The uax_url_email tokenizer accepts the following parameters:

max_token_length

The maximum token length. If a token is seen that exceeds this length then it is split at max_token_length intervals. Defaults to 255.

Example configuration

In this example, we configure the uax_url_email tokenizer to have a max_token_length of 5 (for demonstration purposes):

  1. resp = client.indices.create(
  2.     index="my-index-000001",
  3.     settings={
  4.         "analysis": {
  5.             "analyzer": {
  6.                 "my_analyzer": {
  7.                     "tokenizer": "my_tokenizer"
  8.                 }
  9.             },
  10.             "tokenizer": {
  11.                 "my_tokenizer": {
  12.                     "type": "uax_url_email",
  13.                     "max_token_length": 5
  14.                 }
  15.             }
  16.         }
  17.     },
  18. )
  19. print(resp)
  21. resp1 = client.indices.analyze(
  22.     index="my-index-000001",
  23.     analyzer="my_analyzer",
  24.     text="john.smith@global-international.com",
  25. )
  26. print(resp1)
  1. response = client.indices.create(
  2.   index: 'my-index-000001',
  3.   body: {
  4.     settings: {
  5.       analysis: {
  6.         analyzer: {
  7.           my_analyzer: {
  8.             tokenizer: 'my_tokenizer'
  9.           }
  10.         },
  11.         tokenizer: {
  12.           my_tokenizer: {
  13.             type: 'uax_url_email',
  14.             max_token_length: 5
  15.           }
  16.         }
  17.       }
  18.     }
  19.   }
  20. )
  21. puts response
  23. response = client.indices.analyze(
  24.   index: 'my-index-000001',
  25.   body: {
  26.     analyzer: 'my_analyzer',
  27.     text: 'john.smith@global-international.com'
  28.   }
  29. )
  30. puts response
  1. const response = await client.indices.create({
  2.   index: "my-index-000001",
  3.   settings: {
  4.     analysis: {
  5.       analyzer: {
  6.         my_analyzer: {
  7.           tokenizer: "my_tokenizer",
  8.         },
  9.       },
  10.       tokenizer: {
  11.         my_tokenizer: {
  12.           type: "uax_url_email",
  13.           max_token_length: 5,
  14.         },
  15.       },
  16.     },
  17.   },
  18. });
  19. console.log(response);
  21. const response1 = await client.indices.analyze({
  22.   index: "my-index-000001",
  23.   analyzer: "my_analyzer",
  24.   text: "john.smith@global-international.com",
  25. });
  26. console.log(response1);
  1. PUT my-index-000001
  2. {
  3.   "settings": {
  4.     "analysis": {
  5.       "analyzer": {
  6.         "my_analyzer": {
  7.           "tokenizer": "my_tokenizer"
  8.         }
  9.       },
  10.       "tokenizer": {
  11.         "my_tokenizer": {
  12.           "type": "uax_url_email",
  13.           "max_token_length": 5
  14.         }
  15.       }
  16.     }
  17.   }
  18. }
  20. POST my-index-000001/_analyze
  21. {
  22.   "analyzer": "my_analyzer",
  23.   "text": "john.smith@global-international.com"
  24. }

The above example produces the following terms:

  1. [ john, smith, globa, l, inter, natio, nal.c, om ]