用語レベルのクエリ - 用語（Terms） - 《Elasticsearchガイドv8.15》日本語

用語クエリ
用語のトップレベルパラメータ
ノート
- 用語クエリのハイライト
- 用語ルックアップ

用語クエリ

指定されたフィールドに1つ以上の正確な用語を含むドキュメントを返します。


## 例リクエスト
次の検索は、`````user.id`````フィールドに`````kimchy`````または`````elkbee`````を含むドキュメントを返します。
#### Python
``````python
resp = client.search(
   query={
   "terms": {
   "user.id": [
   "kimchy",
   "elkbee"
   ],
   "boost": 1
   }
   },
)
print(resp)
`

Ruby

response = client.search(
  body: {
   query: {
   terms: {
   'user.id' => [
   'kimchy',
   'elkbee'
   ],
   boost: 1
   }
   }
  }
)
puts response

Js

const response = await client.search({
  query: {
   terms: {
   "user.id": ["kimchy", "elkbee"],
   boost: 1,
   },
  },
});
console.log(response);

コンソール

GET /_search
{
  "query": {
   "terms": {
   "user.id": [ "kimchy", "elkbee" ],
   "boost": 1.0
   }
  }
}

用語のトップレベルパラメータ

<field>
(オプション、オブジェクト) 検索したいフィールド。
このパラメータの値は、指定されたフィールドで見つけたい用語の配列です。ドキュメントを返すには、1つ以上の用語がフィールド値と正確に一致する必要があります。空白や大文字小文字も含まれます。
デフォルトでは、Elasticsearchはtermsクエリを最大65,536用語に制限します。この制限は、index.max_terms_count設定を使用して変更できます。
既存のドキュメントのフィールド値を検索用語として使用するには、boostパラメータを使用します。
boost
(オプション、浮動小数点数) クエリの関連スコアを減少または増加させるために使用される浮動小数点数。デフォルトは1.0です。
boostパラメータを使用して、2つ以上のクエリを含む検索の関連スコアを調整できます。
ブースト値は1.0のデフォルト値に対して相対的です。0と1.0の間のブースト値は関連スコアを減少させます。1.0より大きい値は関連スコアを増加させます。

ノート

用語クエリのハイライト

ハイライトは最善の努力のみです。Elasticsearchは、次の理由によりtermsクエリのハイライト結果を返さない場合があります：

ハイライターの種類
クエリ内の用語の数

用語ルックアップ

用語ルックアップは、既存のドキュメントのフィールド値を取得します。Elasticsearchは、その値を検索用語として使用します。これは、大量の用語を検索する際に役立ちます。

用語ルックアップを実行するには、フィールドの_sourceを有効にする必要があります。リモートインデックスで用語ルックアップを実行するためにクロスクラスタ検索を使用することはできません。

デフォルトでは、Elasticsearchはtermsクエリを最大65,536用語に制限します。これには、用語ルックアップを使用して取得された用語が含まれます。この制限は、index.max_terms_count設定を使用して変更できます。

ネットワークトラフィックを減少させるために、用語ルックアップは可能であればローカルデータノードのシャードからドキュメントの値を取得します。用語データが大きくない場合は、ネットワークトラフィックを最小限に抑えるために、すべての適用可能なデータノードに完全に複製された単一のプライマリシャードを持つインデックスを使用することを検討してください。

用語ルックアップを実行するには、次のパラメータを使用します。

用語ルックアップパラメータ

index
(必須、文字列) フィールド値を取得するインデックスの名前。
id
(必須、文字列) フィールド値を取得するドキュメントのID。
path
(必須、文字列) フィールド値を取得するフィールドの名前。Elasticsearchはこれらの値をクエリの検索用語として使用します。
フィールド値にネストされた内部オブジェクトの配列が含まれている場合、ドット表記法を使用してそれらのオブジェクトにアクセスできます。
routing
(オプション、文字列) 用語値を取得するドキュメントのカスタムルーティング値。ドキュメントがインデックスされたときにカスタムルーティング値が提供された場合、このパラメータは必須です。

用語ルックアップの例

用語ルックアップがどのように機能するかを確認するには、次の例を試してください。

1. keywordフィールド名のcolorを持つインデックスを作成します。

Python

resp = client.indices.create(
   index="my-index-000001",
   mappings={
   "properties": {
   "color": {
   "type": "keyword"
   }
   }
   },
  )
  print(resp)

Ruby

response = client.indices.create(
   index: 'my-index-000001',
   body: {
   mappings: {
   properties: {
   color: {
   type: 'keyword'
   }
   }
   }
   }
  )
  puts response

Go

res, err := es.Indices.Create(
      "my-index-000001",
      es.Indices.Create.WithBody(strings.NewReader(`{
      "mappings": {
      "properties": {
      "color": {
      "type": "keyword"
      }
      }
      }
      }`)),
  )
  fmt.Println(res, err)

Js

const response = await client.indices.create({
   index: "my-index-000001",
   mappings: {
   properties: {
   color: {
   type: "keyword",
   },
   },
   },
  });
  console.log(response);

コンソール

PUT my-index-000001
  {
   "mappings": {
   "properties": {
   "color": { "type": "keyword" }
   }
   }
  }

2. IDが1で["blue", "green"]の値をcolorフィールドに持つドキュメントをインデックスします。

Python

resp = client.index(
   index="my-index-000001",
   id="1",
   document={
   "color": [
   "blue",
   "green"
   ]
   },
  )
  print(resp)

Ruby

response = client.index(
   index: 'my-index-000001',
   id: 1,
   body: {
   color: [
   'blue',
   'green'
   ]
   }
  )
  puts response

Go

res, err := es.Index(
      "my-index-000001",
      strings.NewReader(`{
      "color": [
      "blue",
      "green"
      ]
      }`),
      es.Index.WithDocumentID("1"),
      es.Index.WithPretty(),
  )
  fmt.Println(res, err)

Js

const response = await client.index({
   index: "my-index-000001",
   id: 1,
   document: {
   color: ["blue", "green"],
   },
  });
  console.log(response);

コンソール

PUT my-index-000001/_doc/1
  {
   "color":   ["blue", "green"]
  }

3. IDが2でblueの値をcolorフィールドに持つ別のドキュメントをインデックスします。

Python

resp = client.index(
   index="my-index-000001",
   id="2",
   document={
   "color": "blue"
   },
  )
  print(resp)

Ruby

response = client.index(
   index: 'my-index-000001',
   id: 2,
   body: {
   color: 'blue'
   }
  )
  puts response

Go

res, err := es.Index(
      "my-index-000001",
      strings.NewReader(`{
      "color": "blue"
      }`),
      es.Index.WithDocumentID("2"),
      es.Index.WithPretty(),
  )
  fmt.Println(res, err)

Js

const response = await client.index({
   index: "my-index-000001",
   id: 2,
   document: {
   color: "blue",
   },
  });
  console.log(response);

コンソール

PUT my-index-000001/_doc/2
  {
   "color":   "blue"
  }

4. termsクエリを用語ルックアップパラメータと共に使用して、ドキュメント2と同じ用語の1つ以上を含むドキュメントを見つけます。応答がより読みやすくなるようにprettyパラメータを含めます。

Python

resp = client.search(
   index="my-index-000001",
   pretty=True,
   query={
   "terms": {
   "color": {
   "index": "my-index-000001",
   "id": "2",
   "path": "color"
   }
   }
   },
  )
  print(resp)

Ruby

response = client.search(
   index: 'my-index-000001',
   pretty: true,
   body: {
   query: {
   terms: {
   color: {
   index: 'my-index-000001',
   id: '2',
   path: 'color'
   }
   }
   }
   }
  )
  puts response

Go

res, err := es.Search(
      es.Search.WithIndex("my-index-000001"),
      es.Search.WithBody(strings.NewReader(`{
      "query": {
      "terms": {
      "color": {
      "index": "my-index-000001",
      "id": "2",
      "path": "color"
      }
      }
      }
      }`)),
      es.Search.WithPretty(),
  )
  fmt.Println(res, err)

Js

const response = await client.search({
   index: "my-index-000001",
   pretty: "true",
   query: {
   terms: {
   color: {
   index: "my-index-000001",
   id: "2",
   path: "color",
   },
   },
   },
  });
  console.log(response);

コンソール

GET my-index-000001/_search?pretty
  {
   "query": {
   "terms": {
   "color" : {
   "index" : "my-index-000001",
   "id" : "2",
   "path" : "color"
   }
   }
   }
  }

ドキュメント2とドキュメント1の両方がblueをcolorフィールドの値として含んでいるため、Elasticsearchは両方のドキュメントを返します。

コンソール-結果

{
   "took" : 17,
   "timed_out" : false,
   "_shards" : {
   "total" : 1,
   "successful" : 1,
   "skipped" : 0,
   "failed" : 0
   },
   "hits" : {
   "total" : {
   "value" : 2,
   "relation" : "eq"
   },
   "max_score" : 1.0,
   "hits" : [
   {
   "_index" : "my-index-000001",
   "_id" : "1",
   "_score" : 1.0,
   "_source" : {
   "color" : [
   "blue",
   "green"
   ]
   }
   },
   {
   "_index" : "my-index-000001",
   "_id" : "2",
   "_score" : 1.0,
   "_source" : {
   "color" : "blue"
   }
   }
   ]
   }
  }