Documents - Search Get

Dienst:

Search Service

API-Version:

2023-10-01-Preview

Sucht nach Dokumenten im Index.

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

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}&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=2023-10-01-Preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Index.
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 kann sich auf die Leistung auswirken. Beachten Sie, dass die zurückgegebene Anzahl ein Näherungswert 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. Standardmäßig wird in aufsteigender Reihenfolge sortiert. Verknüpfungen werden durch die Ergebnisstände von Dokumenten getrennt. Wenn kein OrderBy angegeben ist, ist die Standardsortierreihenfolge absteigend nach Dokumentabgleichsbewertung. Es können maximal 32 $orderby-Klauseln vorhanden sein.
$select	query		string[]	Die Liste der abzurufenden Felder. Wenn nicht anders angegeben, werden alle im Schema als abrufbar gekennzeichnete Felder einbezogen.
$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 $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 das clientseitige Paging von Suchergebnissen zu implementieren. Wenn ergebnisse aufgrund von serverseitigem Paging abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine weitere Suchanforderung für die nächste Ergebnisseite auszugeben.
answers	query		QueryAnswerType	Dieser Parameter ist nur gültig, wenn der Abfragetyp lautet semantic. Wenn festgelegt, gibt die Abfrage Antworten zurück, die aus Schlüsselpassagen in den dokumenten mit dem höchsten Rang extrahiert wurden. Die Anzahl der zurückgegebenen Antworten kann konfiguriert werden, indem das Pipezeichen | gefolgt von der count-<number of answers> Option nach dem Antwortparameterwert angefügt wird, z extractive|count-3. B. . Die Standardanzahl ist 1. Der Konfidenzschwellenwert kann konfiguriert werden, indem das Pipezeichen | gefolgt von der threshold-<confidence threshold> Option nach dem Wert des Answers-Parameters angefügt wird, z extractive|threshold-0.9. B. . Der Standardschwellenwert ist 0,7.
captions	query		QueryCaptionType	Dieser Parameter ist nur gültig, wenn der Abfragetyp lautet semantic. Wenn festgelegt, gibt die Abfrage Beschriftungen zurück, die aus Schlüsselpassagen in den Dokumenten mit dem höchsten Rang extrahiert wurden. Wenn Captions auf extractivefestgelegt ist, ist die Hervorhebung standardmäßig aktiviert und kann konfiguriert werden, indem das Pipezeichen | gefolgt von der highlight-<true/false> Option wie extractive|highlight-trueangefügt wird. Der Standardwert lautet None.
debug	query		QueryDebugMode	Aktiviert ein Debugtool, das verwendet werden kann, um Ihre Suchergebnisse weiter zu untersuchen.
facet	query		string[]	Die Liste der Facettenausdrü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 für die Trefferherhebung 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, dem Trefferhighlights vorangestellt sind. 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 erfolgreich gemeldet wird. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standard ist 100.
queryLanguage	query		QueryLanguage	Die Sprache der Abfrage.
queryType	query		QueryType	Ein -Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
scoringParameter	query		string[]	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit dem Format name-values verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne die Anführungszeichen).
scoringProfile	query		string	Der Name eines Bewertungsprofils zum Auswerten von Übereinstimmungsbewertungen für den Vergleich von Dokumenten, um die Ergebnisse zu sortieren.
scoringStatistics	query		ScoringStatistics	Ein -Wert, der angibt, ob Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für eine geringere Latenz berechnet werden sollen.
search	query		string	Ein Volltextsuchabfrageausdruck; Verwenden Sie "*", oder lassen Sie diesen Parameter aus, um alle Dokumente abzugleichen.
searchFields	query		string[]	Die Liste der Feldnamen, auf die die Volltextsuche ausgerichtet werden soll. Wenn Sie die feldierte Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage verwenden, haben die Feldnamen jedes feldierten Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind.
searchMode	query		SearchMode	Ein -Wert, der angibt, ob ein oder alle Suchbegriffe abgeglichen werden 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 die Auswahl, ob ein semantischer Aufruf vollständig fehlschlagen oder Teilergebnisse (Standard) zurückgeben soll.
semanticFields	query		string[]	Die Liste der Feldnamen, die für die semantische Rangfolge verwendet werden.
semanticMaxWaitInMilliseconds	query		integer int32	Ermöglicht dem Benutzer, eine Obergrenze für den Zeitraum festzulegen, der benötigt wird, bis die Verarbeitung der semantischen Anreicherung abgeschlossen ist, 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. Eignet sich für Szenarien, in denen unterschiedliche Abfragen zwischen der Basisabruf- und Rangfolgephase und der semantischen L2-Phase verwendet werden müssen.
sessionId	query		string	Ein Wert, der zum Erstellen einer dauerhaften Sitzung verwendet werden soll, wodurch konsistentere Ergebnisse erzielt werden können. Solange dieselbe sessionId verwendet wird, wird versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die wiederholte Wiederverwendung der gleichen sessionID-Werte den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der als „sessionId“ verwendete Wert darf nicht mit dem Zeichen „_“ beginnen.
speller	query		Speller	Verbessern Sie den Suchrückruf, indem Sie einzelne Suchabfragebegriffe rechtschreibkorrekturen.

