Documents - Search Get

Odwołanie

Usługa:: Search Service

Wersja interfejsu API:: 2024-07-01

Wyszukuje dokumenty w indeksie.

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

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}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2024-07-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}

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`.
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.
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).
semanticMaxWaitInMilliseconds	query		integer int32	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 "_".

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

SearchIndexSearchDocumentsSemanticGet

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&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-07-01

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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

Przykładowe żądanie

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2024-07-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "@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
    }
  ],
  "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"
      ]
    }
  ]
}

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 `semantic`.
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.
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.
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.
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.
SemanticErrorReason	Przyczyna zwrócenia częściowej odpowiedzi dla semantycznego żądania klasyfikacji.
SemanticSearchResultsType	Typ częściowej odpowiedzi 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 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	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 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 istotnego dla zapytania wyszukiwania.

ErrorAdditionalInfo

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

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

ErrorDetail

Szczegóły błędu.

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

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

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 zwracanych 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 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	string	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.
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 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	Pola wektorów 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 pierwsze trafienia.
kind	string: vector	Rodzaj wykonywanego zapytania wektorowego.
oversampling	number	Współczynnik nadmiernego próbkowania. Wartość minimalna to 1. Zastępuje on parametr "defaultOversampling" skonfigurowany w definicji indeksu. Można go ustawić tylko wtedy, gdy wartość "rerankWithOriginalVectors" ma wartość true. Ten parametr jest dozwolony tylko wtedy, gdy metoda kompresji jest używana w polu wektora bazowego.
vector	number[]	Wektorowa reprezentacja zapytania wyszukiwania.
weight	number	Względna waga zapytania wektorowego w porównaniu z innym zapytaniem wektorowym i/lub zapytaniem tekstowym w ramach tego samego żądania wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list rankingowych generowanych przez różne zapytania wektorowe i/lub wyniki pobrane za pośrednictwem zapytania tekstowego. Im większa waga, tym wyższa liczba dokumentów pasujących do tego zapytania będzie znajdować się w końcowej klasyfikacji. Wartość domyślna to 1.0, a wartość musi być liczbą dodatnią większą niż zero.

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 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	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

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

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

SearchRequest

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.
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	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.
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 (domyślne/bieżące zachowanie) lub zwrócić częściowe wyniki.
semanticMaxWaitInMilliseconds	integer	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	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.
top	integer	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" dla nowych indeksów.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametry zapytania dla wektorów i zapytań wyszukiwania hybrydowego.

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.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 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	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 wystąpi wyjątek podczas kroku przetwarzania semantycznego, zapytanie zakończy się niepowodzeniem i zwróci odpowiedni kod HTTP w zależności od błędu.
partial	string	Jeśli przetwarzanie semantyczne zakończy się niepowodzeniem, wyniki częściowe nadal 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 `semanticMaxWaitInMilliseconds` została ustawiona, a czas trwania przetwarzania semantycznego przekroczył ten wartość. Zwrócono tylko wyniki podstawowe.
transient	string	Co najmniej jeden krok procesu semantycznego zakończył się niepowodzeniem.

SemanticSearchResultsType

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

Nazwa	Typ	Opis
baseResults	string	Wyniki bez żadnego semantycznego wzbogacania ani ponownego korbowania.
rerankedResults	string	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.

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 kandydata. W zależności od selektora 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	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	Pola wektorów 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 pierwsze trafienia.
kind	string: text	Rodzaj wykonywanego zapytania wektorowego.
oversampling	number	Współczynnik nadmiernego próbkowania. Wartość minimalna to 1. Zastępuje on parametr "defaultOversampling" skonfigurowany w definicji indeksu. Można go ustawić tylko wtedy, gdy wartość "rerankWithOriginalVectors" ma wartość true. Ten parametr jest dozwolony tylko wtedy, gdy metoda kompresji jest używana w polu wektora bazowego.
text	string	Tekst, który ma zostać wektoryzowany w celu wykonania zapytania wyszukiwania wektorowego.
weight	number	Względna waga zapytania wektorowego w porównaniu z innym zapytaniem wektorowym i/lub zapytaniem tekstowym w ramach tego samego żądania wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list rankingowych generowanych przez różne zapytania wektorowe i/lub wyniki pobrane za pośrednictwem zapytania tekstowego. Im większa waga, tym wyższa liczba dokumentów pasujących do tego zapytania będzie znajdować się w końcowej klasyfikacji. Wartość domyślna to 1.0, a wartość musi być liczbą dodatnią większą niż zero.

VectorQueryKind

Rodzaj wykonywanego zapytania wektorowego.

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

Udostępnij za pośrednictwem

Documents - Search Get

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Przykłady

SearchIndexSearchDocumentsGet

Przykładowe żądanie

Przykładowa odpowiedź

SearchIndexSearchDocumentsSemanticGet

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

Dodatkowe zasoby