Documents - Search Post

Dienst:: Search Service

API-Version:: 2025-11-01-preview

Sucht nach Dokumenten im Index.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Index.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Typ	Beschreibung
Accept	Accept	Die Überschrift "Annehmen".
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.
x-ms-enable-elevated-read	boolean	Ein Wert, der erhöhte Lesevorgänge ermöglicht, die Berechtigungsüberprüfungen auf Dokumentebene für den Abfragevorgang umgehen.
x-ms-client-request-id	string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

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 Beschriftungen als Teil der Suchantwort zurückgegeben werden sollen.
count	boolean	Ein Wert, der angibt, ob die Gesamtanzahl der Ergebnisse abgerufen werden soll. Der Standardwert ist "false". Das Festlegen dieses Werts auf "true" hat möglicherweise auswirkungen auf die Leistung. Beachten Sie, dass die zurückgegebene Anzahl eine Annäherung ist.
debug	QueryDebugMode	Aktiviert ein Debugtool, mit dem Sie Ihre neu eingestuften Ergebnisse weiter untersuchen können.
facets	string[]	Die Liste der Facetausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facetausdruck enthält einen Feldnamen, optional gefolgt von einer durch Trennzeichen getrennten Liste von Name:Wert-Paaren.
filter	string	Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll.
highlight	string	Die durch Trennzeichen getrennte Liste der Feldnamen, die für Trefferhighlights verwendet werden sollen. Nur durchsuchbare Felder können zum Hervorheben von Treffern verwendet werden.
highlightPostTag	string	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.
highlightPreTag	string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Der Standardwert ist <em>.
hybridSearch	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 Erfolg gemeldet werden kann. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert ist 100.
orderby	string	Die durch Trennzeichen getrennte Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Jedem Ausdruck kann asc folgen, um aufsteigend oder desc anzuzeigen, um absteigend anzugeben. Der Standardwert ist die aufsteigende Reihenfolge. Die Verknüpfungen werden durch die Übereinstimmungsergebnisse von Dokumenten unterbrochen. Wenn keine $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können höchstens 32 $orderby Klauseln vorhanden sein.
queryLanguage	QueryLanguage	Ein Wert, der die Sprache der Suchabfrage angibt.
queryRewrites	QueryRewritesType	Ein Wert, der angibt, ob Abfrageumschreibungen generiert werden sollen, um die Suchabfrage zu erweitern.
queryType	QueryType	Ein Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "einfach". Verwenden Sie "vollständig", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
scoringParameters	string[]	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit den Formatnamenwerten verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne anführungszeichen).
scoringProfile	string	Der Name eines Bewertungsprofils, um Übereinstimmungsergebnisse für übereinstimmende Dokumente auszuwerten, um die Ergebnisse zu sortieren.
scoringStatistics	ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Der Standardwert ist 'local'. Verwenden Sie "global", um 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 angewendet werden soll. Bei Verwendung der feldbezogenen Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage haben die Feldnamen jedes feldbezogenen Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind.
searchMode	SearchMode	Ein Wert, der angibt, ob eine oder alle Suchbegriffe übereinstimmen müssen, um das Dokument als Übereinstimmung zu zählen.
select	string	Die durch Kommas getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, sind alle Felder enthalten, die im Schema als abrufbar gekennzeichnet sind.
semanticConfiguration	string	Der Name einer semantischen Konfiguration, die bei der Verarbeitung von Dokumenten für Abfragen vom Typ Semantik verwendet wird.
semanticErrorHandling	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.
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 versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die Wiederverwendung der gleichen SessionID-Werte wiederholt den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der wert, der als sessionId verwendet wird, kann nicht mit einem '_'-Zeichen beginnen.
skip	integer (int32)	Die Anzahl der zu überspringenden Suchergebnisse. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente sequenzieren müssen, aber aufgrund dieser Einschränkung nicht überspringen können, sollten Sie stattdessen "orderby" für einen vollständig sortierten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern.
speller	QuerySpellerType	Ein Wert, der den Typ des Schreibers angibt, der verwendet wird, um einzelne Suchbegriffe zu rechtweisen.
top	integer (int32)	Die Anzahl der abzurufenden Suchergebnisse. Dies kann in Verbindung mit $skip verwendet werden, um clientseitige Paging von Suchergebnissen zu implementieren. Wenn Ergebnisse aufgrund der serverseitigen Auslagerung abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine andere Suchanforderung für die nächste Seite der Ergebnisse auszuweisen.
vectorFilterMode	VectorFilterMode	Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden. Der Standardwert ist 'preFilter' für neue Indizes.
vectorQueries	VectorQuery[]: VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[] VectorizedQuery[]	Die Abfrageparameter für Vektor- und Hybridsuchabfragen.