Anforderungsheader

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

Antworten

Name	Typ	Beschreibung
200 OK	SearchDocumentsResult	Antwort mit Dokumenten, die den Suchkriterien entsprechen.
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

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

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

Definitionen

Name	Beschreibung
AnswerResult	Eine Antwort ist eine Textpassage, die aus dem Inhalt der relevantesten Dokumente extrahiert wird, die mit der Abfrage übereinstimmen. Antworten werden aus den wichtigsten Suchergebnissen extrahiert. Antwortkandidaten werden bewertet und die besten Antworten ausgewählt.
CaptionResult	Beschriftungen sind die repräsentativsten Passagen aus dem Dokument im Verhältnis zur Suchabfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Beschriftungen werden nur für Abfragen vom Typ "semantic" zurückgegeben.
DocumentDebugInfo	Enthält Debuginformationen, die verwendet werden können, um Ihre Suchergebnisse weiter zu untersuchen.
QueryAnswerType	Ein -Wert, der angibt, ob Antworten im Rahmen der Suchantwort zurückgegeben werden sollen.
QueryCaptionType	Ein Wert, der angibt, ob Untertitel als Teil der Suchantwort zurückgegeben werden sollen.
QueryDebugMode	Aktiviert ein Debugtool, das verwendet werden kann, um Ihre Suchergebnisse weiter zu untersuchen.
QueryLanguage	Die Sprache der Abfrage.
QueryResultDocumentRerankerInput	Die unformatierten verketteten Zeichenfolgen, die an den semantischen Anreicherungsprozess gesendet wurden.
QueryResultDocumentSemanticField	Beschreibung der Felder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie deren Verwendung
QuerySpellerType	Ein -Wert, der den Typ der Rechtschreibprüfung angibt, die zur Rechtschreibkorrektur einzelner Suchabfragebegriffe verwendet werden soll.
QueryType	Gibt die Syntax der Suchabfrage an. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet, und "semantisch", wenn die Abfragesyntax nicht benötigt wird.
RawVectorQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert angegeben wird.
ScoringStatistics	Ein Wert, der angibt, ob Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für eine geringere Latenz berechnet werden sollen. Der Standardwert ist "local". Verwenden Sie "global", um Bewertungsstatistiken global vor der Bewertung zu aggregieren. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchabfragen erhöhen.
SearchDocumentsResult	Antwort, die Suchergebnisse aus einem Index enthält.
SearchError	Beschreibt eine Fehlerbedingung für die API.
SearchMode	Gibt an, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung zählt.
SearchRequest	Parameter zum Filtern, Sortieren, Faceting, Paging und anderen Suchabfrageverhalten.
SearchResult	Enthält ein Dokument, das von einer Suchabfrage gefunden wurde, sowie zugeordnete Metadaten.
SemanticDebugInfo
SemanticErrorMode	Ermöglicht dem Benutzer die Auswahl, ob ein semantischer Aufruf vollständig fehlschlagen oder Teilergebnisse (Standard) zurückgeben soll.
SemanticErrorReason	Grund dafür, dass eine Teilantwort für eine semantische Rangfolgeanforderung zurückgegeben wurde.
SemanticFieldState	Die Art und Weise, wie das Feld für den semantischen Anreicherungsprozess verwendet wurde (vollständig verwendet, teilweise verwendet oder nicht verwendet)
SemanticSearchResultsType	Typ der Teilantwort, die für eine semantische Rangfolgeanforderung zurückgegeben wurde.
Speller	Verbessern Sie den Suchrückruf, indem Sie einzelne Suchabfragebegriffe rechtschreibkorrekturen.
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 wird, die mit der Abfrage übereinstimmen. Antworten werden aus den wichtigsten Suchergebnissen extrahiert. Antwortkandidaten werden bewertet und die besten Antworten ausgewählt.

