nominatim/api/search/icu_tokenizer.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2023 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Implementation of query analysis for the ICU tokenizer.
   9 """
  10 from typing import Tuple, Dict, List, Optional, NamedTuple, Iterator, Any, cast
  11 from collections import defaultdict
  12 import dataclasses
  13 import difflib
  14
  15 from icu import Transliterator
  16
  17 import sqlalchemy as sa
  18
  19 from nominatim.typing import SaRow
  20 from nominatim.api.connection import SearchConnection
  21 from nominatim.api.logging import log
  22 from nominatim.api.search import query as qmod
  23 from nominatim.api.search.query_analyzer_factory import AbstractQueryAnalyzer
  24 from nominatim.db.sqlalchemy_types import Json
  25
  26
  27 DB_TO_TOKEN_TYPE = {
  28     'W': qmod.TokenType.WORD,
  29     'w': qmod.TokenType.PARTIAL,
  30     'H': qmod.TokenType.HOUSENUMBER,
  31     'P': qmod.TokenType.POSTCODE,
  32     'C': qmod.TokenType.COUNTRY
  33 }
  34
  35
  36 class QueryPart(NamedTuple):
  37     """ Normalized and transliterated form of a single term in the query.
  38         When the term came out of a split during the transliteration,
  39         the normalized string is the full word before transliteration.
  40         The word number keeps track of the word before transliteration
  41         and can be used to identify partial transliterated terms.
  42     """
  43     token: str
  44     normalized: str
  45     word_number: int
  46
  47
  48 QueryParts = List[QueryPart]
  49 WordDict = Dict[str, List[qmod.TokenRange]]
  50
  51 def yield_words(terms: List[QueryPart], start: int) -> Iterator[Tuple[str, qmod.TokenRange]]:
  52     """ Return all combinations of words in the terms list after the
  53         given position.
  54     """
  55     total = len(terms)
  56     for first in range(start, total):
  57         word = terms[first].token
  58         yield word, qmod.TokenRange(first, first + 1)
  59         for last in range(first + 1, min(first + 20, total)):
  60             word = ' '.join((word, terms[last].token))
  61             yield word, qmod.TokenRange(first, last + 1)
  62
  63
  64 @dataclasses.dataclass
  65 class ICUToken(qmod.Token):
  66     """ Specialised token for ICU tokenizer.
  67     """
  68     word_token: str
  69     info: Optional[Dict[str, Any]]
  70
  71     def get_category(self) -> Tuple[str, str]:
  72         assert self.info
  73         return self.info.get('class', ''), self.info.get('type', '')
  74
  75
  76     def rematch(self, norm: str) -> None:
  77         """ Check how well the token matches the given normalized string
  78             and add a penalty, if necessary.
  79         """
  80         if not self.lookup_word:
  81             return
  82
  83         seq = difflib.SequenceMatcher(a=self.lookup_word, b=norm)
  84         distance = 0
  85         for tag, afrom, ato, bfrom, bto in seq.get_opcodes():
  86             if tag in ('delete', 'insert') and (afrom == 0 or ato == len(self.lookup_word)):
  87                 distance += 1
  88             elif tag == 'replace':
  89                 distance += max((ato-afrom), (bto-bfrom))
  90             elif tag != 'equal':
  91                 distance += abs((ato-afrom) - (bto-bfrom))
  92         self.penalty += (distance/len(self.lookup_word))
  93
  94
  95     @staticmethod
  96     def from_db_row(row: SaRow) -> 'ICUToken':
  97         """ Create a ICUToken from the row of the word table.
  98         """
  99         count = 1 if row.info is None else row.info.get('count', 1)
 100
 101         penalty = 0.0
 102         if row.type == 'w':
 103             penalty = 0.3
 104         elif row.type == 'W':
 105             if len(row.word_token) == 1 and row.word_token == row.word:
 106                 penalty = 0.2 if row.word.isdigit() else 0.3
 107         elif row.type == 'H':
 108             penalty = sum(0.1 for c in row.word_token if c != ' ' and not c.isdigit())
 109             if all(not c.isdigit() for c in row.word_token):
 110                 penalty += 0.2 * (len(row.word_token) - 1)
 111         elif row.type == 'C':
 112             if len(row.word_token) == 1:
 113                 penalty = 0.3
 114
 115         if row.info is None:
 116             lookup_word = row.word
 117         else:
 118             lookup_word = row.info.get('lookup', row.word)
 119         if lookup_word:
 120             lookup_word = lookup_word.split('@', 1)[0]
 121         else:
 122             lookup_word = row.word_token
 123
 124         return ICUToken(penalty=penalty, token=row.word_id, count=count,
 125                         lookup_word=lookup_word, is_indexed=True,
 126                         word_token=row.word_token, info=row.info)
 127
 128
 129
 130 class ICUQueryAnalyzer(AbstractQueryAnalyzer):
 131     """ Converter for query strings into a tokenized query
 132         using the tokens created by a ICU tokenizer.
 133     """
 134
 135     def __init__(self, conn: SearchConnection) -> None:
 136         self.conn = conn
 137
 138
 139     async def setup(self) -> None:
 140         """ Set up static data structures needed for the analysis.
 141         """
 142         async def _make_normalizer() -> Any:
 143             rules = await self.conn.get_property('tokenizer_import_normalisation')
 144             return Transliterator.createFromRules("normalization", rules)
 145
 146         self.normalizer = await self.conn.get_cached_value('ICUTOK', 'normalizer',
 147                                                            _make_normalizer)
 148
 149         async def _make_transliterator() -> Any:
 150             rules = await self.conn.get_property('tokenizer_import_transliteration')
 151             return Transliterator.createFromRules("transliteration", rules)
 152
 153         self.transliterator = await self.conn.get_cached_value('ICUTOK', 'transliterator',
 154                                                                _make_transliterator)
 155
 156         if 'word' not in self.conn.t.meta.tables:
 157             sa.Table('word', self.conn.t.meta,
 158                      sa.Column('word_id', sa.Integer),
 159                      sa.Column('word_token', sa.Text, nullable=False),
 160                      sa.Column('type', sa.Text, nullable=False),
 161                      sa.Column('word', sa.Text),
 162                      sa.Column('info', Json))
 163
 164
 165     async def analyze_query(self, phrases: List[qmod.Phrase]) -> qmod.QueryStruct:
 166         """ Analyze the given list of phrases and return the
 167             tokenized query.
 168         """
 169         log().section('Analyze query (using ICU tokenizer)')
 170         normalized = list(filter(lambda p: p.text,
 171                                  (qmod.Phrase(p.ptype, self.normalize_text(p.text))
 172                                   for p in phrases)))
 173         query = qmod.QueryStruct(normalized)
 174         log().var_dump('Normalized query', query.source)
 175         if not query.source:
 176             return query
 177
 178         parts, words = self.split_query(query)
 179         log().var_dump('Transliterated query', lambda: _dump_transliterated(query, parts))
 180
 181         for row in await self.lookup_in_db(list(words.keys())):
 182             for trange in words[row.word_token]:
 183                 token = ICUToken.from_db_row(row)
 184                 if row.type == 'S':
 185                     if row.info['op'] in ('in', 'near'):
 186                         if trange.start == 0:
 187                             query.add_token(trange, qmod.TokenType.NEAR_ITEM, token)
 188                     else:
 189                         if trange.start == 0 and trange.end == query.num_token_slots():
 190                             query.add_token(trange, qmod.TokenType.NEAR_ITEM, token)
 191                         else:
 192                             query.add_token(trange, qmod.TokenType.QUALIFIER, token)
 193                 else:
 194                     query.add_token(trange, DB_TO_TOKEN_TYPE[row.type], token)
 195
 196         self.add_extra_tokens(query, parts)
 197         self.rerank_tokens(query, parts)
 198
 199         log().table_dump('Word tokens', _dump_word_tokens(query))
 200
 201         return query
 202
 203
 204     def normalize_text(self, text: str) -> str:
 205         """ Bring the given text into a normalized form. That is the
 206             standardized form search will work with. All information removed
 207             at this stage is inevitably lost.
 208         """
 209         norm = cast(str, self.normalizer.transliterate(text))
 210         numspaces = norm.count(' ')
 211         if numspaces > 4 and len(norm) <= (numspaces + 1) * 3:
 212             return ''
 213
 214         return norm
 215
 216
 217     def split_query(self, query: qmod.QueryStruct) -> Tuple[QueryParts, WordDict]:
 218         """ Transliterate the phrases and split them into tokens.
 219
 220             Returns the list of transliterated tokens together with their
 221             normalized form and a dictionary of words for lookup together
 222             with their position.
 223         """
 224         parts: QueryParts = []
 225         phrase_start = 0
 226         words = defaultdict(list)
 227         wordnr = 0
 228         for phrase in query.source:
 229             query.nodes[-1].ptype = phrase.ptype
 230             for word in phrase.text.split(' '):
 231                 trans = self.transliterator.transliterate(word)
 232                 if trans:
 233                     for term in trans.split(' '):
 234                         if term:
 235                             parts.append(QueryPart(term, word, wordnr))
 236                             query.add_node(qmod.BreakType.TOKEN, phrase.ptype)
 237                     query.nodes[-1].btype = qmod.BreakType.WORD
 238                 wordnr += 1
 239             query.nodes[-1].btype = qmod.BreakType.PHRASE
 240
 241             for word, wrange in yield_words(parts, phrase_start):
 242                 words[word].append(wrange)
 243
 244             phrase_start = len(parts)
 245         query.nodes[-1].btype = qmod.BreakType.END
 246
 247         return parts, words
 248
 249
 250     async def lookup_in_db(self, words: List[str]) -> 'sa.Result[Any]':
 251         """ Return the token information from the database for the
 252             given word tokens.
 253         """
 254         t = self.conn.t.meta.tables['word']
 255         return await self.conn.execute(t.select().where(t.c.word_token.in_(words)))
 256
 257
 258     def add_extra_tokens(self, query: qmod.QueryStruct, parts: QueryParts) -> None:
 259         """ Add tokens to query that are not saved in the database.
 260         """
 261         for part, node, i in zip(parts, query.nodes, range(1000)):
 262             if len(part.token) <= 4 and part[0].isdigit()\
 263                and not node.has_tokens(i+1, qmod.TokenType.HOUSENUMBER):
 264                 query.add_token(qmod.TokenRange(i, i+1), qmod.TokenType.HOUSENUMBER,
 265                                 ICUToken(0.5, 0, 1, part.token, True, part.token, None))
 266
 267
 268     def rerank_tokens(self, query: qmod.QueryStruct, parts: QueryParts) -> None:
 269         """ Add penalties to tokens that depend on presence of other token.
 270         """
 271         for i, node, tlist in query.iter_token_lists():
 272             if tlist.ttype == qmod.TokenType.POSTCODE:
 273                 for repl in node.starting:
 274                     if repl.end == tlist.end and repl.ttype != qmod.TokenType.POSTCODE \
 275                        and (repl.ttype != qmod.TokenType.HOUSENUMBER
 276                             or len(tlist.tokens[0].lookup_word) > 4):
 277                         repl.add_penalty(0.39)
 278             elif tlist.ttype == qmod.TokenType.HOUSENUMBER \
 279                  and len(tlist.tokens[0].lookup_word) <= 3:
 280                 if any(c.isdigit() for c in tlist.tokens[0].lookup_word):
 281                     for repl in node.starting:
 282                         if repl.end == tlist.end and repl.ttype != qmod.TokenType.HOUSENUMBER:
 283                             repl.add_penalty(0.5 - tlist.tokens[0].penalty)
 284             elif tlist.ttype not in (qmod.TokenType.COUNTRY, qmod.TokenType.PARTIAL):
 285                 norm = parts[i].normalized
 286                 for j in range(i + 1, tlist.end):
 287                     if parts[j - 1].word_number != parts[j].word_number:
 288                         norm += '  ' + parts[j].normalized
 289                 for token in tlist.tokens:
 290                     cast(ICUToken, token).rematch(norm)
 291
 292
 293 def _dump_transliterated(query: qmod.QueryStruct, parts: QueryParts) -> str:
 294     out = query.nodes[0].btype.value
 295     for node, part in zip(query.nodes[1:], parts):
 296         out += part.token + node.btype.value
 297     return out
 298
 299
 300 def _dump_word_tokens(query: qmod.QueryStruct) -> Iterator[List[Any]]:
 301     yield ['type', 'token', 'word_token', 'lookup_word', 'penalty', 'count', 'info']
 302     for node in query.nodes:
 303         for tlist in node.starting:
 304             for token in tlist.tokens:
 305                 t = cast(ICUToken, token)
 306                 yield [tlist.ttype.name, t.token, t.word_token or '',
 307                        t.lookup_word or '', t.penalty, t.count, t.info]
 308
 309
 310 async def create_query_analyzer(conn: SearchConnection) -> AbstractQueryAnalyzer:
 311     """ Create and set up a new query analyzer for a database based
 312         on the ICU tokenizer.
 313     """
 314     out = ICUQueryAnalyzer(conn)
 315     await out.setup()
 316
 317     return out