Antworten

Name	Typ	Beschreibung
200 OK	SearchDocumentsResult	Die Anforderung ist erfolgreich.
Other Status Codes	SearchDocumentsResult	Erfolgreich
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://search.azure.com/.default

Beispiele

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Beispielanforderung

HTTP

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2025-11-01-preview




{
  "count": true,
  "facets": [
    "ownerId",
    "price,metric:sum,default:10"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "minimumCoverage": 100,
  "queryType": "semantic",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "debug": "vector",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "queryLanguage": "en-us",
  "speller": "lexicon",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "queryRewrites": "generative",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "oversampling": 20,
      "weight": 1,
      "threshold": {
        "value": 0.984,
        "kind": "vectorSimilarity"
      },
      "filterOverride": "ownerId eq 'sam'"
    }
  ],
  "vectorFilterMode": "preFilter",
  "hybridSearch": {
    "maxTextRecallSize": 100,
    "countAndFacetMode": "countAllResults"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.count": 27,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 27.725889205932617
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 39.23316955566406
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 23.01456642150879
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Statuscode:: 206

{
  "@odata.count": 27,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 27.725889205932617
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 39.23316955566406
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 23.01456642150879
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Beispielanforderung

HTTP

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

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

Statuscode:: 200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@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=2025-05-01-preview"
}

Statuscode:: 206

{
  "@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=2025-05-01-preview"
}

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
DebugInfo	Enthält Debuginformationen, die verwendet werden können, um Ihre Suchergebnisse weiter zu untersuchen.
DocumentDebugInfo	Enthält Debuginformationen, die verwendet werden können, um Ihre Suchergebnisse weiter zu untersuchen.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
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'.
HybridSearch	Die Abfrageparameter zum Konfigurieren von Hybridsuchverhalten.
QueryAnswerResult	Eine Antwort ist eine Textpassage, die aus dem Inhalt der relevantesten Dokumente extrahiert wurde, die der Abfrage entsprechen. Antworten werden aus den wichtigsten Suchergebnissen extrahiert. Antwortkandidaten werden bewertet, und die wichtigsten Antworten werden ausgewählt.
QueryAnswerType	Dieser Parameter ist nur gültig, wenn der Abfragetyp `semantic`ist. Wenn diese Option festgelegt ist, gibt die Abfrage Antworten zurück, die aus Schlüsselpassagen in den am höchsten bewerteten Dokumenten extrahiert wurden. Die Anzahl der zurückgegebenen Antworten kann konfiguriert werden, indem der senkrechte Strich `\|` gefolgt von der `count-<number of answers>` Option nach dem Wert des Parameters answers angehängt wird, z. B `extractive\|count-3`. . Die Standardanzahl ist 1. Der Konfidenzschwellenwert kann konfiguriert werden, indem der senkrechte Strich `\|` gefolgt von der `threshold-<confidence threshold>` Option nach dem Wert des Parameters answers angehängt wird, z. B `extractive\|threshold-0.9`. . . Der Standardschwellenwert ist 0,7. Die maximale Zeichenlänge von Antworten kann konfiguriert werden, indem der senkrechte Strich '\|' gefolgt von der 'count-number< of maximum character length>' angehängt wird, z. B. 'extractive\|maxcharlength-600'.
QueryCaptionResult	Beschriftungen sind die repräsentativsten Passagen aus dem Dokument relativ zur Suchabfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Beschriftungen werden nur für Abfragen vom Typ `semantic`zurückgegeben.
QueryCaptionType	Dieser Parameter ist nur gültig, wenn der Abfragetyp `semantic`ist. Wenn festgelegt, gibt die Abfrage Beschriftungen zurück, die aus Schlüsselabschnitten in den höchsten bewerteten Dokumenten extrahiert wurden. Wenn Beschriftungen auf `extractive`festgelegt ist, ist die Hervorhebung standardmäßig aktiviert und kann konfiguriert werden, indem der senkrechte Strich `\|` gefolgt von der `highlight-<true/false>` Option angehängt wird, z. B `extractive\|highlight-true`. . . Wird standardmäßig auf `None` festgelegt. Die maximale Zeichenlänge von Untertiteln kann konfiguriert werden, indem der senkrechte Strich '\|' gefolgt von der 'count-number< of maximum character length>' angehängt wird, z. B. 'extractive\|maxcharlength-600'.
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.
QueryLanguage	Die Sprache der Abfrage.
QueryResultDocumentRerankerInput	Die unformatierten verketteten Zeichenfolgen, die an den semantischen Anreicherungsprozess gesendet wurden.
QueryResultDocumentSemanticField	Beschreibung von Feldern, die an den semantischen Anreicherungsprozess gesendet wurden, sowie deren Verwendung
QueryResultDocumentSubscores	Die Aufschlüsselung von Teilergebnissen zwischen den Text- und Vektorabfragekomponenten der Suchabfrage für dieses Dokument. Jede Vektorabfrage wird als separates Objekt in derselben Reihenfolge angezeigt, in der sie empfangen wurden.
QueryRewritesDebugInfo	Enthält Debugginginformationen, die für Abfrageumschreibungen spezifisch sind.
QueryRewritesType	Dieser Parameter ist nur gültig, wenn der Abfragetyp `semantic`ist. Wenn QueryRewrites auf `generative`festgelegt ist, werden die Abfragebegriffe an ein Generierungsmodell gesendet, das 10 (Standard-)Umschreibungen erzeugt, um den Abruf der Anforderung zu erhöhen. Die angeforderte Anzahl kann konfiguriert werden, indem Sie den senkrechten Strich `\|` gefolgt von der `count-<number of rewrites>` Option anhängen, z. B `generative\|count-3`. . . Wird standardmäßig auf `None` festgelegt.
QueryRewritesValuesDebugInfo	Enthält Debugginginformationen, die für Abfrageumschreibungen spezifisch sind.
QuerySpellerType	Verbessern Sie den Suchrückruf, indem Sie einzelne Suchabfragebegriffe rechtschreibkorrekturen.
QueryType	Gibt die Syntax der Suchabfrage an. Der Standardwert ist "einfach". Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet, und 'semantic', wenn die Abfragesyntax nicht benötigt wird.
ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Der Standardwert ist 'local'. Verwenden Sie "global", um Punktestatistiken global zu aggregieren, bevor Sie eine Bewertung vornehmen. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchanfragen erhöhen.
SearchDocumentsResult	Antwort, die Suchergebnisse aus einem Index enthält.
SearchMode	Gibt an, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung gezählt wird.
SearchRequest	Parameter zum Filtern, Sortieren, Faceting, Paging und anderen Suchabfrageverhalten.
SearchResult	Enthält ein Dokument, das von einer Suchabfrage gefunden wurde, sowie zugeordnete Metadaten.
SearchScoreThreshold	Die Ergebnisse der Vektoranfrage filtern basierend auf dem '
SemanticDebugInfo	Enthält Debuginformationen, die für semantische Rangfolgeanforderungen spezifisch sind.
SemanticErrorMode	Ermöglicht es dem Benutzer zu wählen, ob ein semantischer Aufruf vollständig fehlschlägt oder teilweise Ergebnisse zurückgibt.
SemanticErrorReason	Grund dafür, dass eine Teilantwort für eine semantische Rangfolgeanforderung zurückgegeben wurde.
SemanticFieldState	Die Art und Weise, wie das Feld für den semantischen Anreicherungsprozess verwendet wurde.
SemanticQueryRewritesResultType	Typ des Umschreibens von Abfragen, der für diese Anforderung verwendet wurde.
SemanticSearchResultsType	Typ der Teilantwort, die für eine semantische Rangfolgeanforderung zurückgegeben wurde.
SingleVectorFieldResult	Ein einzelnes Vektorfeldergebnis. Beides
TextResult	Die BM25- oder Classic-Bewertung für den Textbereich der Abfrage.
VectorFilterMode	Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden.
VectorizableImageBinaryQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine base64-codierte Binärdatei eines Bilds bereitgestellt wird, das vektorisiert werden muss.
VectorizableImageUrlQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine URL, die einen Bildwert darstellt, der vektorisiert werden muss, bereitgestellt wird.
VectorizableTextQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein Textwert bereitgestellt wird, der vektorisiert werden muss.
VectorizedQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert bereitgestellt wird.
VectorQueryKind	Die Art der Vektorabfrage, die ausgeführt wird.
VectorsDebugInfo	"Enthält Debugging-Informationen, die spezifisch für Vektor- und Hybridsuche sind.")
VectorSimilarityThreshold	Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorgleichheitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die Version des Abstands. Die Schwellenwertrichtung (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt.
VectorThresholdKind	Die Art von Schwelle, die zum Filtern von Vektorabfragen verwendet wird.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=none

DebugInfo

Objekt

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

Name	Typ	Beschreibung
queryRewrites	QueryRewritesDebugInfo	Enthält Debugginginformationen, die für Abfrageumschreibungen spezifisch sind.

DocumentDebugInfo

Objekt

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

Name	Typ	Beschreibung
innerHits	object	Enthält Debuginformationen, die für Vektoren spezifisch sind, die in einer Auflistung komplexer Typen übereinstimmen.
semantic	SemanticDebugInfo	Enthält Debuginformationen, die für semantische Rangfolgeanforderungen spezifisch sind.
vectors	VectorsDebugInfo	Enthält Debugginginformationen, die Vektor- und Hybridsuche spezifisch sind.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

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

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

HybridCountAndFacetMode

Enumeration

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

Objekt

Die Abfrageparameter zum Konfigurieren von Hybridsuchverhalten.

Name	Typ	Beschreibung
countAndFacetMode	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.
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.

QueryAnswerResult

Objekt

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

Name	Typ	Beschreibung
highlights	string	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.

QueryAnswerType

Enumeration

Dieser Parameter ist nur gültig, wenn der Abfragetyp semanticist. Wenn diese Option festgelegt ist, gibt die Abfrage Antworten zurück, die aus Schlüsselpassagen in den am höchsten bewerteten Dokumenten extrahiert wurden. Die Anzahl der zurückgegebenen Antworten kann konfiguriert werden, indem der senkrechte Strich | gefolgt von der count-<number of answers> Option nach dem Wert des Parameters answers angehängt wird, z. B extractive|count-3. . Die Standardanzahl ist 1. Der Konfidenzschwellenwert kann konfiguriert werden, indem der senkrechte Strich | gefolgt von der threshold-<confidence threshold> Option nach dem Wert des Parameters answers angehängt wird, z. B extractive|threshold-0.9. . . Der Standardschwellenwert ist 0,7. Die maximale Zeichenlänge von Antworten kann konfiguriert werden, indem der senkrechte Strich '|' gefolgt von der 'count-number< of maximum character length>' angehängt wird, z. B. 'extractive|maxcharlength-600'.

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

QueryCaptionResult

Objekt

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

Name	Typ	Beschreibung
highlights	string	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.

QueryCaptionType

Enumeration

Dieser Parameter ist nur gültig, wenn der Abfragetyp semanticist. Wenn festgelegt, gibt die Abfrage Beschriftungen zurück, die aus Schlüsselabschnitten in den höchsten bewerteten Dokumenten extrahiert wurden. Wenn Beschriftungen auf extractivefestgelegt ist, ist die Hervorhebung standardmäßig aktiviert und kann konfiguriert werden, indem der senkrechte Strich | gefolgt von der highlight-<true/false> Option angehängt wird, z. B extractive|highlight-true. . . Wird standardmäßig auf None festgelegt. Die maximale Zeichenlänge von Untertiteln kann konfiguriert werden, indem der senkrechte Strich '|' gefolgt von der 'count-number< of maximum character length>' angehängt wird, z. B. 'extractive|maxcharlength-600'.

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

QueryDebugMode

Enumeration

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

Enumeration

Die Sprache der Abfrage.

Wert	Beschreibung
none	Abfragesprache nicht angegeben.
en-us	Abfrage des Sprachwerts 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

Objekt

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

Objekt

Beschreibung von Feldern, die an den semantischen Anreicherungsprozess gesendet wurden, sowie deren Verwendung

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

QueryResultDocumentSubscores

Objekt

Die Aufschlüsselung von Teilergebnissen zwischen den Text- und Vektorabfragekomponenten der Suchabfrage für dieses Dokument. Jede Vektorabfrage wird als separates Objekt in derselben Reihenfolge angezeigt, in der sie empfangen wurden.

Name	Typ	Beschreibung
documentBoost	number (double)	Die BM25- oder Classic-Bewertung für den Textbereich der Abfrage.
text	TextResult	Die BM25- oder Classic-Bewertung für den Textbereich der Abfrage.
vectors	<string, SingleVectorFieldResult>	Die Vektorähnlichkeit und

QueryRewritesDebugInfo

Objekt

Enthält Debugginginformationen, die für Abfrageumschreibungen spezifisch sind.

Name	Typ	Beschreibung
text	QueryRewritesValuesDebugInfo	Liste der Abfrageumschreibungen, die für die Textabfrage generiert wurden.
vectors	QueryRewritesValuesDebugInfo[]	Liste der Abfrageumschreibungen, die für die vektorisierbaren Textabfragen generiert wurden.

QueryRewritesType

Enumeration

Dieser Parameter ist nur gültig, wenn der Abfragetyp semanticist. Wenn QueryRewrites auf generativefestgelegt ist, werden die Abfragebegriffe an ein Generierungsmodell gesendet, das 10 (Standard-)Umschreibungen erzeugt, um den Abruf der Anforderung zu erhöhen. Die angeforderte Anzahl kann konfiguriert werden, indem Sie den senkrechten Strich | gefolgt von der count-<number of rewrites> Option anhängen, z. B generative|count-3. . . Wird standardmäßig auf None festgelegt.

Wert	Beschreibung
none	Generieren Sie keine zusätzlichen Abfrageumschreibungen für diese Abfrage.
generative	Generieren Sie alternative Abfragebegriffe, um den Rückruf einer Suchanforderung zu erhöhen.

QueryRewritesValuesDebugInfo

Objekt

Enthält Debugginginformationen, die für Abfrageumschreibungen 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

Enumeration

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

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

Enumeration

Gibt die Syntax der Suchabfrage an. Der Standardwert 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.

ScoringStatistics

Enumeration

Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Der Standardwert ist 'local'. Verwenden Sie "global", um 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

Objekt

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. Wenn vorhanden, kann die Anzahl größer als die Anzahl der Ergebnisse in dieser Antwort sein. 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	QueryAnswerResult[]	Die Ergebnisse der Antwortabfrage für den Suchvorgang; null, wenn der Antwortabfrageparameter 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 nicht in der Anforderung angegeben wurde.
@search.debug	DebugInfo	Debuggen Sie Informationen, die für die Suchergebnisse als Ganzes gelten.
@search.facets	object	Die Facetabfrageergebnisse für den Suchvorgang, organisiert als Sammlung von Buckets für jedes faceted-Feld; null, wenn die Abfrage keine Facetausdrücke enthält.
@search.nextPageParameters	SearchRequest	Die JSON-Fortsetzungsnutzlast, die zurückgegeben wird, wenn die Abfrage nicht alle angeforderten Ergebnisse in einer einzigen Antwort zurückgeben kann. Du kannst dieses JSON zusammen mit
@search.semanticPartialResponseReason	SemanticErrorReason	Grund dafür, dass eine Teilantwort für eine semantische Rangfolgeanforderung zurückgegeben wurde.
@search.semanticPartialResponseType	SemanticSearchResultsType	Typ der Teilantwort, die für eine semantische Rangfolgeanforderung zurückgegeben wurde.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	Typ der Abfrageumschreibung, die zum Abrufen von Dokumenten verwendet wurde.
value	SearchResult[]	Die Abfolge der ergebnisse, die von der Abfrage zurückgegeben werden.

SearchMode

Enumeration

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

Objekt

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

Name	Typ	Beschreibung
answers	QueryAnswerType	Ein Wert, der angibt, ob Antworten als Teil der Suchantwort zurückgegeben werden sollen.
captions	QueryCaptionType	Ein Wert, der angibt, ob Beschriftungen als Teil der Suchantwort zurückgegeben werden sollen.
count	boolean	Ein Wert, der angibt, ob die Gesamtanzahl der Ergebnisse abgerufen werden soll. Der Standardwert ist "false". Das Festlegen dieses Werts auf "true" hat möglicherweise auswirkungen auf die Leistung. Beachten Sie, dass die zurückgegebene Anzahl eine Annäherung ist.
debug	QueryDebugMode	Aktiviert ein Debugtool, mit dem Sie Ihre neu eingestuften Ergebnisse weiter untersuchen können.
facets	string[]	Die Liste der Facetausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facetausdruck enthält einen Feldnamen, optional gefolgt von einer durch Trennzeichen getrennten Liste von Name:Wert-Paaren.
filter	string	Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll.
highlight	string	Die durch Trennzeichen getrennte Liste der Feldnamen, die für Trefferhighlights verwendet werden sollen. Nur durchsuchbare Felder können zum Hervorheben von Treffern verwendet werden.
highlightPostTag	string	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.
highlightPreTag	string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Der Standardwert ist <em>.
hybridSearch	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 Erfolg gemeldet werden kann. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert ist 100.
orderby	string	Die durch Trennzeichen getrennte Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Jedem Ausdruck kann asc folgen, um aufsteigend oder desc anzuzeigen, um absteigend anzugeben. Der Standardwert ist die aufsteigende Reihenfolge. Die Verknüpfungen werden durch die Übereinstimmungsergebnisse von Dokumenten unterbrochen. Wenn keine $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können höchstens 32 $orderby Klauseln vorhanden sein.
queryLanguage	QueryLanguage	Ein Wert, der die Sprache der Suchabfrage angibt.
queryRewrites	QueryRewritesType	Ein Wert, der angibt, ob Abfrageumschreibungen generiert werden sollen, um die Suchabfrage zu erweitern.
queryType	QueryType	Ein Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "einfach". Verwenden Sie "vollständig", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
scoringParameters	string[]	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit den Formatnamenwerten verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne anführungszeichen).
scoringProfile	string	Der Name eines Bewertungsprofils, um Übereinstimmungsergebnisse für übereinstimmende Dokumente auszuwerten, um die Ergebnisse zu sortieren.
scoringStatistics	ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Der Standardwert ist 'local'. Verwenden Sie "global", um 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 angewendet werden soll. Bei Verwendung der feldbezogenen Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage haben die Feldnamen jedes feldbezogenen Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind.
searchMode	SearchMode	Ein Wert, der angibt, ob eine oder alle Suchbegriffe übereinstimmen müssen, um das Dokument als Übereinstimmung zu zählen.
select	string	Die durch Kommas getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, sind alle Felder enthalten, die im Schema als abrufbar gekennzeichnet sind.
semanticConfiguration	string	Der Name einer semantischen Konfiguration, die bei der Verarbeitung von Dokumenten für Abfragen vom Typ Semantik verwendet wird.
semanticErrorHandling	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.
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 versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die Wiederverwendung der gleichen SessionID-Werte wiederholt den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der wert, der als sessionId verwendet wird, kann nicht mit einem '_'-Zeichen beginnen.
skip	integer (int32)	Die Anzahl der zu überspringenden Suchergebnisse. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente sequenzieren müssen, aber aufgrund dieser Einschränkung nicht überspringen können, sollten Sie stattdessen "orderby" für einen vollständig sortierten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern.
speller	QuerySpellerType	Ein Wert, der den Typ des Schreibers angibt, der verwendet wird, um einzelne Suchbegriffe zu rechtweisen.
top	integer (int32)	Die Anzahl der abzurufenden Suchergebnisse. Dies kann in Verbindung mit $skip verwendet werden, um clientseitige Paging von Suchergebnissen zu implementieren. Wenn Ergebnisse aufgrund der serverseitigen Auslagerung abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine andere Suchanforderung für die nächste Seite der Ergebnisse auszuweisen.
vectorFilterMode	VectorFilterMode	Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden. Der Standardwert ist 'preFilter' für neue Indizes.
vectorQueries	VectorQuery[]: VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[] VectorizedQuery[]	Die Abfrageparameter für Vektor- und Hybridsuchabfragen.