Name	Typ	Beschreibung
highlights	string	Dieselbe Textpassage wie in der Text-Eigenschaft mit hervorgehobenen Textbegriffen, die für die Abfrage am wichtigsten sind.
key	string	Der Schlüssel des Dokuments, aus dem die Antwort extrahiert wurde.
score	number	Der Bewertungswert gibt an, wie relevant die Antwort für die Abfrage im Verhältnis 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 im Verhältnis zur Suchabfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Beschriftungen werden nur für Abfragen vom Typ "semantic" zurückgegeben.

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

DocumentDebugInfo

Enthält Debuginformationen, die verwendet werden können, um Ihre Suchergebnisse weiter zu untersuchen.

Name	Typ	Beschreibung
semantic	SemanticDebugInfo	Enthält Debuginformationen, die speziell für semantische Rangfolgeanforderungen gelten.

QueryAnswerType

Ein -Wert, der angibt, ob Antworten im Rahmen der Suchantwort zurückgegeben werden sollen.

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

QueryCaptionType

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

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

QueryDebugMode

Aktiviert ein Debugtool, das verwendet werden kann, um Ihre Suchergebnisse weiter zu untersuchen.

Name	Typ	Beschreibung
disabled	string	Es werden keine Informationen zum Debuggen von Abfragen zurückgegeben.
semantic	string	Ermöglicht es dem Benutzer, seine neu bewerteten Ergebnisse weiter zu untersuchen.

QueryLanguage

Die Sprache der Abfrage.

