Documents - Search Post

Dienst:: Search Service

API-Version:: 2025-09-01

Sucht nach Dokumenten im Index.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2025-09-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 Nachverfolgungs-ID, die mit der Anforderung gesendet wird, um das Debuggen zu unterstützen.

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 es sich bei der zurückgegebenen Zählung um einen Näherungswert handelt.
debug	QueryDebugMode	Aktiviert ein Debugtool, mit dem Sie Ihre neu eingestuften Ergebnisse weiter untersuchen können.
facets	string[]	Die Liste der Facettenausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facettenausdruck enthält einen Feldnamen, optional gefolgt von einer durch Kommas getrennten Liste von Name-Wert-Paaren.
filter	string	Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll.
highlight	string	Die durch Kommas getrennte Liste von Feldnamen, die für Trefferhervorhebungen verwendet werden sollen. Nur durchsuchbare Felder können für die Trefferhervorhebung verwendet werden.
highlightPostTag	string	Ein Zeichenfolgen-Tag, das an Treffermarkierungen angehängt wird. Muss mit highlightPreTag gesetzt werden. Der Standardwert ist </em>.
highlightPreTag	string	Ein Zeichenfolgen-Tag, dem das Erreichen von Highlights vorangestellt wird. Muss mit highlightPostTag gesetzt werden. Der Standardwert ist <em>.
minimumCoverage	number (double)	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Suchabfrage abgedeckt werden muss, damit die Abfrage als erfolgreich gemeldet wird. Dieser Parameter kann nützlich sein, um die Verfügbarkeit der Suche auch für Dienste mit nur einem Replikat sicherzustellen. Der Standard ist 100.
orderby	string	Die durch Trennzeichen getrennte Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Auf jeden Ausdruck kann asc folgen, um aufsteigend anzugeben, oder desc, um absteigend anzugeben. Die Standardeinstellung ist aufsteigend. Unentschieden werden durch die Spielergebnisse der Dokumente aufgelöst. Wenn keine $orderby angegeben ist, ist die Standardsortierreihenfolge absteigend nach Dokumentabgleichsbewertung. Es können höchstens 32 $orderby Klauseln bestehen.
queryType	QueryType	Ein Wert, der die Syntax der Suchabfrage angibt. Die Standardeinstellung ist 'einfach'. Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
scoringParameters	string[]	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) im Format name-values verwendet werden sollen. Wenn das Bewertungsprofil z. B. eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne Anführungszeichen).
scoringProfile	string	Der Name eines Bewertungsprofils zum Auswerten von Übereinstimmungsergebnissen für übereinstimmende Dokumente, um die Ergebnisse zu sortieren.
scoringStatistics	ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. die Häufigkeit von Dokumenten) global berechnen möchten, um eine konsistentere Bewertung zu erzielen, oder lokal, um die Latenz zu verringern. Der Standardwert ist 'local'. Verwenden Sie "global", um Punktestatistiken global zu aggregieren, bevor Sie eine Bewertung vornehmen. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchanfragen erhöhen.
search	string	Ein Ausdruck für eine Volltextsuchabfrage. Verwenden Sie "*" oder lassen Sie diesen Parameter weg, um alle Dokumente abzugleichen.
searchFields	string	Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche beschränkt werden soll. Wenn Sie die Feldsuche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage verwenden, haben die Feldnamen der einzelnen Feldsuchausdrücke Vorrang vor allen Feldnamen, die in diesem Parameter aufgeführt sind.
searchMode	SearchMode	Ein Wert, der angibt, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung gezählt wird.
select	string	Die durch Kommas getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, werden alle Felder, die im Schema als abrufbar markiert sind, eingeschlossen.
semanticConfiguration	string	Der Name einer semantischen Konfiguration, die bei der Verarbeitung von Dokumenten für Abfragen vom Typ Semantik verwendet wird.
semanticErrorHandling	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.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Ermöglicht es dem Benutzer, eine Obergrenze für die Zeit festzulegen, die die semantische Anreicherung benötigt, um die Verarbeitung abzuschließen, bevor die Anforderung fehlschlägt.
semanticQuery	string	Ermöglicht das Festlegen einer separaten Suchanfrage, die ausschließlich für semantisches Reranking, semantische Untertitel und semantische Antworten verwendet wird. Ist nützlich für Szenarien, in denen zwischen der Basisabruf- und Bewertungsphase und der semantischen L2-Phase unterschiedliche Abfragen verwendet werden müssen.
sessionId	string	Ein Wert, der zum Erstellen einer fixierten Sitzung verwendet werden soll, um konsistentere Ergebnisse zu erzielen. Solange dieselbe sessionId verwendet wird, wird nach bestem Wissen und Gewissen versucht, dieselbe Replikatgruppe als Ziel zu verwenden. Achten Sie darauf, dass die wiederholte Wiederverwendung derselben sessionID-Werte den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und sich negativ auf die Leistung des Suchdiensts auswirken kann. Der als sessionId verwendete Wert darf nicht mit dem Zeichen "_" beginnen.
skip	integer (int32)	Die Anzahl der Suchergebnisse, die übersprungen werden sollen. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente nacheinander scannen müssen, aber aufgrund dieser Einschränkung Skip nicht verwenden können, sollten Sie orderby für einen vollständig geordneten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern.
top	integer (int32)	Die Anzahl der Suchergebnisse, die abgerufen werden sollen. Dies kann in Verbindung mit $skip verwendet werden, um das clientseitige Paging von Suchergebnissen zu implementieren. Wenn Ergebnisse aufgrund der serverseitigen Auslagerung abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine weitere Suchanforderung für die nächste Ergebnisseite auszugeben.
vectorFilterMode	VectorFilterMode	Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden. Der Standardwert ist 'preFilter' für neue Indizes.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Die Abfrageparameter für Vektor- und Hybrid-Suchanfragen.

