Documents - Search Get

Referenz

Dienst:: Search Service

API-Version:: 2024-07-01

Sucht nach Dokumenten im Index.

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

Mit optionalen Parametern:

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}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Indexes.
api-version	query	True	string	Client-API-Version.
$count	query		boolean	Ein Wert, der angibt, ob die Gesamtanzahl der Ergebnisse abgerufen werden soll. Der Standardwert ist "false". Das Festlegen dieses Werts auf "true" hat möglicherweise auswirkungen auf die Leistung. Beachten Sie, dass die zurückgegebene Anzahl eine Annäherung ist.
$filter	query		string	Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll.
$orderby	query		string[]	Die Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Jedem Ausdruck kann asc folgen, um aufsteigend anzugeben, und desc, um absteigend anzugeben. Der Standardwert ist die aufsteigende Reihenfolge. Die Verknüpfungen werden durch die Übereinstimmungsergebnisse von Dokumenten unterbrochen. Wenn keine OrderBy angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können höchstens 32 $orderby Klauseln vorhanden sein.
$select	query		string[]	Die Liste der abzurufenden Felder. Wenn nicht angegeben, sind alle Felder enthalten, die im Schema als abrufbar gekennzeichnet sind.
$skip	query		integer int32	Die Anzahl der zu überspringenden Suchergebnisse. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente nacheinander scannen müssen, aber aufgrund dieser Einschränkung nicht $skip verwenden können, sollten Sie stattdessen $orderby für einen vollständig sortierten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage $filter.
$top	query		integer int32	Die Anzahl der abzurufenden Suchergebnisse. Dies kann in Verbindung mit $skip verwendet werden, um clientseitige Paging von Suchergebnissen zu implementieren. Wenn Ergebnisse aufgrund der serverseitigen Auslagerung abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine andere Suchanforderung für die nächste Seite der Ergebnisse auszuweisen.
answers	query		QueryAnswerType	Dieser Parameter ist nur gültig, wenn der Abfragetyp `semantic`ist. Bei Festlegung gibt die Abfrage Antworten zurück, die aus wichtigen Passagen in den am höchsten bewerteten Dokumenten extrahiert wurden. Die Anzahl der zurückgegebenen Antworten kann konfiguriert werden, indem sie das Pipezeichen `\|` gefolgt von der Option `count-<number of answers>` nach dem Wert des Antwortparameters, z. B. `extractive\|count-3`, anfügen. Die Standardanzahl ist 1. Der Konfidenzschwellenwert kann konfiguriert werden, indem das Pipezeichen `\|` gefolgt von der Option `threshold-<confidence threshold>` nach dem Wert des Antwortparameters, z. B. `extractive\|threshold-0.9`, angefügt wird. Der Standardschwellenwert ist 0,7.
captions	query		QueryCaptionType	Dieser Parameter ist nur gültig, wenn der Abfragetyp `semantic`ist. Wenn festgelegt, gibt die Abfrage Beschriftungen zurück, die aus Schlüsselabschnitten in den höchsten bewerteten Dokumenten extrahiert wurden. Wenn Beschriftungen auf `extractive`festgelegt sind, ist die Hervorhebung standardmäßig aktiviert und kann durch Anfügen des Strichs `\|` gefolgt von der Option `highlight-<true/false>` konfiguriert werden, z. B. `extractive\|highlight-true`. Standardmäßig wird `None`.
facet	query		string[]	Die Liste der Facetausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facetausdruck enthält einen Feldnamen, optional gefolgt von einer durch Trennzeichen getrennten Liste von Name:Wert-Paaren.
highlight	query		string[]	Die Liste der Feldnamen, die für Trefferhighlights verwendet werden sollen. Nur durchsuchbare Felder können zum Hervorheben von Treffern verwendet werden.
highlightPostTag	query		string	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.
highlightPreTag	query		string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Der Standardwert ist <em>.
minimumCoverage	query		number double	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Suchabfrage abgedeckt werden muss, damit die Abfrage als Erfolg gemeldet werden kann. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert ist 100.
queryType	query		QueryType	Ein Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "einfach". Verwenden Sie "vollständig", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
scoringParameter	query		string[]	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit den Formatnamenwerten verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne anführungszeichen).
scoringProfile	query		string	Der Name eines Bewertungsprofils, um Übereinstimmungsergebnisse für übereinstimmende Dokumente auszuwerten, um die Ergebnisse zu sortieren.
scoringStatistics	query		ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten.
search	query		string	Ein Volltext-Suchabfrageausdruck; Verwenden Sie "*", oder lassen Sie diesen Parameter aus, um alle Dokumente abzugleichen.
searchFields	query		string[]	Die Liste der Feldnamen, auf die die Volltextsuche angewendet werden soll. Bei Verwendung der feldbezogenen Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage haben die Feldnamen jedes feldbezogenen Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind.
searchMode	query		SearchMode	Ein Wert, der angibt, ob eine oder alle Suchbegriffe übereinstimmen müssen, um das Dokument als Übereinstimmung zu zählen.
semanticConfiguration	query		string	Der Name der semantischen Konfiguration, die auflistet, welche Felder für semantische Rangfolge, Beschriftungen, Hervorhebungen und Antworten verwendet werden sollen
semanticErrorHandling	query		SemanticErrorMode	Ermöglicht dem Benutzer auszuwählen, ob ein semantischer Aufruf vollständig fehlschlägt oder partielle Ergebnisse (Standardeinstellung) zurückgeben soll.
semanticMaxWaitInMilliseconds	query		integer int32	Ermöglicht es dem Benutzer, eine obere Grenze für die Zeitspanne festzulegen, die für die semantische Anreicherung benötigt wird, um die Verarbeitung abzuschließen, bevor die Anforderung fehlschlägt.
semanticQuery	query		string	Ermöglicht das Festlegen einer separaten Suchabfrage, die ausschließlich für semantische Reranking, semantische Beschriftungen und semantische Antworten verwendet wird. Ist nützlich für Szenarien, in denen verschiedene Abfragen zwischen der Basisabruf- und Rangfolgephase und der L2-Semantikphase verwendet werden müssen.
sessionId	query		string	Ein Wert, der zum Erstellen einer Haftsitzung verwendet werden soll, was dazu beitragen kann, konsistentere Ergebnisse zu erzielen. Solange dieselbe sessionId verwendet wird, wird versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die Wiederverwendung der gleichen SessionID-Werte wiederholt den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der wert, der als sessionId verwendet wird, kann nicht mit einem '_'-Zeichen beginnen.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Die Tracking-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen.