Name	Typ	Beschreibung
ar-eg	string	Abfragesprachwert für Arabisch (Ägypten).
ar-jo	string	Abfragesprachwert für Arabisch (Jordanien).
ar-kw	string	Abfragesprachwert für Arabisch (Kuwait).
ar-ma	string	Abfragesprachwert für Arabisch (Marokko).
ar-sa	string	Abfragesprachwert für Arabisch (Saudi-Arabien).
bg-bg	string	Abfragesprachwert für Bulgarisch (Bulgarien).
bn-in	string	Abfragesprachwert für Bengali (Indien).
ca-es	string	Abfragesprachwert für Katalanisch.
cs-cz	string	Abfragesprachwert für Tschechisch (Tschechische Republik).
da-dk	string	Abfragesprachwert für Dänisch (Dänemark).
de-de	string	Abfragesprachwert für Deutsch (Deutschland).
el-gr	string	Abfragesprachwert für Griechisch (Griechenland).
en-au	string	Abfragesprachwert für Englisch (Australien).
en-ca	string	Abfragesprachwert für Englisch (Kanada).
en-gb	string	Abfragesprachwert für Englisch (Großbritannien).
en-in	string	Abfragesprachwert für Englisch (Indien).
en-us	string	Abfragesprachwert für Englisch (USA).
es-es	string	Abfragesprachwert für Spanisch (Spanien).
es-mx	string	Abfragesprachwert für Spanisch (Mexiko).
et-ee	string	Abfragesprachwert für Estnisch (Estland).
eu-es	string	Abfragesprachwert für Baskisch.
fa-ae	string	Abfragesprachwert für Persisch (U.A.E.).
fi-fi	string	Abfragesprachwert für Finnisch (Finnland).
fr-ca	string	Abfragesprachwert für Französisch (Kanada).
fr-fr	string	Abfragesprachwert für Französisch (Frankreich).
ga-ie	string	Abfragesprachwert für Irisch (Irland).
gl-es	string	Abfragesprachwert für Galizisch.
gu-in	string	Abfragesprachwert für Gujarati (Indien).
he-il	string	Abfragesprachwert für Hebräisch (Israel).
hi-in	string	Abfragesprachwert für Hindi (Indien).
hr-ba	string	Abfragesprachwert für Kroatisch (Bosnien und Herzegowina).
hr-hr	string	Abfragesprachwert für Kroatisch (Kroatien).
hu-hu	string	Abfragesprachwert für Ungarisch (Ungarn).
hy-am	string	Abfragesprachwert für Armenisch (Armenien).
id-id	string	Abfragesprachwert für Indonesisch (Indonesien).
is-is	string	Abfragesprachwert für Isländisch (Island).
it-it	string	Abfragesprachwert für Italienisch (Italien).
ja-jp	string	Abfragesprachwert für Japanisch (Japan).
kn-in	string	Abfragesprachwert für Kannada (Indien).
ko-kr	string	Abfragesprachwert für Koreanisch (Korea).
lt-lt	string	Abfragesprachwert für Litauisch (Litauen).
lv-lv	string	Abfragesprachwert für Lettisch (Lettland).
ml-in	string	Abfragesprachwert für Malayalam (Indien).
mr-in	string	Abfragesprachwert für Marathi (Indien).
ms-bn	string	Abfragesprachwert für Malaiisch (Brunei Darussalam).
ms-my	string	Abfragesprachwert für Malaiisch (Malaysia).
nb-no	string	Abfragesprachwert für Norwegisch (Norwegen).
nl-be	string	Abfragesprachwert für Niederländisch (Belgien).
nl-nl	string	Abfragesprachwert für Niederländisch (Niederlande).
no-no	string	Abfragesprachwert für Norwegisch (Norwegen).
none	string	Abfragesprache nicht angegeben.
pa-in	string	Abfragesprachwert für Punjabi (Indien).
pl-pl	string	Abfragesprachwert für Polnisch (Polen).
pt-br	string	Abfragesprachwert für Portugiesisch (Brasilien).
pt-pt	string	Abfragesprachwert für Portugiesisch (Portugal).
ro-ro	string	Abfragesprachwert für Rumänisch (Rumänien).
ru-ru	string	Abfragesprachwert für Russisch (Russland).
sk-sk	string	Abfragesprachwert für Slowakisch (Slowakei).
sl-sl	string	Abfragesprachwert für Slowenisch (Slowenien).
sr-ba	string	Abfragesprachwert für Serbisch (Bosnien und Herzegowina).
sr-me	string	Abfragesprachwert für Serbisch (Montenegro).
sr-rs	string	Abfragesprachwert für Serbisch (Serbien).
sv-se	string	Abfragesprachwert für Schwedisch (Schweden).
ta-in	string	Abfragesprachwert für Tamilisch (Indien).
te-in	string	Abfragesprachwert für Telugu (Indien).
th-th	string	Abfragesprachwert für Thai (Thailand).
tr-tr	string	Abfragesprachwert für Türkisch (Türkei).
uk-ua	string	Abfragesprachwert für Ukrainisch (Ukraine).
ur-pk	string	Abfragesprachwert für Urdu (Pakistan).
vi-vn	string	Abfragesprachwert für Vietnamesisch (Vietnam).
zh-cn	string	Abfragesprachwert für Chinesisch (China).
zh-tw	string	Abfragesprachwert für Chinesisch (Taiwan).

QueryResultDocumentRerankerInput

Die unformatierten verketteten Zeichenfolgen, die an den semantischen Anreicherungsprozess gesendet wurden.

Name	Typ	Beschreibung
content	string	Die unformatierten verketteten Zeichenfolgen für die Inhaltsfelder, die für die semantische Anreicherung verwendet wurden.
keywords	string	Die unformatierten verketteten Zeichenfolgen für die Schlüsselwort (keyword) Felder, die für die semantische Anreicherung verwendet wurden.
title	string	Die unformatierte Zeichenfolge für das Titelfeld, das für die semantische Anreicherung verwendet wurde.

QueryResultDocumentSemanticField

Beschreibung der Felder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie deren Verwendung

Name	Typ	Beschreibung
name	string	Der Name des Felds, das an den semantischen Anreicherungsprozess gesendet wurde.
state	SemanticFieldState	Die Art und Weise, wie das Feld für den semantischen Anreicherungsprozess verwendet wurde (vollständig verwendet, teilweise verwendet oder nicht verwendet)

QuerySpellerType

Ein -Wert, der den Typ der Rechtschreibprüfung angibt, die zur Rechtschreibkorrektur einzelner Suchabfragebegriffe verwendet werden soll.

Name	Typ	Beschreibung
lexicon	string	Die Rechtschreibprüfung korrigiert einzelne Abfragebegriffe mithilfe eines statischen Lexikons für die sprache, die durch den queryLanguage-Parameter angegeben wird.
none	string	Rechtschreibprüfung nicht aktiviert.

