Documents - Autocomplete Post

Usługa:

Search Service

Wersja interfejsu API:

2024-07-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2024-07-01

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.

Nagłówek żądania

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

Treść żądania

Nazwa	Wymagane	Typ	Opis
search	True	string	Tekst wyszukiwania, na którym mają być oparte wyniki autouzupełniania.
suggesterName	True	string	Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
autocompleteMode		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.
filter		string	Wyrażenie OData, które filtruje dokumenty używane do tworzenia ukończonych terminów dla wyniku autouzupełniania.
fuzzy		boolean	Wartość wskazująca, czy używać dopasowywania rozmytego dla zapytania autouzupełniania. Wartość domyślna to false. Po ustawieniu wartości true zapytanie będzie automatycznie wypełniać terminy, nawet jeśli w tekście wyszukiwania nie ma znaku zastępczego lub brakującego. 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		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		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		number	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		string	Rozdzielona przecinkami 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.
top		integer	Liczba terminów do pobrania przez autouzukończone. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5.

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	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchIndexAutocompleteDocumentsPost

Przykładowe żądanie

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-07-01

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

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.
AutocompleteRequest	Parametry dopasowania rozmytego i inne zachowania zapytań autouzupełniania.
AutocompleteResult	Wynik zapytania autouzupełniania.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd

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 ciągu "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 "medycyna".
oneTermWithContext	string	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".
twoTerms	string	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".

AutocompleteRequest

Parametry dopasowania rozmytego i inne zachowania zapytań autouzupełniania.

Nazwa	Typ	Opis
autocompleteMode	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.
filter	string	Wyrażenie OData, które filtruje dokumenty używane do tworzenia ukończonych terminów dla wyniku autouzupełniania.
fuzzy	boolean	Wartość wskazująca, czy używać dopasowywania rozmytego dla zapytania autouzupełniania. Wartość domyślna to false. Po ustawieniu wartości true zapytanie będzie automatycznie wypełniać terminy, nawet jeśli w tekście wyszukiwania nie ma znaku zastępczego lub brakującego. 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	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	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	number	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	string	Tekst wyszukiwania, na którym mają być oparte wyniki autouzupełniania.
searchFields	string	Rozdzielona przecinkami 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.
suggesterName	string	Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
top	integer	Liczba terminów do pobrania przez autouzukończone. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5.

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 minimalna wartośćCoverage nie została określona w żądaniu.
value	AutocompleteItem[]	Lista zwróconych elementów autouzupełnionych.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.