Antworten

Name	Typ	Beschreibung
200 OK	SearchDocumentsResult	Antwort, die Dokumente enthält, die den Suchkriterien entsprechen.
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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}

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AnswerResult	Eine Antwort ist eine Textpassage, die aus dem Inhalt der relevantesten Dokumente extrahiert wurde, die der Abfrage entsprechen. Antworten werden aus den wichtigsten Suchergebnissen extrahiert. Antwortkandidaten werden bewertet, und die wichtigsten Antworten werden ausgewählt.
CaptionResult	Beschriftungen sind die repräsentativsten Passagen aus dem Dokument relativ zur Suchabfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Beschriftungen werden nur für Abfragen vom Typ `semantic`zurückgegeben.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
QueryAnswerType	Ein Wert, der angibt, ob Antworten als Teil der Suchantwort zurückgegeben werden sollen.
QueryCaptionType	Ein Wert, der angibt, ob Beschriftungen als Teil der Suchantwort zurückgegeben werden sollen.
QueryType	Gibt die Syntax der Suchabfrage an. Der Standardwert ist "einfach". Verwenden Sie "vollständig", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
RawVectorQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert bereitgestellt wird.
ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Der Standardwert ist "local". Verwenden Sie "global", um Bewertungsstatistiken global vor der Bewertung zu aggregieren. Die Verwendung von globalen Bewertungsstatistiken kann die Latenz von Suchabfragen erhöhen.
SearchDocumentsResult	Antwort, die Suchergebnisse aus einem Index enthält.
SearchMode	Gibt an, ob eine oder alle Suchbegriffe übereinstimmen müssen, um das Dokument als Übereinstimmung zu zählen.
SearchRequest	Parameter zum Filtern, Sortieren, Faceting, Paging und anderen Suchabfrageverhalten.
SearchResult	Enthält ein Dokument, das von einer Suchabfrage gefunden wurde, sowie zugeordnete Metadaten.
SemanticErrorMode	Ermöglicht dem Benutzer auszuwählen, ob ein semantischer Aufruf vollständig fehlschlagen soll (Standard-/aktuelles Verhalten) oder partielle Ergebnisse zurückzugeben.
SemanticErrorReason	Grund für die Rückgabe einer teilweisen Antwort für eine semantische Bewertungsanforderung.
SemanticSearchResultsType	Typ der teilweisen Antwort, die für eine semantische Bewertungsanforderung zurückgegeben wurde.
VectorFilterMode	Bestimmt, ob Filter vor oder nach der Vektorsuche angewendet werden.
VectorizableTextQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein Textwert bereitgestellt wird, der vektorisiert werden muss.
VectorQueryKind	Die Art der ausgeführten Vektorabfrage.