QueryType

Gibt die Syntax der Suchabfrage an. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet, und "semantisch", wenn die Abfragesyntax nicht benötigt wird.

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 Funktionen ermöglicht.
semantic	string	Am besten geeignet für Abfragen, die in natürlicher Sprache im Gegensatz zu Schlüsselwörtern ausgedrückt werden. Verbessert die Genauigkeit der Suchergebnisse, indem die besten Suchergebnisse mithilfe eines im Webkorpus trainierten Bewertungsmodells neu bewertet werden.
simple	string	Verwendet die einfache Abfragesyntax für Suchvorgänge. Suchtext wird mithilfe einer einfachen Abfragesprache interpretiert, die Symbole wie +, * und "" ermöglicht. Abfragen werden standardmäßig für alle durchsuchbaren Felder ausgewertet, es sei denn, der searchFields-Parameter ist angegeben.

RawVectorQuery

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

Name	Typ	Beschreibung
exhaustive	boolean	Wenn true, löst eine vollständige k-nächste Nachbarsuche für alle Vektoren innerhalb des Vektorindexes aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen entscheidend sind, z. B. die Bestimmung der Bodenwahrheitswerte.
fields	string	Vektorfelder vom Typ Collection(Edm.Single), die in den gesuchten Vektor eingeschlossen werden sollen.
k	integer	Anzahl der nächsten Nachbarn, die als Top-Treffer zurückgegeben werden sollen.
kind	string: vector	Die Art der ausgeführten Vektorabfrage.
vector	number[]	Die Vektordarstellung einer Suchabfrage.

ScoringStatistics

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

Name	Typ	Beschreibung
global	string	Die Bewertungsstatistiken werden global berechnet, um eine konsistentere Bewertung zu erzielen.
local	string	Die Bewertungsstatistiken werden lokal für eine geringere Latenz berechnet.

SearchDocumentsResult

Antwort, die Suchergebnisse aus einem Index enthält.

Name	Typ	Beschreibung
@odata.count	integer	Die Gesamtanzahl der vom Suchvorgang gefundenen Ergebnisse oder NULL, wenn die Anzahl nicht angefordert wurde. Falls vorhanden, kann die Anzahl größer sein als die Anzahl der Ergebnisse in dieser Antwort. Dies kann vorkommen, 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	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 weitere GET- oder POST-Suchanforderung zu formulieren, um den nächsten Teil der Suchantwort abzurufen. Stellen Sie sicher, dass Sie dasselbe Verb (GET oder POST) wie die Anforderung verwenden, die diese Antwort erzeugt hat.
@search.answers	AnswerResult[]	Die Antwortabfrageergebnisse 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 in der Anforderung nicht angegeben wurde.
@search.facets	object	Die Facetabfrageergebnisse für den Suchvorgang, die als Sammlung von Buckets für jedes Facettenfeld organisiert sind; null, wenn die Abfrage keine Facetausdrücke enthält.
@search.nextPageParameters	SearchRequest	Die JSON-Nutzlast der Fortsetzung 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 weitere POST-Suchanforderung zu formulieren, um den nächsten Teil der Suchantwort abzurufen.
@search.semanticPartialResponseReason	SemanticErrorReason	Grund dafür, dass eine partielle Antwort für eine semantische Rangfolgeanforderung zurückgegeben wurde.
@search.semanticPartialResponseType	SemanticSearchResultsType	Typ der partiellen Antwort, die für eine semantische Rangfolgeanforderung zurückgegeben wurde.
value	SearchResult[]	Die Sequenz der von der Abfrage zurückgegebenen Ergebnisse.

SearchError

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

SearchMode

Gibt an, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung zählt.

