AutoVervollständigen

Die automatische Vervollständigung bietet Endbenutzern reaktives Feedback, während sie ihre Suchabfrage eingeben. Es enthält Vorschläge für Adressen und Interessenpunkte, die auf teilweisem oder falsch geschriebenem Freiformtext basieren. Sie können Ortsindexressourcen verwenden, um Vorschläge zur automatischen Vervollständigung anzufordern und die resultierenden Vorschläge in Ihrer Anwendung anzuzeigen.

Amazon Location unterstützt keine Speicherung von Vorschlägen zur automatischen Vervollständigung. Ein Fehler wird zurückgegeben, wenn der für einen Autocomplete-Aufruf verwendete Ortsindex für die Verwendung mit gespeicherten Geocodes konfiguriert ist. Um gespeicherte Geocodes zu verwenden und Vorschläge abzufragen, erstellen und konfigurieren Sie mehrere Ortsindizes.

In diesem Abschnitt wird beschrieben, wie Sie eine automatische Vervollständigungsanforderung senden. Es beginnt mit der einfachsten Form der Anforderung und zeigt dann optionale Parameter an, mit denen Sie die Relevanz von Suchergebnissen zur automatischen Vervollständigung erhöhen können.

Verwenden der automatischen Vervollständigung

Sie können eine einfache Anfrage für Vorschläge zur automatischen Vervollständigung über die -SearchPlaceIndexForSuggestionsOperation einreichen. Die einfachste Form der Anforderung hat einen einzelnen erforderlichen Parameter, die Abfrage Text:

• Text – Der Freiform-Teiltext, der zum Generieren von Ortsvorschlägen verwendet werden soll. Zum Beispiel die Zeichenfolge eiffel tow.

Um die Anzahl der zurückgegebenen Ergebnisse zu begrenzen, fügen Sie den optionalen MaxResults Parameter hinzu:

• MaxResults – Beschränkt die Anzahl der Ergebnisse, die in der Abfrageantwort zurückgegeben werden.

Sie können die Amazon Location APIs oder die verwenden AWS CLI.

API

Das folgende Beispiel ist eine SearchPlaceIndexForSuggestions Anforderung, die Ortsindex-Ressource nach bis zu 5 Vorschlägen zu durchsuchenExamplePlaceIndex, die auf dem partiellen Ortsnamen .

POST /places/v0/indexes/ExamplePlaceIndex/search/suggestions
Content-type: application/json

{
    "Text": "kamp",
    "MaxResults": 5
}

AWS CLI

Das folgende Beispiel ist ein search-place-index-for-suggestions Befehl, um die Ortsindex-Ressource nach bis zu 5 Vorschlägen zu durchsuchenExamplePlaceIndex, die auf dem partiellen Ortsnamen .

aws location \
              search-place-index-for-suggestions \
              --index-name ExamplePlaceIndex \
              --text kamp \
              --max-results 5

Der Aufruf von SearchPlaceIndexForSuggestions führt zu einer Liste von Orten mit jeweils einem Namen und einer ID. Sie können diese Ergebnisse verwenden, um Vorschläge darüber zu präsentieren, wonach der Benutzer während der Eingabe suchen könnte, z. B. eine Dropdownliste mit Auswahlmöglichkeiten unter einem Textfeld. Im Folgenden finden Sie beispielsweise die Ergebnisse für Vorschläge, die auf einem Benutzer basieren, der eingibt.