AnswerResult

Eine Antwort ist eine Textpassage, die aus dem Inhalt der relevantesten Dokumente extrahiert wurde, die der Abfrage entsprechen. Antworten werden aus den wichtigsten Suchergebnissen extrahiert. Antwortkandidaten werden bewertet, und die wichtigsten Antworten werden ausgewählt.

Name	Typ	Beschreibung
highlights	string	Derselbe Textabschnitt wie in der Texteigenschaft mit hervorgehobenen Textausdrücken, die für die Abfrage am relevantesten sind.
key	string	Der Schlüssel des Dokuments, aus dem die Antwort extrahiert wurde.
score	number	Der Bewertungswert stellt dar, wie relevant die Antwort auf die Abfrage relativ zu anderen Antworten ist, die für die Abfrage zurückgegeben werden.
text	string	Die aus dem Dokumentinhalt extrahierte Textpassage als Antwort.

CaptionResult

Beschriftungen sind die repräsentativsten Passagen aus dem Dokument relativ zur Suchabfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Beschriftungen werden nur für Abfragen vom Typ semanticzurückgegeben.

Name	Typ	Beschreibung
highlights	string	Derselbe Textabschnitt wie in der Text-Eigenschaft mit hervorgehobenen Ausdrücken, die für die Abfrage am relevantesten sind.
text	string	Ein repräsentativer Textabschnitt, der aus dem Dokument extrahiert wurde, das für die Suchabfrage am relevantesten ist.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

QueryAnswerType

Ein Wert, der angibt, ob Antworten als Teil der Suchantwort zurückgegeben werden sollen.

Name	Typ	Beschreibung
extractive	string	Extrahiert Antwortkandidaten aus dem Inhalt der zurückgegebenen Dokumente als Antwort auf eine Abfrage, die als Frage in natürlicher Sprache ausgedrückt wird.
none	string	Geben Sie keine Antworten für die Abfrage zurück.

QueryCaptionType

Ein Wert, der angibt, ob Beschriftungen als Teil der Suchantwort zurückgegeben werden sollen.

Name	Typ	Beschreibung
extractive	string	Extrahiert Beschriftungen aus den übereinstimmenden Dokumenten, die Passagen enthalten, die für die Suchabfrage relevant sind.
none	string	Geben Sie keine Beschriftungen für die Abfrage zurück.

QueryType

Gibt die Syntax der Suchabfrage an. Der Standardwert ist "einfach". Verwenden Sie "vollständig", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.