Name	Typ	Beschreibung
all	string	Alle Suchbegriffe müssen abgeglichen werden, um das Dokument als Übereinstimmung zu zählen.
any	string	Jeder der Suchbegriffe muss abgeglichen werden, 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 Untertitel 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 kann sich auf die Leistung auswirken. Beachten Sie, dass die zurückgegebene Anzahl ein Näherungswert ist.
debug	QueryDebugMode	Aktiviert ein Debugtool, das verwendet werden kann, um Ihre neu bewerteten Ergebnisse weiter zu untersuchen.
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 zur Treffermarkierung verwendet werden.
highlightPostTag	string	Ein Zeichenfolgentag, das an Hervorhebungen angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.
highlightPreTag	string	Ein Zeichenfolgentag, dem das Erreichen von Hervorhebungen 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 erfolgreich gemeldet wird. Dieser Parameter kann nützlich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standard 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 anzugeben, oder desc, um absteigend anzugeben. Standardmäßig wird in aufsteigender Reihenfolge sortiert. Verknüpfungen werden durch die Ergebnisstände von Dokumenten getrennt. Wenn kein $orderby angegeben ist, wird die Standardsortierreihenfolge nach dokumentgleicher Bewertung absteigend. Es können maximal 32 $orderby-Klauseln vorhanden sein.
queryLanguage	QueryLanguage	Ein Wert, der die Sprache der Suchabfrage angibt.
queryType	QueryType	Ein Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "einfach". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
scoringParameters	string[]	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) unter Verwendung des Formats name-values verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne die Anführungszeichen).
scoringProfile	string	Der Name eines Bewertungsprofils zum Auswerten von Übereinstimmungsbewertungen für den Vergleich von Dokumenten, um die Ergebnisse zu sortieren.
scoringStatistics	ScoringStatistics	Ein Wert, der angibt, ob Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für eine geringere Latenz berechnet werden sollen. Der Standardwert ist "local". Verwenden Sie "global", um Bewertungsstatistiken global vor der Bewertung zu aggregieren. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchabfragen erhöhen.
search	string	Ein Volltextsuchabfrageausdruck; Verwenden Sie "*", oder lassen Sie diesen Parameter aus, um allen Dokumenten zu entsprechen.
searchFields	string	Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche abgegrenzt werden soll. Wenn Sie die Feldsuche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage verwenden, haben die Feldnamen jedes feldierten Suchausdrucks Vorrang vor allen in diesem Parameter aufgeführten Feldnamen.
searchMode	SearchMode	Ein Wert, der angibt, ob ein 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 anders angegeben, werden alle im Schema als abrufbar gekennzeichnete Felder einbezogen.
semanticConfiguration	string	Der Name einer semantischen Konfiguration, die beim Verarbeiten von Dokumenten für Abfragen vom Typ Semantik verwendet wird.
semanticErrorHandling	SemanticErrorMode	Ermöglicht dem Benutzer die Auswahl, ob bei einem semantischen Aufruf ein vollständiger Fehler auftreten soll oder ob partielle Ergebnisse zurückgegeben werden sollen (Standard).
semanticFields	string	Die durch Trennzeichen getrennte Liste der Feldnamen, die für die semantische Rangfolge verwendet werden.
semanticMaxWaitInMilliseconds	integer	Ermöglicht es dem Benutzer, eine Obergrenze für die Zeit festzulegen, die bis zur semantischen Anreicherung benötigt wird, bis die Verarbeitung abgeschlossen ist, bevor die Anforderung fehlschlägt.
semanticQuery	string	Ermöglicht das Festlegen einer separaten Suchabfrage, die ausschließlich für semantische Neuranking, semantische Beschriftungen und semantische Antworten verwendet wird. Ist nützlich für Szenarien, in denen zwischen der Basisabruf- und Rangfolgephase und der semantischen L2-Phase unterschiedliche Abfragen verwendet werden müssen.
sessionId	string	Ein Wert, der zum Erstellen einer klebrigen Sitzung verwendet werden soll, mit dem konsistentere Ergebnisse erzielt werden können. Solange dieselbe sessionId verwendet wird, wird ein Best-Effort-Versuch unternommen, um denselben Replikatsatz als Ziel festzulegen. Seien Sie vorsichtig, dass die wiederholte Wiederverwendung der gleichen sessionID-Werte den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der als „sessionId“ verwendete Wert darf nicht mit dem Zeichen „_“ beginnen.
skip	integer	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 orderby für einen vollständig sortierten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern.
speller	QuerySpellerType	Ein Wert, der den Typ der Rechtschreibprüfung angibt, mit dem einzelne Suchabfragebegriffe rechtschreibfehlert werden sollen.
top	integer	Die Anzahl der abzurufenden Suchergebnisse. Dies kann in Verbindung mit $skip verwendet werden, um das clientseitige Paging von Suchergebnissen zu implementieren. Wenn ergebnisse aufgrund von serverseitigem Paging abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine weitere Suchanforderung für die nächste Ergebnisseite auszustellen.
vectorFilterMode	VectorFilterMode	Bestimmt, ob Filter vor oder nach der Vektorsuche angewendet werden. Der Standardwert ist "preFilter".
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 im Verhältnis zur Suchabfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Beschriftungen werden nur für Abfragen vom Typ "semantic" zurückgegeben.
@search.documentDebugInfo	DocumentDebugInfo[]	Enthält Debuginformationen, die verwendet werden können, um Ihre Suchergebnisse weiter zu untersuchen.
@search.highlights	object	Textfragmente aus dem Dokument, die die übereinstimmenden Suchbegriffe angeben, sortiert nach jedem anwendbaren Feld; NULL, wenn die Trefferherhebung für die Abfrage nicht aktiviert war.
@search.rerankerScore	number	Die Relevanzbewertung, die vom semantischen Rangfolger für die obersten Suchergebnisse berechnet wird. Die Suchergebnisse werden zuerst nach RerankerScore und dann nach der Bewertung sortiert. RerankerScore wird nur für Abfragen vom Typ "semantic" zurückgegeben.
@search.score	number	Die Relevanzbewertung des Dokuments im Vergleich zu anderen Dokumenten, die von der Abfrage zurückgegeben werden.

