Documents - Search Get
Sucht nach Dokumenten im Index.
GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-08-01-preview
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=2025-08-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&queryRewrites={queryRewrites}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
Die Endpunkt-URL des Suchdiensts. |
|
index
|
path | True |
string |
Der Name des Index. |
|
api-version
|
query | True |
string |
Version der Client-API. |
|
$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 es sich bei der zurückgegebenen Zählung um einen Näherungswert handelt. |
|
|
$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. Auf jeden Ausdruck kann asc folgen, um aufsteigend anzugeben, und desc, um absteigend anzugeben. Die Standardeinstellung ist aufsteigend. Unentschieden werden durch die Spielergebnisse der Dokumente aufgelöst. Wenn kein OrderBy angegeben ist, wird die Standardsortierreihenfolge absteigend nach Dokumentabgleichsbewertung verwendet. Es können höchstens 32 $orderby Klauseln bestehen. |
|
|
$select
|
query |
string[] |
Die Liste der Felder, die abgerufen werden sollen. Wenn nicht angegeben, werden alle Felder, die im Schema als abrufbar markiert sind, eingeschlossen. |
|
|
$skip
|
query |
integer (int32) |
Die Anzahl der Suchergebnisse, die übersprungen werden sollen. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente nacheinander scannen müssen, $skip aber aufgrund dieser Einschränkung nicht verwenden können, sollten Sie $orderby für einen vollständig geordneten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage $filter. |
|
|
$top
|
query |
integer (int32) |
Die Anzahl der Suchergebnisse, die abgerufen werden sollen. Dies kann in Verbindung mit $skip verwendet werden, um das 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 weitere Suchanforderung für die nächste Ergebnisseite auszugeben. |
|
|
answers
|
query |
Dieser Parameter ist nur gültig, wenn der Abfragetyp |
||
|
captions
|
query |
Dieser Parameter ist nur gültig, wenn der Abfragetyp |
||
|
debug
|
query |
Aktiviert ein Debugtool, mit dem Sie Ihre Suchergebnisse weiter untersuchen können. |
||
|
facet
|
query |
string[] |
Die Liste der Facettenausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facettenausdruck enthält einen Feldnamen, optional gefolgt von einer durch Kommas getrennten Liste von Name-Wert-Paaren. |
|
|
highlight
|
query |
string[] |
Die Liste der Feldnamen, die für Trefferhervorhebungen verwendet werden sollen. Nur durchsuchbare Felder können für die Trefferhervorhebung verwendet werden. |
|
|
highlight
|
query |
string |
Ein Zeichenfolgen-Tag, das an Treffermarkierungen angehängt wird. Muss mit highlightPreTag gesetzt werden. Der Standardwert ist </em>. |
|
|
highlight
|
query |
string |
Ein Zeichenfolgen-Tag, dem das Erreichen von Highlights vorangestellt wird. Muss mit highlightPostTag gesetzt werden. Der Standardwert ist <em>. |
|
|
minimum
|
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 erfolgreich gemeldet wird. Dieser Parameter kann nützlich sein, um die Verfügbarkeit der Suche auch für Dienste mit nur einem Replikat sicherzustellen. Der Standard ist 100. |
|
|
query
|
query |
Die Sprache der Abfrage. |
||
|
query
|
query |
Wenn QueryRewrites auf |
||
|
query
|
query |
Ein Wert, der die Syntax der Suchabfrage angibt. Die Standardeinstellung ist 'einfach'. Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet. |
||
|
scoring
|
query |
string[] |
Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) im Format name-values verwendet werden sollen. Wenn das Bewertungsprofil z. B. eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne Anführungszeichen). |
|
|
scoring
|
query |
string |
Der Name eines Bewertungsprofils zum Auswerten von Übereinstimmungsergebnissen für übereinstimmende Dokumente, um die Ergebnisse zu sortieren. |
|
|
scoring
|
query |
Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. die Häufigkeit von Dokumenten) global berechnen möchten, um eine konsistentere Bewertung zu erzielen, oder lokal, um die Latenz zu verringern. |
||
|
search
|
query |
string |
Ein Ausdruck für eine Volltextsuchabfrage. Verwenden Sie "*" oder lassen Sie diesen Parameter weg, um alle Dokumente abzugleichen. |
|
|
search
|
query |
string[] |
Die Liste der Feldnamen, auf die die Volltextsuche beschränkt werden soll. Wenn Sie die Feldsuche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage verwenden, haben die Feldnamen der einzelnen Feldsuchausdrücke Vorrang vor allen Feldnamen, die in diesem Parameter aufgeführt sind. |
|
|
search
|
query |
Ein Wert, der angibt, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung gezählt wird. |
||
|
semantic
|
query |
string |
Der Name der semantischen Konfiguration, die auflistet, welche Felder für die semantische Rangfolge, Beschriftungen, Hervorhebungen und Antworten verwendet werden sollen |
|
|
semantic
|
query |
Ermöglicht dem Benutzer die Auswahl, ob ein semantischer Aufruf vollständig fehlschlagen oder Teilergebnisse zurückgeben sollen (Standard). |
||
|
semantic
|
query |
string[] |
Die Liste der Feldnamen, die für die semantische Rangfolge verwendet werden. |
|
|
semantic
|
query |
integer (int32) minimum: 700 |
Ermöglicht es dem Benutzer, eine Obergrenze für die Zeit festzulegen, die die semantische Anreicherung benötigt, um die Verarbeitung abzuschließen, bevor die Anforderung fehlschlägt. |
|
|
semantic
|
query |
string |
Ermöglicht das Festlegen einer separaten Suchanfrage, die ausschließlich für semantisches Reranking, semantische Untertitel und semantische Antworten verwendet wird. Ist nützlich für Szenarien, in denen zwischen der Basisabruf- und Bewertungsphase und der semantischen L2-Phase unterschiedliche Abfragen verwendet werden müssen. |
|
|
session
|
query |
string |
Ein Wert, der zum Erstellen einer fixierten Sitzung verwendet werden soll, was dazu beitragen kann, konsistentere Ergebnisse zu erzielen. Solange dieselbe sessionId verwendet wird, wird nach bestem Wissen und Gewissen versucht, dieselbe Replikatgruppe als Ziel zu verwenden. Achten Sie darauf, dass die wiederholte Wiederverwendung derselben sessionID-Werte den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und sich negativ auf die Leistung des Suchdiensts auswirken kann. Der als sessionId verwendete Wert darf nicht mit dem Zeichen "_" beginnen. |
|
|
speller
|
query |
Verbessern Sie die Sucherinnerung, indem Sie die Rechtschreibung einzelner Suchbegriffe korrigieren. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Die Nachverfolgungs-ID, die mit der Anforderung gesendet wird, um das Debuggen zu unterstützen. |
|
| x-ms-query-source-authorization |
string |
Token, das den Benutzer identifiziert, für den die Abfrage ausgeführt wird. Dieses Token wird verwendet, um Sicherheitseinschränkungen für Dokumente durchzusetzen. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Antwort mit Dokumenten, die den Suchkriterien entsprechen. |
|
| Other Status Codes |
Antwort, die Teildokumente enthält, die den Suchkriterien entsprechen. |
|
| Other Status Codes |
Fehlerantwort. |
Beispiele
|
Search |
|
Search |
SearchIndexSearchDocumentsGet
Beispielanforderung
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=2025-08-01-preview&speller={speller}
Beispiel für eine Antwort
{
"@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"
}
]
}
{
"@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
GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2025-08-01-preview&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}
Beispiel für eine Antwort
{
"@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"
]
}
]
}
{
"@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 |
|---|---|
|
Answer |
Eine Antwort ist eine Textpassage, die aus dem Inhalt der relevantesten Dokumente extrahiert wird, die der Suchanfrage entsprechen. Die Antworten werden aus den Top-Suchergebnissen extrahiert. Die Antwortkandidaten werden bewertet und die besten Antworten werden ausgewählt. |
|
Caption |
Bildunterschriften sind die repräsentativsten Passagen aus dem Dokument im Verhältnis zur Suchanfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Untertitel werden nur für Abfragen vom Typ |
|
Debug |
Enthält Debuginformationen, die zum weiteren Untersuchen Ihrer Suchergebnisse verwendet werden können. |
|
Document |
Enthält Debuginformationen, die zum weiteren Untersuchen Ihrer Suchergebnisse verwendet werden können. |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
|
Hybrid |
Bestimmt, ob die Anzahl und die Facetten alle Dokumente enthalten sollen, die der Suchabfrage entsprechen, oder nur die Dokumente, die im Fenster "maxTextRecallSize" abgerufen werden. Der Standardwert ist 'countAllResults'. |
|
Hybrid |
DDie Abfrageparameter zur Konfiguration von hybridem Suchverhalten. |
|
Query |
Ein Wert, der angibt, ob Antworten als Teil der Suchantwort zurückgegeben werden sollen. |
|
Query |
Ein Wert, der angibt, ob Untertitel als Teil der Suchantwort zurückgegeben werden sollen. |
|
Query |
Aktiviert ein Debugtool, mit dem Sie Ihre Suchergebnisse weiter untersuchen können. Sie können mehrere Debug-Modi gleichzeitig aktivieren, indem Sie sie mit einem | Zeichen, zum Beispiel: semantic|queryRewrites. |
|
Query |
Die Sprache der Abfrage. |
|
Query |
Die unformatierten verketteten Zeichenfolgen, die an den semantischen Anreicherungsprozess gesendet wurden. |
|
Query |
Beschreibung der Felder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie deren Verwendung |
|
Query |
Die Aufschlüsselung der Teilbewertungen zwischen den Text- und Vektorabfragekomponenten der Suchabfrage für dieses Dokument. Jede Vektorabfrage wird als separates Objekt in der gleichen Reihenfolge angezeigt, in der sie empfangen wurde. |
|
Query |
Enthält Debuginformationen, die für das Umschreiben von Abfragen spezifisch sind. |
|
Query |
Ein Wert, der angibt, ob Abfrageumschreibungen generiert werden sollen, um die Suchabfrage zu erweitern. |
|
Query |
Enthält Debuginformationen, die für das Umschreiben von Abfragen spezifisch sind. |
|
Query |
Ein Wert, der den Typ der Rechtschreibprüfung angibt, die zum Korrigieren einzelner Suchbegriffe verwendet werden soll. |
|
Query |
Gibt die Syntax der Suchabfrage an. Die Standardeinstellung ist 'einfach'. Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet, und 'semantic', wenn die Abfragesyntax nicht benötigt wird. |
|
Raw |
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert angegeben wird. |
|
Scoring |
Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. die Häufigkeit von Dokumenten) global berechnen möchten, um eine konsistentere Bewertung zu erzielen, oder lokal, um die Latenz zu verringern. Der Standardwert ist 'local'. Verwenden Sie "global", um Punktestatistiken global zu aggregieren, bevor Sie eine Bewertung vornehmen. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchanfragen erhöhen. |
|
Search |
Antwort, die Suchergebnisse aus einem Index enthält. |
|
Search |
Gibt an, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung gezählt wird. |
|
Search |
Parameter zum Filtern, Sortieren, Facettieren, Auslagern und andere Verhaltensweisen von Suchabfragen. |
|
Search |
Enthält ein Dokument, das durch eine Suchabfrage gefunden wurde, sowie die zugehörigen Metadaten. |
|
Search |
Die Ergebnisse der Vektorabfrage werden basierend auf dem Wert "@search.score" gefiltert. Beachten Sie, dass dies der @search.score zurückgegebene Teil der Suchantwort ist. Die Schwellenrichtung wird für höher @search.scoregewählt. |
|
Semantic |
|
|
Semantic |
Ermöglicht dem Benutzer die Auswahl, ob ein semantischer Aufruf vollständig fehlschlagen soll (Standard-/aktuelles Verhalten) oder ob Teilergebnisse zurückgegeben werden sollen. |
|
Semantic |
Grund dafür, dass eine Teilantwort für eine semantische Rangfolgeanforderung zurückgegeben wurde. |
|
Semantic |
Die Art und Weise, wie das Feld für den semantischen Anreicherungsprozess verwendet wurde (vollständig verwendet, teilweise verwendet oder nicht verwendet) |
|
Semantic |
Typ des Umschreibens von Abfragen, der für diese Anforderung verwendet wurde. |
|
Semantic |
Typ der Teilantwort, die für eine semantische Rangfolgeanforderung zurückgegeben wurde. |
|
Single |
Ein einzelnes Vektorfeldergebnis. Sowohl als auch @search.score Vektorähnlichkeitswerte werden zurückgegeben. Die Vektorähnlichkeit wird durch eine Gleichung in Beziehung gesetzt @search.score . |
|
Text |
Die BM25- oder Classic-Bewertung für den Textteil der Abfrage. |
|
Vector |
Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden. |
|
Vectorizable |
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine Base64-codierte Binärdatei eines Bildes bereitgestellt wird, das vektorisiert werden muss. |
|
Vectorizable |
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine URL angegeben wird, die einen Bildwert darstellt, der vektorisiert werden muss. |
|
Vectorizable |
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein Textwert angegeben wird, der vektorisiert werden muss. |
|
Vector |
Die Art der Vektorabfrage, die ausgeführt wird. |
|
Vectors |
|
|
Vector |
Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorähnlichkeitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die "Entfernungs"-Version. Die Richtung des Schwellenwerts (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt. |
|
Vector |
Die Art der Vektorabfrage, die ausgeführt wird. |
AnswerResult
Eine Antwort ist eine Textpassage, die aus dem Inhalt der relevantesten Dokumente extrahiert wird, die der Suchanfrage entsprechen. Die Antworten werden aus den Top-Suchergebnissen extrahiert. Die Antwortkandidaten werden bewertet und die besten Antworten werden ausgewählt.
| Name | Typ | Beschreibung |
|---|---|---|
| highlights |
string |
Dieselbe Textpassage wie in der Text-Eigenschaft mit hervorgehobenen Textphrasen, die für die Abfrage am relevantesten sind. |
| key |
string |
Der Schlüssel des Dokuments, aus dem die Antwort extrahiert wurde. |
| score |
number (double) |
Der Bewertungswert gibt an, wie relevant die Antwort für die Abfrage im Vergleich zu anderen Antworten ist, die für die Abfrage zurückgegeben werden. |
| text |
string |
Die aus dem Dokumentinhalt extrahierte Textpassage als Antwort. |
CaptionResult
Bildunterschriften sind die repräsentativsten Passagen aus dem Dokument im Verhältnis zur Suchanfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Untertitel werden nur für Abfragen vom Typ semantic.
| 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 wird, das für die Suchanfrage am relevantesten ist. |
DebugInfo
Enthält Debuginformationen, die zum weiteren Untersuchen Ihrer Suchergebnisse verwendet werden können.
| Name | Typ | Beschreibung |
|---|---|---|
| queryRewrites |
Enthält Debuginformationen, die für das Umschreiben von Abfragen spezifisch sind. |
DocumentDebugInfo
Enthält Debuginformationen, die zum weiteren Untersuchen Ihrer Suchergebnisse verwendet werden können.
| Name | Typ | Beschreibung |
|---|---|---|
| innerHits |
object |
Enthält Debuginformationen, die für Vektoren spezifisch sind, die in einer Auflistung komplexer Typen übereinstimmen. |
| semantic |
Enthält Debuginformationen, die für semantische Rangfolgeanforderungen spezifisch sind. |
|
| vectors |
Enthält Debugging-Informationen, die für die Vektor- und Hybridsuche spezifisch sind. |
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 |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
HybridCountAndFacetMode
Bestimmt, ob die Anzahl und die Facetten alle Dokumente enthalten sollen, die der Suchabfrage entsprechen, oder nur die Dokumente, die im Fenster "maxTextRecallSize" abgerufen werden. Der Standardwert ist 'countAllResults'.
| Wert | Beschreibung |
|---|---|
| countRetrievableResults |
Schließen Sie bei der Berechnung von "Anzahl" und "Facetten" nur Dokumente ein, die innerhalb des Abruffensters "maxTextRecallSize" abgeglichen wurden. |
| countAllResults |
Schließen Sie alle Dokumente ein, die von der Suchabfrage beim Berechnen von "count" und "facets" übereinstimmen, unabhängig davon, ob sich diese Dokumente innerhalb des Abruffensters "maxTextRecallSize" befinden oder nicht. |
HybridSearch
DDie Abfrageparameter zur Konfiguration von hybridem Suchverhalten.
| Name | Typ | Beschreibung |
|---|---|---|
| countAndFacetMode |
Bestimmt, ob die Anzahl und die Facetten alle Dokumente enthalten sollen, die der Suchabfrage entsprechen, oder nur die Dokumente, die im Fenster "maxTextRecallSize" abgerufen werden. |
|
| maxTextRecallSize |
integer (int32) |
Bestimmt die maximale Anzahl von Dokumenten, die vom Textabfrageteil einer Hybridsuchanforderung abgerufen werden sollen. Diese Dokumente werden mit den Dokumenten kombiniert, die den Vektorabfragen entsprechen, um eine einzige endgültige Ergebnisliste zu erstellen. Wenn Sie einen größeren maxTextRecallSize-Wert auswählen, können Sie mehr Dokumente abrufen und durchblättern (mit den Parametern top und skip), was zu einer höheren Ressourcenauslastung und höheren Latenz führt. Der Wert muss zwischen 1 und 10.000 liegen. Der Standard ist 1000. |
QueryAnswerType
Ein Wert, der angibt, ob Antworten als Teil der Suchantwort zurückgegeben werden sollen.
| Wert | Beschreibung |
|---|---|
| none |
Geben Sie keine Antworten für die Abfrage zurück. |
| extractive |
Extrahiert Antwortkandidaten aus dem Inhalt der Dokumente, die als Antwort auf eine Abfrage zurückgegeben werden, die als Frage in natürlicher Sprache ausgedrückt wird. |
QueryCaptionType
Ein Wert, der angibt, ob Untertitel als Teil der Suchantwort zurückgegeben werden sollen.
| Wert | Beschreibung |
|---|---|
| none |
Geben Sie keine Untertitel für die Abfrage zurück. |
| extractive |
Extrahiert Beschriftungen aus den übereinstimmenden Dokumenten, die für die Suchanfrage relevante Passagen enthalten. |
QueryDebugMode
Aktiviert ein Debugtool, mit dem Sie Ihre Suchergebnisse weiter untersuchen können. Sie können mehrere Debug-Modi gleichzeitig aktivieren, indem Sie sie mit einem | Zeichen, zum Beispiel: semantic|queryRewrites.
| Wert | Beschreibung |
|---|---|
| disabled |
Es werden keine Informationen zum Debuggen von Abfragen zurückgegeben. |
| semantic |
Ermöglicht es dem Benutzer, seine neu eingestuften Ergebnisse weiter zu untersuchen. |
| vector |
Ermöglicht es dem Benutzer, seine Hybrid- und Vektorabfrageergebnisse weiter zu untersuchen. |
| queryRewrites |
Ermöglicht es dem Benutzer, die Liste der Abfrageumschreibungen zu untersuchen, die für seine Suchanforderung generiert wurden. |
| innerHits |
Ermöglicht dem Benutzer das Abrufen von Bewertungsinformationen zu Vektoren, die in einer Auflistung komplexer Typen übereinstimmen. |
| all |
Aktivieren Sie alle Debug-Optionen. |
QueryLanguage
Die Sprache der Abfrage.
| Wert | Beschreibung |
|---|---|
| none |
Abfragesprache nicht angegeben. |
| en-us |
Wert der Abfragesprache für Englisch (USA). |
| en-gb |
Wert der Abfragesprache für Englisch (Großbritannien). |
| en-in |
Wert der Abfragesprache für Englisch (Indien). |
| en-ca |
Wert der Abfragesprache für Englisch (Kanada). |
| en-au |
Wert der Abfragesprache für Englisch (Australien). |
| fr-fr |
Wert der Abfragesprache für Französisch (Frankreich). |
| fr-ca |
Wert der Abfragesprache für Französisch (Kanada). |
| de-de |
Wert der Abfragesprache für Deutsch (Deutschland). |
| es-es |
Wert der Abfragesprache für Spanisch (Spanien). |
| es-mx |
Wert der Abfragesprache für Spanisch (Mexiko). |
| zh-cn |
Wert der Abfragesprache für Chinesisch (China). |
| zh-tw |
Wert der Abfragesprache für Chinesisch (Taiwan). |
| pt-br |
Wert der Abfragesprache für Portugiesisch (Brasilien). |
| pt-pt |
Wert der Abfragesprache für Portugiesisch (Portugal). |
| it-it |
Wert der Abfragesprache für Italienisch (Italien). |
| ja-jp |
Wert der Abfragesprache für Japanisch (Japan). |
| ko-kr |
Wert der Abfragesprache für Koreanisch (Korea). |
| ru-ru |
Wert der Abfragesprache für Russisch (Russland). |
| cs-cz |
Wert der Abfragesprache für Tschechisch (Tschechische Republik). |
| nl-be |
Wert der Abfragesprache für Niederländisch (Belgien). |
| nl-nl |
Wert der Abfragesprache für Niederländisch (Niederlande). |
| hu-hu |
Wert der Abfragesprache für Ungarisch (Ungarn). |
| pl-pl |
Wert der Abfragesprache für Polnisch (Polen). |
| sv-se |
Wert der Abfragesprache für Schwedisch (Schweden). |
| tr-tr |
Wert der Abfragesprache für Türkisch (Türkei). |
| hi-in |
Wert der Abfragesprache für Hindi (Indien). |
| ar-sa |
Wert der Abfragesprache für Arabisch (Saudi-Arabien). |
| ar-eg |
Wert der Abfragesprache für Arabisch (Ägypten). |
| ar-ma |
Wert der Abfragesprache für Arabisch (Marokko). |
| ar-kw |
Wert der Abfragesprache für Arabisch (Kuwait). |
| ar-jo |
Wert der Abfragesprache für Arabisch (Jordanien). |
| da-dk |
Wert der Abfragesprache für Dänisch (Dänemark). |
| no-no |
Wert der Abfragesprache für Norwegisch (Norwegen). |
| bg-bg |
Wert der Abfragesprache für Bulgarisch (Bulgarien). |
| hr-hr |
Wert der Abfragesprache für Kroatisch (Kroatien). |
| hr-ba |
Wert der Abfragesprache für Kroatisch (Bosnien und Herzegowina). |
| ms-my |
Wert der Abfragesprache für Malaiisch (Malaysia). |
| ms-bn |
Wert der Abfragesprache für Malaiisch (Brunei Darussalam). |
| sl-sl |
Wert der Abfragesprache für Slowenisch (Slowenien). |
| ta-in |
Wert der Abfragesprache für Tamil (Indien). |
| vi-vn |
Wert der Abfragesprache für Vietnamesisch (Vietnam). |
| el-gr |
Wert der Abfragesprache für Griechisch (Griechenland). |
| ro-ro |
Wert der Abfragesprache für Rumänisch (Rumänien). |
| is-is |
Wert der Abfragesprache für Isländisch (Island). |
| id-id |
Wert der Abfragesprache für Indonesisch (Indonesien). |
| th-th |
Wert der Abfragesprache für Thai (Thailand). |
| lt-lt |
Wert der Abfragesprache für Litauisch (Litauen). |
| uk-ua |
Wert der Abfragesprache für Ukrainisch (Ukraine). |
| lv-lv |
Wert der Abfragesprache für Lettisch (Lettland). |
| et-ee |
Wert der Abfragesprache für Estnisch (Estland). |
| ca-es |
Wert der Abfragesprache für Katalanisch. |
| fi-fi |
Wert der Abfragesprache für Finnisch (Finnland). |
| sr-ba |
Wert der Abfragesprache für Serbisch (Bosnien und Herzegowina). |
| sr-me |
Wert der Abfragesprache für Serbisch (Montenegro). |
| sr-rs |
Wert der Abfragesprache für Serbisch (Serbien). |
| sk-sk |
Wert der Abfragesprache für Slowakisch (Slowakei). |
| nb-no |
Wert der Abfragesprache für Norwegisch (Norwegen). |
| hy-am |
Wert der Abfragesprache für Armenisch (Armenien). |
| bn-in |
Wert der Abfragesprache für Bengali (Indien). |
| eu-es |
Wert der Abfragesprache für Baskisch. |
| gl-es |
Wert der Abfragesprache für Galizisch. |
| gu-in |
Wert der Abfragesprache für Gujarati (Indien). |
| he-il |
Wert der Abfragesprache für Hebräisch (Israel). |
| ga-ie |
Wert der Abfragesprache für Irisch (Irland). |
| kn-in |
Wert der Abfragesprache für Kannada (Indien). |
| ml-in |
Wert der Abfragesprache für Malayalam (Indien). |
| mr-in |
Wert der Abfragesprache für Marathi (Indien). |
| fa-ae |
Wert der Abfragesprache für Persisch (V.A.E.). |
| pa-in |
Wert der Abfragesprache für Punjabi (Indien). |
| te-in |
Wert der Abfragesprache für Telugu (Indien). |
| ur-pk |
Wert der Abfragesprache für Urdu (Pakistan). |
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üsselwortfelder, 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 |
Die Art und Weise, wie das Feld für den semantischen Anreicherungsprozess verwendet wurde (vollständig verwendet, teilweise verwendet oder nicht verwendet) |
QueryResultDocumentSubscores
Die Aufschlüsselung der Teilbewertungen zwischen den Text- und Vektorabfragekomponenten der Suchabfrage für dieses Dokument. Jede Vektorabfrage wird als separates Objekt in der gleichen Reihenfolge angezeigt, in der sie empfangen wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| documentBoost |
number (double) |
Die BM25- oder Classic-Bewertung für den Textteil der Abfrage. |
| text |
Die BM25- oder Classic-Bewertung für den Textteil der Abfrage. |
|
| vectors |
<string,
Single |
Die Vektorähnlichkeit und @search.score die Werte für jede Vektorabfrage. |
QueryRewritesDebugInfo
Enthält Debuginformationen, die für das Umschreiben von Abfragen spezifisch sind.
| Name | Typ | Beschreibung |
|---|---|---|
| text |
Liste der Abfrageumschreibungen, die für die Textabfrage generiert wurden. |
|
| vectors |
Liste der Abfrageumschreibungen, die für die vektorisierbaren Textabfragen generiert wurden. |
QueryRewritesType
Ein Wert, der angibt, ob Abfrageumschreibungen generiert werden sollen, um die Suchabfrage zu erweitern.
| Wert | Beschreibung |
|---|---|
| none |
Generieren Sie keine zusätzlichen Abfrageumschreibungen für diese Abfrage. |
| generative |
Generieren Sie alternative Abfragebegriffe, um den Abruf einer Suchanfrage zu erhöhen. |
QueryRewritesValuesDebugInfo
Enthält Debuginformationen, die für das Umschreiben von Abfragen spezifisch sind.
| Name | Typ | Beschreibung |
|---|---|---|
| inputQuery |
string |
Der Eingabetext für das Modell zum Umschreiben von generativen Abfragen. Es kann Fälle geben, in denen die Benutzerabfrage und die Eingabe für das generative Modell nicht identisch sind. |
| rewrites |
string[] |
Liste der Abfrageumschreibungen. |
QuerySpellerType
Ein Wert, der den Typ der Rechtschreibprüfung angibt, die zum Korrigieren einzelner Suchbegriffe verwendet werden soll.
| Wert | Beschreibung |
|---|---|
| none |
Rechtschreibprüfung nicht aktiviert. |
| lexicon |
Die Rechtschreibprüfung korrigiert einzelne Abfragebegriffe mithilfe eines statischen Lexikons für die Sprache, die durch den queryLanguage-Parameter angegeben wird. |
QueryType
Gibt die Syntax der Suchabfrage an. Die Standardeinstellung ist 'einfach'. Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet, und 'semantic', wenn die Abfragesyntax nicht benötigt wird.
| Wert | Beschreibung |
|---|---|
| simple |
Verwendet die einfache Abfragesyntax für Suchvorgänge. Der Suchtext wird mit einer einfachen Abfragesprache interpretiert, die Symbole wie +, * und "" zulässt. Abfragen werden standardmäßig über alle durchsuchbaren Felder ausgewertet, es sei denn, der Parameter searchFields ist angegeben. |
| full |
Verwendet die vollständige Lucene-Abfragesyntax für Suchvorgänge. Der Suchtext wird mit der Abfragesprache Lucene interpretiert, die feldspezifische und gewichtete Suchen sowie andere erweiterte Funktionen ermöglicht. |
| semantic |
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 Top-Suchergebnisse mithilfe eines im Webkorpus trainierten Rangfolgemodells neu eingestuft werden. |
RawVectorQuery
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert angegeben wird.
| Name | Typ | Beschreibung |
|---|---|---|
| exhaustive |
boolean |
Wenn true, wird eine umfassende Suche nach dem nächsten k-Nachbarn für alle Vektoren innerhalb des Vektorindex ausgelöst. Nützlich für Szenarien, in denen exakte Übereinstimmungen entscheidend sind, z. B. bei der Bestimmung von Ground-Truth-Werten. |
| fields |
string |
Vektor Felder vom Typ Collection(Edm.Single), die in den gesuchten Vektor aufgenommen werden sollen. |
| filterOverride |
string |
Der OData-Filterausdruck, der auf diese spezielle Vektorabfrage angewendet werden soll. Wenn auf Vektorebene kein Filterausdruck definiert ist, wird stattdessen der Ausdruck verwendet, der im Filterparameter der obersten Ebene definiert ist. |
| k |
integer (int32) |
Anzahl der nächsten Nachbarn, die als Top-Treffer zurückgegeben werden sollen. |
| kind |
string:
vector |
Die Art der Vektorabfrage, die ausgeführt wird. |
| oversampling |
number (double) |
Oversampling-Faktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter 'defaultOversampling'. Sie kann nur gesetzt werden, wenn 'rerankWithOriginalVectors' wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird. |
| perDocumentVectorLimit |
integer (int32) |
Steuert, wie viele Vektoren aus jedem Dokument in einer Vektorsuchabfrage abgeglichen werden können. Wenn Sie den Wert auf 1 setzen, wird sichergestellt, dass maximal ein Vektor pro Dokument abgeglichen wird, wodurch sichergestellt wird, dass die Ergebnisse aus unterschiedlichen Dokumenten stammen. Wenn Sie den Wert auf 0 (unbegrenzt) setzen, können mehrere relevante Vektoren aus demselben Dokument abgeglichen werden. Standard ist "0". |
| threshold | VectorThreshold: |
Der Schwellenwert, der für Vektorabfragen verwendet wird. Beachten Sie, dass dies nur festgelegt werden kann, wenn alle "Felder" dieselbe Ähnlichkeitsmetrik verwenden. |
| vector |
number[] (float) |
Die Vektordarstellung einer Suchanfrage. |
| weight |
number (float) |
Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanfrage. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Ranglisten, die von den verschiedenen Vektorabfragen erzeugt werden, und/oder die über die Textabfrage abgerufenen Ergebnisse kombiniert werden. Je höher die Gewichtung, 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 Null sein. |
ScoringStatistics
Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. die Häufigkeit von Dokumenten) global berechnen möchten, um eine konsistentere Bewertung zu erzielen, oder lokal, um die Latenz zu verringern. Der Standardwert ist 'local'. Verwenden Sie "global", um Punktestatistiken global zu aggregieren, bevor Sie eine Bewertung vornehmen. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchanfragen erhöhen.
| Wert | Beschreibung |
|---|---|
| local |
Die Bewertungsstatistiken werden lokal berechnet, um die Latenz zu verringern. |
| global |
Die Punktestatistiken werden global berechnet, um eine konsistentere Bewertung zu gewährleisten. |
SearchDocumentsResult
Antwort, die Suchergebnisse aus einem Index enthält.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.count |
integer (int64) |
Die Gesamtanzahl der Ergebnisse, die vom Suchvorgang gefunden wurden, 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 der Fall sein, 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, die zurückgegeben wird, 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 |
Die Antworten Abfrageergebnisse für den Suchvorgang; NULL, wenn der Abfrageparameter answers nicht angegeben oder auf 'none' festgelegt wurde. |
|
| @search.coverage |
number (double) |
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.debug |
Debug-Informationen, die für die Suchergebnisse als Ganzes gelten. |
|
| @search.facets |
object |
Die Facettenabfrageergebnisse für den Suchvorgang, organisiert als Sammlung von Buckets für jedes facettenreiche Feld; null, wenn die Abfrage keine Facettenausdrücke enthält. |
| @search.nextPageParameters |
Die JSON-Fortsetzungsnutzlast, die zurückgegeben wird, 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 und den nächsten Teil der Suchantwort abzurufen. |
|
| @search.semanticPartialResponseReason |
Grund dafür, dass eine Teilantwort für eine semantische Rangfolgeanforderung zurückgegeben wurde. |
|
| @search.semanticPartialResponseType |
Typ der Teilantwort, die für eine semantische Rangfolgeanforderung zurückgegeben wurde. |
|
| @search.semanticQueryRewritesResultType |
Typ der Abfrageumschreibung, die zum Abrufen von Dokumenten verwendet wurde. |
|
| value |
Die Abfolge der Ergebnisse, die von der Abfrage zurückgegeben werden. |
SearchMode
Gibt an, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung gezählt wird.
| Wert | Beschreibung |
|---|---|
| any |
Alle Suchbegriffe müssen übereinstimmen, damit das Dokument als Übereinstimmung gezählt wird. |
| all |
Alle Suchbegriffe müssen übereinstimmen, damit das Dokument als Übereinstimmung gezählt wird. |
SearchRequest
Parameter zum Filtern, Sortieren, Facettieren, Auslagern und andere Verhaltensweisen von Suchabfragen.
| Name | Typ | Beschreibung |
|---|---|---|
| answers |
Ein Wert, der angibt, ob Antworten als Teil der Suchantwort zurückgegeben werden sollen. |
|
| captions |
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 es sich bei der zurückgegebenen Zählung um einen Näherungswert handelt. |
| debug |
Aktiviert ein Debugtool, mit dem Sie Ihre neu eingestuften Ergebnisse weiter untersuchen können. |
|
| facets |
string[] |
Die Liste der Facettenausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facettenausdruck enthält einen Feldnamen, optional gefolgt von einer durch Kommas getrennten Liste von Name-Wert-Paaren. |
| filter |
string |
Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll. |
| highlight |
string |
Die durch Kommas getrennte Liste von Feldnamen, die für Trefferhervorhebungen verwendet werden sollen. Nur durchsuchbare Felder können für die Trefferhervorhebung verwendet werden. |
| highlightPostTag |
string |
Ein Zeichenfolgen-Tag, das an Treffermarkierungen angehängt wird. Muss mit highlightPreTag gesetzt werden. Der Standardwert ist </em>. |
| highlightPreTag |
string |
Ein Zeichenfolgen-Tag, dem das Erreichen von Highlights vorangestellt wird. Muss mit highlightPostTag gesetzt werden. Der Standardwert ist <em>. |
| hybridSearch |
Die Abfrageparameter zum Konfigurieren von Hybridsuchverhalten. |
|
| minimumCoverage |
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 erfolgreich gemeldet wird. Dieser Parameter kann nützlich sein, um die Verfügbarkeit der Suche 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. Auf jeden Ausdruck kann asc folgen, um aufsteigend anzugeben, oder desc, um absteigend anzugeben. Die Standardeinstellung ist aufsteigend. Unentschieden werden durch die Spielergebnisse der Dokumente aufgelöst. Wenn keine $orderby angegeben ist, ist die Standardsortierreihenfolge absteigend nach Dokumentabgleichsbewertung. Es können höchstens 32 $orderby Klauseln bestehen. |
| queryLanguage |
Ein Wert, der die Sprache der Suchabfrage angibt. |
|
| queryRewrites |
Ein Wert, der angibt, ob Abfrageumschreibungen generiert werden sollen, um die Suchabfrage zu erweitern. |
|
| queryType |
Ein Wert, der die Syntax der Suchabfrage angibt. Die Standardeinstellung ist 'einfach'. Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet. |
|
| scoringParameters |
string[] |
Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) im Format name-values verwendet werden sollen. Wenn das Bewertungsprofil z. B. 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 zum Auswerten von Übereinstimmungsergebnissen für übereinstimmende Dokumente, um die Ergebnisse zu sortieren. |
| scoringStatistics |
Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. die Häufigkeit von Dokumenten) global berechnen möchten, um eine konsistentere Bewertung zu erzielen, oder lokal, um die Latenz zu verringern. Der Standardwert ist 'local'. Verwenden Sie "global", um Punktestatistiken global zu aggregieren, bevor Sie eine Bewertung vornehmen. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchanfragen erhöhen. |
|
| search |
string |
Ein Ausdruck für eine Volltextsuchabfrage. Verwenden Sie "*" oder lassen Sie diesen Parameter weg, um alle Dokumente abzugleichen. |
| searchFields |
string |
Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche beschränkt werden soll. Wenn Sie die Feldsuche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage verwenden, haben die Feldnamen der einzelnen Feldsuchausdrücke Vorrang vor allen Feldnamen, die in diesem Parameter aufgeführt sind. |
| searchMode |
Ein Wert, der angibt, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung gezählt wird. |
|
| select |
string |
Die durch Kommas getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, werden alle Felder, die im Schema als abrufbar markiert sind, eingeschlossen. |
| semanticConfiguration |
string |
Der Name einer semantischen Konfiguration, die bei der Verarbeitung von Dokumenten für Abfragen vom Typ Semantik verwendet wird. |
| semanticErrorHandling |
Ermöglicht dem Benutzer die Auswahl, ob ein semantischer Aufruf vollständig fehlschlagen soll (Standard-/aktuelles Verhalten) oder ob Teilergebnisse zurückgegeben werden sollen. |
|
| semanticFields |
string |
Die durch Trennzeichen getrennte Liste von Feldnamen, die für die semantische Rangfolge verwendet werden. |
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
Ermöglicht es dem Benutzer, eine Obergrenze für die Zeit festzulegen, die die semantische Anreicherung benötigt, um die Verarbeitung abzuschließen, bevor die Anforderung fehlschlägt. |
| semanticQuery |
string |
Ermöglicht das Festlegen einer separaten Suchanfrage, die ausschließlich für semantisches Reranking, semantische Untertitel und semantische Antworten verwendet wird. Ist nützlich für Szenarien, in denen zwischen der Basisabruf- und Bewertungsphase und der semantischen L2-Phase unterschiedliche Abfragen verwendet werden müssen. |
| sessionId |
string |
Ein Wert, der zum Erstellen einer fixierten Sitzung verwendet werden soll, um konsistentere Ergebnisse zu erzielen. Solange dieselbe sessionId verwendet wird, wird nach bestem Wissen und Gewissen versucht, dieselbe Replikatgruppe als Ziel zu verwenden. Achten Sie darauf, dass die wiederholte Wiederverwendung derselben sessionID-Werte den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und sich negativ auf die Leistung des Suchdiensts auswirken kann. Der als sessionId verwendete Wert darf nicht mit dem Zeichen "_" beginnen. |
| skip |
integer (int32) |
Die Anzahl der Suchergebnisse, die übersprungen werden sollen. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente nacheinander scannen müssen, aber aufgrund dieser Einschränkung Skip nicht verwenden können, sollten Sie orderby für einen vollständig geordneten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern. |
| speller |
Ein Wert, der den Typ der Rechtschreibprüfung angibt, die zum Korrigieren einzelner Suchbegriffe verwendet werden soll. |
|
| top |
integer (int32) |
Die Anzahl der Suchergebnisse, die abgerufen werden sollen. Dies kann in Verbindung mit $skip verwendet werden, um das 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 weitere Suchanforderung für die nächste Ergebnisseite auszugeben. |
| vectorFilterMode |
Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden. Der Standardwert ist 'preFilter' für neue Indizes. |
|
| vectorQueries | VectorQuery[]: |
Die Abfrageparameter für Vektor- und Hybrid-Suchanfragen. |
SearchResult
Enthält ein Dokument, das durch eine Suchabfrage gefunden wurde, sowie die zugehörigen Metadaten.
| Name | Typ | Beschreibung |
|---|---|---|
| @search.captions |
Bildunterschriften sind die repräsentativsten Passagen aus dem Dokument im Verhältnis zur Suchanfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Untertitel werden nur für Abfragen vom Typ 'semantic' zurückgegeben. |
|
| @search.documentDebugInfo |
Enthält Debuginformationen, die zum weiteren Untersuchen Ihrer Suchergebnisse verwendet werden können. |
|
| @search.highlights |
object |
Textfragmente aus dem Dokument, die die übereinstimmenden Suchbegriffe angeben, geordnet nach den einzelnen zutreffenden Feldern; NULL, wenn die Trefferhervorhebung für die Abfrage nicht aktiviert wurde. |
| @search.rerankerBoostedScore |
number (double) |
Die Relevanzbewertung, die durch Erhöhen des Reranker-Scores berechnet wird. Die Suchergebnisse werden nach dem RerankerScore/RerankerBoostedScore sortiert, basierend auf useScoringProfileBoostedRanking in der semantischen Konfiguration. RerankerBoostedScore wird nur für Abfragen vom Typ 'semantic' zurückgegeben |
| @search.rerankerScore |
number (double) |
Die Relevanzbewertung, die von der semantischen Rangfolge für die Top-Suchergebnisse berechnet wird. Die Suchergebnisse werden zuerst nach dem RerankerScore und dann nach dem Score sortiert. RerankerScore wird nur für Abfragen vom Typ 'semantic' zurückgegeben. |
| @search.score |
number (double) |
Die Relevanzbewertung des Dokuments im Vergleich zu anderen Dokumenten, die von der Abfrage zurückgegeben werden. |
SearchScoreThreshold
Die Ergebnisse der Vektorabfrage werden basierend auf dem Wert "@search.score" gefiltert. Beachten Sie, dass dies der @search.score zurückgegebene Teil der Suchantwort ist. Die Schwellenrichtung wird für höher @search.scoregewählt.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
search |
Die Art des Schwellenwerts, der zum Filtern von Vektorabfragen verwendet wird |
| value |
number (double) |
Der Schwellenwert wird basierend auf dem Wert "@search.score" gefiltert. Beachten Sie, dass dies der @search.score zurückgegebene Teil der Suchantwort ist. Die Schwellenrichtung wird für höher @search.scoregewählt. |
SemanticDebugInfo
| Name | Typ | Beschreibung |
|---|---|---|
| contentFields |
Die Inhaltsfelder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie die Art und Weise, wie sie verwendet wurden |
|
| keywordFields |
Die Schlüsselwortfelder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie die Art und Weise, wie sie verwendet wurden |
|
| rerankerInput |
Die unformatierten verketteten Zeichenfolgen, die an den semantischen Anreicherungsprozess gesendet wurden. |
|
| titleField |
Das Titelfeld, das an den semantischen Anreicherungsprozess gesendet wurde, sowie die Art und Weise, wie es verwendet wurde |
SemanticErrorMode
Ermöglicht dem Benutzer die Auswahl, ob ein semantischer Aufruf vollständig fehlschlagen soll (Standard-/aktuelles Verhalten) oder ob Teilergebnisse zurückgegeben werden sollen.
| Wert | Beschreibung |
|---|---|
| partial |
Wenn die semantische Verarbeitung fehlschlägt, werden dennoch Teilergebnisse zurückgegeben. Die Definition von Teilergebnissen hängt davon ab, welcher semantische Schritt fehlgeschlagen ist und was der Grund für das Scheitern war. |
| fail |
Wenn während des semantischen Verarbeitungsschritts eine Ausnahme auftritt, schlägt die Abfrage fehl und gibt je nach Fehler den entsprechenden HTTP-Code zurück. |
SemanticErrorReason
Grund dafür, dass eine Teilantwort für eine semantische Rangfolgeanforderung zurückgegeben wurde.
| Wert | Beschreibung |
|---|---|
| maxWaitExceeded |
Wenn |
| capacityOverloaded |
Die Anforderung wurde gedrosselt. Es wurden nur die Basisergebnisse zurückgegeben. |
| transient |
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)
| Wert | Beschreibung |
|---|---|
| used |
Das Feld wurde vollständig für die semantische Anreicherung genutzt. |
| unused |
Das Feld wurde nicht für die semantische Anreicherung verwendet. |
| partial |
Das Feld wurde teilweise für die semantische Anreicherung verwendet. |
SemanticQueryRewritesResultType
Typ des Umschreibens von Abfragen, der für diese Anforderung verwendet wurde.
| Wert | Beschreibung |
|---|---|
| originalQueryOnly |
Für diese Anforderung wurden Abfrageumschreibungen nicht erfolgreich generiert. Zum Abrufen der Ergebnisse wurde nur die ursprüngliche Abfrage verwendet. |
SemanticSearchResultsType
Typ der Teilantwort, die für eine semantische Rangfolgeanforderung zurückgegeben wurde.
| Wert | Beschreibung |
|---|---|
| baseResults |
Ergebnisse ohne semantische Anreicherung oder Neueinstufung. |
| rerankedResults |
Die Ergebnisse wurden mit dem Reranker-Modell neu eingestuft und enthalten semantische Untertitel. Sie enthalten keine Antworten, Hervorhebungen von Antworten oder Beschriftungen. |
SingleVectorFieldResult
Ein einzelnes Vektorfeldergebnis. Sowohl als auch @search.score Vektorähnlichkeitswerte werden zurückgegeben. Die Vektorähnlichkeit wird durch eine Gleichung in Beziehung gesetzt @search.score .
| Name | Typ | Beschreibung |
|---|---|---|
| searchScore |
number (double) |
Der @search.score Wert, der aus der Vektorähnlichkeitsbewertung berechnet wird. Dies ist die Bewertung, die in einer reinen Einzelfeld-Einzelvektorabfrage sichtbar ist. |
| vectorSimilarity |
number (double) |
Die Bewertung der Vektorähnlichkeit für dieses Dokument. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die "Entfernungs"-Version. Zum Beispiel Kosinusähnlichkeit anstelle des Kosinusabstands. |
TextResult
Die BM25- oder Classic-Bewertung für den Textteil der Abfrage.
| Name | Typ | Beschreibung |
|---|---|---|
| searchScore |
number (double) |
Die BM25- oder Classic-Bewertung für den Textteil der Abfrage. |
VectorFilterMode
Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden.
| Wert | Beschreibung |
|---|---|
| postFilter |
Der Filter wird angewendet, nachdem der Kandidatensatz der Vektorergebnisse zurückgegeben wurde. Abhängig von der Filterselektivität kann dies zu weniger Ergebnissen führen, als vom Parameter 'k' gefordert werden. |
| preFilter |
Der Filter wird vor der Suchanfrage angewendet. |
| strictPostFilter |
Der Filter wird angewendet, nachdem der globale Top-k-Kandidatensatz der Vektorergebnisse zurückgegeben wurde. Dies führt zu weniger Ergebnissen, als vom Parameter 'k' angefordert werden. |
VectorizableImageBinaryQuery
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine Base64-codierte Binärdatei eines Bildes bereitgestellt wird, das vektorisiert werden muss.
| Name | Typ | Beschreibung |
|---|---|---|
| base64Image |
string |
Die Basis-64-kodierte Binärdatei eines Bildes, das vektorisiert werden soll, um eine Vektorsuchabfrage durchzuführen. |
| exhaustive |
boolean |
Wenn true, wird eine umfassende Suche nach dem nächsten k-Nachbarn für alle Vektoren innerhalb des Vektorindex ausgelöst. Nützlich für Szenarien, in denen exakte Übereinstimmungen entscheidend sind, z. B. bei der Bestimmung von Ground-Truth-Werten. |
| fields |
string |
Vektor Felder vom Typ Collection(Edm.Single), die in den gesuchten Vektor aufgenommen werden sollen. |
| filterOverride |
string |
Der OData-Filterausdruck, der auf diese spezielle Vektorabfrage angewendet werden soll. Wenn auf Vektorebene kein Filterausdruck definiert ist, wird stattdessen der Ausdruck verwendet, der im Filterparameter der obersten Ebene definiert ist. |
| k |
integer (int32) |
Anzahl der nächsten Nachbarn, die als Top-Treffer zurückgegeben werden sollen. |
| kind |
string:
image |
Die Art der Vektorabfrage, die ausgeführt wird. |
| oversampling |
number (double) |
Oversampling-Faktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter 'defaultOversampling'. Sie kann nur gesetzt werden, wenn 'rerankWithOriginalVectors' wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird. |
| perDocumentVectorLimit |
integer (int32) |
Steuert, wie viele Vektoren aus jedem Dokument in einer Vektorsuchabfrage abgeglichen werden können. Wenn Sie den Wert auf 1 setzen, wird sichergestellt, dass maximal ein Vektor pro Dokument abgeglichen wird, wodurch sichergestellt wird, dass die Ergebnisse aus unterschiedlichen Dokumenten stammen. Wenn Sie den Wert auf 0 (unbegrenzt) setzen, können mehrere relevante Vektoren aus demselben Dokument abgeglichen werden. Standard ist "0". |
| threshold | VectorThreshold: |
Der Schwellenwert, der für Vektorabfragen verwendet wird. Beachten Sie, dass dies nur festgelegt werden kann, wenn alle "Felder" dieselbe Ähnlichkeitsmetrik verwenden. |
| weight |
number (float) |
Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanfrage. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Ranglisten, die von den verschiedenen Vektorabfragen erzeugt werden, und/oder die über die Textabfrage abgerufenen Ergebnisse kombiniert werden. Je höher die Gewichtung, 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 Null sein. |
VectorizableImageUrlQuery
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine URL angegeben wird, die einen Bildwert darstellt, der vektorisiert werden muss.
| Name | Typ | Beschreibung |
|---|---|---|
| exhaustive |
boolean |
Wenn true, wird eine umfassende Suche nach dem nächsten k-Nachbarn für alle Vektoren innerhalb des Vektorindex ausgelöst. Nützlich für Szenarien, in denen exakte Übereinstimmungen entscheidend sind, z. B. bei der Bestimmung von Ground-Truth-Werten. |
| fields |
string |
Vektor Felder vom Typ Collection(Edm.Single), die in den gesuchten Vektor aufgenommen werden sollen. |
| filterOverride |
string |
Der OData-Filterausdruck, der auf diese spezielle Vektorabfrage angewendet werden soll. Wenn auf Vektorebene kein Filterausdruck definiert ist, wird stattdessen der Ausdruck verwendet, der im Filterparameter der obersten Ebene definiert ist. |
| k |
integer (int32) |
Anzahl der nächsten Nachbarn, die als Top-Treffer zurückgegeben werden sollen. |
| kind |
string:
image |
Die Art der Vektorabfrage, die ausgeführt wird. |
| oversampling |
number (double) |
Oversampling-Faktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter 'defaultOversampling'. Sie kann nur gesetzt werden, wenn 'rerankWithOriginalVectors' wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird. |
| perDocumentVectorLimit |
integer (int32) |
Steuert, wie viele Vektoren aus jedem Dokument in einer Vektorsuchabfrage abgeglichen werden können. Wenn Sie den Wert auf 1 setzen, wird sichergestellt, dass maximal ein Vektor pro Dokument abgeglichen wird, wodurch sichergestellt wird, dass die Ergebnisse aus unterschiedlichen Dokumenten stammen. Wenn Sie den Wert auf 0 (unbegrenzt) setzen, können mehrere relevante Vektoren aus demselben Dokument abgeglichen werden. Standard ist "0". |
| threshold | VectorThreshold: |
Der Schwellenwert, der für Vektorabfragen verwendet wird. Beachten Sie, dass dies nur festgelegt werden kann, wenn alle "Felder" dieselbe Ähnlichkeitsmetrik verwenden. |
| url |
string |
Die URL eines Bildes, das vektorisiert werden soll, um eine Vektorsuchabfrage durchzuführen. |
| weight |
number (float) |
Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanfrage. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Ranglisten, die von den verschiedenen Vektorabfragen erzeugt werden, und/oder die über die Textabfrage abgerufenen Ergebnisse kombiniert werden. Je höher die Gewichtung, 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 Null sein. |
VectorizableTextQuery
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein Textwert angegeben wird, der vektorisiert werden muss.
| Name | Typ | Beschreibung |
|---|---|---|
| exhaustive |
boolean |
Wenn true, wird eine umfassende Suche nach dem nächsten k-Nachbarn für alle Vektoren innerhalb des Vektorindex ausgelöst. Nützlich für Szenarien, in denen exakte Übereinstimmungen entscheidend sind, z. B. bei der Bestimmung von Ground-Truth-Werten. |
| fields |
string |
Vektor Felder vom Typ Collection(Edm.Single), die in den gesuchten Vektor aufgenommen werden sollen. |
| filterOverride |
string |
Der OData-Filterausdruck, der auf diese spezielle Vektorabfrage angewendet werden soll. Wenn auf Vektorebene kein Filterausdruck definiert ist, wird stattdessen der Ausdruck verwendet, der im Filterparameter der obersten Ebene definiert ist. |
| k |
integer (int32) |
Anzahl der nächsten Nachbarn, die als Top-Treffer zurückgegeben werden sollen. |
| kind |
string:
text |
Die Art der Vektorabfrage, die ausgeführt wird. |
| oversampling |
number (double) |
Oversampling-Faktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter 'defaultOversampling'. Sie kann nur gesetzt werden, wenn 'rerankWithOriginalVectors' wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird. |
| perDocumentVectorLimit |
integer (int32) |
Steuert, wie viele Vektoren aus jedem Dokument in einer Vektorsuchabfrage abgeglichen werden können. Wenn Sie den Wert auf 1 setzen, wird sichergestellt, dass maximal ein Vektor pro Dokument abgeglichen wird, wodurch sichergestellt wird, dass die Ergebnisse aus unterschiedlichen Dokumenten stammen. Wenn Sie den Wert auf 0 (unbegrenzt) setzen, können mehrere relevante Vektoren aus demselben Dokument abgeglichen werden. Standard ist "0". |
| queryRewrites |
Kann so konfiguriert werden, dass ein generatives Modell die Abfrage neu schreiben kann, bevor sie zur Vektorisierung gesendet wird. |
|
| text |
string |
Der Text, der vektorisiert werden soll, um eine Vektorsuchabfrage durchzuführen. |
| threshold | VectorThreshold: |
Der Schwellenwert, der für Vektorabfragen verwendet wird. Beachten Sie, dass dies nur festgelegt werden kann, wenn alle "Felder" dieselbe Ähnlichkeitsmetrik verwenden. |
| weight |
number (float) |
Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanfrage. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Ranglisten, die von den verschiedenen Vektorabfragen erzeugt werden, und/oder die über die Textabfrage abgerufenen Ergebnisse kombiniert werden. Je höher die Gewichtung, 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 Null sein. |
VectorQueryKind
Die Art der Vektorabfrage, die ausgeführt wird.
| Wert | Beschreibung |
|---|---|
| vector |
Vektorabfrage, bei der ein roher Vektorwert angegeben wird. |
| text |
Vektorabfrage, bei der ein Textwert angegeben wird, der vektorisiert werden muss. |
| imageUrl |
Vektorabfrage, bei der eine URL bereitgestellt wird, die einen Bildwert darstellt, der vektorisiert werden muss. |
| imageBinary |
Vektorabfrage, bei der eine Base64-kodierte Binärdatei eines Bildes bereitgestellt wird, das vektorisiert werden muss. |
VectorsDebugInfo
| Name | Typ | Beschreibung |
|---|---|---|
| subscores |
Die Aufschlüsselung der Teilbewertungen des Dokuments vor der gewählten Fusions-/Kombinationsmethode der Ergebnismenge, wie z. B. RRF. |
VectorSimilarityThreshold
Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorähnlichkeitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die "Entfernungs"-Version. Die Richtung des Schwellenwerts (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
vector |
Die Art des Schwellenwerts, der zum Filtern von Vektorabfragen verwendet wird |
| value |
number (double) |
Der Schwellenwert wird basierend auf dem Wert der Ähnlichkeitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die "Entfernungs"-Version. Die Richtung des Schwellenwerts (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt. |
VectorThresholdKind
Die Art der Vektorabfrage, die ausgeführt wird.
| Wert | Beschreibung |
|---|---|
| vectorSimilarity |
Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorähnlichkeitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die "Entfernungs"-Version. Die Richtung des Schwellenwerts (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt. |
| searchScore |
Die Ergebnisse der Vektorabfrage werden basierend auf dem Wert "@search.score" gefiltert. Beachten Sie, dass dies der @search.score zurückgegebene Teil der Suchantwort ist. Die Schwellenrichtung wird für höher @search.scoregewählt. |