検索アプリケーション検索（Search Application Search）

検索アプリケーション検索

この機能はベータ版であり、変更される可能性があります。デザインとコードは公式GA機能よりも成熟しておらず、保証なしでそのまま提供されています。ベータ機能は公式GA機能のサポートSLAの対象外です。

指定されたクエリパラメータに基づいて、検索アプリケーションに関連付けられた検索テンプレートを使用してElasticsearchクエリを生成および実行します。指定されていないテンプレートパラメータにはデフォルト値が割り当てられます（該当する場合）。

リクエスト

POST _application/search_application/<name>/_search

前提条件

検索アプリケーションのバックエイリアスに対する読み取り権限が必要です。

パスパラメータ

• typed_keys
• （オプション、ブール値）trueの場合、集約およびサジェスター名はレスポンス内でそれぞれのタイプによってプレフィックスされます。デフォルトはfalseです。

リクエストボディ

• params
• （オプション、文字列からオブジェクトへのマップ）検索アプリケーションに関連付けられた検索テンプレートからElasticsearchクエリを生成するために使用されるクエリパラメータ。検索テンプレートで使用されるパラメータがparamsで指定されていない場合、そのパラメータのデフォルト値が使用されます。

検索アプリケーションは、検索テンプレートパラメータを検証するように構成できます。詳細については、検索アプリケーションを更新するAPIのdictionaryパラメータを参照してください。

レスポンスコード

• 400
• 検索テンプレートに無効なパラメータが渡されました。例には以下が含まれます：
  • 必須パラメータが欠落している
  • 無効なパラメータデータ型
  • 無効なパラメータ値
• 404
• 検索アプリケーション<name>は存在しません。

例

以下の例は、テキスト検索の例からの検索テンプレートを使用して、my-appという検索アプリケーションに対して検索を実行します：

Python

resp = client.search_application.search(
   name="my-app",
   params={
   "query_string": "my first query",
   "text_fields": [
   {
   "name": "title",
   "boost": 5
   },
   {
   "name": "description",
   "boost": 1
   }
   ]
   },
)
print(resp)

Js

const response = await client.searchApplication.search({
  name: "my-app",
  params: {
   query_string: "my first query",
   text_fields: [
   {
   name: "title",
   boost: 5,
   },
   {
   name: "description",
   boost: 1,
   },
   ],
  },
});
console.log(response);

コンソール

POST _application/search_application/my-app/_search
{
  "params": {
   "query_string": "my first query",
   "text_fields": [
   {"name": "title", "boost": 5},
   {"name": "description", "boost": 1}
   ]
  }
}

生成されたElasticsearchクエリは次のようになります：

コンソール-結果

{
  "from": 0,
  "size": 10,
  "query": {
   "multi_match": {
   "query": "my first query",
   "fields": [
   "description^1.0",
   "title^5.0"
   ]
   }
  },
  "explain": false
}

この場合、from、size、およびexplainパラメータはリクエストで指定されていないため、検索テンプレートで指定されたデフォルト値が使用されます。

期待されるレスポンスは、生成されて実行されたElasticsearchクエリからの検索結果です。レスポンス形式は、Elasticsearch Search APIで使用される形式と同じです：

コンソール-結果

{
  "took": 5,
  "timed_out": false,
  "_shards": {
   "total": 1,
   "successful": 1,
   "skipped": 0,
   "failed": 0
  },
  "hits": {
   "total": {
   "value": 1,
   "relation": "eq"
   },
   "max_score": 0.8630463,
   "hits": ...
  }
}