Documents - Search Get

Usługa:: Search Service

Wersja interfejsu API:: 2024-03-01-Preview

Wyszukuje dokumenty w indeksie.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-03-01-Preview

Z parametrami opcjonalnymi:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&semanticQuery={semanticQuery}&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&debug={debug}&searchFields={searchFields}&queryLanguage={queryLanguage}&speller={speller}&answers={answers}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&captions={captions}&semanticFields={semanticFields}&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.
indexName	path	True	string	Nazwa indeksu.
api-version	query	True	string	Wersja interfejsu API klienta.
$count	query		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 zwracana liczba jest przybliżeniem.
$filter	query		string	Wyrażenie $filter OData, które ma być stosowane do zapytania wyszukiwania.
$orderby	query		string[]	Lista wyrażeń $orderby OData, 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, a desc wskazać malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki dopasowania dokumentów. Jeśli nie określono opcji OrderBy, domyślna kolejność sortowania malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby.
$select	query		string[]	Lista pól do pobrania. W przypadku nieokreślonego dołączono wszystkie pola oznaczone jako możliwe do pobrania w schemacie.
$skip	query		integer (int32)	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ć $skip z powodu tego ograniczenia, rozważ użycie $orderby na całkowicie uporządkowanym kluczu i $filter z zapytaniem zakresu.
$top	query		integer (int32)	Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania po stronie klienta wyników wyszukiwania. Jeśli wyniki zostaną 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.
answers	query		QueryAnswerType	Ten parametr jest prawidłowy tylko wtedy, gdy typ zapytania jest `semantic`. W przypadku ustawienia zapytanie zwraca odpowiedzi wyodrębnione z kluczowych fragmentów w najwyższych dokumentach. Liczbę zwróconych odpowiedzi można skonfigurować, dołączając znak potoku `\|` a następnie opcję `count-<number of answers>` po wartości parametru odpowiedzi, na przykład `extractive\|count-3`. Liczba domyślna to 1. Próg ufności można skonfigurować, dołączając znak potoku `\|` a następnie opcję `threshold-<confidence threshold>` po wartości parametru odpowiedzi, na przykład `extractive\|threshold-0.9`. Domyślny próg to 0,7.
captions	query		QueryCaptionType	Ten parametr jest prawidłowy tylko wtedy, gdy typ zapytania jest `semantic`. W przypadku ustawienia zapytanie zwraca podpisy wyodrębnione z kluczowych fragmentów w najwyżej sklasyfikowanych dokumentach. Gdy dla opcji Podpisy ustawiono wartość `extractive`, wyróżnianie jest domyślnie włączone i można je skonfigurować, dołączając znak potoku `\|` a następnie opcję `highlight-<true/false>`, taką jak `extractive\|highlight-true`. Wartość domyślna to `None`.
debug	query		QueryDebugMode	Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania wyników wyszukiwania.
facet	query		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.
highlight	query		string[]	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	query		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	query		string	Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. Wartość domyślna to <>.
minimumCoverage	query		number (double)	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.
queryLanguage	query		QueryLanguage	Język zapytania.
queryType	query		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.
scoringParameter	query		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 to "mylocation--122.2,44.8" (bez cudzysłowów).
scoringProfile	query		string	Nazwa profilu oceniania do oceny wyników dla pasujących dokumentów w celu sortowania wyników.
scoringStatistics	query		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.
search	query		string	Wyrażenie zapytania wyszukiwania pełnotekstowego; Użyj wartości "*" lub pomiń ten parametr, aby dopasować wszystkie dokumenty.
searchFields	query		string[]	Lista nazw pól, do których ma być objęte wyszukiwanie pełnotekstowe. 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 wszystkimi nazwami pól wymienionymi w tym parametrze.
searchMode	query		SearchMode	Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być dopasowane w celu zliczenia dokumentu jako dopasowania.
semanticConfiguration	query		string	Nazwa konfiguracji semantycznej, która zawiera listę pól, które powinny być używane do semantycznego klasyfikowania, podpisów, wyróżnień i odpowiedzi
semanticErrorHandling	query		SemanticErrorMode	Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić wyniki częściowe (ustawienie domyślne).
semanticFields	query		string[]	Lista nazw pól używanych do klasyfikacji semantycznej.
semanticMaxWaitInMilliseconds	query		integer (int32) minimum: 700	Umożliwia użytkownikowi ustawienie górnej granicy na czas potrzebny na zakończenie przetwarzania semantycznego, zanim żądanie zakończy się niepowodzeniem.
semanticQuery	query		string	Umożliwia ustawienie oddzielnego zapytania wyszukiwania, które będzie używane wyłącznie do semantycznego korbowania, transkrybów semantycznych i semantycznych odpowiedzi. Jest przydatna w scenariuszach, w których istnieje potrzeba użycia różnych zapytań między fazą pobierania podstawowego i klasyfikacji oraz semantyczną fazą L2.
sessionId	query		string	Wartość, która ma zostać użyta do utworzenia lepkiej sesji, co może pomóc uzyskać bardziej spójne wyniki. Tak długo, jak jest używany ten sam identyfikator sessionId, zostanie podjęta najlepsza próba ukierunkowana na ten sam zestaw replik. Należy się 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 "_".
speller	query		Speller	Popraw kompletność wyszukiwania przez poprawianie pisowni poszczególnych terminów zapytania wyszukiwania.