Name	Typ	Beschreibung
full	string	Verwendet die vollständige Lucene-Abfragesyntax für Suchvorgänge. Suchtext wird mithilfe der Lucene-Abfragesprache interpretiert, die feldspezifische und gewichtete Suchvorgänge sowie andere erweiterte Features ermöglicht.
semantic	string	Am besten geeignet für Abfragen, die in natürlicher Sprache ausgedrückt werden, im Gegensatz zu Schlüsselwörtern. Verbessert die Genauigkeit von Suchergebnissen, indem die wichtigsten Suchergebnisse mithilfe eines bewertungsmodells, das im Webkorpus trainiert wurde, neu sortiert werden.
simple	string	Verwendet die einfache Abfragesyntax für Suchvorgänge. Suchtext wird mithilfe einer einfachen Abfragesprache interpretiert, die Symbole wie +, * und "" zulässt. Abfragen werden standardmäßig für alle durchsuchbaren Felder ausgewertet, es sei denn, der Parameter searchFields ist angegeben.

RawVectorQuery

Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert bereitgestellt wird.

Name	Typ	Beschreibung
exhaustive	boolean	Wenn wahr, löst eine vollständige k-nächste Nachbarsuche über alle Vektoren innerhalb des Vektorindex aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen kritisch sind, z. B. das Bestimmen von Boden-Wahrheitswerten.
fields	string	Vektorfelder vom Typ Collection(Edm.Single), die in den durchsuchten Vektor einbezogen werden sollen.
k	integer	Die Anzahl der nächsten Nachbarn, die als Toptreffer zurückgegeben werden sollen.
kind	string: vector	Die Art der ausgeführten Vektorabfrage.
oversampling	number	Übersamplingfaktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter "defaultOversampling". Sie kann nur festgelegt werden, wenn "rerankWithOriginalVectors" wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird.
vector	number[]	Die Vektordarstellung einer Suchabfrage.
weight	number	Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanforderung. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Bewertungslisten kombiniert werden, die von den verschiedenen Vektorabfragen und/oder den ergebnissen, die über die Textabfrage abgerufen wurden. Je höher die Gewichtung ist, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0 und der Wert muss eine positive Zahl größer als 0 sein.

ScoringStatistics

Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Der Standardwert ist "local". Verwenden Sie "global", um Bewertungsstatistiken global vor der Bewertung zu aggregieren. Die Verwendung von globalen Bewertungsstatistiken kann die Latenz von Suchabfragen erhöhen.

Name	Typ	Beschreibung
global	string	Die Bewertungsstatistiken werden global für eine konsistentere Bewertung berechnet.
local	string	Die Bewertungsstatistiken werden lokal für niedrigere Latenz berechnet.

SearchDocumentsResult

Antwort, die Suchergebnisse aus einem Index enthält.

Name	Typ	Beschreibung
@odata.count	integer	Die Gesamtanzahl der Ergebnisse, die vom Suchvorgang gefunden wurden, oder NULL, wenn die Anzahl nicht angefordert wurde. Wenn vorhanden, kann die Anzahl größer als die Anzahl der Ergebnisse in dieser Antwort sein. Dies kann passieren, wenn Sie die parameter $top oder $skip verwenden oder wenn die Abfrage nicht alle angeforderten Dokumente in einer einzigen Antwort zurückgeben kann.
@odata.nextLink	string	Die Fortsetzungs-URL wird zurückgegeben, wenn die Abfrage nicht alle angeforderten Ergebnisse in einer einzigen Antwort zurückgeben kann. Sie können diese URL verwenden, um eine andere GET- oder POST-Suchanforderung zu formulieren, um den nächsten Teil der Suchantwort abzurufen. Stellen Sie sicher, dass Sie das gleiche Verb (GET oder POST) wie die Anforderung verwenden, die diese Antwort erstellt hat.
@search.answers	AnswerResult[]	Die Ergebnisse der Antwortabfrage für den Suchvorgang; null, wenn der Antwortabfrageparameter nicht angegeben oder auf 'none' festgelegt wurde.
@search.coverage	number	Ein Wert, der den Prozentsatz des Indexes angibt, der in der Abfrage enthalten war, oder null, wenn minimumCoverage nicht in der Anforderung angegeben wurde.
@search.facets	object	Die Facetabfrageergebnisse für den Suchvorgang, organisiert als Sammlung von Buckets für jedes faceted-Feld; null, wenn die Abfrage keine Facetausdrücke enthält.
@search.nextPageParameters	SearchRequest	Die JSON-Fortsetzungsnutzlast wird zurückgegeben, wenn die Abfrage nicht alle angeforderten Ergebnisse in einer einzigen Antwort zurückgeben kann. Sie können diesen JSON-Code zusammen mit @odata.nextLink verwenden, um eine andere POST-Suchanforderung zu formulieren, um den nächsten Teil der Suchantwort zu erhalten.
@search.semanticPartialResponseReason	SemanticErrorReason	Grund für die Rückgabe einer teilweisen Antwort für eine semantische Bewertungsanforderung.
@search.semanticPartialResponseType	SemanticSearchResultsType	Typ der teilweisen Antwort, die für eine semantische Bewertungsanforderung zurückgegeben wurde.
value	SearchResult[]	Die Abfolge der ergebnisse, die von der Abfrage zurückgegeben werden.