SearchResult

Objekt

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

Name	Typ	Beschreibung
@search.captions	QueryCaptionResult[]	Beschriftungen sind die repräsentativsten Passagen aus dem Dokument relativ zur Suchabfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Untertitel werden nur für Abfragen vom Typ 'semantic' zurückgegeben.
@search.documentDebugInfo	DocumentDebugInfo	Enthält Debuginformationen, die verwendet werden können, um Ihre Suchergebnisse weiter zu untersuchen.
@search.highlights	object	Textfragmente aus dem Dokument, die die übereinstimmenden Suchbegriffe angeben, 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 sind nach RerankerScore/RerankerBoostedScore sortiert, basierend auf useScoringProfileBoostedRanking in der semantischen Konfiguration. RerankerBoostedScore wird nur für Anfragen vom Typ 'semantisch' 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

Objekt

Die Ergebnisse der Vektoranfrage filtern basierend auf dem '

Name	Typ	Beschreibung
kind	string: searchScore	Art der Schwelle.
value	number (double)	Der Schwellenwert filtert basierend auf dem '

SemanticDebugInfo

Objekt

Enthält Debuginformationen, die für semantische Rangfolgeanforderungen spezifisch sind.

Name	Typ	Beschreibung
contentFields	QueryResultDocumentSemanticField[]	Die Inhaltsfelder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie die Art und Weise, wie sie verwendet wurden
keywordFields	QueryResultDocumentSemanticField[]	Die Schlüsselwortfelder, die an den semantischen Anreicherungsprozess gesendet wurden, sowie die Art und Weise, wie sie verwendet wurden
rerankerInput	QueryResultDocumentRerankerInput	Die unformatierten verketteten Zeichenfolgen, die an den semantischen Anreicherungsprozess gesendet wurden.
titleField	QueryResultDocumentSemanticField	Das Titelfeld, das an den semantischen Anreicherungsprozess gesendet wurde, sowie die Art und Weise, wie es verwendet wurde