Antworten

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

Beispiele

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Beispielanforderung

HTTP

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.search?api-version=2025-09-01


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "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",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "exhaustive": true,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@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": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "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": 1.0779930353164673
            },
            "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": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@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": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@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": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@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": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Statuscode:: 206

{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@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": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "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": 1.0779930353164673
            },
            "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": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@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": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@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": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@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": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "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-09-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

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=2024-07-01"
}

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=2024-07-01"
}

Definitionen

Name	Beschreibung
AnswerResult	Eine Antwort ist eine Textpassage, die aus dem Inhalt der relevantesten Dokumente extrahiert wird, die der Suchanfrage entsprechen. Die Antworten werden aus den Top-Suchergebnissen extrahiert. Die Antwortkandidaten werden bewertet und die besten Antworten werden ausgewählt.
CaptionResult	Bildunterschriften sind die repräsentativsten Passagen aus dem Dokument im Verhältnis zur Suchanfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Untertitel werden nur für Abfragen vom Typ `semantic`.
DocumentDebugInfo	Enthält Debuginformationen, die zum weiteren Untersuchen Ihrer Suchergebnisse verwendet werden können.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
QueryAnswerType	Ein Wert, der angibt, ob Antworten als Teil der Suchantwort zurückgegeben werden sollen.
QueryCaptionType	Ein Wert, der angibt, ob Untertitel als Teil der Suchantwort zurückgegeben werden sollen.
QueryDebugMode	Aktiviert ein Debugtool, mit dem Sie Ihre Suchergebnisse weiter untersuchen können.
QueryResultDocumentSubscores	Die Aufschlüsselung der Teilbewertungen zwischen den Text- und Vektorabfragekomponenten der Suchabfrage für dieses Dokument. Jede Vektorabfrage wird als separates Objekt in der gleichen Reihenfolge angezeigt, in der sie empfangen wurde.
QueryType	Gibt die Syntax der Suchabfrage an. Die Standardeinstellung ist 'einfach'. Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
RawVectorQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert angegeben wird.
ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. die Häufigkeit von Dokumenten) global berechnen möchten, um eine konsistentere Bewertung zu erzielen, oder lokal, um die Latenz zu verringern. Der Standardwert ist 'local'. Verwenden Sie "global", um Punktestatistiken global zu aggregieren, bevor Sie eine Bewertung vornehmen. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchanfragen erhöhen.
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, Facettieren, Auslagern und andere Verhaltensweisen von Suchabfragen.
SearchResult	Enthält ein Dokument, das durch eine Suchabfrage gefunden wurde, sowie die zugehörigen 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.
SingleVectorFieldResult	Ein einzelnes Vektorfeldergebnis. Sowohl als auch @search.score Vektorähnlichkeitswerte werden zurückgegeben. Die Vektorähnlichkeit wird durch eine Gleichung in Beziehung gesetzt @search.score .
TextResult	Die BM25- oder Classic-Bewertung für den Textteil der Abfrage.
VectorFilterMode	Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden.
VectorizableTextQuery	Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein Textwert angegeben wird, der vektorisiert werden muss.
VectorQueryKind	Die Art der Vektorabfrage, die ausgeführt wird.
VectorsDebugInfo