SearchMode

Gibt an, ob eine oder alle Suchbegriffe übereinstimmen müssen, um das Dokument als Übereinstimmung zu zählen.

Name	Typ	Beschreibung
all	string	Alle Suchbegriffe müssen übereinstimmen, um das Dokument als Übereinstimmung zu zählen.
any	string	Alle Suchbegriffe müssen übereinstimmen, um das Dokument als Übereinstimmung zu zählen.

SearchRequest

Parameter zum Filtern, Sortieren, Faceting, Paging und anderen Suchabfrageverhalten.

Name	Typ	Beschreibung
answers	QueryAnswerType	Ein Wert, der angibt, ob Antworten als Teil der Suchantwort zurückgegeben werden sollen.
captions	QueryCaptionType	Ein Wert, der angibt, ob Beschriftungen als Teil der Suchantwort zurückgegeben werden sollen.
count	boolean	Ein Wert, der angibt, ob die Gesamtanzahl der Ergebnisse abgerufen werden soll. Der Standardwert ist "false". Das Festlegen dieses Werts auf "true" hat möglicherweise auswirkungen auf die Leistung. Beachten Sie, dass die zurückgegebene Anzahl eine Annäherung ist.
facets	string[]	Die Liste der Facetausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facetausdruck enthält einen Feldnamen, optional gefolgt von einer durch Trennzeichen getrennten Liste von Name:Wert-Paaren.
filter	string	Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll.
highlight	string	Die durch Trennzeichen getrennte Liste der Feldnamen, die für Trefferhighlights verwendet werden sollen. Nur durchsuchbare Felder können zum Hervorheben von Treffern verwendet werden.
highlightPostTag	string	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.
highlightPreTag	string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Der Standardwert ist <em>.
minimumCoverage	number	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Suchabfrage abgedeckt werden muss, damit die Abfrage als Erfolg gemeldet werden kann. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert ist 100.
orderby	string	Die durch Trennzeichen getrennte Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Jedem Ausdruck kann asc folgen, um aufsteigend oder desc anzuzeigen, um absteigend anzugeben. Der Standardwert ist die aufsteigende Reihenfolge. Die Verknüpfungen werden durch die Übereinstimmungsergebnisse von Dokumenten unterbrochen. Wenn keine $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können höchstens 32 $orderby Klauseln vorhanden sein.
queryType	QueryType	Ein Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "einfach". Verwenden Sie "vollständig", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
scoringParameters	string[]	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit den Formatnamenwerten verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne anführungszeichen).
scoringProfile	string	Der Name eines Bewertungsprofils, um Übereinstimmungsergebnisse für übereinstimmende Dokumente auszuwerten, um die Ergebnisse zu sortieren.
scoringStatistics	ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Der Standardwert ist "local". Verwenden Sie "global", um Bewertungsstatistiken global vor der Bewertung zu aggregieren. Die Verwendung von globalen Bewertungsstatistiken kann die Latenz von Suchabfragen erhöhen.
search	string	Ein Volltext-Suchabfrageausdruck; Verwenden Sie "*", oder lassen Sie diesen Parameter aus, um alle Dokumente abzugleichen.
searchFields	string	Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche angewendet werden soll. Bei Verwendung der feldbezogenen Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage haben die Feldnamen jedes feldbezogenen Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind.
searchMode	SearchMode	Ein Wert, der angibt, ob eine oder alle Suchbegriffe übereinstimmen müssen, um das Dokument als Übereinstimmung zu zählen.
select	string	Die durch Trennzeichen getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, sind alle Felder enthalten, die im Schema als abrufbar gekennzeichnet sind.
semanticConfiguration	string	Der Name einer semantischen Konfiguration, die beim Verarbeiten von Dokumenten für Abfragen der Typsemantik verwendet wird.
semanticErrorHandling	SemanticErrorMode	Ermöglicht dem Benutzer auszuwählen, ob ein semantischer Aufruf vollständig fehlschlagen soll (Standard-/aktuelles Verhalten) oder partielle Ergebnisse zurückzugeben.
semanticMaxWaitInMilliseconds	integer	Ermöglicht es dem Benutzer, eine obere Grenze für die Zeitspanne festzulegen, die für die semantische Anreicherung benötigt wird, um die Verarbeitung abzuschließen, bevor die Anforderung fehlschlägt.
semanticQuery	string	Ermöglicht das Festlegen einer separaten Suchabfrage, die ausschließlich für semantische Reranking, semantische Beschriftungen und semantische Antworten verwendet wird. Ist nützlich für Szenarien, in denen verschiedene Abfragen zwischen der Basisabruf- und Rangfolgephase und der L2-Semantikphase verwendet werden müssen.
sessionId	string	Ein Wert, der zum Erstellen einer Haftsitzung verwendet werden soll, was dazu beitragen kann, konsistentere Ergebnisse zu erzielen. Solange dieselbe sessionId verwendet wird, wird versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die Wiederverwendung der gleichen SessionID-Werte wiederholt den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der wert, der als sessionId verwendet wird, kann nicht mit einem '_'-Zeichen beginnen.
skip	integer	Die Anzahl der zu überspringenden Suchergebnisse. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente sequenzieren müssen, aber aufgrund dieser Einschränkung nicht überspringen können, sollten Sie stattdessen "orderby" für einen vollständig sortierten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern.
top	integer	Die Anzahl der abzurufenden Suchergebnisse. Dies kann in Verbindung mit $skip verwendet werden, um clientseitige Paging von Suchergebnissen zu implementieren. Wenn Ergebnisse aufgrund der serverseitigen Auslagerung abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine andere Suchanforderung für die nächste Seite der Ergebnisse auszuweisen.
vectorFilterMode	VectorFilterMode	Bestimmt, ob Filter vor oder nach der Vektorsuche angewendet werden. Der Standardwert ist 'preFilter' für neue Indizes.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Die Abfrageparameter für Vektor- und Hybridsuchabfragen.