SemanticErrorMode

Enumeration

Ermöglicht es dem Benutzer zu wählen, ob ein semantischer Aufruf vollständig fehlschlägt oder teilweise Ergebnisse zurückgibt.

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

Enumeration

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

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

SemanticFieldState

Enumeration

Die Art und Weise, wie das Feld für den semantischen Anreicherungsprozess verwendet wurde.

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

Enumeration

Typ des Umschreibens von Abfragen, der für diese Anforderung verwendet wurde.

Wert	Beschreibung
originalQueryOnly	Für diese Anforderung wurden Abfrageumschreibungen nicht erfolgreich generiert. Nur die ursprüngliche Abfrage wurde zum Abrufen der Ergebnisse verwendet.

SemanticSearchResultsType

Enumeration

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

Objekt

Ein einzelnes Vektorfeldergebnis. Beides

Name	Typ	Beschreibung
searchScore	number (double)	Das
vectorSimilarity	number (double)	Die Bewertung der Vektorähnlichkeit für dieses Dokument. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die Version des Abstands. Zum Beispiel Kosinusähnlichkeit anstelle des Kosinusabstands.

TextResult

Objekt

Die BM25- oder Classic-Bewertung für den Textbereich der Abfrage.

Name	Typ	Beschreibung
searchScore	number (double)	Die BM25- oder Classic-Bewertung für den Textbereich der Abfrage.

