バケット集約 - マルチターム（Multi Terms） - 《Elasticsearchガイドv8.15》日本語

マルチターム集約
欠損値

マルチターム集約

ユニークな値のセットごとにバケットが動的に構築されるマルチバケット値ソースに基づく集約です。マルチターム集約は、terms aggregationに非常に似ていますが、ほとんどの場合、ターム集約よりも遅く、より多くのメモリを消費します。したがって、同じフィールドセットが常に使用される場合は、これらのフィールドの結合キーを別のフィールドとしてインデックス化し、このフィールドに対してターム集約を使用する方が効率的です。

マルチターム集約は、ドキュメント数や複合キーに対するメトリック集約でソートし、上位N件の結果を取得する必要がある場合に最も便利です。ソートが必要ない場合、すべての値がネストされたターム集約を使用して取得されることが期待される場合、composite aggregationsはより迅速でメモリ効率の良い解決策となります。

例:

Python

resp = client.search(
   index="products",
   aggs={
   "genres_and_products": {
   "multi_terms": {
   "terms": [
   {
   "field": "genre"
   },
   {
   "field": "product"
   }
   ]
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'products',
  body: {
   aggregations: {
   genres_and_products: {
   multi_terms: {
   terms: [
   {
   field: 'genre'
   },
   {
   field: 'product'
   }
   ]
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "products",
  aggs: {
   genres_and_products: {
   multi_terms: {
   terms: [
   {
   field: "genre",
   },
   {
   field: "product",
   },
   ],
   },
   },
  },
});
console.log(response);

コンソール

GET /products/_search
{
  "aggs": {
   "genres_and_products": {
   "multi_terms": {
   "terms": [{
   "field": "genre"
   }, {
   "field": "product"
   }]
   }
   }
  }
}


	`multi_terms`集約は、同じフィールドタイプで動作することができ、 `terms aggregation`のほとんどのターム集約パラメータをサポートします。

レスポンス:

コンソール-結果

{
  ...
  "aggregations" : {
   "genres_and_products" : {
   "doc_count_error_upper_bound" : 0,
   "sum_other_doc_count" : 0,
   "buckets" : [
   {
   "key" : [
   "rock",
   "Product A"
   ],
   "key_as_string" : "rock|Product A",<br>   "doc_count" : 2<br>   },<br>   {<br>   "key" : [<br>   "electronic",<br>   "Product B"<br>   ],<br>   "key_as_string" : "electronic|Product B",<br>   "doc_count" : 1<br>   },<br>   {<br>   "key" : [<br>   "jazz",<br>   "Product B"<br>   ],<br>   "key_as_string" : "jazz|Product B",<br>   "doc_count" : 1<br>   },<br>   {<br>   "key" : [<br>   "rock",<br>   "Product B"<br>   ],<br>   "key_as_string" : "rock|Product B",<br>   "doc_count" : 1<br>   }<br>   ]<br>   }<br>  }<br>}<br>``````<br><br>
|     |     |
| --- | --- |
|  | 各タームのドキュメントカウントに対する誤差の上限、詳細は <br><<search-aggregations-bucket-multi-terms-aggregation-approximate-counts,below>> |
|  | ユニークなタームが多数ある場合、Elasticsearchは上位のタームのみを返します。この数は、レスポンスの一部でないすべてのバケットのドキュメントカウントの合計です |
|  | 上位バケットのリスト。 |
|  | キーは、集約の`````terms`````パラメータの式と同じ順序で並べられた値の配列です |
デフォルトでは、`````multi_terms`````集約は、`````doc_count`````で順序付けられた上位10タームのバケットを返します。このデフォルトの動作は、`````size`````パラメータを設定することで変更できます。
## 集約パラメータ
以下のパラメータがサポートされています。これらのパラメータの詳細な説明については、[`````terms aggregation`````](aa21c04ecd5a1ccc.md#search-aggregations-bucket-terms-aggregation-order)を参照してください。
|     |     |
| --- | --- |
| size | オプション。全体のタームリストから返されるタームバケットの数を定義します。デフォルトは10です。 |
| shard\_size | オプション。要求された`````size`````が高いほど、結果はより正確になりますが、最終結果を計算するのにより高価になります。デフォルトの`````shard_size`````は`````(size * 1.5 + 10)`````です。 |
| show\_term\_doc\_count\_error | オプション。各タームに基づいてドキュメントカウントの誤差を計算します。デフォルトは`````false`````です。 |
| order | オプション。バケットの順序を指定します。デフォルトはバケットごとのドキュメント数です。バケットタームの値は、同じドキュメントカウントのバケットのためのタイブレイカーとして使用されます。 |
| min\_doc\_count | オプション。バケットに返されるための最小ドキュメント数です。デフォルトは1です。 |
| shard\_min\_doc\_count | オプション。各シャードのバケットに返されるための最小ドキュメント数です。デフォルトは`````min_doc_count`````です。 |
| collect\_mode | オプション。データ収集の戦略を指定します。`````depth_first`````または`````breadth_first`````モードがサポートされています。デフォルトは`````breadth_first`````です。|
## スクリプト
スクリプトを使用してタームを生成する:
#### Python
``````python
resp = client.search(
   index="products",
   runtime_mappings={
   "genre.length": {
   "type": "long",
   "script": "emit(doc['genre'].value.length())"
   }
   },
   aggs={
   "genres_and_products": {
   "multi_terms": {
   "terms": [
   {
   "field": "genre.length"
   },
   {
   "field": "product"
   }
   ]
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'products',
  body: {
   runtime_mappings: {
   'genre.length' => {
   type: 'long',
   script: "emit(doc['genre'].value.length())"
   }
   },
   aggregations: {
   genres_and_products: {
   multi_terms: {
   terms: [
   {
   field: 'genre.length'
   },
   {
   field: 'product'
   }
   ]
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "products",
  runtime_mappings: {
   "genre.length": {
   type: "long",
   script: "emit(doc['genre'].value.length())",
   },
  },
  aggs: {
   genres_and_products: {
   multi_terms: {
   terms: [
   {
   field: "genre.length",
   },
   {
   field: "product",
   },
   ],
   },
   },
  },
});
console.log(response);

コンソール

GET /products/_search
{
  "runtime_mappings": {
   "genre.length": {
   "type": "long",
   "script": "emit(doc['genre'].value.length())"
   }
  },
  "aggs": {
   "genres_and_products": {
   "multi_terms": {
   "terms": [
   {
   "field": "genre.length"
   },
   {
   "field": "product"
   }
   ]
   }
   }
  }
}

レスポンス:

コンソール-結果

{
  ...
  "aggregations" : {
   "genres_and_products" : {
   "doc_count_error_upper_bound" : 0,
   "sum_other_doc_count" : 0,
   "buckets" : [
   {
   "key" : [
   4,
   "Product A"
   ],
   "key_as_string" : "4|Product A",
   "doc_count" : 2
   },
   {
   "key" : [
   4,
   "Product B"
   ],
   "key_as_string" : "4|Product B",
   "doc_count" : 2
   },
   {
   "key" : [
   10,
   "Product B"
   ],
   "key_as_string" : "10|Product B",
   "doc_count" : 1
   }
   ]
   }
  }
}

欠損値


#### Python
``````python
resp = client.search(
   index="products",
   aggs={
   "genres_and_products": {
   "multi_terms": {
   "terms": [
   {
   "field": "genre"
   },
   {
   "field": "product",
   "missing": "Product Z"
   }
   ]
   }
   }
   },
)
print(resp)
`

Ruby

response = client.search(
  index: 'products',
  body: {
   aggregations: {
   genres_and_products: {
   multi_terms: {
   terms: [
   {
   field: 'genre'
   },
   {
   field: 'product',
   missing: 'Product Z'
   }
   ]
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "products",
  aggs: {
   genres_and_products: {
   multi_terms: {
   terms: [
   {
   field: "genre",
   },
   {
   field: "product",
   missing: "Product Z",
   },
   ],
   },
   },
  },
});
console.log(response);

コンソール

GET /products/_search
{
  "aggs": {
   "genres_and_products": {
   "multi_terms": {
   "terms": [
   {
   "field": "genre"
   },
   {
   "field": "product",
   "missing": "Product Z"
   }
   ]
   }
   }
  }
}

レスポンス:

コンソール-結果

{
   ...
   "aggregations" : {
   "genres_and_products" : {
   "doc_count_error_upper_bound" : 0,
   "sum_other_doc_count" : 0,
   "buckets" : [
   {
   "key" : [
   "rock",
   "Product A"
   ],
   "key_as_string" : "rock|Product A",<br>   "doc_count" : 2<br>   },<br>   {<br>   "key" : [<br>   "electronic",<br>   "Product B"<br>   ],<br>   "key_as_string" : "electronic|Product B",<br>   "doc_count" : 1<br>   },<br>   {<br>   "key" : [<br>   "electronic",<br>   "Product Z"<br>   ],<br>   "key_as_string" : "electronic|Product Z",<br>   "doc_count" : 1<br>   },<br>   {<br>   "key" : [<br>   "jazz",<br>   "Product B"<br>   ],<br>   "key_as_string" : "jazz|Product B",<br>   "doc_count" : 1<br>   },<br>   {<br>   "key" : [<br>   "rock",<br>   "Product B"<br>   ],<br>   "key_as_string" : "rock|Product B",<br>   "doc_count" : 1<br>   }<br>   ]<br>   }<br>  }<br>}<br>``````<br><br>
|     |     |
| --- | --- |
|  | `````product`````フィールドに値がないドキュメントは、値が`````Product Z`````であるドキュメントと同じバケットに入ります。 |
## フィールドタイプの混合
複数のインデックスで集約する際、集約フィールドのタイプはすべてのインデックスで同じでない場合があります。一部のタイプは互換性があります（`````integer`````と`````long`````または`````float`````と`````double`````）が、デシマルと非デシマルの数の混合の場合、ターム集約は非デシマルの数をデシマルの数に昇格させます。これにより、バケット値の精度が失われる可能性があります。
## サブ集約とソートの例
ほとんどのバケット集約と同様に、`````multi_term`````はサブ集約をサポートし、メトリックサブ集約によってバケットを順序付けます:
#### Python
``````python
resp = client.search(
   index="products",
   aggs={
   "genres_and_products": {
   "multi_terms": {
   "terms": [
   {
   "field": "genre"
   },
   {
   "field": "product"
   }
   ],
   "order": {
   "total_quantity": "desc"
   }
   },
   "aggs": {
   "total_quantity": {
   "sum": {
   "field": "quantity"
   }
   }
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'products',
  body: {
   aggregations: {
   genres_and_products: {
   multi_terms: {
   terms: [
   {
   field: 'genre'
   },
   {
   field: 'product'
   }
   ],
   order: {
   total_quantity: 'desc'
   }
   },
   aggregations: {
   total_quantity: {
   sum: {
   field: 'quantity'
   }
   }
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "products",
  aggs: {
   genres_and_products: {
   multi_terms: {
   terms: [
   {
   field: "genre",
   },
   {
   field: "product",
   },
   ],
   order: {
   total_quantity: "desc",
   },
   },
   aggs: {
   total_quantity: {
   sum: {
   field: "quantity",
   },
   },
   },
   },
  },
});
console.log(response);

コンソール

GET /products/_search
{
  "aggs": {
   "genres_and_products": {
   "multi_terms": {
   "terms": [
   {
   "field": "genre"
   },
   {
   "field": "product"
   }
   ],
   "order": {
   "total_quantity": "desc"
   }
   },
   "aggs": {
   "total_quantity": {
   "sum": {
   "field": "quantity"
   }
   }
   }
   }
  }
}

コンソール-結果

{
  ...
  "aggregations" : {
   "genres_and_products" : {
   "doc_count_error_upper_bound" : 0,
   "sum_other_doc_count" : 0,
   "buckets" : [
   {
   "key" : [
   "jazz",
   "Product B"
   ],
   "key_as_string" : "jazz|Product B",
   "doc_count" : 1,
   "total_quantity" : {
   "value" : 10.0
   }
   },
   {
   "key" : [
   "rock",
   "Product A"
   ],
   "key_as_string" : "rock|Product A",
   "doc_count" : 2,
   "total_quantity" : {
   "value" : 9.0
   }
   },
   {
   "key" : [
   "electronic",
   "Product B"
   ],
   "key_as_string" : "electronic|Product B",
   "doc_count" : 1,
   "total_quantity" : {
   "value" : 3.0
   }
   },
   {
   "key" : [
   "rock",
   "Product B"
   ],
   "key_as_string" : "rock|Product B",
   "doc_count" : 1,
   "total_quantity" : {
   "value" : 1.0
   }
   }
   ]
   }
  }
}