サジェスター（Suggesters）

Suggesters

提供されたテキストに基づいて、似たような用語を提案するためにサジェスターを使用します。

Python

resp = client.search(
   index="my-index-000001",
   query={
   "match": {
   "message": "tring out Elasticsearch"
   }
   },
   suggest={
   "my-suggestion": {
   "text": "tring out Elasticsearch",
   "term": {
   "field": "message"
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'my-index-000001',
  body: {
   query: {
   match: {
   message: 'tring out Elasticsearch'
   }
   },
   suggest: {
   "my-suggestion": {
   text: 'tring out Elasticsearch',
   term: {
   field: 'message'
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "my-index-000001",
  query: {
   match: {
   message: "tring out Elasticsearch",
   },
  },
  suggest: {
   "my-suggestion": {
   text: "tring out Elasticsearch",
   term: {
   field: "message",
   },
   },
  },
});
console.log(response);

Console

POST my-index-000001/_search
{
  "query" : {
   "match": {
   "message": "tring out Elasticsearch"
   }
  },
  "suggest" : {
   "my-suggestion" : {
   "text" : "tring out Elasticsearch",
   "term" : {
   "field" : "message"
   }
   }
  }
}

Request

サジェスト機能は、提供されたテキストに基づいて似たような用語を提案します。サジェストリクエスト部分は、_searchリクエストのクエリ部分と一緒に定義されます。クエリ部分が省略された場合、提案のみが返されます。

Examples

リクエストごとに複数の提案を指定できます。各提案は任意の名前で識別されます。以下の例では、2つの提案が要求されています。my-suggest-1とmy-suggest-2の両方の提案はtermサジェスターを使用していますが、textは異なります。

Python

resp = client.search(
   suggest={
   "my-suggest-1": {
   "text": "tring out Elasticsearch",
   "term": {
   "field": "message"
   }
   },
   "my-suggest-2": {
   "text": "kmichy",
   "term": {
   "field": "user.id"
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  body: {
   suggest: {
   "my-suggest-1": {
   text: 'tring out Elasticsearch',
   term: {
   field: 'message'
   }
   },
   "my-suggest-2": {
   text: 'kmichy',
   term: {
   field: 'user.id'
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  suggest: {
   "my-suggest-1": {
   text: "tring out Elasticsearch",
   term: {
   field: "message",
   },
   },
   "my-suggest-2": {
   text: "kmichy",
   term: {
   field: "user.id",
   },
   },
  },
});
console.log(response);

Console

POST _search
{
  "suggest": {
   "my-suggest-1" : {
   "text" : "tring out Elasticsearch",
   "term" : {
   "field" : "message"
   }
   },
   "my-suggest-2" : {
   "text" : "kmichy",
   "term" : {
   "field" : "user.id"
   }
   }
  }
}

以下のサジェストレスポンスの例には、my-suggest-1とmy-suggest-2の提案レスポンスが含まれています。各提案部分にはエントリが含まれています。各エントリは実質的にサジェストテキストからのトークンであり、提案エントリテキスト、サジェストテキスト内の元の開始オフセットと長さ、および見つかった場合の任意の数のオプションが含まれています。

Console-Result

{
  "_shards": ...
  "hits": ...
  "took": 2,
  "timed_out": false,
  "suggest": {
   "my-suggest-1": [ {
   "text": "tring",
   "offset": 0,
   "length": 5,
   "options": [ {"text": "trying", "score": 0.8, "freq": 1 } ]
   }, {
   "text": "out",
   "offset": 6,
   "length": 3,
   "options": []
   }, {
   "text": "elasticsearch",
   "offset": 10,
   "length": 13,
   "options": []
   } ],
   "my-suggest-2": ...
  }
}

各オプション配列には、提案されたテキスト、その文書頻度、および提案エントリテキストに対するスコアを含むオプションオブジェクトが含まれています。スコアの意味は使用されるサジェスターによって異なります。用語サジェスターのスコアは編集距離に基づいています。

Global suggest text

サジェストテキストの繰り返しを避けるために、グローバルテキストを定義することが可能です。以下の例では、サジェストテキストがグローバルに定義され、my-suggest-1とmy-suggest-2の提案に適用されます。

Php

$params = [
   'body' => [
   'suggest' => [
   'text' => 'tring out Elasticsearch',
   'my-suggest-1' => [
   'term' => [
   'field' => 'message',
   ],
   ],
   'my-suggest-2' => [
   'term' => [
   'field' => 'user',
   ],
   ],
   ],
   ],
];
$response = $client->search($params);

Python

resp = client.search(
   suggest={
   "text": "tring out Elasticsearch",
   "my-suggest-1": {
   "term": {
   "field": "message"
   }
   },
   "my-suggest-2": {
   "term": {
   "field": "user"
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  body: {
   suggest: {
   text: 'tring out Elasticsearch',
   "my-suggest-1": {
   term: {
   field: 'message'
   }
   },
   "my-suggest-2": {
   term: {
   field: 'user'
   }
   }
   }
  }
)
puts response

Go

res, err := es.Search(
    es.Search.WithBody(strings.NewReader(`{
      "suggest": {
      "text": "tring out Elasticsearch",
      "my-suggest-1": {
      "term": {
      "field": "message"
      }
      },
      "my-suggest-2": {
      "term": {
      "field": "user"
      }
      }
      }
    }`)),
    es.Search.WithPretty(),
)
fmt.Println(res, err)

Js

const response = await client.search({
  suggest: {
   text: "tring out Elasticsearch",
   "my-suggest-1": {
   term: {
   field: "message",
   },
   },
   "my-suggest-2": {
   term: {
   field: "user",
   },
   },
  },
});
console.log(response);

Console

POST _search
{
  "suggest": {
   "text" : "tring out Elasticsearch",
   "my-suggest-1" : {
   "term" : {
   "field" : "message"
   }
   },
   "my-suggest-2" : {
   "term" : {
   "field" : "user"
   }
   }
  }
}

上記の例では、サジェストテキストも提案特有のオプションとして指定できます。提案レベルで指定されたサジェストテキストは、グローバルレベルのサジェストテキストを上書きします。

Term suggester

#### Common suggest options:
|     |     |
| --- | --- |
| `````text````` | サジェストテキスト。サジェストテキストは、グローバルまたは提案ごとに設定する必要がある必須オプションです。 |
| `````field````` | 候補提案を取得するフィールド。これはグローバルまたは提案ごとに設定する必要がある必須オプションです。 |
| `````analyzer````` | サジェストテキストを分析するためのアナライザー。デフォルトはサジェストフィールドの検索アナライザーです。 |
| `````size````` | サジェストテキストトークンごとに返される最大修正数。 |
| `````sort````` | サジェストテキスト用語ごとに提案がどのようにソートされるべきかを定義します。2つの可能な値：<br>- `````score`````: スコアで最初にソートし、次に文書頻度、最後に用語自体をソートします。<br>- `````frequency`````: 文書頻度で最初にソートし、次に類似性スコア、最後に用語自体をソートします。 |
| `````suggest_mode````` | サジェストモードは、どの提案が含まれるか、またはどのサジェストテキスト用語に対して提案が行われるべきかを制御します。指定できる3つの可能な値：
- `````missing`````: インデックスに存在しないサジェストテキスト用語の提案のみを提供します（デフォルト）。
- `````popular`````: 元のサジェストテキスト用語よりも多くの文書に出現する提案のみを提案します。
- `````always`````: サジェストテキスト内の用語に基づいて一致する提案を提案します。
#### Other term suggest options:
|     |     |
| --- | --- |
| `````max_edits````` | 提案として考慮されるために候補提案が持つことができる最大編集距離。1と2の間の値のみです。他の値は不正なリクエストエラーを引き起こします。デフォルトは2です。 |
| `````prefix_length````` | 提案候補となるために一致する必要がある最小接頭辞文字数。デフォルトは1です。この数を増やすとスペルチェックのパフォーマンスが向上します。通常、誤字は用語の最初に発生しません。 |
| `````min_word_length````` | サジェストテキスト用語が含まれるために必要な最小長さ。デフォルトは`````4`````です。 |
| `````shard_size````` | 各個別シャードから取得される最大提案数を設定します。リデュースフェーズでは、`````size`````オプションに基づいて上位Nの提案のみが返されます。デフォルトは`````size`````オプションです。これを`````size`````よりも高い値に設定すると、パフォーマンスのコストでスペル修正のためのより正確な文書頻度を取得できます。用語がシャード間で分割されるため、スペル修正のシャードレベルの文書頻度は正確でない場合があります。これを増やすと、これらの文書頻度がより正確になります。 |
| `````max_inspections````` | シャードレベルでより多くの候補スペル修正を検査するために`````shard_size`````と掛け算するために使用される係数。パフォーマンスのコストで精度を向上させることができます。デフォルトは5です。 |
| `````min_doc_freq````` | 提案が出現する文書の最小しきい値。この値は絶対数または文書数の相対的な割合として指定できます。これにより、高頻度の用語のみを提案することで品質が向上します。デフォルトは0fで、無効になっています。1より大きい値が指定された場合、数は小数であってはなりません。シャードレベルの文書頻度がこのオプションに使用されます。 |
| `````max_term_freq````` | 提案テキストトークンが含まれるために存在できる文書の最大しきい値。相対的な割合の数（例：0.4）または文書頻度を表す絶対数であることができます。1より大きい値が指定された場合、小数は指定できません。デフォルトは0.01fです。これは、通常正しく綴られている高頻度の用語をスペルチェックから除外するために使用できます。これにより、スペルチェックのパフォーマンスも向上します。シャードレベルの文書頻度がこのオプションに使用されます。 |
| `````string_distance````` | 提案された用語がどれだけ類似しているかを比較するために使用する文字列距離の実装。指定できる5つの可能な値：
- `````internal`````: デフォルトはdamerau\_levenshteinに基づいていますが、インデックス内の用語の文字列距離を比較するために最適化されています。
- `````damerau_levenshtein`````: Damerau-Levenshteinアルゴリズムに基づく文字列距離アルゴリズム。
- `````levenshtein`````: Levenshtein編集距離アルゴリズムに基づく文字列距離アルゴリズム。
- `````jaro_winkler`````: Jaro-Winklerアルゴリズムに基づく文字列距離アルゴリズム。
- `````ngram`````: 文字n-グラムに基づく文字列距離アルゴリズム。
## Phrase Suggester
`````term`````サジェスターは、特定の文字列距離内でトークンごとに単語の代替を取得するための非常に便利なAPIを提供します。このAPIは、ストリーム内の各トークンに個別にアクセスできるようにし、サジェスト選択はAPI消費者に委ねられます。しかし、しばしば事前に選択された提案が必要であり、エンドユーザーに提示されます。`````phrase`````サジェスターは、`````term`````サジェスターの上に追加のロジックを追加し、`````ngram-language`````モデルに基づいて重み付けされた個々のトークンの代わりに、全体の修正されたフレーズを選択します。実際には、このサジェスターは共起と頻度に基づいてどのトークンを選択するかについてより良い決定を下すことができます。
#### API Example
一般的に、`````phrase`````サジェスターは機能するために特別なマッピングが必要です。このページの`````phrase`````サジェスターの例では、機能するために次のマッピングが必要です。`````reverse`````アナライザーは、最後の例でのみ使用されます。
#### Python
``````python
resp = client.indices.create(
   index="test",
   settings={
   "index": {
   "number_of_shards": 1,
   "analysis": {
   "analyzer": {
   "trigram": {
   "type": "custom",
   "tokenizer": "standard",
   "filter": [
   "lowercase",
   "shingle"
   ]
   },
   "reverse": {
   "type": "custom",
   "tokenizer": "standard",
   "filter": [
   "lowercase",
   "reverse"
   ]
   }
   },
   "filter": {
   "shingle": {
   "type": "shingle",
   "min_shingle_size": 2,
   "max_shingle_size": 3
   }
   }
   }
   }
   },
   mappings={
   "properties": {
   "title": {
   "type": "text",
   "fields": {
   "trigram": {
   "type": "text",
   "analyzer": "trigram"
   },
   "reverse": {
   "type": "text",
   "analyzer": "reverse"
   }
   }
   }
   }
   },
)
print(resp)
resp1 = client.index(
   index="test",
   refresh=True,
   document={
   "title": "noble warriors"
   },
)
print(resp1)
resp2 = client.index(
   index="test",
   refresh=True,
   document={
   "title": "nobel prize"
   },
)
print(resp2)
`

Ruby

response = client.indices.create(
  index: 'test',
  body: {
   settings: {
   index: {
   number_of_shards: 1,
   analysis: {
   analyzer: {
   trigram: {
   type: 'custom',
   tokenizer: 'standard',
   filter: [
   'lowercase',
   'shingle'
   ]
   },
   reverse: {
   type: 'custom',
   tokenizer: 'standard',
   filter: [
   'lowercase',
   'reverse'
   ]
   }
   },
   filter: {
   shingle: {
   type: 'shingle',
   min_shingle_size: 2,
   max_shingle_size: 3
   }
   }
   }
   }
   },
   mappings: {
   properties: {
   title: {
   type: 'text',
   fields: {
   trigram: {
   type: 'text',
   analyzer: 'trigram'
   },
   reverse: {
   type: 'text',
   analyzer: 'reverse'
   }
   }
   }
   }
   }
  }
)
puts response
response = client.index(
  index: 'test',
  refresh: true,
  body: {
   title: 'noble warriors'
  }
)
puts response
response = client.index(
  index: 'test',
  refresh: true,
  body: {
   title: 'nobel prize'
  }
)
puts response

Js

const response = await client.indices.create({
  index: "test",
  settings: {
   index: {
   number_of_shards: 1,
   analysis: {
   analyzer: {
   trigram: {
   type: "custom",
   tokenizer: "standard",
   filter: ["lowercase", "shingle"],
   },
   reverse: {
   type: "custom",
   tokenizer: "standard",
   filter: ["lowercase", "reverse"],
   },
   },
   filter: {
   shingle: {
   type: "shingle",
   min_shingle_size: 2,
   max_shingle_size: 3,
   },
   },
   },
   },
  },
  mappings: {
   properties: {
   title: {
   type: "text",
   fields: {
   trigram: {
   type: "text",
   analyzer: "trigram",
   },
   reverse: {
   type: "text",
   analyzer: "reverse",
   },
   },
   },
   },
  },
});
console.log(response);
const response1 = await client.index({
  index: "test",
  refresh: "true",
  document: {
   title: "noble warriors",
  },
});
console.log(response1);
const response2 = await client.index({
  index: "test",
  refresh: "true",
  document: {
   title: "nobel prize",
  },
});
console.log(response2);

Console

PUT test
{
  "settings": {
   "index": {
   "number_of_shards": 1,
   "analysis": {
   "analyzer": {
   "trigram": {
   "type": "custom",
   "tokenizer": "standard",
   "filter": ["lowercase","shingle"]
   },
   "reverse": {
   "type": "custom",
   "tokenizer": "standard",
   "filter": ["lowercase","reverse"]
   }
   },
   "filter": {
   "shingle": {
   "type": "shingle",
   "min_shingle_size": 2,
   "max_shingle_size": 3
   }
   }
   }
   }
  },
  "mappings": {
   "properties": {
   "title": {
   "type": "text",
   "fields": {
   "trigram": {
   "type": "text",
   "analyzer": "trigram"
   },
   "reverse": {
   "type": "text",
   "analyzer": "reverse"
   }
   }
   }
   }
  }
}
POST test/_doc?refresh=true
{"title": "noble warriors"}
POST test/_doc?refresh=true
{"title": "nobel prize"}

アナライザーとマッピングが設定されると、phraseサジェスターをtermサジェスターを使用するのと同じ場所で使用できます。

Python

resp = client.search(
   index="test",
   suggest={
   "text": "noble prize",
   "simple_phrase": {
   "phrase": {
   "field": "title.trigram",
   "size": 1,
   "gram_size": 3,
   "direct_generator": [
   {
   "field": "title.trigram",
   "suggest_mode": "always"
   }
   ],
   "highlight": {
   "pre_tag": "<em>",
   "post_tag": "</em>"
   }
   }
   }
   },
)
print(resp)

Js

const response = await client.search({
  index: "test",
  suggest: {
   text: "noble prize",
   simple_phrase: {
   phrase: {
   field: "title.trigram",
   size: 1,
   gram_size: 3,
   direct_generator: [
   {
   field: "title.trigram",
   suggest_mode: "always",
   },
   ],
   highlight: {
   pre_tag: "<em>",
   post_tag: "</em>",
   },
   },
   },
  },
});
console.log(response);

Console

POST test/_search
{
  "suggest": {
   "text": "noble prize",
   "simple_phrase": {
   "phrase": {
   "field": "title.trigram",
   "size": 1,
   "gram_size": 3,
   "direct_generator": [ {
   "field": "title.trigram",
   "suggest_mode": "always"
   } ],
   "highlight": {
   "pre_tag": "<em>",
   "post_tag": "</em>"
   }
   }
   }
  }
}

レスポンスには、最も可能性の高いスペル修正によってスコア付けされた提案が含まれています。この場合、期待される修正「ノーベル賞」を受け取りました。

Console-Result

{
  "_shards": ...
  "hits": ...
  "timed_out": false,
  "took": 3,
  "suggest": {
   "simple_phrase" : [
   {
   "text" : "noble prize",
   "offset" : 0,
   "length" : 11,
   "options" : [ {
   "text" : "nobel prize",
   "highlighted": "<em>nobel</em> prize",
   "score" : 0.48614594
   }]
   }
   ]
  }
}

Basic Phrase suggest API parameters

| collate | 指定されたqueryに対して各提案をチェックし、インデックスに一致する文書が存在しない提案をプルーニングします。提案のコレートクエリは、提案が生成されたローカルシャードでのみ実行されます。queryは指定する必要があり、テンプレート化できます。
検索テンプレートを参照してください。現在の提案は自動的に{{suggestion}}変数として利用可能になり、クエリで使用する必要があります。独自のテンプレートparamsを指定することもできます。suggestion値は、指定した変数に追加されます。さらに、pruneを指定して、すべてのフレーズ提案が返されるかどうかを制御できます。trueに設定すると、提案には追加のオプションcollate_matchがあり、フレーズに一致する文書が見つかった場合はtrue、そうでない場合はfalseになります。

#### Python
``````python
resp = client.search(
   index="test",
   suggest={
   "text": "noble prize",
   "simple_phrase": {
   "phrase": {
   "field": "title.trigram",
   "size": 1,
   "direct_generator": [
   {
   "field": "title.trigram",
   "suggest_mode": "always",
   "min_word_length": 1
   }
   ],
   "collate": {
   "query": {
   "source": {
   "match": {
   "{{field_name}}": "{{suggestion}}"
   }
   }
   },
   "params": {
   "field_name": "title"
   },
   "prune": True
   }
   }
   }
   },
)
print(resp)
`

Js

const response = await client.search({
  index: "test",
  suggest: {
   text: "noble prize",
   simple_phrase: {
   phrase: {
   field: "title.trigram",
   size: 1,
   direct_generator: [
   {
   field: "title.trigram",
   suggest_mode: "always",
   min_word_length: 1,
   },
   ],
   collate: {
   query: {
   source: {
   match: {
   "{{field_name}}": "{{suggestion}}",
   },
   },
   },
   params: {
   field_name: "title",
   },
   prune: true,
   },
   },
   },
  },
});
console.log(response);

Console

POST test/_search
{
  "suggest": {
   "text" : "noble prize",
   "simple_phrase" : {
   "phrase" : {
   "field" :  "title.trigram",
   "size" :   1,
   "direct_generator" : [ {
   "field" :            "title.trigram",
   "suggest_mode" :     "always",
   "min_word_length" :  1
   } ],
   "collate": {
   "query": {
   "source" : {
   "match": {
   "{{field_name}}" : "{{suggestion}}"
   }
   }
   },
   "params": {"field_name" : "title"},
   "prune": true
   }
   }
   }
  }
}

Smoothing Models

|     |     |
| --- | --- |
| `````stupid_backoff````` | 高次のカウントが`````0`````の場合、低次のn-グラムモデルにバックオフし、低次のn-グラムモデルを定数因子で割引く単純なバックオフモデル。デフォルトの`````discount`````は`````0.4`````です。Stupid Backoffがデフォルトモデルです。 |
| `````laplace````` | すべてのカウントに定数（通常は`````1.0`````またはそれ以下）を追加して重みをバランスさせる加法スムージングモデル。デフォルトの`````alpha`````は`````0.5`````です。 |
| `````linear_interpolation````` | ユーザーが提供した重み（ラムダ）に基づいて、ユニグラム、バイグラム、トライグラムの加重平均を取るスムージングモデル。線形補間にはデフォルト値はありません。すべてのパラメータ（`````trigram_lambda`````、`````bigram_lambda`````、`````unigram_lambda`````）を提供する必要があります。
#### Python
``````python
resp = client.search(
   index="test",
   suggest={
   "text": "obel prize",
   "simple_phrase": {
   "phrase": {
   "field": "title.trigram",
   "size": 1,
   "smoothing": {
   "laplace": {
   "alpha": 0.7
   }
   }
   }
   }
   },
)
print(resp)
`

Js

const response = await client.search({
  index: "test",
  suggest: {
   text: "obel prize",
   simple_phrase: {
   phrase: {
   field: "title.trigram",
   size: 1,
   smoothing: {
   laplace: {
   alpha: 0.7,
   },
   },
   },
   },
  },
});
console.log(response);

Console

POST test/_search
{
  "suggest": {
   "text" : "obel prize",
   "simple_phrase" : {
   "phrase" : {
   "field" : "title.trigram",
   "size" : 1,
   "smoothing" : {
   "laplace" : {
   "alpha" : 0.7
   }
   }
   }
   }
  }
}

Candidate Generators

現在、`````direct_generator`````のみがサポートされている候補生成器のタイプです。フレーズサジェストAPIは、`````direct_generator`````キーの下に生成器のリストを受け入れます。リスト内の各生成器は、元のテキスト内の用語ごとに呼び出されます。
#### Direct Generators
直接生成器は、次のパラメータをサポートします：  
|     |     |
| --- | --- |
| `````field````` | 候補提案を取得するフィールド。これはグローバルまたは提案ごとに設定する必要がある必須オプションです。 |
| `````size````` | サジェストテキストトークンごとに返される最大修正数。 |
| `````suggest_mode````` | サジェストモードは、各シャードで生成された提案に含まれる提案を制御します。`````always`````以外のすべての値は、各シャードでテストするために少ない提案を生成するための最適化と見なすことができ、各シャードで生成された提案を組み合わせるときに再チェックされません。したがって、`````missing`````は、他のシャードがそれらを含んでいても、シャードに存在しない用語の提案を生成します。これらは`````confidence`````を使用してフィルタリングする必要があります。指定できる3つの可能な値：<br>- `````missing`````: シャードに存在しない用語の提案のみを生成します。これがデフォルトです。<br>- `````popular`````: 元の用語よりも多くの文書に出現する用語のみを提案します。<br>- `````always`````: サジェストテキスト内の用語に基づいて一致する提案を提案します。 |
| `````max_edits````` | 提案として考慮されるために候補提案が持つことができる最大編集距離。1と2の間の値のみです。他の値は不正なリクエストエラーを引き起こします。デフォルトは2です。 |
| `````prefix_length````` | 提案候補となるために一致する必要がある最小接頭辞文字数。デフォルトは1です。この数を増やすとスペルチェックのパフォーマンスが向上します。通常、誤字は用語の最初に発生しません。 |
| `````min_word_length````` | サジェストテキスト用語が含まれるために必要な最小長さ。デフォルトは4です。 |
| `````max_inspections````` | シャードレベルでより多くの候補スペル修正を検査するために`````shard_size`````と掛け算するために使用される係数。パフォーマンスのコストで精度を向上させることができます。デフォルトは5です。 |
| `````min_doc_freq````` | 提案が出現する文書の最小しきい値。この値は絶対数または文書数の相対的な割合として指定できます。これにより、高頻度の用語のみを提案することで品質が向上します。デフォルトは0fで、無効になっています。1より大きい値が指定された場合、数は小数であってはなりません。シャードレベルの文書頻度がこのオプションに使用されます。 |
| `````max_term_freq````` | 提案テキストトークンが含まれるために存在できる文書の最大しきい値。相対的な割合の数（例：0.4）または文書頻度を表す絶対数であることができます。1より大きい値が指定された場合、小数は指定できません。デフォルトは0.01fです。これは、通常正しく綴られている高頻度の用語をスペルチェックから除外するために使用できます。これにより、スペルチェックのパフォーマンスも向上します。シャードレベルの文書頻度がこのオプションに使用されます。 |
| `````pre_filter````` | この候補生成器に渡される各トークンに適用されるフィルター（アナライザー）。このフィルターは、候補が生成される前に元のトークンに適用されます。 |
| `````post_filter````` | 実際のフレーズスコアラーに渡される前に生成されたトークンに適用されるフィルター（アナライザー）。
以下の例は、2つの生成器を持つ`````phrase`````サジェスト呼び出しを示しています。最初のものは、通常のインデックス用語を含むフィールドを使用し、2番目のものは`````reverse`````フィルターを使用してインデックスされた用語を使用します（トークンは逆順にインデックスされます）。これは、直接生成器の制限を克服するために使用され、高性能の提案を提供するために定数接頭辞を必要とします。`````pre_filter`````と`````post_filter`````オプションは、通常のアナライザー名を受け入れます。
#### Python
``````python
resp = client.search(
   index="test",
   suggest={
   "text": "obel prize",
   "simple_phrase": {
   "phrase": {
   "field": "title.trigram",
   "size": 1,
   "direct_generator": [
   {
   "field": "title.trigram",
   "suggest_mode": "always"
   },
   {
   "field": "title.reverse",
   "suggest_mode": "always",
   "pre_filter": "reverse",
   "post_filter": "reverse"
   }
   ]
   }
   }
   },
)
print(resp)
`

Js

const response = await client.search({
  index: "test",
  suggest: {
   text: "obel prize",
   simple_phrase: {
   phrase: {
   field: "title.trigram",
   size: 1,
   direct_generator: [
   {
   field: "title.trigram",
   suggest_mode: "always",
   },
   {
   field: "title.reverse",
   suggest_mode: "always",
   pre_filter: "reverse",
   post_filter: "reverse",
   },
   ],
   },
   },
  },
});
console.log(response);

Console

POST test/_search
{
  "suggest": {
   "text" : "obel prize",
   "simple_phrase" : {
   "phrase" : {
   "field" : "title.trigram",
   "size" : 1,
   "direct_generator" : [ {
   "field" : "title.trigram",
   "suggest_mode" : "always"
   }, {
   "field" : "title.reverse",
   "suggest_mode" : "always",
   "pre_filter" : "reverse",
   "post_filter" : "reverse"
   } ]
   }
   }
  }
}

pre_filterとpost_filterは、候補が生成された後に同義語を注入するためにも使用できます。たとえば、クエリcaptain usqに対して、用語usqの候補usaを生成することができ、これはamericaの同義語です。これにより、このフレーズが十分に高いスコアを持っている場合、captain americaをユーザーに提示できます。

Completion Suggester

理想的には、自動補完機能は、ユーザーがすでに入力した内容に関連する即時フィードバックを提供するために、ユーザーが入力する速度と同じくらい速くあるべきです。したがって、`````completion`````サジェスターは速度の最適化が行われています。サジェスターは、高速なルックアップを可能にするデータ構造を使用しますが、構築にはコストがかかり、メモリに保存されます。
#### Mapping
[`````completion`````サジェスター](39d4e7248968ca4f.md#completion-suggester)を使用するには、提案を生成したいフィールドを`````completion`````タイプとしてマッピングします。これにより、フィールド値が高速補完のためにインデックスされます。
#### Python
``````python
resp = client.indices.create(
   index="music",
   mappings={
   "properties": {
   "suggest": {
   "type": "completion"
   }
   }
   },
)
print(resp)
`

Ruby

response = client.indices.create(
  index: 'music',
  body: {
   mappings: {
   properties: {
   suggest: {
   type: 'completion'
   }
   }
   }
  }
)
puts response

Js

const response = await client.indices.create({
  index: "music",
  mappings: {
   properties: {
   suggest: {
   type: "completion",
   },
   },
  },
});
console.log(response);

Console

PUT music
{
  "mappings": {
   "properties": {
   "suggest": {
   "type": "completion"
   }
   }
  }
}

Parameters for completion fields

|     |     |
| --- | --- |
| [`````analyzer`````](/read/elasticsearch-8-15/df0c1a6ddee71929.md "analyzer") | 使用するインデックスアナライザー。デフォルトは`````simple`````です。 |
| [`````search_analyzer`````](/read/elasticsearch-8-15/b0cfe1799c03b42e.md "search_analyzer") | 使用する検索アナライザー。デフォルトは`````analyzer`````の値です。 |
| `````preserve_separators````` | セパレーターを保持します。デフォルトは`````true`````です。無効にすると、`````foof`````の提案を行う場合、`````Foo Fighters`````で始まるフィールドを見つけることができます。 |
| `````preserve_position_increments````` | 位置のインクリメントを有効にします。デフォルトは`````true`````です。無効にすると、ストップワードアナライザーを使用している場合、`````The Beatles`````の提案を行う場合、`````b`````で始まるフィールドを取得することができます。**注意**：データを豊かにすることができる場合、`````Beatles`````と`````The Beatles`````の2つの入力をインデックスすることで、単純なアナライザーを変更する必要はありません。 |
| `````max_input_length````` | 単一の入力の長さを制限します。デフォルトは`````50````` UTF-16コードポイントです。この制限は、基礎となるデータ構造が膨張するのを防ぐために、インデックス時にのみ使用されます。ほとんどのユースケースは、デフォルト値によって影響を受けません。接頭辞補完は、通常、数文字以上の接頭辞に成長することはほとんどありません。
#### Indexing
提案は他のフィールドと同様にインデックスします。提案は、`````input`````とオプションの`````weight`````属性で構成されます。`````input`````は、提案クエリによって一致することが期待されるテキストであり、`````weight`````は提案がどのようにスコアリングされるかを決定します。提案をインデックスする方法は次のとおりです：
#### Python
``````python
resp = client.index(
   index="music",
   id="1",
   refresh=True,
   document={
   "suggest": {
   "input": [
   "Nevermind",
   "Nirvana"
   ],
   "weight": 34
   }
   },
)
print(resp)
`

Ruby

response = client.index(
  index: 'music',
  id: 1,
  refresh: true,
  body: {
   suggest: {
   input: [
   'Nevermind',
   'Nirvana'
   ],
   weight: 34
   }
  }
)
puts response

Js

const response = await client.index({
  index: "music",
  id: 1,
  refresh: "true",
  document: {
   suggest: {
   input: ["Nevermind", "Nirvana"],
   weight: 34,
   },
  },
});
console.log(response);

Console

PUT music/_doc/1?refresh
{
  "suggest" : {
   "input": [ "Nevermind", "Nirvana" ],
   "weight" : 34
  }
}

サポートされている次のパラメータ：

| weight | 正の整数または正の整数を含む文字列で、重みを定義し、提案をランク付けすることができます。このフィールドはオプションです。

ドキュメントに対して複数の提案を次のようにインデックスできます：

Python

resp = client.index(
   index="music",
   id="1",
   refresh=True,
   document={
   "suggest": [
   {
   "input": "Nevermind",
   "weight": 10
   },
   {
   "input": "Nirvana",
   "weight": 3
   }
   ]
   },
)
print(resp)

Ruby

response = client.index(
  index: 'music',
  id: 1,
  refresh: true,
  body: {
   suggest: [
   {
   input: 'Nevermind',
   weight: 10
   },
   {
   input: 'Nirvana',
   weight: 3
   }
   ]
  }
)
puts response

Js

const response = await client.index({
  index: "music",
  id: 1,
  refresh: "true",
  document: {
   suggest: [
   {
   input: "Nevermind",
   weight: 10,
   },
   {
   input: "Nirvana",
   weight: 3,
   },
   ],
  },
});
console.log(response);

Console

PUT music/_doc/1?refresh
{
  "suggest": [
   {
   "input": "Nevermind",
   "weight": 10
   },
   {
   "input": "Nirvana",
   "weight": 3
   }
  ]
}

次の省略形を使用できます。提案に重みを指定することはできません。

Python

resp = client.index(
   index="music",
   id="1",
   refresh=True,
   document={
   "suggest": [
   "Nevermind",
   "Nirvana"
   ]
   },
)
print(resp)

Ruby

response = client.index(
  index: 'music',
  id: 1,
  refresh: true,
  body: {
   suggest: [
   'Nevermind',
   'Nirvana'
   ]
  }
)
puts response

Js

const response = await client.index({
  index: "music",
  id: 1,
  refresh: "true",
  document: {
   suggest: ["Nevermind", "Nirvana"],
  },
});
console.log(response);

Console

PUT music/_doc/1?refresh
{
  "suggest" : [ "Nevermind", "Nirvana" ]
}

Querying

提案は通常通り機能しますが、サジェストタイプをcompletionとして指定する必要があります。提案はほぼリアルタイムであり、新しい提案はリフレッシュによって表示される可能性があり、一度削除された文書は決して表示されません。このリクエスト：

Python

resp = client.search(
   index="music",
   pretty=True,
   suggest={
   "song-suggest": {
   "prefix": "nir",
   "completion": {
   "field": "suggest"
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'music',
  pretty: true,
  body: {
   suggest: {
   "song-suggest": {
   prefix: 'nir',
   completion: {
   field: 'suggest'
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "music",
  pretty: "true",
  suggest: {
   "song-suggest": {
   prefix: "nir",
   completion: {
   field: "suggest",
   },
   },
  },
});
console.log(response);

Console

POST music/_search?pretty
{
  "suggest": {
   "song-suggest": {
   "prefix": "nir",
   "completion": {
   "field": "suggest"
   }
   }
  }
}