Autocompleteによる結果のレンダリングと高輝度表示の使用方法

このチュートリアルで/autocomplete は、エンドポイントが入力条件を住所または管理領域の一部に一致させることで、入力テキストをどのように完了しようとするかについて説明します。

プロシージャ

エンドユーザーは、すでに入力されているすべての入力条件を応答に表示し、インテントアドレスを簡単に認識して選択できることを期待できます。 この期待を満たすために、/autocomplete エンドポイントは他 のエンドポイントとは異なる方法で結果title をレンダリングします。

/autocompleteは 、国名から住所までのすべての国の結果titleを統一された方法で表示します。 結果 title には、必ずしもすべてのアドレスコンポーネントが含まれているわけではありません。 そうしないと、長すぎて過負荷になります。 エンドユーザーが結果を認識して最終的に選択するために重要なパーツのみが含まれます。

たとえば、フランクフルトの Pariser Stra ß e で住所を検索する中間クエリは 、次のようにFrankfurt Pariなります。

GET https://autocomplete.search.hereapi.com/v1/
    autocomplete
    ?q=Frankfurt+Pari
    &limit=1
    &apiKey={YOUR_API_KEY}

次のパラメータが使用されます。

• Q - フリーテキストのクエリを入力します。
• Limit ：返される結果の最大数
• apiKey - お客様の API キー 。

ドイツの道路結果のデフォルトの結果title には、国名、郵便番号、市区町村、番地が含まれています。

{
  "items": [
    {
      "title": "Deutschland, Frankfurt am Main, Pariser Straße",
      "id": "here:af:street:Hg5LQ9NeP5Clua0GQ5dkIB",
      "language": "de",
      "resultType": "street",
      "address": {
        "label": "Pariser Straße, 60486 Frankfurt am Main, Deutschland",
        "countryCode": "DEU",
        "countryName": "Deutschland",
        "stateCode": "HE",
        "state": "Hessen",
        "countyCode": "F",
        "county": "Frankfurt am Main",
        "city": "Frankfurt am Main",
        "district": "Gallus",
        "street": "Pariser Straße",
        "postalCode": "60486"
      },
      "highlights": {
        "title": [
          {
            "start": 13,
            "end": 22
          },
          {
            "start": 32,
            "end": 36
          }
        ],
        "address": {
          "label": [
            {
              "start": 0,
              "end": 4
            },
            {
              "start": 22,
              "end": 31
            }
          ],
          "city": [
            {
              "start": 0,
              "end": 9
            }
          ],
          "street": [
            {
              "start": 0,
              "end": 4
            }
          ]
        }
      }
    }
  ]
}

ドイツの州名と郡名は、住所を認識するほど重要ではありません。 そのため、デフォルトでは、州名と郡名は結果title に表示されません。

ただし、ユーザーが状態Hessen の提案のみを取得し、クエリFrankfurt, Hessen, Pariの一部として使用することを希望する場合 があります :

GET https://autocomplete.search.hereapi.com/v1/
    autocomplete
    ?q=Frankfurt%2C+Hessen%2C+Pari
    &apiKey={YOUR_API_KEY}

国名、郵便番号、市区町村、番地のほかに、結果titleには、州名も含まれます。

{
  "items": [
    {
      "title": "Deutschland, Hessen, Frankfurt am Main, Pariser Straße",
      "id": "here:af:street:Hg5LQ9NeP5Clua0GQ5dkIB",
      "language": "de",
      "resultType": "street",
      "address": {
        "label": "Pariser Straße, 60486 Frankfurt am Main, Deutschland",
        "countryCode": "DEU",
        "countryName": "Deutschland",
        "stateCode": "HE",
        "state": "Hessen",
        "countyCode": "F",
        "county": "Frankfurt am Main",
        "city": "Frankfurt am Main",
        "district": "Gallus",
        "street": "Pariser Straße",
        "postalCode": "60486"
      },
      "highlights": {
        "title": [
          {
            "start": 13,
            "end": 19
          },
          {
            "start": 21,
            "end": 30
          },
          {
            "start": 40,
            "end": 44
          }
        ],
        "address": {
          "label": [
            {
              "start": 0,
              "end": 4
            },
            {
              "start": 22,
              "end": 31
            }
          ],
          "state": [
            {
              "start": 0,
              "end": 6
            }
          ],
          "city": [
            {
              "start": 0,
              "end": 9
            }
          ],
          "street": [
            {
              "start": 0,
              "end": 4
            }
          ]
        }
      }
    }
  ]
}

いずれの場合も、/autocompleteエンドポイントは、地域の郵便規則に従ってブロックaddressの結果labelをレンダリングします。 これらのルールは、すべてのエンドポイントで同じです。 すべての入力条件が含まれているわけではありません。

結果には、highlightsという名前のブロックも含まれます。 このブロックhighlights には、結果title 内および address ブロック内の詳細な住所コンポーネント内で、一致するクエリー用語を強調表示するために必要なすべての情報が含まれています。

結果 title が作成され、顧客のアプリケーションが提案を強調表示してレンダリングできるようになります。 上記の 2 つのクエリの結果は同じですが、 2 番目のケースで title はインクルード状態の名前 Hessentitleが使用されます。これにより、エンドユーザーは、入力済みのすべての入力条件を結果で強調表示して確認できます。

追加情報

/autocomplete パラメータの詳細については、次のトピックを参照してください。 API リファレンス。