IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Unique token filter Word delimiter token filter »

› › ›

Uppercase token filter

edit

Uppercase token filter

edit

Changes token text to uppercase. For example, you can use the uppercase filter to change the Lazy DoG to THE LAZY DOG.

This filter uses Lucene’s UpperCaseFilter.

Depending on the language, an uppercase character can map to multiple lowercase characters. Using the uppercase filter could result in the loss of lowercase character information.

To avoid this loss but still have a consistent letter case, use the lowercase filter instead.

Example

edit

The following analyze API request uses the default uppercase filter to change the the Quick FoX JUMPs to uppercase:

resp = client.indices.analyze(
    tokenizer="standard",
    filter=[
        "uppercase"
    ],
    text="the Quick FoX JUMPs",
)
print(resp)

response = client.indices.analyze(
  body: {
    tokenizer: 'standard',
    filter: [
      'uppercase'
    ],
    text: 'the Quick FoX JUMPs'
  }
)
puts response

const response = await client.indices.analyze({
  tokenizer: "standard",
  filter: ["uppercase"],
  text: "the Quick FoX JUMPs",
});
console.log(response);

GET _analyze
{
  "tokenizer" : "standard",
  "filter" : ["uppercase"],
  "text" : "the Quick FoX JUMPs"
}

The filter produces the following tokens:

[ THE, QUICK, FOX, JUMPS ]

Add to an analyzer

edit

The following create index API request uses the uppercase filter to configure a new custom analyzer.

resp = client.indices.create(
    index="uppercase_example",
    settings={
        "analysis": {
            "analyzer": {
                "whitespace_uppercase": {
                    "tokenizer": "whitespace",
                    "filter": [
                        "uppercase"
                    ]
                }
            }
        }
    },
)
print(resp)

response = client.indices.create(
  index: 'uppercase_example',
  body: {
    settings: {
      analysis: {
        analyzer: {
          whitespace_uppercase: {
            tokenizer: 'whitespace',
            filter: [
              'uppercase'
            ]
          }
        }
      }
    }
  }
)
puts response

const response = await client.indices.create({
  index: "uppercase_example",
  settings: {
    analysis: {
      analyzer: {
        whitespace_uppercase: {
          tokenizer: "whitespace",
          filter: ["uppercase"],
        },
      },
    },
  },
});
console.log(response);

PUT uppercase_example
{
  "settings": {
    "analysis": {
      "analyzer": {
        "whitespace_uppercase": {
          "tokenizer": "whitespace",
          "filter": [ "uppercase" ]
        }
      }
    }
  }
}

« Unique token filter Word delimiter token filter »