Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Die Azure AI Search-REST-APIs unterstützen eine Reihe allgemeiner HTTP-Anforderungs-/Antwortheader, die hier zur Referenz zusammengefasst sind:
| Anforderungsheader | Typ | BESCHREIBUNG |
|---|---|---|
| Akzeptieren | Inhaltstyp | Der angeforderte Inhaltstyp für die Antwort. Der Standardwert ist "application/json;odata.metadata=minimal". Andere zulässige Werte sind application/json, application/json; odata.metadata=full, application/json; odata.metadata=none und text/plain (nur für $count). |
| api-key | String | Legen Sie je nach API auf Ihren Abfrage- oder Administratorschlüssel fest. |
| authorization | String | Das OAuth 2.0-Zugriffstoken für die Anforderung. Erfordert die Konfiguration Ihres Suchdiensts für den rollenbasierten Zugriff. Dieser Anforderungsheader gilt für Client-Apps, die Microsoft Entra ID Authentifizierung und Rollenzuweisungen verwenden. Ihr Clientcode muss das Token bereitstellen. Sie können diesen Anforderungsheader mit jeder unterstützten REST-API-Version verwenden, solange der Suchdienst für die Datenebenenauthentifizierung konfiguriert ist. |
| Content-Type | Content-Type | Der Inhaltstyp des Anforderungstexts (PUT/POST). Der Standardwert ist application/json. |
| client-request-id | GUID | Optionale vom Aufrufer angegebene Anforderungs-ID in Form einer GUID ohne Dekoration, z. B. geschweifte Klammern (z. B. client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Ein vom Aufrufer definierter Wert, der die angegebene Anforderung identifiziert. Wenn angegeben, wird dieser Wert in die Antwortinformationen aufgenommen, um die Anforderung zuzuordnen. |
| OData-MaxVersion | "4.0" | Gibt die maximale Version des OData-Protokolls an, das vom Client unterstützt wird. Der Standardwert ist "4.0". |
| Prefer | "return=representation" oder "return=minimal" | Hiermit wird die Antwortnutzlast von PUT- und POST /indexes-Anforderungen gesteuert. Der Standardwert ist "return=representation", wenn ein neuer Index über POST oder PUT erstellt wird, und "return=minimal", um einen vorhandenen Index über PUT zu aktualisieren. |
| Return-Client-Request-id | „true“ oder „false“ | Ist sowohl dieser Header als auch "client-request-id" angegeben, wird der Server angewiesen, den "client-request-id"-Header in die Antwort einzufügen. Der Standardwert lautet False. |
| If-Match | ETag oder * | Wird nur verwendet, um eine Ressource zu ändern, wenn die aktuelle Version mit dem angegebenen ETag übereinstimmt. Verwenden Sie diesen Header mit POST-, PUT- oder DELETE-Methoden für Ressourcen (z. B. Indexer, Indizes und Datenquellen, aber nicht Dokumente), um die Steuerung der optimistischen Parallelität zu ermöglichen. |
| If-None-Match | ETag oder * | Wird nur verwendet, um eine Ressource zu ändern, wenn die aktuelle Version nicht mit dem angegebenen ETag übereinstimmt. Verwenden Sie diesen Header mit POST-, PUT- oder DELETE-Methoden für Ressourcen (z. B. Indexer, Indizes und Datenquellen, aber nicht Dokumente), um die Steuerung der optimistischen Parallelität zu ermöglichen. |
| Antwortheader | Typ | BESCHREIBUNG |
|---|---|---|
| client-request-id | GUID | Ein Bezeichner, der vom Aufrufer in der ursprünglichen Anforderung angegeben wird, sofern vorhanden. |
| Content-Type | Content-Type | Der Inhaltstyp des Antworttexts. |
| Standort | URL | Die URL der neu erstellten Indexdefinition für POST- und PUT /indexes-Anforderungen. |
| OData-Version | "4.0" | Die OData-Protokollversion der Antwort. |
| request-id | GUID | Ein eindeutiger Bezeichner für den aktuellen Vorgang. Ist gleich "client-request-id", wenn dieser Header angegeben ist. Andernfalls wird der Wert auf dem Server generiert. |
| elapsed-time | Number | In Millisekunden die Zeit, die der Dienst zum Verarbeiten der Anforderung benötigt hat. Dieser Wert enthält nur die Zeit, die für die Verarbeitung der Anforderung aufgewendet wird, und enthält keine Netzwerkübertragungszeit. |
| ETag | String | Eine undurchsichtige Zeichenfolge, die die aktuelle Version einer Ressource darstellt (wird für Indexer, Indizes und Datenquellen, aber nicht für Dokumente zurückgegeben). Verwenden Sie diese Zeichenfolge im If-Match- oder If-None-Match-Header für die Steuerung der optimistischen Parallelität. |