AnswerResult

Objekt

Eine Antwort ist eine Textpassage, die aus dem Inhalt der relevantesten Dokumente extrahiert wird, die der Suchanfrage entsprechen. Die Antworten werden aus den Top-Suchergebnissen extrahiert. Die Antwortkandidaten werden bewertet und die besten Antworten werden ausgewählt.

Name	Typ	Beschreibung
highlights	string	Dieselbe Textpassage wie in der Text-Eigenschaft mit hervorgehobenen Textphrasen, die für die Abfrage am relevantesten sind.
key	string	Der Schlüssel des Dokuments, aus dem die Antwort extrahiert wurde.
score	number (double)	Der Bewertungswert gibt an, wie relevant die Antwort für die Abfrage im Vergleich zu anderen Antworten ist, die für die Abfrage zurückgegeben werden.
text	string	Die aus dem Dokumentinhalt extrahierte Textpassage als Antwort.

CaptionResult

Objekt

Bildunterschriften sind die repräsentativsten Passagen aus dem Dokument im Verhältnis zur Suchanfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Untertitel werden nur für Abfragen vom Typ semantic.

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

DocumentDebugInfo

Objekt

Enthält Debuginformationen, die zum weiteren Untersuchen Ihrer Suchergebnisse verwendet werden können.

Name	Typ	Beschreibung
vectors	VectorsDebugInfo	Enthält Debugging-Informationen, die für die Vektor- und Hybridsuche spezifisch sind.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	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

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

QueryAnswerType

Enumeration

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

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

QueryCaptionType

Enumeration

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

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

QueryDebugMode

Enumeration

Aktiviert ein Debugtool, mit dem Sie Ihre Suchergebnisse weiter untersuchen können.

Wert	Beschreibung
disabled	Es werden keine Informationen zum Debuggen von Abfragen zurückgegeben.
vector	Ermöglicht es dem Benutzer, seine Hybrid- und Vektorabfrageergebnisse weiter zu untersuchen.

QueryResultDocumentSubscores

Objekt

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

Name	Typ	Beschreibung
documentBoost	number (double)	Die BM25- oder Classic-Bewertung für den Textteil der Abfrage.
text	TextResult	Die BM25- oder Classic-Bewertung für den Textteil der Abfrage.
vectors	<string, SingleVectorFieldResult>	Die Vektorähnlichkeit und @search.score die Werte für jede Vektorabfrage.

QueryType

Enumeration

Gibt die Syntax der Suchabfrage an. Die Standardeinstellung ist 'einfach'. Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.

