Documents - Search Post

Service:

Search Service

API Version:

2023-10-01-Preview

Wyszukuje dokumenty w indeksie.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-10-01-Preview

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	Typ	Opis
answers	QueryAnswerType	Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania.
captions	QueryCaptionType	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	QueryDebugMode	Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania ponownie sklasyfikowanych wyników.
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	QueryLanguage	Wartość określająca język zapytania wyszukiwania.
queryType	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 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	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ć 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	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	SemanticErrorMode	Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić częściowe wyniki (ustawienie domyślne).
semanticFields	string	Rozdzielona przecinkami lista nazw pól używanych do klasyfikacji semantycznej.
semanticMaxWaitInMilliseconds	integer	Umożliwia użytkownikowi ustawienie górnej granicy czasu, jaki zajmuje ukończenie przetwarzania semantycznego wzbogacenia, zanim żądanie zakończy się niepowodzeniem.
semanticQuery	string	Umożliwia ustawienie oddzielnego zapytania wyszukiwania, które będzie używane wyłącznie do semantycznego korbowania, 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 fazą semantyczną 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ć polecenia skip z powodu tego ograniczenia, rozważ użycie polecenia orderby na całkowicie uporządkowanym kluczu i filtrowanie z zapytaniem zakresu.
speller	QuerySpellerType	Wartość określająca typ sprawdzania pisowni, która ma być używana do sprawdzania pisowni poszczególnych terminów kwerendy 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ą 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	VectorFilterMode	Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego. Wartość domyślna to "preFilter".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametry zapytania dla zapytań wektorowych i hybrydowych wyszukiwania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchDocumentsResult	Odpowiedź zawierająca dokumenty zgodne z kryteriami wyszukiwania.
Other Status Codes	SearchError	Odpowiedź na błąd.

Przykłady

SearchIndexSearchDocumentsPost

Sample Request

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-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
    }
  ],
  "vectorFilterMode": "preFilter"
}

Sample Response

Status code:

200

{
  "@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-10-01-Preview"
}

Definicje

Nazwa	Opis
AnswerResult	Odpowiedź to fragment tekstu 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.
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".
DocumentDebugInfo	Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania.
QueryAnswerType	Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania.
QueryCaptionType	Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania.
QueryDebugMode	Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania wyników wyszukiwania.
QueryLanguage	Język zapytania.
QueryResultDocumentRerankerInput	Nieprzetworzone ciągi łączone, które zostały wysłane do procesu wzbogacania semantycznego.
QueryResultDocumentSemanticField	Opis pól, które zostały wysłane do procesu wzbogacania semantycznego, a także sposobu ich użycia
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.
QueryType	Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj ciągu "full", jeśli zapytanie używa składni zapytań Lucene i "semantycznej", jeśli składnia zapytania nie jest potrzebna.
RawVectorQuery	Parametry zapytania, które mają być używane do wyszukiwania wektorowego po podaniu nieprzetworzonej wartości wektora.
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.
SearchDocumentsResult	Odpowiedź zawierająca wyniki wyszukiwania z indeksu.
SearchError	Opisuje warunek błędu dla interfejsu API.
SearchMode	Określa, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne, aby zliczyć dokument jako dopasowanie.
SearchRequest	Parametry filtrowania, sortowania, tworzenia aspektów, stronicowania i innych zachowań zapytań wyszukiwania.
SearchResult	Zawiera dokument znaleziony przez zapytanie wyszukiwania oraz skojarzone metadane.
SemanticDebugInfo
SemanticErrorMode	Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić częściowe wyniki (ustawienie domyślne).
SemanticErrorReason	Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji.
SemanticFieldState	Sposób użycia pola do procesu wzbogacania semantycznego (w pełni używanego, częściowo używanego lub nieużywanego)
SemanticSearchResultsType	Typ odpowiedzi częściowej zwróconej dla semantycznego żądania klasyfikacji.
VectorFilterMode	Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego.
VectorizableTextQuery	Parametry zapytania do użycia do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi zostać wektoryzowana.
VectorQueryKind	Rodzaj wykonywanego zapytania wektorowego.

AnswerResult