VectorFilterMode

Enumeration

Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden.

Wert	Beschreibung
postFilter	Der Filter wird angewendet, nachdem der Kandidatensatz von Vektorergebnissen zurückgegeben wurde. Je nach Filterauswahl kann dies zu weniger Ergebnissen führen als vom Parameter "k" angefordert.
preFilter	Der Filter wird vor der Suchabfrage 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

Objekt

Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine base64-codierte Binärdatei eines Bilds 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 wahr, löst eine vollständige k-nächste Nachbarsuche über alle Vektoren innerhalb des Vektorindex aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen kritisch sind, z. B. das Bestimmen von Boden-Wahrheitswerten.
fields	string	Vektorfelder vom Typ Collection(Edm.Single), die in den durchsuchten Vektor einbezogen werden sollen.
filterOverride	string	Der OData-Filterausdruck, der auf diese spezifische Vektorabfrage angewendet werden soll. Wenn kein Filterausdruck auf Vektorebene definiert ist, wird stattdessen der im Filterparameter der obersten Ebene definierte Ausdruck verwendet.
k	integer (int32)	Die Anzahl der nächsten Nachbarn, die als Toptreffer zurückgegeben werden sollen.
kind	string: imageBinary	Abfragetyp.
oversampling	number (double)	Übersamplingfaktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter "defaultOversampling". Sie kann nur festgelegt werden, wenn "rerankWithOriginalVectors" wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird.
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: SearchScoreThreshold VectorSimilarityThreshold	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 Suchanforderung. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Bewertungslisten kombiniert werden, die von den verschiedenen Vektorabfragen und/oder den ergebnissen, die über die Textabfrage abgerufen wurden. Je höher die Gewichtung ist, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0 und der Wert muss eine positive Zahl größer als 0 sein.

