Documents - Autocomplete Get
Autouzupełnia niekompletne terminy zapytania na podstawie tekstu wejściowego i pasujące terminy w indeksie.
GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}
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. |
index
|
path | True |
string |
Nazwa indeksu. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
search
|
query | True |
string |
Niekompletny termin, który powinien zostać automatycznie ukończony. |
suggester
|
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 autouzukończonych do pobrania. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5. |
|
autocomplete
|
query |
Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj polecenia "twoTerms", aby uzyskać shingles i "oneTermWithContext", aby użyć bieżącego kontekstu podczas tworzenia terminów wykonanych automatycznie. |
||
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ę zastępczy lub brakujący znak. Chociaż zapewnia to lepsze środowisko w niektórych scenariuszach, wiąże się to z kosztem wydajności, ponieważ rozmyte zapytania autouzupełniania są wolniejsze i zużywają więcej zasobów. |
|
highlight
|
query |
string |
Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z funkcją highlightPreTag. Jeśli pominięto, wyróżnianie trafień jest wyłączone. |
|
highlight
|
query |
string |
Tag ciągu, który jest poprzedzany do wyróżniania. Należy ustawić element z wyróżnionym elementemPostTag. Jeśli pominięto, wyróżnianie trafień jest wyłączone. |
|
minimum
|
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. |
|
search
|
query |
string[] |
Lista nazw pól, które należy wziąć pod uwagę podczas wykonywania zapytań dotyczących terminów wykonanych automatycznie. 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 za pomocą żądania ułatwiającego debugowanie. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Odpowiedź zawierająca sugerowane terminy zapytania, które zakończą częściowe dane wejściowe. |
|
Other Status Codes |
Odpowiedź na błąd. |
Przykłady
SearchIndexAutocompleteDocumentsGet
Sample Request
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
Sample Response
[
{
"text": "medicaid",
"queryPlusText": "washington medicaid"
},
{
"text": "medicare",
"queryPlusText": "washington medicare"
},
{
"text": "medicine",
"queryPlusText": "washington medicine"
}
]
Definicje
Nazwa | Opis |
---|---|
Autocomplete |
Wynik żądań autouzupełniania. |
Autocomplete |
Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj polecenia "twoTerms", aby uzyskać shingles i "oneTermWithContext", aby użyć bieżącego kontekstu w tworzeniu terminów autouzupełniania. |
Autocomplete |
Wynik zapytania autouzupełniania. |
Search |
Opisuje warunek błędu interfejsu API. |
AutocompleteItem
Wynik żądań autouzupełniania.
Nazwa | Typ | Opis |
---|---|---|
queryPlusText |
string |
Zapytanie wraz z ukończonym terminem. |
text |
string |
Ukończony termin. |
AutocompleteMode
Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj polecenia "twoTerms", aby uzyskać shingles i "oneTermWithContext", aby użyć bieżącego kontekstu w tworzeniu terminów autouzupełniania.
Nazwa | Typ | Opis |
---|---|---|
oneTerm |
string |
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 "medicine". |
oneTermWithContext |
string |
Kończy ostatni termin w zapytaniu z co najmniej dwoma terminami, w których ostatnie dwa 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". |
twoTerms |
string |
Sugerowane będą dopasowywanie dwuokresowych fraz w indeksie. Jeśli na przykład dane wejściowe to "medyk", sugerowane terminy mogą obejmować "pokrycie medicare" i "asystent medyczne". |
AutocompleteResult
Wynik zapytania autouzupełniania.
Nazwa | Typ | Opis |
---|---|---|
@search.coverage |
number |
Wartość wskazująca wartość procentową indeksu, który został uwzględniony przez żądanie autouzupełniania, lub wartość null, jeśli minimalnaCoverage nie została określona w żądaniu. |
value |
Lista zwróconych elementów autouzupełniania. |
SearchError
Opisuje warunek błędu interfejsu API.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
details |
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. |