Automatische REST-API-Referenz (Beta)

Note

Auto ist in der Betaversion für externe Partner verfügbar, deren Anwendungsprofil für "Auto" aktiviert ist. Die API-Oberfläche und der Vertrag können sich ändern.

Endpunkt:POST https://api.microsoft.ai/v3/auto

Für alle Anforderungen ist ein API-Schlüssel oder Microsoft Entra ID Zugriffstoken erforderlich. Anweisungen zum Einrichten finden Sie unter "Authentifizierung ".

Musteranforderung

curl -X POST "https://api.microsoft.ai/v3/auto" \
  -H "x-apikey: <Your API key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "Microsoft AI announcements",
    "language": "en",
    "region": "US",
    "location": "lat:47.6062;long:-122.3321",
    "mode": "fast",
    "maxResponseLength": 30000,
    "responseFilter": ["web", "news"]
  }'

Parameters

Parameter Required Typ Vorgabe Description
query Yes string - Suchabfrage, von 1 bis 1.000 Zeichen. Unterstützt site: und -site: Operatoren.
language No string en Zwei-Buchstaben ISO 639-1-Schnittstellensprache.
region No string US Zwei-Buchstaben-Markt- oder Länder-/Regionscode.
mode No string fast fast priorisiert Geschwindigkeit; advanced priorisiert Vollständigkeit.
maxResponseLength No integer 30000 Maximale Gesamtantwortlänge. Werte unter 1500 werden auf 1500 geklemmt; Werte über 500000 werden auf 500000 klammert.
location No string - Geografischer Kontext im lat:<latitude>;long:<longitude> Format, z. B lat:47.6062;long:-122.3321. .
responseFilter No Feld von Zeichenfolgen - Berechtigte Antworttypen: web, , news, weathertimezone, images, . videos

Antwort

Eine erfolgreiche Antwort auf Nachweise gibt zurück 200 OK. Jedes Ergebnis enthält ein typiertes Beweisobjekt und die Zitate, die es unterstützen. Nicht unterstützte oder falsch formatierte Nachweise werden zusammen mit ihren Zitaten weggelassen. Wenn jedes angegebene Nachweisergebnis ausgelassen wird, results ist leer.

AutoEvidenceResponse

Feld Typ Description
results Array von AutoEvidenceResult Nachweiselemente, die mit Zitaten gekoppelt sind, die auf dieses Ergebnis zugeschnitten sind.
traceId string Korrelations-ID für Debugging und Unterstützung.

AutoEvidenceResult

Feld Typ Description
evidence AutoEvidence Generierte typierte Nachweise.
citations Array von AutoEvidenceCitation Zitate, die nur dieses Beweisergebnis unterstützen.

AutoEvidence

Der eigene type Diskriminator des Beweisobjekts wählt das Schema von content.

type content
text Für Web- und Newsergebnisse zurückgegebene Zeichenfolgennachweise.
media/image Bildergebnisobjekt.
media/video Videoergebnisobjekt.
structured/weather Wetterobjekt.
structured/timeZone Zeitzonenobjekt.

Nachrichtentext-Nachweise können auch ein thumbnail mit url, width, und height. Strukturierte Inhalte folgen den gleichen Regeln für die Sichtbarkeit öffentlicher Felder wie die entsprechende Suchantwort.

AutoEvidenceCitation

Feld Typ Description
contentSource string Zitatquelle.
title string Zitattitel.
url string Zitat-URL.
lastUpdatedAt string Zeitstempel der letzten Aktualisierung.
crawledAt string Durchforstungszeitstempel.
language string Inhaltssprache.
isAdult boolean Gibt an, ob das Zitat erwachsene Inhalte enthält.

Beispielantwort

{
  "results": [
    {
      "evidence": {
        "type": "text",
        "content": "Microsoft announced a new set of AI capabilities."
      },
      "citations": [
        {
          "contentSource": "web",
          "url": "https://www.microsoft.com/en-us/ai",
          "title": "Microsoft AI",
          "language": "en",
          "isAdult": false
        }
      ]
    }
  ],
  "traceId": "00000000000000000000000000000000"
}

Fehlercodes

Statuscode Description
200 Die Anforderung war erfolgreich, einschließlich einer gültigen Suche ohne Ergebnisse.
400 Ungültige Parameter oder falsch formatierte JSON.
401 Fehlende oder ungültige Authentifizierungsanmeldeinformationen.
403 Das authentifizierte Profil ist für "Auto" nicht aktiviert.
429 Rate- oder Kontingentgrenze überschritten.
500 Interner Dienstfehler.
503 Ein erforderlicher Dienst ist nicht verfügbar.
504 Zeitüberschreitung der Anforderung.

Informationen zum freigegebenen Fehlerschema und zum Erneuten Wiederholen finden Sie unter "Fehlerbehandlung".

Verwandte Inhalte

  • Zuletzt aktualisiert um