Nagłówek żądania

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

Odpowiedzi

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

Przykłady

SearchIndexSearchDocumentsGet

Przykładowe żądanie

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&speller={speller}&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-03-01-Preview

Przykładowa odpowiedź

Kod stanu:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

Definicje

Nazwa	Opis
AnswerResult	Odpowiedź to fragment tekstowy wyodrębniony z zawartości najbardziej odpowiednich dokumentów pasujących do zapytania. Odpowiedzi są wyodrębniane z pierwszych 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.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
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, 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ść, która określiła typ sprawdzania pisowni, która ma być używana 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 do użycia do wyszukiwania wektorów 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.
SearchMode	Określa, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne w celu zliczenia dokumentu jako dopasowania.
SearchRequest	Parametry do 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ć wyniki częściowe (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żywany, częściowo używany lub nieużywany)
SemanticSearchResultsType	Typ częściowej odpowiedzi zwróconej dla semantycznego żądania klasyfikacji.
Speller	Popraw kompletność wyszukiwania przez poprawianie pisowni poszczególnych terminów zapytania wyszukiwania.
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

Objekt

Odpowiedź to fragment tekstowy wyodrębniony z zawartości najbardziej odpowiednich dokumentów pasujących do zapytania. Odpowiedzi są wyodrębniane z pierwszych 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 (double)	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

Objekt

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

Objekt

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.

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

Szczegóły błędu.

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

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

QueryAnswerType

Wyliczenie

Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania.

Wartość	Opis
none	Nie zwracaj odpowiedzi dla zapytania.
extractive	Wyodrębnia kandydatów odpowiedzi z zawartości dokumentów zwracanych w odpowiedzi na zapytanie wyrażone jako pytanie w języku naturalnym.

QueryCaptionType

Wyliczenie

Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania.

Wartość	Opis
none	Nie zwracaj podpisów dla zapytania.
extractive	Wyodrębnia podpisy z pasujących dokumentów, które zawierają fragmenty istotne dla zapytania wyszukiwania.

QueryDebugMode

Wyliczenie

Umożliwia narzędzie do debugowania, które może służyć do dalszego eksplorowania wyników wyszukiwania.

Wartość	Opis
disabled	Nie zostaną zwrócone żadne informacje debugowania zapytania.
semantic	Umożliwia użytkownikowi dalsze eksplorowanie ponownie sklasyfikowanych wyników.

QueryLanguage

Wyliczenie

Język zapytania.

