候補 - Amazon Location Service
ユースケースリクエストを理解するレスポンスを理解する

候補

Suggest は、関連する場所、対象となるポイント、クエリ用語、検索カテゴリなど、ユーザーの入力またはコンテキストに基づいて予測またはレコメンデーションを提供します。これにより、ユーザーは場所、対象となるポイントを検索したり、不完全な入力またはスペルミスの入力に基づいてフォローアップクエリを特定したりできます。API は可能性のある一致または絞り込みのリストを返します。このリストを使用して、より正確なクエリを作成できます。ユーザーは、さらに検索するために適切な提案を選択できます。API は、場所やその他の属性による結果のフィルタリングをサポートし、音素やタイムゾーンなどの追加機能を提供します。レスポンスには、絞り込まれたクエリ用語と詳細な場所情報が含まれます。

注記

デフォルトでは、Suggest API は ID フィールドと Title フィールドのみを返します。これにより、コスト効率の高いオプションが提供されます。追加のアドレスコンポーネントとハイライトは、additionalFeatures を Core に設定してリクエストできます。保存された結果に関連するコストへの影響については、「場所の料金」を参照してください。

詳細については、「Amazon Location Service API リファレンス」の「Suggest」を参照してください。

この API のリクエスト、レスポンス、cURL、CLI コマンドの例については、「Suggest の使用方法」を参照してください。

ユースケース

  • 配車サービス: 乗車場所と降車場所の住所をすばやく完了するためのリアルタイムの提案を提供し、正確性と乗車予約の迅速化を実現します。

  • 旅行とナビゲーションサービス: 「Eiffel Tower」の「Eifel」など、スペルミスや部分的に入力された用語であっても、場所やランドマークをリアルタイムで予測できます。API は提案を絞り込み、関連する近隣の対象となるポイントを提供し、ユーザーが場所を正確に見つけられるようにします。

  • レストランの検索支援: レストランへのユーザーの関心を予測し、近くのレストランオプションを提案して、検索エクスペリエンスを強化します。

リクエストを理解する

Suggest API リクエストは、パラメータを使用し、ユーザー入力に基づいて提案を生成します。オプションのパラメータを使用すると、位置バイアスとフィルタリング条件を使用して検索結果を絞り込むことができます。詳細については、「Suggest API リファレンス」を参照してください。

このリクエストには次のキーパラメータが含まれます。

認証

他の認証方法を使用する場合、Key パラメータはオプションです。

  • Key: 認証用の API キー。

詳細については、Amazon Location Service を使用して認証するを参照してください。

クエリ

フリーテキスト検索とロケーションバイアスを定義します。

  • QueryText: 提案を生成するための自由形式のテキスト (必須)

  • BiasPosition: 特定の経度と緯度に近い提案を優先します。

詳細については、クエリとバイアスを参照してください。

結果の絞り込み

結果をフィルタリングして検索条件を絞り込みます。

  • Filter: 境界ボックスまたは円形の領域によるフィルタリングを許可して、検索結果を制限します。

詳細については、「フィルタリング」を参照してください。

国際化とローカリゼーション

言語をカスタマイズし、結果にポリティカルビューを適用するためのオプション。

  • Language: 結果の言語を指定します。

  • PoliticalView: 領土主張を反映したポリティカルビューを適用します。

詳細については、ローカリゼーションと国際化を参照してください。

その他の機能

タイムゾーン情報などの追加データをリクエストします。

  • AdditionalFeatures: タイムゾーンや表音データなどの追加の詳細をリクエストするオプション。

詳細については、その他の機能を参照してください。

結果の限定

返される結果またはクエリ絞り込みの数に制限を設定します。

  • MaxQueryRefinements: 返されるクエリ絞り込み条件の数を制限します。

  • MaxResults: 返される候補の数を制限します。

レスポンスを理解する

レスポンスは、場所、住所の詳細、ビジネスチェーン、連絡先、電話、タイムゾーン、営業時間などの属性を使用して、入力クエリに基づいて提案された住所または場所を提供します。API は、入力クエリを完了するための一致候補を表す ResultItems を返します。SuggestResultItemType によって識別される結果には 2 つのタイプがあります。タイプ Query の結果はフォローアップカテゴリまたはチェーンクエリを示唆し、QueryID を SearchText API に渡すことによって、指定されたカテゴリの焦点を絞った結果を取得するために使用できます。タイプ Place の結果は、住所と場所に関する追加情報を含む最終結果を提供します。詳細については、「Suggest API の API リファレンス」を参照してください。

このレスポンスには、以下のキーデータが含まれます。

結果分析

入力クエリの絞り込みに関する情報を提供します。

  • QueryRefinements: 検索クエリを絞り込むために使用できる用語。

  • Highlights: クエリに一致するアドレスまたはタイトルの一部を強調表示します。

場所のタイプとカテゴリ

場所のタイプとカテゴリについて説明します。

  • Categories: レストランや学校など、場所を説明するカテゴリ。

  • PlaceType: 都市、住所、リージョンなど、場所のタイプを指定します。

  • BusinessChains: 関連するビジネスチェーンを示します。

その他の詳細

リクエストで指定された、場所に関する追加情報。

  • Contacts: E メール、電話番号、ウェブサイトを提供します。

  • OpeningHours: 場所の稼働時間。

  • AccessPoints: 場所に関連付けられた地理的座標。

  • Phonemes: 住所コンポーネントの音声表現。

  • TimeZone: オフセットを含むタイムゾーン情報。