{
    "Summary": {
        "Text": "kamp",
        "MaxResults": 5,
        "DataSource": "Esri"
    },
    "Results": [
        {
            "Text": "Kampuchea",
            "PlaceId": "AQAAAIAADsn2T3KdrRWeaXLeVEyjNx_JfeTsMB0NVCEAnAZoJ-o3nqdlJZAdgcT2oWi1w9pS4wXXOk3O1vsKlGsPyHjV4EJxsu289i3hVO_BUPgP7SFoWAi8BW2v7LvAjQ5NfUPy7a1v9ajT3feIqcUZszWSTqKbJHFYvQqW7wdqhpQq3Wy-et39ZQDWSPLZUzgcjN-6VD2gyKkH0Po7gSm8YSJNSQ"
        },
        {
            "Text": "Kampoul, Kabul, AFG",
            "PlaceId": "AQAAAIAAA1mxl_-9ffzXD07rBgo9fh6E01Pd1YKvuT5rz2qBDxqBkhTlgkeiOPR2s5sa3YBLxUqQI8bhymsYcu9R-DkX3L9QSi3CB5LhNPu160iSFJo6H8S1CrxO3QsJALhrr9mdbg0R4R4YDywkhkeBlnbn7g5C5LI_wYx873WeQZuilwtsGm8jcMA0Ya5oK4netQC6piVx6zmnPdwBs-UeXcb_bg"
        },
        {
            "Text": "Kampala, UGA",
            "PlaceId": "AQAAAIAAzZfZt3qMruKGObyhP6MM0pqy2L8SULlVWT7a3ertLBRS6Q5n7I4s9D7E0nRHADAj7mL7kvX1Q8HD-mpuiATXNJ1Ix4_V_1B15zHe8jlYKMWvXbgbO8cMpgR2fqYqZMR1x-dfBOO8OoqujKZldvPIDK1kNe3GwcaqvvMWWPMeaGd203brFynubAe-MmFF-Gjz-WBMfUy9og6MV7bkk6NGCA"
        },
        {
            "Text": "Kampar, Riau, IDN",
            "PlaceId": "AQAAAIAAvbXXx-srOi111tHOkPdao0GF7WQ_KaZ444SEnevycp6Gtf_2JWgPfCE5bIQCYwya1uZQpX2a8YJoFm2K7Col4fLu7IK0yYOLhZx4kp6QzbG4xEAGzfWtWq6nfbb0lZfuHY6r0g1sRlN1aucvwim4AEcKRzckqaa93JI8064pj6Q59kN37pAa3JX4ayEzH1DzIL3m3oqxzd4O16yGfhAIgA"
        },
        {
            "Text": "Kampung Pasir Gudang Baru, Johor, MYS",
            "PlaceId": "AQAAAIAA4HLQHdjUDcaaXLE9wtNIT1cjQYLgkBnMoG2eNN0AaQ8PJoWabLRXmmPUaAj8MAD6vT0i6zqaun5Mixyj7vnYXrk2xp59cbgdqvQaPoWhSCVxBOX0WGs3cZ8TnIRn3c-6v8_UfmqC7es1gUyECfMGK04VBKiwpHwCzjNsqymkd9BC3A9K3QlMgd3dkrGjv_vV94iLlnFTbaecrckl2UDCkA"
        }
    ]
}

Im nächsten Abschnitt wird erläutert, wie Sie die PlaceID aus diesen Ergebnissen verwenden.

Verwenden der Ergebnisse der automatischen Vervollständigung

Der Aufruf von SearchPlaceIndexForSuggestions führt zu einer Liste von Orten mit jeweils einem Namen und einer ID. Sie können diese Ergebnisse verwenden, um Vorschläge darüber zu präsentieren, wonach der Benutzer während der Eingabe suchen könnte, z. B. eine Dropdownliste mit Auswahlmöglichkeiten unter einem Textfeld. Wenn der Benutzer eines der Ergebnisse auswählt, können Sie die GetPlace Operation mit der ID seiner Auswahl aufrufen, um die Details dieses Orts zurückzugeben, einschließlich Standort, Adresse oder anderer Details.

Anmerkung

Eine PlaceId ist nur gültig, wenn alle der folgenden Bedingungen in der ursprünglichen Suchanfrage und im Aufruf von identisch sindGetPlace.

• Kunde AWS-Konto

• AWS-Region

• Der in der Ortsindex-Ressource angegebene Datenanbieter

In der Regel verwenden Sie GetPlace mit den Amazon Location APIs . Das folgende Beispiel ist eine GetPlace Anforderung, einen der Vorschläge aus dem vorherigen Abschnitt zu finden. Dieses Beispiel basiert auf dem partiellen Ortsnamen .

