Documents - Search Post
Wyszukuje dokumenty w indeksie.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-03-01-Preview
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. |
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. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
answers |
Query |
Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania. |
captions |
Query |
Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania. |
count |
boolean |
Wartość określająca, czy pobrać łączną liczbę wyników. Wartość domyślna to false. Ustawienie tej wartości na wartość true może mieć wpływ na wydajność. Zwróć uwagę, że zwrócona liczba jest przybliżeniem. |
debug |
Query |
Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania wyników sklasyfikowanych ponownie. |
facets |
string[] |
Lista wyrażeń aspektowych, które mają być stosowane do zapytania wyszukiwania. Każde wyrażenie aspektu zawiera nazwę pola, po którym opcjonalnie następuje rozdzielona przecinkami lista par name:value. |
filter |
string |
Wyrażenie OData $filter, które ma być stosowane do zapytania wyszukiwania. |
highlight |
string |
Rozdzielona przecinkami lista nazw pól używanych do wyróżniania trafień. Do wyróżniania trafień można używać tylko pól z możliwością wyszukiwania. |
highlightPostTag |
string |
Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z funkcją highlightPreTag. Wartość domyślna to </em>. |
highlightPreTag |
string |
Tag ciągu, który jest poprzedzany do wyróżniania. Należy ustawić element z wyróżnionym elementemPostTag. Wartość domyślna to <em>. |
minimumCoverage |
number |
Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem wyszukiwania 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 100. |
orderby |
string |
Rozdzielona przecinkami lista wyrażeń $orderby OData, według których należy posortować wyniki. Każde wyrażenie może być nazwą pola lub wywołaniem funkcji geo.distance() lub search.score(). Po każdym wyrażeniu można wskazać rosnąco lub desc wskazując malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki meczów dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania jest malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby. |
queryLanguage |
Query |
Wartość określająca język zapytania wyszukiwania. |
queryType |
Query |
Wartość określająca składnię zapytania wyszukiwania. Wartość domyślna to "proste". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene. |
scoringParameters |
string[] |
Lista wartości parametrów, które mają być używane w funkcjach oceniania (na przykład referencePointParameter) przy użyciu formatu name-values. Jeśli na przykład profil oceniania definiuje funkcję z parametrem o nazwie "mylocation", ciąg parametru będzie "mylocation--122.2,44.8" (bez cudzysłowów). |
scoringProfile |
string |
Nazwa profilu oceniania w celu oceny wyników dopasowania pasujących dokumentów w celu sortowania wyników. |
scoringStatistics |
Scoring |
Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszych opóźnień. Wartość domyślna to "local". Użyj wartości "global", aby agregować statystyki oceniania globalnie przed ocenianiem. Użycie globalnych statystyk oceniania może zwiększyć opóźnienie zapytań wyszukiwania. |
search |
string |
Wyrażenie zapytania wyszukiwania pełnotekstowego; Użyj wartości "*" lub pomiń ten parametr, aby dopasować wszystkie dokumenty. |
searchFields |
string |
Rozdzielona przecinkami lista nazw pól, do których ma być włączona funkcja wyszukiwania pełnotekstowego. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól każdego wyrażenia wyszukiwania pól mają pierwszeństwo przed wszelkimi nazwami pól wymienionymi w tym parametrze. |
searchMode |
Search |
Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne w celu zliczenia dokumentu jako dopasowania. |
select |
string |
Rozdzielona przecinkami lista pól do pobrania. Jeśli nieokreślone, zostaną uwzględnione wszystkie pola oznaczone jako możliwe do pobrania w schemacie. |
semanticConfiguration |
string |
Nazwa semantycznej konfiguracji, która będzie używana podczas przetwarzania dokumentów dla zapytań typu semantycznego. |
semanticErrorHandling |
Semantic |
Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić częściowe wyniki (wartość domyślna). |
semanticFields |
string |
Rozdzielona przecinkami lista nazw pól używanych do klasyfikacji semantycznej. |
semanticMaxWaitInMilliseconds |
integer |
Umożliwia użytkownikowi ustawienie górnej granicy czasu potrzebny na semantycznie wzbogacanie w celu zakończenia przetwarzania przed niepowodzeniem żądania. |
semanticQuery |
string |
Umożliwia ustawienie oddzielnego zapytania wyszukiwania, które będzie używane wyłącznie do semantycznego odrywania, semantycznych podpisów i semantycznych odpowiedzi. Jest przydatne w scenariuszach, w których istnieje potrzeba użycia różnych zapytań między fazą pobierania podstawowego i klasyfikacji oraz semantyczną fazą L2. |
sessionId |
string |
Wartość, która ma być używana do tworzenia sesji lepkiej, co może pomóc uzyskać bardziej spójne wyniki. Tak długo, jak jest używany ten sam identyfikator sesji, zostanie podjęta najlepsza próba ukierunkowana na ten sam zestaw replik. Należy pamiętać, że ponowne użycie tych samych wartości sessionID wielokrotnie może zakłócać równoważenie obciążenia żądań między replikami i niekorzystnie wpływać na wydajność usługi wyszukiwania. Wartość używana jako sessionId nie może rozpoczynać się od znaku "_". |
skip |
integer |
Liczba wyników wyszukiwania do pominięcia. Ta wartość nie może być większa niż 100 000. Jeśli musisz skanować dokumenty w sekwencji, ale nie można użyć pomijania ze względu na to ograniczenie, rozważ użycie kolejności na całkowicie uporządkowanym kluczu i filtrze za pomocą zapytania zakresu. |
speller |
Query |
Wartość określająca typ modułu sprawdzania pisowni, która ma służyć do sprawdzania pisowni poszczególnych terminów zapytania wyszukiwania. |
top |
integer |
Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania wyników wyszukiwania po stronie klienta. Jeśli wyniki są obcięte z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, który może służyć do wystawiania innego żądania Search dla następnej strony wyników. |
vectorFilterMode |
Vector |
Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego. Wartość domyślna to "preFilter". |
vectorQueries |
VectorQuery[]:
|
Parametry zapytania dla zapytań wektorowych i hybrydowych wyszukiwania. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Search |
Odpowiedź zawierająca dokumenty zgodne z kryteriami wyszukiwania. |
Other Status Codes |
Error |
Odpowiedź na błąd. |
Przykłady
SearchIndexSearchDocumentsPost
Sample Request
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-03-01-Preview
{
"count": true,
"facets": [
"category,count:10,sort:count"
],
"filter": "rating gt 4.0",
"highlight": "description",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": null,
"orderby": "rating desc",
"queryType": "simple",
"scoringParameters": [
"currentLocation--122.123,44.77233"
],
"scoringProfile": "sp",
"search": "nice hotels",
"searchFields": "category,description",
"searchMode": "any",
"sessionId": "mysessionid",
"scoringStatistics": "global",
"select": "hotelId,description",
"skip": 0,
"top": 10,
"vectorQueries": [
{
"kind": "vector",
"vector": [
0.103,
0.0712,
0.0852,
0.1547,
0.1183
],
"fields": "descriptionEmbedding",
"k": 5,
"exhaustive": true,
"oversampling": 20
}
],
"vectorFilterMode": "preFilter"
}
Sample Response
{
"@odata.count": 25,
"@search.facets": {
"category": [
{
"count": 1,
"value": "Economy"
},
{
"count": 1,
"value": "Luxury"
}
]
},
"@search.nextPageParameters": {
"count": true,
"facets": [
"category,count:10,sort:count"
],
"filter": "rating gt 4.0",
"highlight": "title",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": null,
"orderby": "search.score() desc,rating desc",
"queryType": "simple",
"sessionId": "mysessionid",
"scoringStatistics": "global",
"scoringParameters": [
"currentLocation--122.123,44.77233"
],
"scoringProfile": "sp",
"search": "nice hotels",
"searchFields": "title,description",
"searchMode": "any",
"select": "docId,title,description",
"skip": 2,
"top": 8
},
"value": [
{
"@search.score": 1.5,
"@search.highlights": {
"title": [
"<em>Nice</em> <em>Hotel</em>"
]
},
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
},
{
"@search.score": 0.7,
"@search.highlights": {
"title": [
"Fancy <em>Hotel</em>"
]
},
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-03-01-Preview"
}
Definicje
Nazwa | Opis |
---|---|
Answer |
Odpowiedź to fragment tekstowy wyodrębniony z zawartości najbardziej odpowiednich dokumentów pasujących do zapytania. Odpowiedzi są wyodrębniane z najlepszych wyników wyszukiwania. Kandydaci odpowiedzi są oceniani i wybierane są najważniejsze odpowiedzi. |
Caption |
Podpisy są najbardziej reprezentatywnymi fragmentami z dokumentu stosunkowo do zapytania wyszukiwania. Są one często używane jako podsumowanie dokumentu. Podpisy są zwracane tylko w przypadku zapytań typu "semantyka". |
Document |
Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Query |
Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania. |
Query |
Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania. |
Query |
Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania wyników wyszukiwania. |
Query |
Język zapytania. |
Query |
Nieprzetworzone ciągi łączone, które zostały wysłane do procesu wzbogacania semantycznego. |
Query |
Opis pól, które zostały wysłane do procesu wzbogacania semantycznego, a także sposobu ich użycia |
Query |
Wartość określająca typ modułu sprawdzania pisowni, która ma służyć do sprawdzania pisowni poszczególnych terminów zapytania wyszukiwania. |
Query |
Określa składnię zapytania wyszukiwania. Wartość domyślna to "proste". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene i "semantyki", jeśli składnia zapytania nie jest potrzebna. |
Raw |
Parametry zapytania do użycia do wyszukiwania wektorów po podaniu wartości nieprzetworzonego wektora. |
Scoring |
Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszych opóźnień. Wartość domyślna to "local". Użyj wartości "global", aby agregować statystyki oceniania globalnie przed ocenianiem. Użycie globalnych statystyk oceniania może zwiększyć opóźnienie zapytań wyszukiwania. |
Search |
Odpowiedź zawierająca wyniki wyszukiwania z indeksu. |
Search |
Określa, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne w celu zliczenia dokumentu jako dopasowania. |
Search |
Parametry filtrowania, sortowania, tworzenia aspektów, stronicowania i innych zachowań zapytań wyszukiwania. |
Search |
Zawiera dokument znaleziony przez zapytanie wyszukiwania oraz skojarzone metadane. |
Semantic |
|
Semantic |
Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić częściowe wyniki (wartość domyślna). |
Semantic |
Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji. |
Semantic |
Sposób użycia pola do procesu wzbogacania semantycznego (w pełni używanego, częściowo używanego lub nieużywanego) |
Semantic |
Typ odpowiedzi częściowej zwróconej dla semantycznego żądania klasyfikacji. |
Vector |
Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego. |
Vectorizable |
Parametry zapytania do użycia do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi być wektoryzowana. |
Vector |
Rodzaj wykonywanego zapytania wektorowego. |
AnswerResult
Odpowiedź to fragment tekstowy wyodrębniony z zawartości najbardziej odpowiednich dokumentów pasujących do zapytania. Odpowiedzi są wyodrębniane z najlepszych wyników wyszukiwania. Kandydaci odpowiedzi są oceniani i wybierane są najważniejsze odpowiedzi.
Nazwa | Typ | Opis |
---|---|---|
highlights |
string |
Ten sam fragment tekstu co we właściwości Text z wyróżnionymi frazami tekstowymi najbardziej istotnymi dla zapytania. |
key |
string |
Klucz dokumentu, z którego została wyodrębniona odpowiedź. |
score |
number |
Wartość wyniku reprezentuje sposób, w jaki odpowiedź jest odpowiednia dla zapytania względem innych odpowiedzi zwróconych dla zapytania. |
text |
string |
Fragment tekstu wyodrębniony z zawartości dokumentu jako odpowiedź. |
CaptionResult
Podpisy są najbardziej reprezentatywnymi fragmentami z dokumentu stosunkowo do zapytania wyszukiwania. Są one często używane jako podsumowanie dokumentu. Podpisy są zwracane tylko w przypadku zapytań typu "semantyka".
Nazwa | Typ | Opis |
---|---|---|
highlights |
string |
Ten sam fragment tekstu co we właściwości Text z wyróżnionymi frazami najbardziej istotnymi dla zapytania. |
text |
string |
Reprezentatywny fragment tekstu wyodrębniony z dokumentu najbardziej istotnego dla zapytania wyszukiwania. |
DocumentDebugInfo
Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania.
Nazwa | Typ | Opis |
---|---|---|
semantic |
Semantic |
Zawiera informacje o debugowaniu specyficzne dla semantycznych żądań klasyfikacji. |
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 |
Error |
Dodatkowe informacje o błędzie. |
code |
string |
Kod błędu. |
details |
Error |
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 |
Error |
Obiekt błędu. |
QueryAnswerType
Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania.
Nazwa | Typ | Opis |
---|---|---|
extractive |
string |
Wyodrębnia kandydatów odpowiedzi z zawartości dokumentów zwróconych w odpowiedzi na zapytanie wyrażone jako pytanie w języku naturalnym. |
none |
string |
Nie zwracaj odpowiedzi dla zapytania. |
QueryCaptionType
Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania.
Nazwa | Typ | Opis |
---|---|---|
extractive |
string |
Wyodrębnia podpisy z pasujących dokumentów zawierających fragmenty istotne dla zapytania wyszukiwania. |
none |
string |
Nie zwracaj podpisów dla zapytania. |
QueryDebugMode
Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania wyników wyszukiwania.
Nazwa | Typ | Opis |
---|---|---|
disabled |
string |
Nie zostaną zwrócone żadne informacje dotyczące debugowania zapytań. |
semantic |
string |
Umożliwia użytkownikowi dalsze eksplorowanie ponownie sklasyfikowanych wyników. |
QueryLanguage
Język zapytania.
Nazwa | Typ | Opis |
---|---|---|
ar-eg |
string |
Wartość języka zapytań dla języka arabskiego (Egipt). |
ar-jo |
string |
Wartość języka zapytań dla języka arabskiego (Jordania). |
ar-kw |
string |
Wartość języka zapytań dla języka arabskiego (Kuwejt). |
ar-ma |
string |
Wartość języka zapytań dla języka arabskiego (Maroko). |
ar-sa |
string |
Wartość języka zapytań dla języka arabskiego (Arabia Saudyjska). |
bg-bg |
string |
Wartość języka zapytań dla języka bułgarskiego (Bułgaria). |
bn-in |
string |
Wartość języka zapytań dla Bengali (Indie). |
ca-es |
string |
Wartość języka zapytań dla katalońskiego. |
cs-cz |
string |
Wartość języka zapytań dla języka czeskiego (Czechy). |
da-dk |
string |
Wartość języka zapytań dla języka duńskiego (Dania). |
de-de |
string |
Wartość języka zapytań dla języka niemieckiego (Niemcy). |
el-gr |
string |
Wartość języka zapytań dla języka greckiego (Grecja). |
en-au |
string |
Wartość języka zapytań dla języka angielskiego (Australia). |
en-ca |
string |
Wartość języka zapytań dla języka angielskiego (Kanada). |
en-gb |
string |
Wartość języka zapytań dla języka angielskiego (Wielka Brytania). |
en-in |
string |
Wartość języka zapytań dla języka angielskiego (Indie). |
en-us |
string |
Wartość języka zapytań dla języka angielskiego (Stany Zjednoczone). |
es-es |
string |
Wartość języka zapytań dla języka hiszpańskiego (Hiszpania). |
es-mx |
string |
Wartość języka zapytań dla języka hiszpańskiego (Meksyk). |
et-ee |
string |
Wartość języka zapytań dla estonii (Estonia). |
eu-es |
string |
Wartość języka zapytań dla języka basowego. |
fa-ae |
string |
Wartość języka zapytań dla perskiego (U.A.E.). |
fi-fi |
string |
Wartość języka zapytań dla fińskiego (Finlandia). |
fr-ca |
string |
Wartość języka zapytań dla języka francuskiego (Kanada). |
fr-fr |
string |
Wartość języka zapytań dla języka francuskiego (Francja). |
ga-ie |
string |
Wartość języka zapytań dla Irlandii (Irlandia). |
gl-es |
string |
Wartość języka zapytań dla Galicji. |
gu-in |
string |
Wartość języka zapytań dla Gujarati (Indie). |
he-il |
string |
Wartość języka zapytań dla języka hebrajskiego (Izrael). |
hi-in |
string |
Wartość języka zapytań dla języka Hindi (Indie). |
hr-ba |
string |
Wartość języka zapytań dla Chorwackiego (Bośnia i Hercegowina). |
hr-hr |
string |
Wartość języka zapytań dla Chorwackiego (Chorwacja). |
hu-hu |
string |
Wartość języka zapytań dla języka węgierskiego (Węgry). |
hy-am |
string |
Wartość języka zapytań dla ormiańskiego (Armenia). |
id-id |
string |
Wartość języka zapytań dla indonezyjskiego (Indonezja). |
is-is |
string |
Wartość języka zapytań dla islandii (Islandia). |
it-it |
string |
Wartość języka zapytań dla języka włoskiego (Włochy). |
ja-jp |
string |
Wartość języka zapytań dla języka japońskiego (Japonia). |
kn-in |
string |
Wartość języka zapytań dla Kannada (Indie). |
ko-kr |
string |
Wartość języka zapytań dla języka koreańskiego (Korea). |
lt-lt |
string |
Wartość języka zapytań dla Litewskiego (Litwa). |
lv-lv |
string |
Wartość języka zapytań dla łotewskiego (Łotwa). |
ml-in |
string |
Wartość języka zapytań dla Malajalam (Indie). |
mr-in |
string |
Wartość języka zapytań dla Marathi (Indie). |
ms-bn |
string |
Wartość języka zapytań dla Malay (Brunei Darussalam). |
ms-my |
string |
Wartość języka zapytań dla Malajczyka (Malezja). |
nb-no |
string |
Wartość języka zapytań dla języka norweskiego (Norwegia). |
nl-be |
string |
Wartość języka zapytań dla języka holenderskiego (Belgia). |
nl-nl |
string |
Wartość języka zapytań dla holenderskiego (Holandia). |
no-no |
string |
Wartość języka zapytań dla języka norweskiego (Norwegia). |
none |
string |
Nie określono języka zapytań. |
pa-in |
string |
Wartość języka zapytań dla Punjabi (Indie). |
pl-pl |
string |
Wartość języka zapytań dla języka polskiego (Polska). |
pt-br |
string |
Wartość języka zapytań dla języka portugalskiego (Brazylia). |
pt-pt |
string |
Wartość języka zapytań dla portugalskiego (Portugalia). |
ro-ro |
string |
Wartość języka zapytań dla rumuńskiego (Rumunia). |
ru-ru |
string |
Wartość języka zapytań dla języka rosyjskiego (Rosja). |
sk-sk |
string |
Wartość języka zapytań dla Słowaka (Słowacja). |
sl-sl |
string |
Wartość języka zapytań dla słowenii (Słowenia). |
sr-ba |
string |
Wartość języka zapytań dla serbskiego (Bośnia i Hercegowina). |
sr-me |
string |
Wartość języka zapytań dla serbskiego (Czarnogóra). |
sr-rs |
string |
Wartość języka zapytań dla serbskiego (Serbia). |
sv-se |
string |
Wartość języka zapytań dla języka szwedzkiego (Szwecja). |
ta-in |
string |
Wartość języka zapytań dla Tamil (Indie). |
te-in |
string |
Wartość języka zapytań dla telugu (Indie). |
th-th |
string |
Wartość języka zapytań dla języka tajskiego (Tajlandia). |
tr-tr |
string |
Wartość języka zapytań dla języka tureckiego (Turcja). |
uk-ua |
string |
Wartość języka zapytań dla języka ukraińskiego (Ukraina). |
ur-pk |
string |
Wartość języka zapytań dla Urdu (Pakistan). |
vi-vn |
string |
Wartość języka zapytań dla wietnamskiego (Viet Nam). |
zh-cn |
string |
Wartość języka zapytań dla języka chińskiego (Chiny). |
zh-tw |
string |
Wartość języka zapytań dla języka chińskiego (Tajwan). |
QueryResultDocumentRerankerInput
Nieprzetworzone ciągi łączone, które zostały wysłane do procesu wzbogacania semantycznego.
Nazwa | Typ | Opis |
---|---|---|
content |
string |
Nieprzetworzone ciągi dla pól zawartości, które były używane do wzbogacania semantycznego. |
keywords |
string |
Nieprzetworzone ciągi dla pól słów kluczowych, które były używane do wzbogacania semantycznego. |
title |
string |
Nieprzetworzone ciąg pola tytułu, które zostało użyte do wzbogacania semantycznego. |
QueryResultDocumentSemanticField
Opis pól, które zostały wysłane do procesu wzbogacania semantycznego, a także sposobu ich użycia
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa pola wysłanego do procesu wzbogacania semantycznego |
state |
Semantic |
Sposób użycia pola do procesu wzbogacania semantycznego (w pełni używanego, częściowo używanego lub nieużywanego) |
QuerySpellerType
Wartość określająca typ modułu sprawdzania pisowni, która ma służyć do sprawdzania pisowni poszczególnych terminów zapytania wyszukiwania.
Nazwa | Typ | Opis |
---|---|---|
lexicon |
string |
Moduł sprawdzania pisowni poprawia poszczególne terminy zapytania przy użyciu statycznego leksykonu dla języka określonego przez parametr queryLanguage. |
none |
string |
Nie włączono sprawdzania pisowni. |
QueryType
Określa składnię zapytania wyszukiwania. Wartość domyślna to "proste". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene i "semantyki", jeśli składnia zapytania nie jest potrzebna.
Nazwa | Typ | Opis |
---|---|---|
full |
string |
Używa pełnej składni zapytania Lucene do wyszukiwania. Search tekst jest interpretowany przy użyciu języka zapytań Lucene, który umożliwia wyszukiwanie specyficzne dla pola i ważone, a także inne zaawansowane funkcje. |
semantic |
string |
Najlepiej nadaje się do zapytań wyrażonych w języku naturalnym, w przeciwieństwie do słów kluczowych. Poprawia precyzję wyników wyszukiwania, ponownie klasyfikowanie najlepszych wyników wyszukiwania przy użyciu modelu klasyfikacji wyszkolonego w korpusie sieci Web. |
simple |
string |
Używa prostej składni zapytania do wyszukiwania. Search tekst jest interpretowany przy użyciu prostego języka zapytań, który umożliwia używanie symboli, takich jak +, * i "". Zapytania są domyślnie oceniane we wszystkich polach z możliwością wyszukiwania, chyba że określono parametr searchFields. |
RawVectorQuery
Parametry zapytania do użycia do wyszukiwania wektorów po podaniu wartości nieprzetworzonego wektora.
Nazwa | Typ | Opis |
---|---|---|
exhaustive |
boolean |
W przypadku wartości true wyzwala wyczerpujące wyszukiwanie najbliższego sąsiada w wszystkich wektorach w indeksie wektorów. Przydatne w scenariuszach, w których dokładne dopasowania są krytyczne, takie jak określanie wartości prawdy podstawowej. |
fields |
string |
Pola wektorów typu Collection(Edm.Single) do ujęć w wyszukiwanym wektorze. |
k |
integer |
Liczba najbliższych sąsiadów, które mają być zwracane jako najważniejsze trafienia. |
kind |
string:
vector |
Rodzaj wykonywanego zapytania wektorowego. |
oversampling |
number |
Współczynnik nadmiernego próbkowania. Wartość minimalna to 1. Zastępuje on parametr "defaultOversampling" skonfigurowany w definicji indeksu. Można go ustawić tylko wtedy, gdy wartość "rerankWithOriginalVectors" ma wartość true. Ten parametr jest dozwolony tylko wtedy, gdy metoda kompresji jest używana w polu wektora bazowego. |
vector |
number[] |
Wektorowa reprezentacja zapytania wyszukiwania. |
ScoringStatistics
Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszych opóźnień. Wartość domyślna to "local". Użyj wartości "global", aby agregować statystyki oceniania globalnie przed ocenianiem. Użycie globalnych statystyk oceniania może zwiększyć opóźnienie zapytań wyszukiwania.
Nazwa | Typ | Opis |
---|---|---|
global |
string |
Statystyki oceniania będą obliczane globalnie w celu uzyskania bardziej spójnego oceniania. |
local |
string |
Statystyki oceniania będą obliczane lokalnie pod kątem mniejszego opóźnienia. |
SearchDocumentsResult
Odpowiedź zawierająca wyniki wyszukiwania z indeksu.
Nazwa | Typ | Opis |
---|---|---|
@odata.count |
integer |
Łączna liczba wyników znalezionych przez operację wyszukiwania lub wartość null, jeśli liczba nie została żądana. Jeśli jest obecna, liczba może być większa niż liczba wyników w tej odpowiedzi. Może się to zdarzyć, jeśli używasz parametrów $top lub $skip lub jeśli zapytanie nie może zwrócić wszystkich żądanych dokumentów w jednej odpowiedzi. |
@odata.nextLink |
string |
Adres URL kontynuacji zwrócony, gdy zapytanie nie może zwrócić wszystkich żądanych wyników w jednej odpowiedzi. Ten adres URL umożliwia sformułowanie innego żądania GET lub POST Search w celu uzyskania następnej części odpowiedzi wyszukiwania. Pamiętaj, aby użyć tego samego czasownika (GET lub POST) co żądanie, które wygenerowało tę odpowiedź. |
@search.answers |
Answer |
Wyniki zapytania odpowiedzi dla operacji wyszukiwania; null, jeśli parametr zapytania odpowiedzi nie został określony lub ustawiony na wartość "none". |
@search.coverage |
number |
Wartość wskazująca wartość procentową indeksu, który został uwzględniony w zapytaniu, lub wartość null, jeśli minimalnaCoverage nie została określona w żądaniu. |
@search.facets |
object |
Wyniki zapytania aspektowego dla operacji wyszukiwania zorganizowane jako kolekcja zasobników dla każdego pola aspektowego; null, jeśli zapytanie nie zawiera żadnych wyrażeń aspektowych. |
@search.nextPageParameters |
Search |
Ładunek JSON kontynuacji zwrócony, gdy zapytanie nie może zwrócić wszystkich żądanych wyników w jednej odpowiedzi. Możesz użyć tego kodu JSON wraz z @odata.nextLink formułą innego żądania POST Search, aby uzyskać następną część odpowiedzi wyszukiwania. |
@search.semanticPartialResponseReason |
Semantic |
Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji. |
@search.semanticPartialResponseType |
Semantic |
Typ odpowiedzi częściowej zwróconej dla semantycznego żądania klasyfikacji. |
value |
Search |
Sekwencja wyników zwróconych przez zapytanie. |
SearchMode
Określa, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne w celu zliczenia dokumentu jako dopasowania.
Nazwa | Typ | Opis |
---|---|---|
all |
string |
Wszystkie terminy wyszukiwania muszą być dopasowane w celu zliczenia dokumentu jako dopasowania. |
any |
string |
Aby dokument był zgodny, należy dopasować dowolne terminy wyszukiwania. |
SearchRequest
Parametry filtrowania, sortowania, tworzenia aspektów, stronicowania i innych zachowań zapytań wyszukiwania.
Nazwa | Typ | Opis |
---|---|---|
answers |
Query |
Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania. |
captions |
Query |
Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania. |
count |
boolean |
Wartość określająca, czy pobrać łączną liczbę wyników. Wartość domyślna to false. Ustawienie tej wartości na wartość true może mieć wpływ na wydajność. Zwróć uwagę, że zwrócona liczba jest przybliżeniem. |
debug |
Query |
Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania wyników sklasyfikowanych ponownie. |
facets |
string[] |
Lista wyrażeń aspektowych, które mają być stosowane do zapytania wyszukiwania. Każde wyrażenie aspektu zawiera nazwę pola, po którym opcjonalnie następuje rozdzielona przecinkami lista par name:value. |
filter |
string |
Wyrażenie OData $filter, które ma być stosowane do zapytania wyszukiwania. |
highlight |
string |
Rozdzielona przecinkami lista nazw pól używanych do wyróżniania trafień. Do wyróżniania trafień można używać tylko pól z możliwością wyszukiwania. |
highlightPostTag |
string |
Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z funkcją highlightPreTag. Wartość domyślna to </em>. |
highlightPreTag |
string |
Tag ciągu, który jest poprzedzany do wyróżniania. Należy ustawić element z wyróżnionym elementemPostTag. Wartość domyślna to <em>. |
minimumCoverage |
number |
Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem wyszukiwania 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 100. |
orderby |
string |
Rozdzielona przecinkami lista wyrażeń $orderby OData, według których należy posortować wyniki. Każde wyrażenie może być nazwą pola lub wywołaniem funkcji geo.distance() lub search.score(). Po każdym wyrażeniu można wskazać rosnąco lub desc wskazując malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki meczów dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania jest malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby. |
queryLanguage |
Query |
Wartość określająca język zapytania wyszukiwania. |
queryType |
Query |
Wartość określająca składnię zapytania wyszukiwania. Wartość domyślna to "proste". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene. |
scoringParameters |
string[] |
Lista wartości parametrów, które mają być używane w funkcjach oceniania (na przykład referencePointParameter) przy użyciu formatu name-values. Jeśli na przykład profil oceniania definiuje funkcję z parametrem o nazwie "mylocation", ciąg parametru będzie "mylocation--122.2,44.8" (bez cudzysłowów). |
scoringProfile |
string |
Nazwa profilu oceniania w celu oceny wyników dopasowania pasujących dokumentów w celu sortowania wyników. |
scoringStatistics |
Scoring |
Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszych opóźnień. Wartość domyślna to "local". Użyj wartości "global", aby agregować statystyki oceniania globalnie przed ocenianiem. Użycie globalnych statystyk oceniania może zwiększyć opóźnienie zapytań wyszukiwania. |
search |
string |
Wyrażenie zapytania wyszukiwania pełnotekstowego; Użyj wartości "*" lub pomiń ten parametr, aby dopasować wszystkie dokumenty. |
searchFields |
string |
Rozdzielona przecinkami lista nazw pól, do których ma być włączona funkcja wyszukiwania pełnotekstowego. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól każdego wyrażenia wyszukiwania pól mają pierwszeństwo przed wszelkimi nazwami pól wymienionymi w tym parametrze. |
searchMode |
Search |
Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne w celu zliczenia dokumentu jako dopasowania. |
select |
string |
Rozdzielona przecinkami lista pól do pobrania. Jeśli nieokreślone, zostaną uwzględnione wszystkie pola oznaczone jako możliwe do pobrania w schemacie. |
semanticConfiguration |
string |
Nazwa semantycznej konfiguracji, która będzie używana podczas przetwarzania dokumentów dla zapytań typu semantycznego. |
semanticErrorHandling |
Semantic |
Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić częściowe wyniki (wartość domyślna). |
semanticFields |
string |
Rozdzielona przecinkami lista nazw pól używanych do klasyfikacji semantycznej. |
semanticMaxWaitInMilliseconds |
integer |
Umożliwia użytkownikowi ustawienie górnej granicy czasu potrzebny na semantycznie wzbogacanie w celu zakończenia przetwarzania przed niepowodzeniem żądania. |
semanticQuery |
string |
Umożliwia ustawienie oddzielnego zapytania wyszukiwania, które będzie używane wyłącznie do semantycznego odrywania, semantycznych podpisów i semantycznych odpowiedzi. Jest przydatne w scenariuszach, w których istnieje potrzeba użycia różnych zapytań między fazą pobierania podstawowego i klasyfikacji oraz semantyczną fazą L2. |
sessionId |
string |
Wartość, która ma być używana do tworzenia sesji lepkiej, co może pomóc uzyskać bardziej spójne wyniki. Tak długo, jak jest używany ten sam identyfikator sesji, zostanie podjęta najlepsza próba ukierunkowana na ten sam zestaw replik. Należy pamiętać, że ponowne użycie tych samych wartości sessionID wielokrotnie może zakłócać równoważenie obciążenia żądań między replikami i niekorzystnie wpływać na wydajność usługi wyszukiwania. Wartość używana jako sessionId nie może rozpoczynać się od znaku "_". |
skip |
integer |
Liczba wyników wyszukiwania do pominięcia. Ta wartość nie może być większa niż 100 000. Jeśli musisz skanować dokumenty w sekwencji, ale nie można użyć pomijania ze względu na to ograniczenie, rozważ użycie kolejności na całkowicie uporządkowanym kluczu i filtrze za pomocą zapytania zakresu. |
speller |
Query |
Wartość określająca typ modułu sprawdzania pisowni, która ma służyć do sprawdzania pisowni poszczególnych terminów zapytania wyszukiwania. |
top |
integer |
Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania wyników wyszukiwania po stronie klienta. Jeśli wyniki są obcięte z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, który może służyć do wystawiania innego żądania Search dla następnej strony wyników. |
vectorFilterMode |
Vector |
Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego. Wartość domyślna to "preFilter". |
vectorQueries |
VectorQuery[]:
|
Parametry zapytania dla zapytań wektorowych i hybrydowych wyszukiwania. |
SearchResult
Zawiera dokument znaleziony przez zapytanie wyszukiwania oraz skojarzone metadane.
Nazwa | Typ | Opis |
---|---|---|
@search.captions |
Caption |
Podpisy są najbardziej reprezentatywnymi fragmentami z dokumentu stosunkowo do zapytania wyszukiwania. Są one często używane jako podsumowanie dokumentu. Podpisy są zwracane tylko w przypadku zapytań typu "semantyka". |
@search.documentDebugInfo |
Document |
Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania. |
@search.highlights |
object |
Fragmenty tekstu z dokumentu wskazujące pasujące terminy wyszukiwania uporządkowane według każdego odpowiedniego pola; null, jeśli wyróżnianie trafień nie zostało włączone dla zapytania. |
@search.rerankerScore |
number |
Wynik istotności obliczony przez semantyczny rangator dla najlepszych wyników wyszukiwania. Search wyniki są posortowane według funkcji RerankerScore, a następnie według wyniku. Funkcja RerankerScore jest zwracana tylko w przypadku zapytań typu "semantyka". |
@search.score |
number |
Wynik istotności dokumentu w porównaniu z innymi dokumentami zwracanym przez zapytanie. |
SemanticDebugInfo
Nazwa | Typ | Opis |
---|---|---|
contentFields |
Query |
Pola zawartości, które zostały wysłane do procesu wzbogacania semantycznego, a także sposób ich użycia |
keywordFields |
Query |
Pola słów kluczowych, które zostały wysłane do procesu wzbogacania semantycznego, a także sposób ich użycia |
rerankerInput |
Query |
Nieprzetworzone ciągi łączone, które zostały wysłane do procesu wzbogacania semantycznego. |
titleField |
Query |
Pole tytułu wysłane do procesu wzbogacania semantycznego, a także sposób jego użycia |
SemanticErrorMode
Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić częściowe wyniki (wartość domyślna).
Nazwa | Typ | Opis |
---|---|---|
fail |
string |
Jeśli wystąpi wyjątek podczas kroku przetwarzania semantycznego, zapytanie zakończy się niepowodzeniem i zwróci odpowiedni kod HTTP w zależności od błędu. |
partial |
string |
Jeśli przetwarzanie semantyczne zakończy się niepowodzeniem, wyniki częściowe nadal zwracają. Definicja częściowych wyników zależy od tego, jaki krok semantyczny zakończył się niepowodzeniem i jaki był powód niepowodzenia. |
SemanticErrorReason
Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji.
Nazwa | Typ | Opis |
---|---|---|
capacityOverloaded |
string |
Żądanie zostało ograniczone. Zwracano tylko wyniki podstawowe. |
maxWaitExceeded |
string |
Jeśli ustawiono wartość "semanticMaxWaitInMilliseconds", a czas trwania przetwarzania semantycznego przekroczył ten wartość. Zwracano tylko wyniki podstawowe. |
transient |
string |
Co najmniej jeden krok procesu semantycznego zakończył się niepowodzeniem. |
SemanticFieldState
Sposób użycia pola do procesu wzbogacania semantycznego (w pełni używanego, częściowo używanego lub nieużywanego)
Nazwa | Typ | Opis |
---|---|---|
partial |
string |
Pole było częściowo używane do wzbogacania semantycznego. |
unused |
string |
Pole nie było używane do wzbogacania semantycznego. |
used |
string |
Pole było w pełni używane do wzbogacania semantycznego. |
SemanticSearchResultsType
Typ odpowiedzi częściowej zwróconej dla semantycznego żądania klasyfikacji.
Nazwa | Typ | Opis |
---|---|---|
baseResults |
string |
Wyniki bez semantycznego wzbogacania lub ponownego korcenia. |
rerankedResults |
string |
Wyniki zostały ponownie sklasyfikowane za pomocą modelu reranker i będą zawierać podpisy semantyczne. Nie będą zawierać żadnych odpowiedzi, wyróżniania odpowiedzi ani wyróżniania podpis. |
VectorFilterMode
Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego.
Nazwa | Typ | Opis |
---|---|---|
postFilter |
string |
Filtr zostanie zastosowany po zwracaniu zestawu wyników wektorów kandydata. W zależności od wyboru filtru może to spowodować mniej wyników niż żądane przez parametr "k". |
preFilter |
string |
Filtr zostanie zastosowany przed zapytaniem wyszukiwania. |
VectorizableTextQuery
Parametry zapytania do użycia do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi być wektoryzowana.
Nazwa | Typ | Opis |
---|---|---|
exhaustive |
boolean |
W przypadku wartości true wyzwala wyczerpujące wyszukiwanie najbliższego sąsiada w wszystkich wektorach w indeksie wektorów. Przydatne w scenariuszach, w których dokładne dopasowania są krytyczne, takie jak określanie wartości prawdy podstawowej. |
fields |
string |
Pola wektorów typu Collection(Edm.Single) do ujęć w wyszukiwanym wektorze. |
k |
integer |
Liczba najbliższych sąsiadów, które mają być zwracane jako najważniejsze trafienia. |
kind |
string:
text |
Rodzaj wykonywanego zapytania wektorowego. |
oversampling |
number |
Współczynnik nadmiernego próbkowania. Wartość minimalna to 1. Zastępuje on parametr "defaultOversampling" skonfigurowany w definicji indeksu. Można go ustawić tylko wtedy, gdy wartość "rerankWithOriginalVectors" ma wartość true. Ten parametr jest dozwolony tylko wtedy, gdy metoda kompresji jest używana w polu wektora bazowego. |
text |
string |
Tekst, który ma zostać wektoryzowany w celu wykonania zapytania wyszukiwania wektorowego. |
VectorQueryKind
Rodzaj wykonywanego zapytania wektorowego.
Nazwa | Typ | Opis |
---|---|---|
text |
string |
Zapytanie wektorowe, w którym podano wartość tekstową, która musi być wektoryzowana. |
vector |
string |
Zapytanie wektorowe, w którym podano wartość nieprzetworzonego wektora. |