Wartość	Opis
none	Nie określono języka zapytań.
en-us	Wartość języka zapytań dla języka angielskiego (Stany Zjednoczone).
en-gb	Wartość języka zapytań dla języka angielskiego (Wielka Brytania).
en-in	Wartość języka zapytań dla języka angielskiego (Indie).
en-ca	Wartość języka zapytań dla języka angielskiego (Kanada).
en-au	Wartość języka zapytań dla języka angielskiego (Australia).
fr-fr	Wartość języka zapytań dla języka francuskiego (Francja).
fr-ca	Wartość języka zapytań dla języka francuskiego (Kanada).
de-de	Wartość języka zapytań dla języka niemieckiego (Niemcy).
es-es	Wartość języka zapytań dla języka hiszpańskiego (Hiszpania).
es-mx	Wartość języka zapytań dla języka hiszpańskiego (Meksyk).
zh-cn	Wartość języka zapytań dla języka chińskiego (Chiny).
zh-tw	Wartość języka zapytań dla języka chińskiego (Tajwan).
pt-br	Wartość języka zapytań dla języka portugalskiego (Brazylia).
pt-pt	Wartość języka zapytań dla języka portugalskiego (Portugalia).
it-it	Wartość języka zapytań dla języka włoskiego (Włochy).
ja-jp	Wartość języka zapytań dla języka japońskiego (Japonia).
ko-kr	Wartość języka zapytań dla języka koreańskiego (Korea).
ru-ru	Wartość języka zapytań dla języka rosyjskiego (Rosja).
cs-cz	Wartość języka zapytań dla języka czeskiego (Czechy).
nl-be	Wartość języka zapytań dla holenderskiego (Belgia).
nl-nl	Wartość języka zapytań dla holenderskiego (Holandia).
hu-hu	Wartość języka zapytań dla języka węgierskiego (Węgry).
pl-pl	Wartość języka zapytań dla polski (Polska).
sv-se	Wartość języka zapytań dla języka szwedzkiego (Szwecja).
tr-tr	Wartość języka zapytań dla języka tureckiego (Turcja).
hi-in	Wartość języka zapytań dla języka hindi (Indie).
ar-sa	Wartość języka zapytań dla języka arabskiego (Arabia Saudyjska).
ar-eg	Wartość języka zapytań dla języka arabskiego (Egipt).
ar-ma	Wartość języka zapytań dla języka arabskiego (Maroko).
ar-kw	Wartość języka zapytań dla języka arabskiego (Kuwejt).
ar-jo	Wartość języka zapytania dla języka arabskiego (Jordania).
da-dk	Wartość języka zapytań dla języka duńskiego (Dania).
no-no	Wartość języka zapytań dla języka norweskiego (Norwegia).
bg-bg	Wartość języka zapytań dla języka bułgarskiego (Bułgaria).
hr-hr	Wartość języka zapytań dla języka chorwackiego (Chorwacja).
hr-ba	Wartość języka zapytań dla języka chorwackiego (Bośnia i Hercegowina).
ms-my	Wartość języka zapytań dla Malay (Malezja).
ms-bn	Wartość języka zapytań dla Malay (Brunei Darussalam).
sl-sl	Wartość języka zapytań dla Słowenii (Słowenia).
ta-in	Wartość języka zapytań dla Tamil (Indie).
vi-vn	Wartość języka zapytań dla wietnamskiego (Viet Nam).
el-gr	Wartość języka zapytań dla języka greckiego (Grecja).
ro-ro	Wartość języka zapytań dla rumuńskiego (Rumunia).
is-is	Wartość języka zapytań dla islandii (Islandia).
id-id	Wartość języka zapytań dla języka indonezyjskiego (Indonezja).
th-th	Wartość języka zapytań dla języka tajskiego (Tajlandia).
lt-lt	Wartość języka zapytań dla Litewskiego (Litwa).
uk-ua	Wartość języka zapytań dla języka ukraińskiego (Ukraina).
lv-lv	Wartość języka zapytań dla Łotewskiego (Łotewski).
et-ee	Wartość języka zapytań dla estońskiego (Estonia).
ca-es	Wartość języka zapytań dla katalońskiego.
fi-fi	Wartość języka zapytań dla fińskiego (Finlandia).
sr-ba	Wartość języka zapytań dla serbskiego (Bośnia i Hercegowina).
sr-me	Wartość języka zapytań dla serbskiego (Czarnogóra).
sr-rs	Wartość języka zapytań dla serbskiego (Serbia).
sk-sk	Wartość języka zapytań dla słowaka (Słowacja).
nb-no	Wartość języka zapytań dla języka norweskiego (Norwegia).
hy-am	Wartość języka zapytań dla ormiańskiego (Armenia).
bn-in	Wartość języka zapytań dla Bengali (Indie).
eu-es	Wartość języka zapytań dla baskijki.
gl-es	Wartość języka zapytań dla Galicji.
gu-in	Wartość języka zapytań dla Gujarati (Indie).
he-il	Wartość języka zapytań dla języka hebrajskiego (Izrael).
ga-ie	Wartość języka zapytań dla języka irlandzkiego (Irlandia).
kn-in	Wartość języka zapytań dla Kannada (Indie).
ml-in	Wartość języka zapytań dla Malayalam (Indie).
mr-in	Wartość języka zapytań dla Marathi (Indie).
fa-ae	Wartość języka zapytań dla perskiego (U.A.E.).
pa-in	Wartość języka zapytań dla Punjabi (Indie).
te-in	Wartość języka zapytań dla telugu (Indie).
ur-pk	Wartość języka zapytania dla Urdu (Pakistan).