SemanticDebugInfo

Name	Typ	Beschreibung
contentFields	QueryResultDocumentSemanticField[]	Die Inhaltsfelder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie deren Verwendung
keywordFields	QueryResultDocumentSemanticField[]	Die Schlüsselwort (keyword) Felder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie deren Verwendung
rerankerInput	QueryResultDocumentRerankerInput	Die unformatierten verketteten Zeichenfolgen, die an den semantischen Anreicherungsprozess gesendet wurden.
titleField	QueryResultDocumentSemanticField	Das Titelfeld, das an den semantischen Anreicherungsprozess gesendet wurde, sowie die Verwendung

SemanticErrorMode

Ermöglicht dem Benutzer die Auswahl, ob ein semantischer Aufruf vollständig fehlschlagen oder Teilergebnisse (Standard) zurückgeben soll.

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 den Fehler war.

SemanticErrorReason

Grund dafür, dass eine Teilantwort für eine semantische Rangfolgeanforderung zurückgegeben wurde.

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

SemanticFieldState

Die Art und Weise, wie das Feld für den semantischen Anreicherungsprozess verwendet wurde (vollständig verwendet, teilweise verwendet oder nicht verwendet)

Name	Typ	Beschreibung
partial	string	Das Feld wurde teilweise für die semantische Anreicherung verwendet.
unused	string	Das Feld wurde nicht für die semantische Anreicherung verwendet.
used	string	Das Feld wurde vollständig für die semantische Anreicherung verwendet.

SemanticSearchResultsType

Typ der Teilantwort, die für eine semantische Rangfolgeanforderung zurückgegeben wurde.

Name	Typ	Beschreibung
baseResults	string	Ergebnisse ohne semantische Anreicherung oder Umrankung.
rerankedResults	string	Die Ergebnisse wurden mit dem Rerankermodell neu bewertet und enthalten semantische Beschriftungen. Sie enthalten keine Antworten, Antworten auf Hervorhebungen oder Untertitel Highlights.

Speller

Verbessern Sie den Suchrückruf, indem Sie einzelne Suchabfragebegriffe rechtschreibkorrekturen.

Name	Typ	Beschreibung
lexicon	string	Die Rechtschreibprüfung korrigiert einzelne Abfragebegriffe mithilfe eines statischen Lexikons für die sprache, die durch den queryLanguage-Parameter angegeben wird.
none	string	Rechtschreibprüfung nicht aktiviert.

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 Filtersektivität kann dies zu weniger Ergebnissen führen, als vom Parameter "k" angefordert wird.
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 true, löst eine vollständige k-nächste Nachbarsuche für alle Vektoren innerhalb des Vektorindexes aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen entscheidend sind, z. B. die Bestimmung der Bodenwahrheitswerte.
fields	string	Vektorfelder vom Typ Collection(Edm.Single), die in den gesuchten Vektor eingeschlossen werden sollen.
k	integer	Anzahl der nächsten Nachbarn, die als Top-Treffer zurückgegeben werden sollen.
kind	string: text	Die Art der ausgeführten Vektorabfrage.
text	string	Der Text, der vektorisiert werden soll, um eine Vektorsuchabfrage auszuführen.

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.