Freigeben über


Documents - Search Post

Sucht nach Dokumenten im Index.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-11-01

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.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string

uuid

Die Tracking-ID, die mit der Anforderung gesendet wurde, beim Debuggen zu helfen.

Anforderungstext

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.

facets

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.

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 für die Trefferherhebung verwendet werden.

highlightPostTag

string

Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.

highlightPreTag

string

Ein Zeichenfolgentag, dem Trefferhighlights vorangestellt sind. 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 hilfreich 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 Dokumentabgleichsbewertung absteigend ausgeführt. Es können maximal 32 $orderby-Klauseln vorhanden sein.

queryType

QueryType

Ein -Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.

scoringParameters

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

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 vor der Bewertung global zu aggregieren. Die Verwendung von globalen Bewertungsstatistiken kann die Latenz von Suchabfragen erhöhen.

search

string

Ein Volltextsuchabfrageausdruck; Verwenden Sie "*", oder lassen Sie diesen Parameter aus, um alle Dokumente abzugleichen.

searchFields

string

Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche 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

SearchMode

Ein -Wert, der angibt, ob ein oder alle Suchbegriffe abgeglichen werden 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 (Standardverhalten/aktuelles Verhalten), oder ob partielle Ergebnisse zurückgegeben werden sollen.

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.

sessionId

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.

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.

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" für neue Indizes.

vectorQueries VectorQuery[]:

RawVectorQuery[]

Die Abfrageparameter für Vektor- und Hybridsuchabfragen.

Antworten

Name Typ Beschreibung
200 OK

SearchDocumentsResult

Antwort, die Dokumente enthält, die den Suchkriterien entsprechen.

Other Status Codes

SearchError

Fehlerantwort.

Beispiele

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Beispielanforderung

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,category,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Beispiel für eine Antwort

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "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.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01"
}

SearchIndexSearchDocumentsSemanticPost

Beispielanforderung

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

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
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "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.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-11-01"
}

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 semanticzurückgegeben.

QueryAnswerType

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

QueryCaptionType

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

QueryType

Gibt die Syntax der Suchabfrage an. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.

RawVectorQuery

Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein roher 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 vor der Bewertung global zu aggregieren. Die Verwendung von globalen 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.

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.

SemanticErrorReason

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

SemanticSearchResultsType

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

VectorFilterMode

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

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 semanticzurü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.

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

QueryType

Gibt die Syntax der Suchabfrage an. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.

Name Typ Beschreibung
full

string

Verwendet die vollständige Lucene-Abfragesyntax für Suchvorgänge. Suchtext wird mithilfe der Lucene-Abfragesprache interpretiert, die feldspezifische und gewichtete Suchvorgänge sowie andere erweiterte 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 roher Vektorwert angegeben wird.

Name Typ Beschreibung
exhaustive

boolean

Wenn true, löst eine umfassende k-nächstgelegene Nachbarsuche für alle Vektoren innerhalb des Vektorindexes aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen entscheidend sind, z. B. die Bestimmung von Bodenwahrheitswerten.

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 vor der Bewertung global zu aggregieren. Die Verwendung von globalen 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.

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.

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 (Standardverhalten/aktuelles Verhalten), oder ob partielle Ergebnisse zurückgegeben werden sollen.

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.

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.

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" für neue Indizes.

vectorQueries VectorQuery[]:

RawVectorQuery[]

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 semanticzurückgegeben.

@search.highlights

object

Textfragmente aus dem Dokument, die die übereinstimmenden Suchbegriffe angeben, sortiert nach jedem anwendbaren Feld; null, wenn die Treffermarkierung für die Abfrage nicht aktiviert war.

@search.rerankerScore

number

Die Relevanzbewertung, die vom semantischen Rangfolger für die top Suchergebnisse berechnet wird. Die Suchergebnisse werden zuerst nach rerankerScore und dann nach der Bewertung sortiert. RerankerScore wird nur für Abfragen vom Typ semanticzurückgegeben.

@search.score

number

Die Relevanzbewertung des Dokuments im Vergleich zu anderen Dokumenten, die von der Abfrage zurückgegeben werden.

SemanticErrorMode

Ermöglicht dem Benutzer die Auswahl, ob ein semantischer Aufruf vollständig fehlschlagen soll (Standard-/aktuelles Verhalten), oder ob Teilergebnisse zurückgegeben werden sollen.

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 überschritten hat. Es wurden nur die Basisergebnisse zurückgegeben.

transient

string

Mindestens ein Schritt des semantischen Prozesses ist fehlgeschlagen.

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.

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.

VectorQueryKind

Die Art der ausgeführten Vektorabfrage.

Name Typ Beschreibung
vector

string

Vektorabfrage, bei der ein unformatierter Vektorwert bereitgestellt wird.