SearchResult

Enthält ein Dokument, das von einer Suchabfrage gefunden wurde, sowie zugeordnete Metadaten.

Name	Typ	Beschreibung
@search.captions	CaptionResult[]	Beschriftungen sind die repräsentativsten Passagen aus dem Dokument relativ zur Suchabfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Beschriftungen werden nur für Abfragen vom Typ "Semantik" zurückgegeben.
@search.highlights	object	Textfragmente aus dem Dokument, die die übereinstimmenden Suchbegriffe angeben, sortiert nach jedem anwendbaren Feld; null, wenn die Treffermarkierung für die Abfrage nicht aktiviert war.
@search.rerankerScore	number	Die Relevanzbewertung, die vom semantischen Rangfolger für die wichtigsten Suchergebnisse berechnet wird. Suchergebnisse werden zuerst nach "RerankerScore" und dann nach der Bewertung sortiert. RerankerScore wird nur für Abfragen vom Typ 'Semantik' zurückgegeben.
@search.score	number	Die Relevanzbewertung des Dokuments im Vergleich zu anderen Dokumenten, die von der Abfrage zurückgegeben werden.

SemanticErrorMode

Ermöglicht dem Benutzer auszuwählen, ob ein semantischer Aufruf vollständig fehlschlagen soll (Standard-/aktuelles Verhalten) oder partielle Ergebnisse zurückzugeben.