Wert	Beschreibung
simple	Verwendet die einfache Abfragesyntax für Suchvorgänge. Der Suchtext wird mit einer einfachen Abfragesprache interpretiert, die Symbole wie +, * und "" zulässt. Abfragen werden standardmäßig über alle durchsuchbaren Felder ausgewertet, es sei denn, der Parameter searchFields ist angegeben.
full	Verwendet die vollständige Lucene-Abfragesyntax für Suchvorgänge. Der Suchtext wird mit der Abfragesprache Lucene interpretiert, die feldspezifische und gewichtete Suchen sowie andere erweiterte Funktionen ermöglicht.
semantic	Am besten geeignet für Abfragen, die in natürlicher Sprache im Gegensatz zu Schlüsselwörtern ausgedrückt werden. Verbessert die Genauigkeit der Suchergebnisse, indem die Top-Suchergebnisse mithilfe eines im Webkorpus trainierten Rangfolgemodells neu eingestuft werden.

RawVectorQuery

Objekt

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

Name	Typ	Beschreibung
exhaustive	boolean	Wenn true, wird eine umfassende Suche nach dem nächsten k-Nachbarn für alle Vektoren innerhalb des Vektorindex ausgelöst. Nützlich für Szenarien, in denen exakte Übereinstimmungen entscheidend sind, z. B. bei der Bestimmung von Ground-Truth-Werten.
fields	string	Vektor Felder vom Typ Collection(Edm.Single), die in den gesuchten Vektor aufgenommen werden sollen.
k	integer (int32)	Anzahl der nächsten Nachbarn, die als Top-Treffer zurückgegeben werden sollen.
kind	string: vector	Die Art der Vektorabfrage, die ausgeführt wird.
oversampling	number (double)	Oversampling-Faktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter 'defaultOversampling'. Sie kann nur gesetzt werden, wenn 'rerankWithOriginalVectors' wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird.
vector	number[] (float)	Die Vektordarstellung einer Suchanfrage.
weight	number (float)	Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanfrage. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Ranglisten, die von den verschiedenen Vektorabfragen erzeugt werden, und/oder die über die Textabfrage abgerufenen Ergebnisse kombiniert werden. Je höher die Gewichtung, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0, und der Wert muss eine positive Zahl größer als Null sein.

ScoringStatistics

Enumeration

Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. die Häufigkeit von Dokumenten) global berechnen möchten, um eine konsistentere Bewertung zu erzielen, oder lokal, um die Latenz zu verringern. Der Standardwert ist 'local'. Verwenden Sie "global", um Punktestatistiken global zu aggregieren, bevor Sie eine Bewertung vornehmen. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchanfragen erhöhen.

Wert	Beschreibung
local	Die Bewertungsstatistiken werden lokal berechnet, um die Latenz zu verringern.
global	Die Punktestatistiken werden global berechnet, um eine konsistentere Bewertung zu gewährleisten.