POST /places/v0/indexes/ExamplePlaceIndex/places/AQAAAIAADsn2T3KdrRWeaXLeVEyjNx_JfeTsMB0NVCEAnAZoJ-o3nqdlJZAdgcT2oWi1w9pS4wXXOk3O1vsKlGsPyHjV4EJxsu289i3hVO_BUPgP7SFoWAi8BW2v7LvAjQ5NfUPy7a1v9ajT3feIqcUZszWSTqKbJHFYvQqW7wdqhpQq3Wy-et39ZQDWSPLZUzgcjN-6VD2gyKkH0Po7gSm8YSJNSQ

Automatische Vervollständigung nahe einer Position

Wenn Sie mithilfe von nach Vorschlägen zur automatischen Vervollständigung von Orten suchenSearchPlaceIndexForSuggestions, können Sie lokal relevantere Vorschläge erhalten, indem Sie den folgenden optionalen Parameter hinzufügen:

• BiasPosition – Die Position, an der Sie in der Nähe suchen möchten. Definiert als [longitude, latitude].

Im folgenden Beispiel wird eine -SearchPlaceIndexForSuggestionsAnforderung verwendet, um die Ortsindex-Ressource ExamplePlaceIndex nach Ortsvorschlägen zu durchsuchen, die mit dem partiellen Abfrageblock nahe der Position [32.5827,0.3169] übereinstimmen.

POST /places/v0/indexes/ExamplePlaceIndex/search/suggestions
Content-type: application/json

{
    "Text": "kamp",
    "BiasPosition": [32.5827,0.3169]
}

Die für dasselbe zurückgegebenen Vorschläge Text können unterschiedlich sein, wenn ein anderes ausgewählt BiasPosition wird, z. B. [-96.7977, 32.776].

Automatische Vervollständigung innerhalb eines Begrenzungsrahmens

Sie können Ihre Suche nach automatischer Vervollständigung einschränken, um nur Vorschläge für Stellen zu erhalten, die sich innerhalb einer bestimmten Grenze befinden, indem Sie den folgenden optionalen Parameter hinzufügen:

• FilterBBox – Ein Begrenzungsrahmen, den Sie angeben, um Ihre Ergebnisse nach Koordinaten innerhalb der Grenzen des Rahmens zu filtern. Definiert als [LongitudeSW, LatitudeSW, LongitudeNE, LatitudeNE]

  Anmerkung

  Eine Anforderung darf nicht sowohl die FilterBBox BiasPosition Parameter als auch enthalten. Die Angabe beider Parameter in der Anforderung gibt einen ValidationException Fehler zurück.

Im folgenden Beispiel wird eine -SearchPlaceIndexForSuggestionsAnforderung verwendet, um die Ortsindex-Ressource ExamplePlaceIndex nach Ortsvorschlägen zu durchsuchen, die mit der partiellen Abfrage „“ übereinstimmen und die im Begrenzungsrahmen enthalten sind, wobei:

• Der Längengrad der Westecke des Begrenzungsrahmens beträgt 32,5020.

• Der Breitengrad der Bolwesten Ecke des Begrenzungsrahmens beträgt 0,2678.

• Der Längengrad der nordöstlichen Ecke des Begrenzungsrahmens beträgt 32,6129.

• Der Breitengrad der nordöstlichen Ecke des Begrenzungsrahmens beträgt 0,3502.

POST /places/v0/indexes/ExamplePlaceIndex/search/suggestions
Content-type: application/json

{
    "Text": "kamp",
    "FilterBBox": [
        32.5020, 0.2678,
        32.6129, 0.3502
    ]
}

Die für dasselbe zurückgegebenen Vorschläge Text unterscheiden sich, wenn ein anderes ausgewählt FilterBBox wird, z. B. [-97.9651, 32.0640, -95.1196, 34.0436].

Automatische Vervollständigung innerhalb eines Landes

Sie können Ihre Suche nach automatischer Vervollständigung einschränken, um nur Vorschläge für Orte zu erhalten, die sich in einem bestimmten Land oder einer bestimmten Gruppe von Ländern befinden, indem Sie den folgenden optionalen Parameter hinzufügen:

• FilterCountries – Die Länder, in denen Sie nach Ortsvorschlägen suchen möchten. Sie können bis zu 100 Länder in einer Anfrage mit einem dreistelligen ISO-3166-Ländercode angeben. Verwenden Sie beispielsweise AUS für Australien.

