Documents - Autocomplete Get

Usługa:: Search Service

Wersja interfejsu API:: 2023-11-01

Autouzupełnianie niekompletnych terminów zapytania na podstawie tekstu wejściowego i dopasowywania terminów w indeksie.

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}

Z parametrami opcjonalnymi:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
indexName	path	True	string	Nazwa indeksu.
api-version	query	True	string	Wersja interfejsu API klienta.
search	query	True	string	Niepełny termin, który powinien zostać automatycznie ukończony.
suggesterName	query	True	string	Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
$filter	query		string	Wyrażenie OData, które filtruje dokumenty używane do tworzenia ukończonych terminów dla wyniku autouzupełniania.
$top	query		integer (int32)	Liczba terminów do pobrania przez autouzukończone. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5.
autocompleteMode	query		AutocompleteMode	Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj ciągu "twoTerms", aby uzyskać shingles i "oneTermWithContext", aby użyć bieżącego kontekstu podczas tworzenia terminów autouzukończonych.
fuzzy	query		boolean	Wartość wskazująca, czy używać dopasowywania rozmytego dla zapytania autouzupełniania. Wartość domyślna to false. Po ustawieniu wartości true zapytanie znajdzie terminy, nawet jeśli w tekście wyszukiwania znajduje się znak zastępczy lub brak go. Chociaż zapewnia to lepsze środowisko w niektórych scenariuszach, wiąże się to z kosztem wydajności, ponieważ zapytania rozmyte autouzupełniania są wolniejsze i zużywają więcej zasobów.
highlightPostTag	query		string	Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z elementem highlightPreTag. W przypadku pominięcia wyróżnianie trafień jest wyłączone.
highlightPreTag	query		string	Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. W przypadku pominięcia wyróżnianie trafień jest wyłączone.
minimumCoverage	query		number (double)	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem autouzupełniania w celu zgłoszenia zapytania jako powodzenia. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet dla usług z tylko jedną repliką. Wartość domyślna to 80.
searchFields	query		string[]	Lista nazw pól, które należy wziąć pod uwagę podczas wykonywania zapytań dotyczących terminów autouzukończonych. Pola docelowe muszą być uwzględnione w określonym sugestorze.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby ułatwić debugowanie.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AutocompleteResult	Odpowiedź zawierająca sugerowane terminy zapytania, które zakończą częściowe dane wejściowe.
Other Status Codes	SearchError	Odpowiedź na błąd.

Przykłady

SearchIndexAutocompleteDocumentsGet

Przykładowe żądanie

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2023-11-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Przykładowa odpowiedź

Kod stanu:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

Definicje

Nazwa	Opis
AutocompleteItem	Wynik żądań autouzupełniania.
AutocompleteMode	Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj ciągu "twoTerms", aby uzyskać shingles i "oneTermWithContext", aby użyć bieżącego kontekstu w tworzeniu terminów autouzupełniania.
AutocompleteResult	Wynik zapytania autouzupełniania.
SearchError	Opisuje warunek błędu interfejsu API.

AutocompleteItem

Objekt

Wynik żądań autouzupełniania.

Nazwa	Typ	Opis
queryPlusText	string	Zapytanie wraz z ukończonym terminem.
text	string	Ukończony termin.

AutocompleteMode

Wyliczenie

Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj ciągu "twoTerms", aby uzyskać shingles i "oneTermWithContext", aby użyć bieżącego kontekstu w tworzeniu terminów autouzupełniania.

Wartość	Opis
oneTerm	Sugerowany jest tylko jeden termin. Jeśli zapytanie ma dwa terminy, zostanie ukończony tylko ostatni termin. Jeśli na przykład dane wejściowe to "washington medic", sugerowane terminy mogą obejmować "medicaid", "medicare" i "medycyna".
twoTerms	Sugerowane będzie dopasowywanie dwuterminowych fraz w indeksie. Jeśli na przykład dane wejściowe to "medyk", sugerowane terminy mogą obejmować "ubezpieczenie medicare" i "asystenta medycznego".
oneTermWithContext	Kończy ostatni termin w zapytaniu z co najmniej dwoma terminami, gdzie dwa ostatnie terminy są frazą, która istnieje w indeksie. Jeśli na przykład dane wejściowe to "washington medic", sugerowane terminy mogą obejmować "washington medicaid" i "washington medical".

AutocompleteResult

Objekt

Wynik zapytania autouzupełniania.

Nazwa	Typ	Opis
@search.coverage	number (double)	Wartość wskazująca wartość procentową indeksu, który został uwzględniony przez żądanie autouzupełniania, lub wartość null, jeśli minimalna wartośćCoverage nie została określona w żądaniu.
value	AutocompleteItem[]	Lista zwróconych elementów autouzupełnionych.

SearchError

Objekt

Opisuje warunek błędu interfejsu API.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	SearchError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
message	string	Czytelna dla człowieka reprezentacja błędu.