VectorizableImageUrlQuery

Objekt

Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine URL, die einen Bildwert darstellt, der vektorisiert werden muss, bereitgestellt wird.

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

VectorizableTextQuery

Objekt

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

Name	Typ	Beschreibung
exhaustive	boolean	Wenn wahr, löst eine vollständige k-nächste Nachbarsuche über alle Vektoren innerhalb des Vektorindex aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen kritisch sind, z. B. das Bestimmen von Boden-Wahrheitswerten.
fields	string	Vektorfelder vom Typ Collection(Edm.Single), die in den durchsuchten Vektor einbezogen werden sollen.
filterOverride	string	Der OData-Filterausdruck, der auf diese spezifische Vektorabfrage angewendet werden soll. Wenn kein Filterausdruck auf Vektorebene definiert ist, wird stattdessen der im Filterparameter der obersten Ebene definierte Ausdruck verwendet.
k	integer (int32)	Die Anzahl der nächsten Nachbarn, die als Toptreffer zurückgegeben werden sollen.
kind	string: text	Abfragetyp.
oversampling	number (double)	Übersamplingfaktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter "defaultOversampling". Sie kann nur festgelegt werden, wenn "rerankWithOriginalVectors" wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird.
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	QueryRewritesType	Kann so konfiguriert werden, dass ein generatives Modell die Abfrage neu schreiben kann, bevor sie an die Vektorisierung gesendet wird.
text	string	Der text, der vektorisiert werden soll, um eine Vektorsuchabfrage auszuführen.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	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 Suchanforderung. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Bewertungslisten kombiniert werden, die von den verschiedenen Vektorabfragen und/oder den ergebnissen, die über die Textabfrage abgerufen wurden. Je höher die Gewichtung ist, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0 und der Wert muss eine positive Zahl größer als 0 sein.

VectorizedQuery

Objekt

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

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

VectorQueryKind

Enumeration

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

Objekt

"Enthält Debugging-Informationen, die spezifisch für Vektor- und Hybridsuche sind.")

Name	Typ	Beschreibung
subscores	QueryResultDocumentSubscores	Die Aufschlüsselung der Teilbewertungen des Dokuments vor der gewählten Fusions-/Kombinationsmethode der Ergebnismenge, wie z. B. RRF.

VectorSimilarityThreshold

Objekt

Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorgleichheitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die Version des Abstands. Die Schwellenwertrichtung (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt.

Name	Typ	Beschreibung
kind	string: vectorSimilarity	Art der Schwelle.
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 Version des Abstands. Die Schwellenwertrichtung (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt.

VectorThresholdKind

Enumeration

Die Art von Schwelle, die zum Filtern von Vektorabfragen verwendet wird.

Wert	Beschreibung
vectorSimilarity	Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorgleichheitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die Version des Abstands. Die Schwellenwertrichtung (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 die @search.score, die als Teil der Suchantwort zurückgegeben wird. Die Schwellenwertrichtung wird für höhere @search.scoreausgewählt.