SearchDocumentsResult

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. Falls vorhanden, kann die Anzahl größer sein als die Anzahl der Ergebnisse in dieser Antwort. Dies kann der Fall sein, wenn Sie die Parameter $top oder $skip verwenden oder wenn die Abfrage nicht alle angeforderten Dokumente in einer einzigen Antwort zurückgeben kann.
@odata.nextLink	string	Fortsetzungs-URL, die zurückgegeben wird, wenn die Abfrage nicht alle angeforderten Ergebnisse in einer einzigen Antwort zurückgeben kann. Sie können diese URL verwenden, um eine weitere GET- oder POST-Suchanforderung zu formulieren, um den nächsten Teil der Suchantwort abzurufen. Stellen Sie sicher, dass Sie dasselbe Verb (GET oder POST) wie die Anforderung verwenden, die diese Antwort erzeugt hat.
@search.answers	AnswerResult[]	Die Antworten Abfrageergebnisse für den Suchvorgang; NULL, wenn der Abfrageparameter answers nicht angegeben oder auf 'none' festgelegt wurde.
@search.coverage	number (double)	Ein Wert, der den Prozentsatz des Indexes angibt, der in der Abfrage enthalten war, oder NULL, wenn minimumCoverage in der Anforderung nicht angegeben wurde.
@search.facets	object	Die Facettenabfrageergebnisse für den Suchvorgang, organisiert als Sammlung von Buckets für jedes facettenreiche Feld; null, wenn die Abfrage keine Facettenausdrücke enthält.
@search.nextPageParameters	SearchRequest	Die JSON-Fortsetzungsnutzlast, die zurückgegeben wird, wenn die Abfrage nicht alle angeforderten Ergebnisse in einer einzigen Antwort zurückgeben kann. Sie können diesen JSON-Code zusammen mit @odata.nextLink verwenden, um eine weitere POST-Suchanforderung zu formulieren und den nächsten Teil der Suchantwort abzurufen.
@search.semanticPartialResponseReason	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.
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, Facettieren, Auslagern und andere Verhaltensweisen von Suchabfragen.

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 es sich bei der zurückgegebenen Zählung um einen Näherungswert handelt.
debug	QueryDebugMode	Aktiviert ein Debugtool, mit dem Sie Ihre neu eingestuften Ergebnisse weiter untersuchen können.
facets	string[]	Die Liste der Facettenausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facettenausdruck enthält einen Feldnamen, optional gefolgt von einer durch Kommas getrennten Liste von Name-Wert-Paaren.
filter	string	Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll.
highlight	string	Die durch Kommas getrennte Liste von Feldnamen, die für Trefferhervorhebungen verwendet werden sollen. Nur durchsuchbare Felder können für die Trefferhervorhebung verwendet werden.
highlightPostTag	string	Ein Zeichenfolgen-Tag, das an Treffermarkierungen angehängt wird. Muss mit highlightPreTag gesetzt werden. Der Standardwert ist </em>.
highlightPreTag	string	Ein Zeichenfolgen-Tag, dem das Erreichen von Highlights vorangestellt wird. Muss mit highlightPostTag gesetzt werden. Der Standardwert ist <em>.
minimumCoverage	number (double)	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Suchabfrage abgedeckt werden muss, damit die Abfrage als erfolgreich gemeldet wird. Dieser Parameter kann nützlich sein, um die Verfügbarkeit der Suche auch für Dienste mit nur einem Replikat sicherzustellen. Der Standard ist 100.
orderby	string	Die durch Trennzeichen getrennte Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Auf jeden Ausdruck kann asc folgen, um aufsteigend anzugeben, oder desc, um absteigend anzugeben. Die Standardeinstellung ist aufsteigend. Unentschieden werden durch die Spielergebnisse der Dokumente aufgelöst. Wenn keine $orderby angegeben ist, ist die Standardsortierreihenfolge absteigend nach Dokumentabgleichsbewertung. Es können höchstens 32 $orderby Klauseln bestehen.
queryType	QueryType	Ein Wert, der die Syntax der Suchabfrage angibt. Die Standardeinstellung ist 'einfach'. Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet.
scoringParameters	string[]	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) im Format name-values verwendet werden sollen. Wenn das Bewertungsprofil z. B. eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne Anführungszeichen).
scoringProfile	string	Der Name eines Bewertungsprofils zum Auswerten von Übereinstimmungsergebnissen für übereinstimmende Dokumente, um die Ergebnisse zu sortieren.
scoringStatistics	ScoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. die Häufigkeit von Dokumenten) global berechnen möchten, um eine konsistentere Bewertung zu erzielen, oder lokal, um die Latenz zu verringern. Der Standardwert ist 'local'. Verwenden Sie "global", um Punktestatistiken global zu aggregieren, bevor Sie eine Bewertung vornehmen. Die Verwendung globaler Bewertungsstatistiken kann die Latenz von Suchanfragen erhöhen.
search	string	Ein Ausdruck für eine Volltextsuchabfrage. Verwenden Sie "*" oder lassen Sie diesen Parameter weg, um alle Dokumente abzugleichen.
searchFields	string	Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche beschränkt werden soll. Wenn Sie die Feldsuche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage verwenden, haben die Feldnamen der einzelnen Feldsuchausdrücke Vorrang vor allen Feldnamen, die in diesem Parameter aufgeführt sind.
searchMode	SearchMode	Ein Wert, der angibt, ob einige oder alle Suchbegriffe übereinstimmen müssen, damit das Dokument als Übereinstimmung gezählt wird.
select	string	Die durch Kommas getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, werden alle Felder, die im Schema als abrufbar markiert sind, eingeschlossen.
semanticConfiguration	string	Der Name einer semantischen Konfiguration, die bei der Verarbeitung von Dokumenten für Abfragen vom Typ Semantik verwendet wird.
semanticErrorHandling	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.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Ermöglicht es dem Benutzer, eine Obergrenze für die Zeit festzulegen, die die semantische Anreicherung benötigt, um die Verarbeitung abzuschließen, bevor die Anforderung fehlschlägt.
semanticQuery	string	Ermöglicht das Festlegen einer separaten Suchanfrage, die ausschließlich für semantisches Reranking, semantische Untertitel und semantische Antworten verwendet wird. Ist nützlich für Szenarien, in denen zwischen der Basisabruf- und Bewertungsphase und der semantischen L2-Phase unterschiedliche Abfragen verwendet werden müssen.
sessionId	string	Ein Wert, der zum Erstellen einer fixierten Sitzung verwendet werden soll, um konsistentere Ergebnisse zu erzielen. Solange dieselbe sessionId verwendet wird, wird nach bestem Wissen und Gewissen versucht, dieselbe Replikatgruppe als Ziel zu verwenden. Achten Sie darauf, dass die wiederholte Wiederverwendung derselben sessionID-Werte den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und sich negativ auf die Leistung des Suchdiensts auswirken kann. Der als sessionId verwendete Wert darf nicht mit dem Zeichen "_" beginnen.
skip	integer (int32)	Die Anzahl der Suchergebnisse, die übersprungen werden sollen. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente nacheinander scannen müssen, aber aufgrund dieser Einschränkung Skip nicht verwenden können, sollten Sie orderby für einen vollständig geordneten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern.
top	integer (int32)	Die Anzahl der Suchergebnisse, die abgerufen werden sollen. Dies kann in Verbindung mit $skip verwendet werden, um das clientseitige Paging von Suchergebnissen zu implementieren. Wenn Ergebnisse aufgrund der serverseitigen Auslagerung abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine weitere Suchanforderung für die nächste Ergebnisseite auszugeben.
vectorFilterMode	VectorFilterMode	Legt fest, ob Filter vor oder nach der Vektorsuche angewendet werden. Der Standardwert ist 'preFilter' für neue Indizes.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Die Abfrageparameter für Vektor- und Hybrid-Suchanfragen.

