Query API を使用して検索インターフェースを作成する

Query API は、検索インターフェースを作成したり、アプリケーションに検索結果を埋め込んだりする search メソッドと suggest メソッド提供します。

最小限の要件を持つウェブ アプリケーションの場合は、検索ウィジェットの使用を検討してください。詳細については、検索ウィジェットを使用して検索インターフェースを作成するをご覧ください。

検索インターフェースを作成する

最小限の検索インターフェースを作成するには、いくつかの手順が必要です。

  1. 検索アプリケーションを構成する
  2. アプリケーションの OAuth 認証情報を生成する
  3. インデックスを照会する
  4. クエリ結果を表示する

ページング、並べ替え、フィルタリング、ファセット、自動提案などの機能を使用して、検索インターフェースをさらに強化できます。

検索アプリケーションを構成する

1 つ以上の検索アプリケーションを作成して、作成する各検索インターフェースに関連付ける必要があります。検索アプリケーションでは、使用するデータソース、並べ替え順序、フィルタ、リクエストするファセットなど、クエリのデフォルト パラメータが用意されています。必要に応じて、クエリ API を使用してこれらのパラメータをオーバーライドできます。

検索アプリケーションの詳細については、Cloud Search の検索機能をカスタマイズするをご覧ください。

アプリケーションの OAuth 認証情報を生成する

Google Cloud Search API へのアクセスを構成するの手順に加えて、ウェブ アプリケーションの OAuth 認証情報も生成する必要があります。作成する認証情報の種類は、API が使用されるコンテキストによって異なります。

認証情報を使用してユーザーの代わりに承認をリクエストします。承認をリクエストする場合は、スコープ https://www.googleapis.com/auth/cloud_search.query を使用します。