Name	Typ	Beschreibung
fail	string	Wenn während des semantischen Verarbeitungsschritts eine Ausnahme auftritt, schlägt die Abfrage fehl und gibt abhängig vom Fehler den entsprechenden HTTP-Code zurück.
partial	string	Wenn die semantische Verarbeitung fehlschlägt, werden weiterhin Teilergebnisse zurückgegeben. Die Definition von Teilergebnissen hängt davon ab, welcher semantische Schritt fehlgeschlagen ist und was der Grund für einen Fehler war.

SemanticErrorReason

Grund für die Rückgabe einer teilweisen Antwort für eine semantische Bewertungsanforderung.

Name	Typ	Beschreibung
capacityOverloaded	string	Die Anforderung wurde gedrosselt. Es wurden nur die Basisergebnisse zurückgegeben.
maxWaitExceeded	string	Wenn `semanticMaxWaitInMilliseconds` festgelegt wurde und die Semantikverarbeitungsdauer diesen Wert überschritten hat. Es wurden nur die Basisergebnisse zurückgegeben.
transient	string	Mindestens ein Schritt des semantischen Prozesses ist fehlgeschlagen.

SemanticSearchResultsType

Typ der teilweisen Antwort, die für eine semantische Bewertungsanforderung zurückgegeben wurde.

Name	Typ	Beschreibung
baseResults	string	Ergebnisse ohne semantische Anreicherung oder Reranking.
rerankedResults	string	Die Ergebnisse wurden mit dem Reranker-Modell neu bewertet und enthalten semantische Beschriftungen. Sie enthalten keine Antworten, Antworthighlights oder Beschriftungshighlights.

VectorFilterMode

Bestimmt, ob Filter vor oder nach der Vektorsuche angewendet werden.

Name	Typ	Beschreibung
postFilter	string	Der Filter wird angewendet, nachdem der Kandidatensatz von Vektorergebnissen zurückgegeben wurde. Je nach Filterauswahl kann dies zu weniger Ergebnissen führen als vom Parameter "k" angefordert.
preFilter	string	Der Filter wird vor der Suchabfrage angewendet.

VectorizableTextQuery

Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein Textwert bereitgestellt wird, der vektorisiert werden muss.

Name	Typ	Beschreibung
exhaustive	boolean	Wenn wahr, löst eine vollständige k-nächste Nachbarsuche über alle Vektoren innerhalb des Vektorindex aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen kritisch sind, z. B. das Bestimmen von Boden-Wahrheitswerten.
fields	string	Vektorfelder vom Typ Collection(Edm.Single), die in den durchsuchten Vektor einbezogen werden sollen.
k	integer	Die Anzahl der nächsten Nachbarn, die als Toptreffer zurückgegeben werden sollen.
kind	string: text	Die Art der ausgeführten Vektorabfrage.
oversampling	number	Übersamplingfaktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter "defaultOversampling". Sie kann nur festgelegt werden, wenn "rerankWithOriginalVectors" wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird.
text	string	Der text, der vektorisiert werden soll, um eine Vektorsuchabfrage auszuführen.
weight	number	Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanforderung. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Bewertungslisten kombiniert werden, die von den verschiedenen Vektorabfragen und/oder den ergebnissen, die über die Textabfrage abgerufen wurden. Je höher die Gewichtung ist, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0 und der Wert muss eine positive Zahl größer als 0 sein.

VectorQueryKind

Die Art der ausgeführten Vektorabfrage.

Name	Typ	Beschreibung
text	string	Vektorabfrage, bei der ein Textwert bereitgestellt wird, der vektorisiert werden muss.
vector	string	Vektorabfrage, bei der ein unformatierter Vektorwert bereitgestellt wird.

Freigeben über

Documents - Search Get

URI-Parameter

Anforderungsheader

Antworten

Beispiele

SearchIndexSearchDocumentsGet

Beispielanforderung

Beispiel für eine Antwort

SearchIndexSearchDocumentsSemanticGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

Zusätzliche Ressourcen