SearchResult

Objekt

Enthält ein Dokument, das durch eine Suchabfrage gefunden wurde, sowie die zugehörigen Metadaten.

Name	Typ	Beschreibung
@search.captions	CaptionResult[]	Bildunterschriften sind die repräsentativsten Passagen aus dem Dokument im Verhältnis zur Suchanfrage. Sie werden häufig als Dokumentzusammenfassung verwendet. Untertitel werden nur für Abfragen vom Typ 'semantic' zurückgegeben.
@search.documentDebugInfo	DocumentDebugInfo	Enthält Debuginformationen, die zum weiteren Untersuchen Ihrer Suchergebnisse verwendet werden können.
@search.highlights	object	Textfragmente aus dem Dokument, die die übereinstimmenden Suchbegriffe angeben, geordnet nach den einzelnen zutreffenden Feldern; NULL, wenn die Trefferhervorhebung für die Abfrage nicht aktiviert wurde.
@search.rerankerBoostedScore	number (double)	Die Relevanzbewertung, die durch Erhöhen des Reranker-Scores berechnet wird. Die Suchergebnisse werden nach dem RerankerScore/RerankerBoostedScore sortiert, basierend auf useScoringProfileBoostedRanking in der semantischen Konfiguration. RerankerBoostedScore wird nur für Abfragen vom Typ 'semantic' zurückgegeben
@search.rerankerScore	number (double)	Die Relevanzbewertung, die von der semantischen Rangfolge für die Top-Suchergebnisse berechnet wird. Die Suchergebnisse werden zuerst nach dem RerankerScore und dann nach dem Score sortiert. RerankerScore wird nur für Abfragen vom Typ 'semantic' zurückgegeben.
@search.score	number (double)	Die Relevanzbewertung des Dokuments im Vergleich zu anderen Dokumenten, die von der Abfrage zurückgegeben werden.