OAuth オプションとクライアント ライブラリの詳細については、[Google Identity Platform](https://developers.google.com/identity/Choose-auth{: .external target="_blank"} をご覧ください。

インデックスを照会する

search メソッドを使用して、インデックスに対する検索を実行します。

リクエストには、2 つの情報を含める必要があります。アイテムと照合するテキスト query と、使用する検索アプリケーションの ID を識別する searchApplicationId です。

次のスニペットは、映画タイタニックの映画データソースへのクエリを示しています。

{
  "query": "titanic",
  "requestOptions": {
    "searchApplicationId": "searchapplications/<search_app_id>"
  },
}

クエリ結果を表示する

検索インターフェースは少なくとも、title というアイテムと元のアイテムへのリンクを表示する必要があります。検索結果内のさらに詳しい情報(スニペットやメタデータなど)を活用すると、検索結果をさらに表示できるようになります。

補足結果の処理

デフォルトでは、Cloud Search は、ユーザーのクエリに対する十分な結果がない場合に補足結果を返します。レスポンスの queryInterpretation フィールドは、補足の結果が返されるタイミングを示します。補足結果のみが返される場合、InterpretationTypeREPLACE に設定されます。元のクエリに対するいくつかの結果が補足結果とともに返される場合、InterpretationTypeBLEND に設定されます。いずれの場合も QueryInterpretation.Reason = NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY です。

補足結果が返されたら、補足の結果が返されたことを示したテキストの提供を検討します。たとえば REPLACE の場合は、「元のクエリを検索しましたが、一致する結果はありません」という文字列が表示されます。類似のクエリの結果を表示しています。」

BLEND という文字列の場合、「元のクエリに対する検索で十分な結果が得られませんでした。類似のクエリの結果を含める。

人に関する結果を処理する

Cloud Search は、2 種類の「人物の結果」を返します。名前は、クエリで使用される名前に関連するドキュメントと、クエリで使用される名前の従業員情報です。後者の種類の結果は、Cloud Search の People Search 機能の関数です。このようなクエリの結果は、Query API レスポンスの structuredResults フィールドで確認できます。

{
  "results": [...],
  "structuredResults": [{
    "person": {...}
  }]
}

最適化の結果(最適化の結果など)をオフにする

デフォルトでは、補足結果などの最適化は有効になっています。ただし、検索アプリケーションとクエリレベルの両方で、すべての最適化を無効にしたり、補足結果のみを無効にしたりできます。

スニペットをハイライト表示する

インデックス登録されているテキストや HTML コンテンツを含むアイテムが返される場合、コンテンツのスニペットが返されます。このコンテンツは、返されたアイテムの関連性を判断するのに役立ちます。

クエリの単語がスニペットに存在する場合、単語の場所を特定する 1 つ以上の一致範囲も返されます。

結果のレンダリング時に、matchRanges を使用して、一致するテキストをハイライト表示します。次の JavaScript の例は、スニペットの各部分を <span> タグでラップして HTML マークアップに変換します。

function highlightSnippet(snippet) {
  let text = snippet.snippet;
  let formattedText = text;
  if (snippet.matchRanges) {
    let parts = [];
    let index = 0;
    for (let match of snippet.matchRanges) {
      let start = match.start || 0; // Default to 0 if omitted
      let end = match.end;
      if (index < start) { // Include any leading text before/between ranges
        parts.push(text.slice(index, start));
      }
      parts.push('<span class="highlight">');
      parts.push(text.slice(start, end));
      parts.push('</span>');
      index = end;
    }
    parts.push(text.slice(index)); // Include any trailing text after last range
    formattedText = parts.join('');
  }
  return formattedText;
}

スニペットを指定します。

{
  "snippet": "This is an example snippet...",
  "matchRanges": [
    {
      "start": 11,
      "end": 18
    }
  ]
}

結果の HTML 文字列は次のようになります。

This is an <span class="highlight">example</span> snippet...

メタデータを表示する

metadata フィールドを使用して、返された商品に関する追加情報をユーザーに表示します。metadata フィールドには、アイテムの createTimeupdateTime、アイテムに関連する返品可能な構造化データが含まれます。

構造化データを表示するには、displayOptions フィールドを使用します。displayOptions フィールドには、オブジェクト タイプの表示ラベルと metalines のセットを指定します。各メタラインは、スキーマで構成されているディスプレイ ラベルと値のペアの配列です。

追加の結果を取得する

追加の結果を取得するには、リクエストの start フィールドを目的のオフセットに設定します。各ページのサイズは pageSize フィールドで調整できます。

返されるアイテムの数を表示する、または返されるアイテムをページ分けするページング コントロールを表示するには、resultCount フィールドを使用します。結果セットのサイズに応じて、実際の値か推定値が提供されます。

検索結果を並べ替え

返されるアイテムの順序を指定するには、sortOptions フィールドを使用します。sortOptions 値は、次の 2 つのフィールドを持つオブジェクトです。

  • operatorName - 並べ替える構造化データ プロパティの演算子。 複数の演算子を持つプロパティの場合、並べ替えることができるのはメインの等価演算子だけです。
  • sortOrder - 並べ替えの方向。ASCENDING または DESCENDING のいずれかです。

関連性はセカンダリ ソートキーとしても使用されます。クエリで並べ替え順が指定されていない場合、結果は関連性のみによってランク付けされます。

"sortOptions": {
  "operatorName": "priority",
  "sortOrder": "DESCENDING"
}

フィルタを追加する

クエリ式に加えて、フィルタを適用することで、結果をさらに制限できます。フィルタは、検索アプリケーションと検索リクエストの両方で指定できます。

リクエストまたは検索アプリケーションにフィルタを追加するには、dataSourceRestrictions.filterOptions[] フィールドにフィルタを追加します。

データソースをさらにフィルタリングするには、主に 2 つの方法があります。

  • filterOptions[].objectType フィルタによるオブジェクト フィルタ - 一致するアイテムをカスタム スキーマで定義されているように、指定されたタイプに制限します。
  • 値フィルタ - クエリ演算子と指定された値に基づいて一致するアイテムを制限します。

複合フィルタを使用すると、複数の値フィルタを論理式に組み合わせてより複雑なクエリを作成できます。

ムービー スキーマの例では、現在のユーザーに基づいて年齢制限を適用し、MPAA 評価に基づいて利用可能な映画を制限できます。

{
  "query": "adventure",
  "requestOptions": {
    "searchApplicationId": "<search_app_id>"
  },
  "dataSourceRestrictions": [
    {
      "source": {
        "name": "datasources/<data_source_id>"
      },
      "filterOptions": [
        {
          "objectType": "movie",
          "filter": {
            "compositeFilter": {
              "logicOperator": "AND"
              "subFilters": [
                {
                  "compositeFilter": {
                  "logicOperator": "OR"
                  "subFilters": [
                    {
                      "valueFilter": {
                        "operatorName": "rated",
                        "value": {
                          "stringValue": "G"
                        }
                      }
                    },
                    {
                      "valueFilter": {
                        "operatorName": "rated",
                        "value": {
                          "stringValue": "PG"
                        }
                      }
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    }
  ]
}

結果をファセットで絞り込む

ファセットは、検索結果を絞り込むためのカテゴリを表すインデックス登録済みプロパティです。ファセットを使用すると、ユーザーがクエリをインタラクティブに絞り込み、関連するアイテムをすばやく見つけるのに役立ちます。

ファセットは検索アプリケーションで定義できます。クエリの設定によってオーバーライドされます。

ファセットのリクエスト時に、Cloud Search は、一致するアイテムの中でリクエストされたプロパティの頻度が高い値を計算します。これらの値はレスポンスで返されます。これらの値を使用して、後続のクエリで結果を絞り込むフィルタを作成します。

ファセットの一般的な操作パターンは、次のとおりです。

  1. ファセット結果に含めるプロパティを指定する初期クエリを作成します。
  2. 検索とファセットの結果をレンダリングします。
  3. ユーザーは、結果を絞り込む 1 つ以上のファセット値を選択します。
  4. 選択された値に基づいてフィルタを使用してクエリを繰り返します。

たとえば、年と MPAA レーティングによる映画クエリの絞り込みを有効にするには、クエリに facetOptions プロパティを含めます。

"facetOptions": [
  {
    "sourceName": "datasources/<data_source_id>",
    "operatorName": "year"
  },
  {
    "sourceName": "datasources/<data_source_id>",
    "operatorName": "rated"
  }
]

整数ベースのフィールドを使用したファセットの結果

整数ベースのフィールドを使用して、リクエスト結果をファセットすることもできます。たとえば、「book_pages」という整数プロパティを「facetable」としてマークすると、「100 ~ 200」ページからなる書籍の検索結果が絞り込まれます。

整数のプロパティ フィールド スキーマを設定するときに、isFacetabletrue に設定し、対応するバケット化オプションを integerPropertyOptions に追加します。これにより、すべての整数ファセット プロパティでデフォルトのバケット化オプションが定義されます。

バケット オプション ロジックを定義する場合は、範囲を示す増分値の配列を指定します。たとえば、エンドユーザーが範囲を 2, 5, 10, 100 として指定した場合、<2[2-5)[5-10)[10-100)>=100 のファセットが計算されます。

整数ベースのファセットをオーバーライドするには、リクエストで facetOptions に対して同じバケット化オプションを定義します。必要に応じて、検索アプリケーションとクエリ リクエストにファセット オプションが定義されていない場合、Cloud Search はスキーマで定義されたバケット オプションを使用します。クエリで定義されたファセットは、検索アプリケーションで定義されたファセットよりも優先されます。また、検索アプリケーションで定義されたファセットは、スキーマで定義されたファセットよりも優先されます。

ドキュメントのサイズまたは日付で結果をファセット

予約済みの演算子を使用して、ドキュメントのファイルサイズ(バイト単位)、またはドキュメントの作成日時または変更日時で検索結果を絞り込むことができます。カスタム スキーマを定義する必要はありませんが、検索アプリケーションの FacetOptionsoperatorName 値を指定する必要があります。

  • ドキュメント サイズによるファセットの場合は、itemsize を使用してバケット化オプションを定義します。
  • ドキュメント作成日によるファセットの場合は、createddatetimestamp を使用します。
  • ドキュメントの更新日によるファセットの場合は、lastmodified を使用します。

ファセット バケットの解釈

検索クエリ レスポンスの facetResults プロパティには、各 bucketfilter フィールドにユーザーの正確なフィルタ リクエストが含まれています。

整数に基づかないファセットの場合、facetResults にはリクエストされた各プロパティのエントリが含まれます。プロパティごとに、buckets という値または範囲のリストが提供されます。頻度の高い値が先に表示されます。

ユーザーがフィルタリングする値を 1 つ以上選択すると、選択したフィルタで新しいクエリが作成され、API に再度クエリが実行されます。

候補を追加する

suggest API を使用して、ユーザーの個人的なクエリ履歴およびコンタクトとそのドキュメント コーパスに基づいてクエリの自動補完を提供します。

たとえば、次の呼び出しでは、部分的な語句 jo の候補が示されます。

{
  "query": "jo",
  "requestOptions": {
    "searchApplicationId": "<search_app_id>",
    "peoplePhotoOptions": {
      "peoplePhotoUrlSizeInPx": 32
    },
    "timeZone": "America/Denver"
  }
}

結果として得られた候補をアプリケーションに合わせて表示できます。