ピン留めクエリ（Pinned Query）

ピン留めされたクエリ

選択されたドキュメントを、特定のクエリに一致するものよりも高いランクに昇格させます。この機能は、検索者をキュレーションされたドキュメントに誘導するために通常使用され、検索の「オーガニック」な一致よりも優先されます。昇格または「ピン留め」されたドキュメントは、_id フィールドに保存されたドキュメントIDを使用して特定されます。

リクエストの例

Python

resp = client.search(
   query={
   "pinned": {
   "ids": [
   "1",
   "4",
   "100"
   ],
   "organic": {
   "match": {
   "description": "iphone"
   }
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  body: {
   query: {
   pinned: {
   ids: [
   '1',
   '4',
   '100'
   ],
   organic: {
   match: {
   description: 'iphone'
   }
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  query: {
   pinned: {
   ids: ["1", "4", "100"],
   organic: {
   match: {
   description: "iphone",
   },
   },
   },
  },
});
console.log(response);

コンソール

GET /_search
{
  "query": {
   "pinned": {
   "ids": [ "1", "4", "100" ],
   "organic": {
   "match": {
   "description": "iphone"
   }
   }
   }
  }
}

ピン留めされたためのトップレベルパラメータ

• ids
• （オプション、配列）結果に表示される順序でリストされたドキュメントID。docsが指定されていない場合は必須です。
• docs
• （オプション、配列）結果に表示される順序でリストされたドキュメント。idsが指定されていない場合は必須です。各ドキュメントに対して次の属性を指定できます：
  • _id
  • （必須、文字列）ユニークなドキュメントID。
  • _index
  • （オプション、文字列）ドキュメントを含むインデックス。
• organic
• 「ピン留め」されたドキュメントの下にランク付けされるドキュメントをランク付けするために使用される任意のクエリ。

特定のインデックス内のドキュメントをピン留めする

複数のインデックスを検索している場合、docsを使用して特定のインデックス内のドキュメントをピン留めできます。

Python

resp = client.search(
   query={
   "pinned": {
   "docs": [
   {
   "_index": "my-index-000001",
   "_id": "1"
   },
   {
   "_id": "4"
   }
   ],
   "organic": {
   "match": {
   "description": "iphone"
   }
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  body: {
   query: {
   pinned: {
   docs: [
   {
   _index: 'my-index-000001',
   _id: '1'
   },
   {
   _id: '4'
   }
   ],
   organic: {
   match: {
   description: 'iphone'
   }
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  query: {
   pinned: {
   docs: [
   {
   _index: "my-index-000001",
   _id: "1",
   },
   {
   _id: "4",
   },
   ],
   organic: {
   match: {
   description: "iphone",
   },
   },
   },
  },
});
console.log(response);

コンソール

GET /_search
{
  "query": {
   "pinned": {
   "docs": [
   {
   "_index": "my-index-000001",
   "_id": "1"
   },
   {
   "_id": "4"
   }
   ],
   "organic": {
   "match": {
   "description": "iphone"
   }
   }
   }
  }
}