SemanticErrorMode

Enumeration

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

Wert	Beschreibung
partial	Wenn die semantische Verarbeitung fehlschlägt, werden dennoch Teilergebnisse zurückgegeben. Die Definition von Teilergebnissen hängt davon ab, welcher semantische Schritt fehlgeschlagen ist und was der Grund für das Scheitern war.
fail	Wenn während des semantischen Verarbeitungsschritts eine Ausnahme auftritt, schlägt die Abfrage fehl und gibt je nach Fehler den entsprechenden HTTP-Code zurück.

SemanticErrorReason

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.

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. Sowohl als auch @search.score Vektorähnlichkeitswerte werden zurückgegeben. Die Vektorähnlichkeit wird durch eine Gleichung in Beziehung gesetzt @search.score .

Name	Typ	Beschreibung
searchScore	number (double)	Der @search.score Wert, der aus der Vektorähnlichkeitsbewertung berechnet wird. Dies ist die Bewertung, die in einer reinen Einzelfeld-Einzelvektorabfrage sichtbar ist.
vectorSimilarity	number (double)	Die Bewertung der Vektorähnlichkeit für dieses Dokument. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die "Entfernungs"-Version. Zum Beispiel Kosinusähnlichkeit anstelle des Kosinusabstands.

TextResult

Objekt

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

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

VectorFilterMode

Enumeration

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

Wert	Beschreibung
postFilter	Der Filter wird angewendet, nachdem der Kandidatensatz der Vektorergebnisse zurückgegeben wurde. Abhängig von der Filterselektivität kann dies zu weniger Ergebnissen führen, als vom Parameter 'k' gefordert werden.
preFilter	Der Filter wird vor der Suchanfrage angewendet.

VectorizableTextQuery

Objekt

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

Name	Typ	Beschreibung
exhaustive	boolean	Wenn true, wird eine umfassende Suche nach dem nächsten k-Nachbarn für alle Vektoren innerhalb des Vektorindex ausgelöst. Nützlich für Szenarien, in denen exakte Übereinstimmungen entscheidend sind, z. B. bei der Bestimmung von Ground-Truth-Werten.
fields	string	Vektor Felder vom Typ Collection(Edm.Single), die in den gesuchten Vektor aufgenommen werden sollen.
k	integer (int32)	Anzahl der nächsten Nachbarn, die als Top-Treffer zurückgegeben werden sollen.
kind	string: text	Die Art der Vektorabfrage, die ausgeführt wird.
oversampling	number (double)	Oversampling-Faktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter 'defaultOversampling'. Sie kann nur gesetzt werden, wenn 'rerankWithOriginalVectors' wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird.
text	string	Der Text, der vektorisiert werden soll, um eine Vektorsuchabfrage durchzuführen.
weight	number (float)	Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanfrage. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Ranglisten, die von den verschiedenen Vektorabfragen erzeugt werden, und/oder die über die Textabfrage abgerufenen Ergebnisse kombiniert werden. Je höher die Gewichtung, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0, und der Wert muss eine positive Zahl größer als Null sein.

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.

VectorsDebugInfo

Objekt

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

Freigeben über

Documents - Search Post

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Beispiele

SearchIndexSearchDocumentsPost

Beispielanforderung

Beispiel für eine Antwort

SearchIndexSearchDocumentsSemanticPost

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnswerResult

CaptionResult

DocumentDebugInfo

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryDebugMode

QueryResultDocumentSubscores

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

SingleVectorFieldResult

TextResult

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

VectorsDebugInfo