Im folgenden Beispiel wird eine -SearchPlaceIndexForSuggestionsAnforderung verwendet, um die Ortsindex-Ressource ExamplePlaceIndex nach Ortsvorschlägen zu durchsuchen, die mit der partiellen Abfrage „Campp“ übereinstimmen und in Ug Bol, Kenya oderania enthalten sind:

POST /places/v0/indexes/ExamplePlaceIndex/search/suggestions
Content-type: application/json

{
    "Text": "kamp",
    "FilterCountries": ["UGA", "KEN", "TZA"]
}

Die für dasselbe zurückgegebenen Vorschläge Text unterscheiden sich, wenn eine andere FilterCountries Liste ausgewählt wird, z. B. ["USA "].

Beispielantwort

Im Folgenden finden Sie eine Beispielantwort vorgeschlagener automatischer Vervollständigungen für die -SearchPlaceIndexForSuggestionsOperation unter Verwendung des Text-Zumpfes .

{
    "Summary": {
        "Text": "kamp",
        "MaxResults": 5,
        "DataSource": "Esri"
    },
    "Results": [
        {
            "Text": "Kampuchea",
            "PlaceId": "AQAAAIAADsn2T3KdrRWeaXLeVEyjNx_JfeTsMB0NVCEAnAZoJ-o3nqdlJZAdgcT2oWi1w9pS4wXXOk3O1vsKlGsPyHjV4EJxsu289i3hVO_BUPgP7SFoWAi8BW2v7LvAjQ5NfUPy7a1v9ajT3feIqcUZszWSTqKbJHFYvQqW7wdqhpQq3Wy-et39ZQDWSPLZUzgcjN-6VD2gyKkH0Po7gSm8YSJNSQ"
        },
        {
            "Text": "Kampoul, Kabul, AFG",
            "PlaceId": "AQAAAIAAA1mxl_-9ffzXD07rBgo9fh6E01Pd1YKvuT5rz2qBDxqBkhTlgkeiOPR2s5sa3YBLxUqQI8bhymsYcu9R-DkX3L9QSi3CB5LhNPu160iSFJo6H8S1CrxO3QsJALhrr9mdbg0R4R4YDywkhkeBlnbn7g5C5LI_wYx873WeQZuilwtsGm8jcMA0Ya5oK4netQC6piVx6zmnPdwBs-UeXcb_bg"
        },
        {
            "Text": "Kampala, UGA",
            "PlaceId": "AQAAAIAAzZfZt3qMruKGObyhP6MM0pqy2L8SULlVWT7a3ertLBRS6Q5n7I4s9D7E0nRHADAj7mL7kvX1Q8HD-mpuiATXNJ1Ix4_V_1B15zHe8jlYKMWvXbgbO8cMpgR2fqYqZMR1x-dfBOO8OoqujKZldvPIDK1kNe3GwcaqvvMWWPMeaGd203brFynubAe-MmFF-Gjz-WBMfUy9og6MV7bkk6NGCA"
        },
        {
            "Text": "Kampar, Riau, IDN",
            "PlaceId": "AQAAAIAAvbXXx-srOi111tHOkPdao0GF7WQ_KaZ444SEnevycp6Gtf_2JWgPfCE5bIQCYwya1uZQpX2a8YJoFm2K7Col4fLu7IK0yYOLhZx4kp6QzbG4xEAGzfWtWq6nfbb0lZfuHY6r0g1sRlN1aucvwim4AEcKRzckqaa93JI8064pj6Q59kN37pAa3JX4ayEzH1DzIL3m3oqxzd4O16yGfhAIgA"
        },
        {
            "Text": "Kampung Pasir Gudang Baru, Johor, MYS",
            "PlaceId": "AQAAAIAA4HLQHdjUDcaaXLE9wtNIT1cjQYLgkBnMoG2eNN0AaQ8PJoWabLRXmmPUaAj8MAD6vT0i6zqaun5Mixyj7vnYXrk2xp59cbgdqvQaPoWhSCVxBOX0WGs3cZ8TnIRn3c-6v8_UfmqC7es1gUyECfMGK04VBKiwpHwCzjNsqymkd9BC3A9K3QlMgd3dkrGjv_vV94iLlnFTbaecrckl2UDCkA"
        }
    ]
}