QueryResultDocumentRerankerInput

Objekt

Nieprzetworzone ciągi, 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 dla pola tytułu, które zostało użyte do wzbogacania semantycznego.

QueryResultDocumentSemanticField

Objekt

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, które zostało wysłane do procesu wzbogacania semantycznego
state	SemanticFieldState	Sposób użycia pola do procesu wzbogacania semantycznego (w pełni używany, częściowo używany lub nieużywany)

QuerySpellerType

Wyliczenie

Wartość, która określiła typ sprawdzania pisowni, która ma być używana do sprawdzania pisowni poszczególnych terminów zapytania wyszukiwania.

Wartość	Opis
none	Pisownia nie jest włączona.
lexicon	Funkcja Speller poprawia poszczególne terminy zapytania przy użyciu statycznego leksykonu dla języka określonego przez parametr queryLanguage.

QueryType

Wyliczenie

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.

Wartość	Opis
simple	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.
full	Używa pełnej składni zapytania 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	Najlepiej nadaje się do zapytań wyrażonych w języku naturalnym, a nie słów kluczowych. Zwiększa precyzję wyników wyszukiwania przez ponowne klasyfikowanie najlepszych wyników wyszukiwania przy użyciu modelu klasyfikacji wytrenowanego w corpus sieci Web.

RawVectorQuery

Objekt

Parametry zapytania do użycia do wyszukiwania wektorów po podaniu nieprzetworzonej wartości wektora.

Nazwa	Typ	Opis
exhaustive	boolean	W przypadku wartości true 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 podstawowych prawdy.
fields	string	Rozdzielona przecinkami lista nazw pól, które mają zostać uwzględnione w wyszukiwaniu wektorowym. Każde z pól musi być prawidłowym typem wektora, takim jak Collection(Edm.Single). Jeśli podano wiele pól, wektor zostanie użyty do znalezienia najbliższych dopasowań we wszystkich polach.
k	integer (int32)	Liczba najbliższych sąsiadów, które mają być zwracane jako pierwsze trafienia.
kind	string: vector	Rodzaj wykonywanego zapytania wektorowego.
oversampling	number (double)	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[] (float)	Wektorowa reprezentacja zapytania wyszukiwania.

ScoringStatistics

Wyliczenie

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.

