結果のスコアリングを使用する

このチュートリアルでは、APIがスコアリング情報を返す方法を説明します。

手順

/geocode エンドポイントはスコアリング情報を返します。この情報は、元のクエリとどの程度一致したかを各結果に対して示します。これは、顧客アプリケーションによって使用され、ユースケースの間違いがどの程度「高価」であるかに応じて、結果を受け入れるか拒否するかを選択できます。

住所 240 Washington St., Boston に対する自由形式テキストクエリは次のように作成されます。

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?q=240+Washington+St.%2C+Boston
    &apiKey={YOUR_API_KEY}

次のパラメーターを使用します。

q - 名前を入力します。
apiKey - APIキー。

📘
注
このリクエストはAPIキー認証を使用します。HEREプラットフォームの認証オプションの詳細については、「Identity & Access Management Guide」(IDとアクセス管理ガイド)を参照してください。

住所は正しく、間違いや誤字はなく、住所の特定に無関係なコンテンツは含まれていません。

上のリクエストに対するレスポンスは次のようになります。

{
  "items": [
    {
      "title": "240 Washington St, Boston, MA 02108-4603, United States",
      "id": "here:af:streetsection:YCY1nQWrJ5eBrHv075VVOD:CggIBCDns4LfAhABGgMyNDAoZA",
      "resultType": "houseNumber",
      "houseNumberType": "PA",
      "address": {
        "label": "240 Washington St, Boston, MA 02108-4603, United States",
        "countryCode": "USA",
        "countryName": "United States",
        "stateCode": "MA",
        "state": "Massachusetts",
        "county": "Suffolk",
        "city": "Boston",
        "district": "Downtown Boston",
        "street": "Washington St",
        "postalCode": "02108-4603",
        "houseNumber": "240"
      },
      "position": {
        "lat": 42.35814,
        "lng": -71.05765
      },
      "access": [
        {
          "lat": 42.35815,
          "lng": -71.05788
        }
      ],
      "mapView": {
        "west": -71.05887,
        "south": 42.35724,
        "east": -71.05643,
        "north": 42.35904
      },
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "city": 1,
          "streets": [
            1
          ],
          "houseNumber": 1
        }
      }
    },
    {
      "title": "240 Washington St, Boston, MA 02135-3508, United States",
      "id": "here:af:streetsection:6SnFDsUujYAamxhLX-Vr1D:CgcIBCDRnLAhEAEaAzI0MChk",
      "resultType": "houseNumber",
      "houseNumberType": "PA",
      "address": {
        "label": "240 Washington St, Boston, MA 02135-3508, United States",
        "countryCode": "USA",
        "countryName": "United States",
        "stateCode": "MA",
        "state": "Massachusetts",
        "county": "Suffolk",
        "city": "Boston",
        "district": "Brighton Center",
        "street": "Washington St",
        "postalCode": "02135-3508",
        "houseNumber": "240"
      },
      "position": {
        "lat": 42.34754,
        "lng": -71.14943
      },
      "access": [
        {
          "lat": 42.34765,
          "lng": -71.14925
        }
      ],
      "mapView": {
        "west": -71.15065,
        "south": 42.34664,
        "east": -71.14821,
        "north": 42.34844
      },
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "city": 1,
          "streets": [
            1
          ],
          "houseNumber": 1
        }
      }
    }
  ]
}

結果には、2 つの部分で構成される scoring ブロックが含まれます。

queryScore - 返された住所に一致した入力の割合を表す 0 から 1 までの値。すべての入力トークンが認識され、一致した場合は 1 に等しくなります。入力クエリに追加情報 (人の名前、電話番号、またはその他のヒント) が含まれている場合、queryScore は低くなりますが、結果は正しい可能性があります。ただし、queryScore が低い場合は結果が入力クエリ内の住所の関連部分と一致していないことを示している可能性があります。
fieldScore - 結果フィールドとクエリの対応する部分がどの程度一致するかを示す 0 から 1 までの値。国内で住所を特定するために重要なすべてのフィールドが高品質で一致する場合、queryScore の値が低いのは住所以外の情報が追加されているためであると考えることができます。その場合でも、結果は信頼できます。

📘
注
fieldScoreの個別フィールドスコア(cityやstreetsなど)が存在しない場合は、そのフィールドのスコアが0であることを示しています。

追加情報

/geocodeエンドポイントパラメーターの詳細については、「APIリファレンス」を参照してください。