Odpowiedź to fragment tekstu 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, jak istotna jest odpowiedź na zapytanie 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	SemanticDebugInfo	Zawiera informacje o debugowaniu specyficzne dla semantycznych żądań klasyfikacji.

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 debugowania zapytania.
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 zapytania dla języka arabskiego (Jordania).
ar-kw	string	Wartość języka zapytania dla języka arabskiego (Kuwejt).
ar-ma	string	Wartość języka zapytania 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 Chorwacji (Bośnia i Hercegowina).
hr-hr	string	Wartość języka zapytań dla Języka 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 języka 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 malajskiego (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 języka 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 kwerend dla języka polskiego (Polska).
pt-br	string	Wartość języka zapytania dla języka portugalskiego (Brazylia).
pt-pt	string	Wartość języka zapytań dla języka portugalskiego (Portugalia).
ro-ro	string	Wartość języka zapytań dla języka 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 języka słoweńskiego (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	SemanticFieldState	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 "simple". Użyj ciągu "full", jeśli zapytanie używa składni zapytań Lucene i "semantycznej", jeśli składnia zapytania nie jest potrzebna.

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, które mają być używane do wyszukiwania wektorowego po podaniu nieprzetworzonej wartości wektora.

Nazwa	Typ	Opis
exhaustive	boolean	Jeśli to prawda, wyzwala wyczerpujące wyszukiwanie k najbliższych sąsiadów we 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 wektorowe typu Collection(Edm.Single), które mają zostać uwzględnione 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ę tak 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 zwracany, gdy zapytanie nie może zwrócić wszystkich żądanych wyników w jednej odpowiedzi. Możesz użyć tego adresu URL do sformułowania innego żądania GET lub POST Search, aby uzyskać następną część odpowiedzi wyszukiwania. Upewnij się, że używasz tego samego zlecenia (GET lub POST) co żądanie, które wygenerowało tę odpowiedź.
@search.answers	AnswerResult[]	Odpowiedzi na wyniki zapytania 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 w żądaniu nie określono wartości minimalnejCoverage.
@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ń aspektów.
@search.nextPageParameters	SearchRequest	Ładunek JSON kontynuacji zwracany, gdy zapytanie nie może zwrócić wszystkich żądanych wyników w jednej odpowiedzi. Możesz użyć tego kodu JSON wraz z elementem @odata.nextLink , aby sformułować kolejne żądanie wyszukiwania POST, aby uzyskać następną część odpowiedzi wyszukiwania.
@search.semanticPartialResponseReason	SemanticErrorReason	Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji.
@search.semanticPartialResponseType	SemanticSearchResultsType	Typ odpowiedzi częściowej zwróconej dla semantycznego żądania klasyfikacji.
value	SearchResult[]	Sekwencja wyników zwróconych przez zapytanie.

SearchError

Opisuje warunek błędu dla 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.

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	QueryAnswerType	Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania.
captions	QueryCaptionType	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	QueryDebugMode	Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania ponownie sklasyfikowanych wyników.
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.
queryLanguage	QueryLanguage	Wartość określająca język zapytania wyszukiwania.
queryType	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	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	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	SemanticErrorMode	Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić częściowe wyniki (ustawienie domyślne).
semanticFields	string	Rozdzielona przecinkami lista nazw pól używanych do klasyfikacji semantycznej.
semanticMaxWaitInMilliseconds	integer	Umożliwia użytkownikowi ustawienie górnej granicy czasu, jaki zajmuje ukończenie przetwarzania semantycznego wzbogacenia, zanim żądanie zakończy się niepowodzeniem.
semanticQuery	string	Umożliwia ustawienie oddzielnego zapytania wyszukiwania, które będzie używane wyłącznie do semantycznego korbowania, 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 fazą semantyczną L2.
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.
speller	QuerySpellerType	Wartość określająca typ sprawdzania pisowni, która ma być używana do sprawdzania pisowni poszczególnych terminów kwerendy 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ą 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	VectorFilterMode	Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego. Wartość domyślna to "preFilter".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametry zapytania dla zapytań wektorowych i hybrydowych wyszukiwania.

SearchResult

Zawiera dokument znaleziony przez zapytanie wyszukiwania oraz skojarzone metadane.

Nazwa	Typ	Opis
@search.captions	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".
@search.documentDebugInfo	DocumentDebugInfo[]	Zawiera informacje o debugowaniu, których można użyć do dalszego eksplorowania wyników wyszukiwania.
@search.highlights	object	Fragmenty tekstu z dokumentu, które wskazują 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 ranga dla najlepszych wyników wyszukiwania. Wyniki wyszukiwania są sortowane najpierw według rerankerScore, a następnie według wyniku. Funkcja RerankerScore jest zwracana tylko dla zapytań typu "semantyka".
@search.score	number	Wynik istotności dokumentu w porównaniu z innymi dokumentami zwracanym przez zapytanie.

SemanticDebugInfo

Nazwa	Typ	Opis
contentFields	QueryResultDocumentSemanticField[]	Pola zawartości, które zostały wysłane do procesu wzbogacania semantycznego, a także sposób ich użycia
keywordFields	QueryResultDocumentSemanticField[]	Pola słów kluczowych, które zostały wysłane do procesu wzbogacania semantycznego, a także sposób ich użycia
rerankerInput	QueryResultDocumentRerankerInput	Nieprzetworzone ciągi łączone, które zostały wysłane do procesu wzbogacania semantycznego.
titleField	QueryResultDocumentSemanticField	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 (ustawienie domyślne).

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 ustawiono wartość "semanticMaxWaitInMilliseconds", a czas trwania przetwarzania semantycznego przekroczył wartość. Zwrócono 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 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 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 zostać wektoryzowana.

Nazwa	Typ	Opis
exhaustive	boolean	Jeśli to prawda, wyzwala wyczerpujące wyszukiwanie k najbliższych sąsiadów we 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 wektorowe typu Collection(Edm.Single), które mają zostać uwzględnione 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.
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.