Wartość	Opis
local	Statystyki oceniania będą obliczane lokalnie pod kątem mniejszego opóźnienia.
global	Statystyki oceniania będą obliczane globalnie w celu uzyskania bardziej spójnego oceniania.

SearchDocumentsResult

Objekt

Odpowiedź zawierająca wyniki wyszukiwania z indeksu.

Nazwa	Typ	Opis
@odata.count	integer (int64)	Łączna liczba wyników znalezionych przez operację wyszukiwania lub wartość null, jeśli liczba nie została żądana. Jeśli istnieje, 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 albo 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, aby sformułować inne żądanie 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[]	Wyniki zapytania odpowiedzi dla operacji wyszukiwania; null, jeśli parametr zapytania odpowiedzi nie został określony lub ustawiony na wartość "none".
@search.coverage	number (double)	Wartość wskazująca wartość procentową indeksu, który został uwzględniony w zapytaniu, lub wartość null, jeśli minimalna wartośćCoverage 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ń 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 @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 częściowej odpowiedzi zwróconej dla semantycznego żądania klasyfikacji.
value	SearchResult[]	Sekwencja wyników zwróconych przez zapytanie.

SearchMode

Wyliczenie

Określa, czy dowolne lub wszystkie terminy wyszukiwania muszą być zgodne w celu zliczenia dokumentu jako dopasowania.

Wartość	Opis
any	Każdy z terminów wyszukiwania musi być dopasowany, aby zliczyć dokument jako dopasowanie.
all	Wszystkie terminy wyszukiwania muszą być dopasowane w celu zliczenia dokumentu jako dopasowania.

SearchRequest

Objekt

Parametry do 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 zwracana 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 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 elementem highlightPreTag. Wartość domyślna to </em>.
highlightPreTag	string	Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. Wartość domyślna to <>.
minimumCoverage	number (double)	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ąc malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki dopasowania dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania 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, 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 to "mylocation--122.2,44.8" (bez cudzysłowów).
scoringProfile	string	Nazwa profilu oceniania do oceny wyników dla 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ć objęte wyszukiwanie pełnotekstowe. 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 wszystkimi nazwami pól wymienionymi w tym parametrze.
searchMode	SearchMode	Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być dopasowane w celu zliczenia dokumentu jako dopasowania.
select	string	Rozdzielona przecinkami lista pól do pobrania. W przypadku nieokreślonego dołączono 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ń semantycznych typów.
semanticErrorHandling	SemanticErrorMode	Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić wyniki częściowe (ustawienie domyślne).
semanticFields	string	Rozdzielona przecinkami lista nazw pól używanych do klasyfikacji semantycznej.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Umożliwia użytkownikowi ustawienie górnej granicy na czas potrzebny na zakończenie przetwarzania semantycznego, 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, transkrybów semantycznych i semantycznych odpowiedzi. Jest przydatna 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 zostać użyta do utworzenia lepkiej sesji, 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 najlepsza próba ukierunkowana na ten sam zestaw replik. Należy się 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 (int32)	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ć pominięcia z powodu tego ograniczenia, rozważ użycie kolejności na całkowicie uporządkowanym kluczu i filtru z zapytaniem zakresu.
speller	QuerySpellerType	Wartość, która określiła typ sprawdzania pisowni, która ma być używana do sprawdzania pisowni poszczególnych terminów zapytania wyszukiwania.
top	integer (int32)	Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania po stronie klienta wyników wyszukiwania. Jeśli wyniki zostaną 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	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 wektorów i zapytań wyszukiwania hybrydowego.

SearchResult

Objekt

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 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 (double)	Wynik istotności obliczony przez semantyczny rangą dla najlepszych wyników wyszukiwania. Wyniki wyszukiwania są sortowane najpierw według elementu RerankerScore, a następnie według wyniku. Funkcja RerankerScore jest zwracana tylko dla zapytań typu "semantyka".
@search.score	number (double)	Wynik istotności dokumentu w porównaniu z innymi dokumentami zwracanym przez zapytanie.

