Documents - Search Post
Wyszukuje dokumenty w indeksie.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-11-01
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 z żądaniem, aby ułatwić debugowanie. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
answers |
Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania. |
|
captions |
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. |
facets |
string[] |
Lista wyrażeń aspektów, 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 $filter OData, które ma być stosowane do zapytania wyszukiwania. |
highlight |
string |
Rozdzielona przecinkami lista nazw pól do użycia w przypadku wyróżnień 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 elementem highlightPreTag. Wartość domyślna to </em>. |
highlightPreTag |
string |
Tag ciągu, który jest poprzedzany wyróżniania trafień. Należy ustawić element z elementem highlightPostTag. 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ń OData $orderby, według których mają być sortowane 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ącym malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki dopasowań 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. |
queryType |
Wartość określająca składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene. |
|
scoringParameters |
string[] |
Lista wartości parametrów do użycia 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 to "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 |
Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentu) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszego opóźnienia. Wartość domyślna to "local". Użyj wartości "global", aby zagregować 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ć ograniczone wyszukiwanie pełnotekstowe. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól poszczególnych wyrażeń wyszukiwania pól mają pierwszeństwo przed wszelkimi nazwami pól wymienionymi w tym parametrze. |
searchMode |
Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być dopasowane, aby zliczyć dokument jako dopasowanie. |
|
select |
string |
Rozdzielona przecinkami lista pól do pobrania. Jeśli nie zostanie określona, zostaną uwzględnione wszystkie pola oznaczone jako możliwe do pobrania w schemacie. |
semanticConfiguration |
string |
Nazwa konfiguracji semantycznej, która będzie używana podczas przetwarzania dokumentów dla zapytań semantycznych typów. |
semanticErrorHandling |
Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem (domyślne/bieżące zachowanie) lub zwrócić częściowe wyniki. |
|
semanticMaxWaitInMilliseconds |
integer |
Umożliwia użytkownikowi ustawienie górnej granicy czasu, jaki zajmuje ukończenie przetwarzania semantycznego wzbogacenia, zanim żądanie zakończy się niepowodzeniem. |
sessionId |
string |
Wartość, która ma zostać użyta do utworzenia sesji sticky, co może pomóc w uzyskaniu bardziej spójnych wyników. Tak długo, jak jest używany ten sam identyfikator sessionId, zostanie podjęta próba osiągnięcia tego samego zestawu replik. Należy uważać, ż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ć polecenia skip z powodu tego ograniczenia, rozważ użycie polecenia orderby na całkowicie uporządkowanym kluczu i filtrowanie z zapytaniem zakresu. |
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ą obcinane z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, który może służyć do wystawiania innego żądania wyszukiwania dla następnej strony wyników. |
vectorFilterMode |
Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego. Wartość domyślna to "preFilter" dla nowych indeksów. |
|
vectorQueries | VectorQuery[]: |
Parametry zapytania dla zapytań wektorowych i hybrydowych wyszukiwania. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Odpowiedź zawierająca dokumenty zgodne z kryteriami wyszukiwania. |
|
Other Status Codes |
Odpowiedź na błąd. |
Przykłady
Search |
Search |
SearchIndexSearchDocumentsPost
Sample Request
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01
{
"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,category,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
}
],
"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=2023-11-01"
}
SearchIndexSearchDocumentsSemanticPost
Sample Request
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01
{
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780
}
Sample Response
{
"@odata.count": 25,
"@search.answers": [
{
"key": "4123",
"text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).",
"highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).",
"score": 0.94639826
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"value": [
{
"@search.score": 0.5479723,
"@search.rerankerScore": 1.0321671911515296,
"@search.captions": [
{
"text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
"highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
}
],
"id": "4123",
"title": "Earth Atmosphere",
"content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
"locations": [
"Pacific Northwest",
"North America",
"Vancouver"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01"
}
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 dla zapytań typu |
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 |
Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene. |
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ść dokumentu) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszego opóźnienia. Wartość domyślna to "local". Użyj wartości "global", aby zagregować 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 |
Opisuje warunek błędu interfejsu API. |
Search |
Określa, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne, aby zliczyć dokument jako dopasowanie. |
Search |
Parametry filtrowania, sortowania, tworzenia aspektów, stronicowania i innych zachowań zapytań wyszukiwania. |
Search |
Zawiera dokument znaleziony przez zapytanie wyszukiwania oraz skojarzone metadane. |
Semantic |
Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem (domyślne/bieżące zachowanie) lub zwrócić częściowe wyniki. |
Semantic |
Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji. |
Semantic |
Typ odpowiedzi częściowej zwróconej dla semantycznego żądania klasyfikacji. |
Vector |
Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego. |
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 dla zapytań typu semantic
.
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 odpowiedni dla zapytania wyszukiwania. |
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, które zawierają fragmenty istotne dla zapytania wyszukiwania. |
none |
string |
Nie zwracaj podpisów dla zapytania. |
QueryType
Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene.
Nazwa | Typ | Opis |
---|---|---|
full |
string |
Używa pełnej składni zapytań Lucene do wyszukiwania. Tekst wyszukiwania jest interpretowany przy użyciu języka zapytań Lucene, który umożliwia wyszukiwanie specyficzne dla pola i ważone, a także inne funkcje zaawansowane. |
semantic |
string |
Najlepiej nadaje się do zapytań wyrażonych w języku naturalnym, w przeciwieństwie do słów kluczowych. Zwiększa dokładność wyników wyszukiwania przez ponowne klasyfikowanie najlepszych wyników wyszukiwania przy użyciu modelu klasyfikacji wytrenowanego w korpusie internetowym. |
simple |
string |
Używa prostej składni zapytania do wyszukiwania. Tekst wyszukiwania 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. |
vector |
number[] |
Wektorowa reprezentacja zapytania wyszukiwania. |
ScoringStatistics
Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentu) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszego opóźnienia. Wartość domyślna to "local". Użyj wartości "global", aby zagregować 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. Możesz użyć tego adresu URL, aby sformułować kolejne żądanie GET lub POST Search, aby uzyskać następną część odpowiedzi wyszukiwania. Pamiętaj, aby użyć tego samego czasownika (GET lub POST) co żądanie, które wygenerowało tę odpowiedź. |
@search.answers |
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 |
Ł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 wyszukiwania POST, aby uzyskać następną część odpowiedzi wyszukiwania. |
|
@search.semanticPartialResponseReason |
Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji. |
|
@search.semanticPartialResponseType |
Typ odpowiedzi częściowej zwróconej dla semantycznego żądania klasyfikacji. |
|
value |
Sekwencja wyników zwróconych przez zapytanie. |
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. |
SearchMode
Określa, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne, aby zliczyć dokument jako dopasowanie.
Nazwa | Typ | Opis |
---|---|---|
all |
string |
Wszystkie terminy wyszukiwania muszą być dopasowane w celu zliczenia dokumentu jako dopasowania. |
any |
string |
Aby można było policzyć dokument jako dopasowanie, należy dopasować dowolne terminy wyszukiwania. |
SearchRequest
Parametry filtrowania, sortowania, tworzenia aspektów, stronicowania i innych zachowań zapytań wyszukiwania.
Nazwa | Typ | Opis |
---|---|---|
answers |
Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania. |
|
captions |
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. |
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. |
queryType |
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 |
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 |
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 |
Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem (domyślne/bieżące zachowanie) lub zwrócić częściowe wyniki. |
|
semanticMaxWaitInMilliseconds |
integer |
Umożliwia użytkownikowi ustawienie górnej granicy czasu potrzebny na semantycznie wzbogacanie w celu zakończenia przetwarzania przed niepowodzeniem żądania. |
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. |
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 wyszukiwania dla następnej strony wyników. |
vectorFilterMode |
Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego. Wartość domyślna to "preFilter" dla nowych indeksów. |
|
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 |
Podpisy są najbardziej reprezentatywnymi fragmentami z dokumentu stosunkowo do zapytania wyszukiwania. Są one często używane jako podsumowanie dokumentu. Podpisy są zwracane tylko dla zapytań typu |
|
@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. Wyniki wyszukiwania są posortowane według funkcji RerankerScore, a następnie według wyniku. Funkcja RerankerScore jest zwracana tylko dla zapytań typu |
@search.score |
number |
Wynik istotności dokumentu w porównaniu z innymi dokumentami zwracanym przez zapytanie. |
SemanticErrorMode
Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem (domyślne/bieżące zachowanie) lub zwrócić częściowe wyniki.
Nazwa | Typ | Opis |
---|---|---|
fail |
string |
Jeśli podczas kroku przetwarzania semantycznego wystąpi wyjątek, 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 będą zwracane. Definicja częściowych wyników zależy od tego, jaki krok semantyczny zakończył się niepowodzeniem i jaka była przyczyna niepowodzenia. |
SemanticErrorReason
Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji.
Nazwa | Typ | Opis |
---|---|---|
capacityOverloaded |
string |
Żądanie zostało ograniczone. Zwrócono tylko wyniki podstawowe. |
maxWaitExceeded |
string |
Jeśli |
transient |
string |
Co najmniej jeden krok procesu semantycznego zakończył się niepowodzeniem. |
SemanticSearchResultsType
Typ odpowiedzi częściowej zwróconej dla semantycznego żądania klasyfikacji.
Nazwa | Typ | Opis |
---|---|---|
baseResults |
string |
Wyniki bez wzbogacania semantycznego lub ponownego korbowania. |
rerankedResults |
string |
Wyniki zostały ponownie sklasyfikowane za pomocą modelu do ponownego generowania i będą zawierać transkrybacje 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 zwróceniu zestawu wyników wektorów. W zależności od selektywności filtru może to spowodować mniejszą liczbę wyników niż zażądano za pomocą parametru "k". |
preFilter |
string |
Filtr zostanie zastosowany przed zapytaniem wyszukiwania. |
VectorQueryKind
Rodzaj wykonywanego zapytania wektorowego.
Nazwa | Typ | Opis |
---|---|---|
vector |
string |
Zapytanie wektorowe, w którym podano nieprzetworzone wartości wektora. |