SemanticDebugInfo

Objekt

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, które zostały wysłane do procesu wzbogacania semantycznego.
titleField	QueryResultDocumentSemanticField	Pole tytułu, które zostało wysłane do procesu wzbogacania semantycznego, a także sposób jego użycia

SemanticErrorMode

Wyliczenie

Umożliwia użytkownikowi wybranie, czy wywołanie semantyczne powinno zakończyć się niepowodzeniem, czy zwrócić wyniki częściowe (ustawienie domyślne).

Wartość	Opis
partial	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.
fail	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.

SemanticErrorReason

Wyliczenie

Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji.

Wartość	Opis
maxWaitExceeded	Jeśli ustawiono wartość "semanticMaxWaitInMilliseconds", a czas trwania przetwarzania semantycznego przekroczył ten wartość. Zwrócono tylko wyniki podstawowe.
capacityOverloaded	Żądanie zostało ograniczone. Zwrócono tylko wyniki podstawowe.
transient	Co najmniej jeden krok procesu semantycznego zakończył się niepowodzeniem.

SemanticFieldState

Wyliczenie

Sposób użycia pola do procesu wzbogacania semantycznego (w pełni używany, częściowo używany lub nieużywany)

Wartość	Opis
used	Pole zostało w pełni użyte do wzbogacania semantycznego.
unused	Pole nie było używane do wzbogacania semantycznego.
partial	Pole zostało częściowo użyte do wzbogacania semantycznego.

SemanticSearchResultsType

Wyliczenie

Typ częściowej odpowiedzi zwróconej dla semantycznego żądania klasyfikacji.

Wartość	Opis
baseResults	Wyniki bez żadnego semantycznego wzbogacania ani ponownego korbowania.
rerankedResults	Wyniki zostały ponownie sklasyfikowane za pomocą modelu ponownego korekta i będą zawierać transkryby semantyczne. Nie będą zawierać żadnych odpowiedzi, wyróżnionych odpowiedzi ani wyróżnień napisów.

Speller

Wyliczenie

Popraw kompletność wyszukiwania przez poprawianie pisowni poszczególnych terminów zapytania wyszukiwania.

Wartość	Opis
none	Pisownia nie jest włączona.
lexicon	Funkcja Speller poprawia poszczególne terminy zapytania przy użyciu statycznego leksykonu dla języka określonego przez parametr queryLanguage.

VectorFilterMode

Wyliczenie

Określa, czy filtry są stosowane przed lub po wykonaniu wyszukiwania wektorowego.

Wartość	Opis
postFilter	Filtr zostanie zastosowany po zwróceniu zestawu wyników wektorów kandydata. W zależności od selektora filtru może to spowodować mniej wyników niż żądane przez parametr "k".
preFilter	Filtr zostanie zastosowany przed zapytaniem wyszukiwania.

VectorizableTextQuery

Objekt

Parametry zapytania do użycia do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi zostać wektoryzowana.

Nazwa	Typ	Opis
exhaustive	boolean	W przypadku wartości true 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 podstawowych prawdy.
fields	string	Rozdzielona przecinkami lista nazw pól, które mają zostać uwzględnione w wyszukiwaniu wektorowym. Każde z pól musi być prawidłowym typem wektora, takim jak Collection(Edm.Single). Jeśli podano wiele pól, wektor zostanie użyty do znalezienia najbliższych dopasowań we wszystkich polach.
k	integer (int32)	Liczba najbliższych sąsiadów, które mają być zwracane jako pierwsze trafienia.
kind	string: text	Rodzaj wykonywanego zapytania wektorowego.
oversampling	number (double)	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

Wyliczenie

Rodzaj wykonywanego zapytania wektorowego.

Wartość	Opis
vector	Zapytanie wektorowe, w którym jest podana nieprzetworzona wartość wektora.
text	Zapytanie wektorowe, w którym jest udostępniana wartość tekstowa, która musi zostać wektoryzowana.