Dokumentacja automatycznego interfejsu API REST (beta)

Note

Auto jest dostępne w wersji beta dla partnerów zewnętrznych, których profil aplikacji jest włączony dla automatycznego. Powierzchnia i kontrakt interfejsu API mogą ulec zmianie.

Punkt końcowy:POST https://api.microsoft.ai/v3/auto

Wszystkie żądania wymagają klucza interfejsu API lub tokenu dostępu Microsoft Entra ID. Aby uzyskać instrukcje dotyczące konfiguracji, zobacz Uwierzytelnianie .

Przykładowe żądanie

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 Default Description
query Yes ciąg - Zapytanie wyszukiwania z zakresu od 1 do 1000 znaków. Obsługuje site: operatory i -site: .
language No ciąg en Dwuliterowy język interfejsu ISO 639-1.
region No ciąg US Dwuliterowy kod rynku lub kraju/regionu.
mode No ciąg fast fast określa priorytet prędkości; advanced priorytetowo określa kompleksowość.
maxResponseLength No liczba całkowita 30000 Maksymalna łączna długość odpowiedzi. Wartości poniżej 1500 są zaciskane do 1500; wartości powyżej 500000 są zaciskane do 500000.
location No ciąg - Kontekst geograficzny w lat:<latitude>;long:<longitude> formacie, na przykład lat:47.6062;long:-122.3321.
responseFilter No tablica ciągów - Kwalifikujące się typy odpowiedzi: web, , newstimezone, weather, images, videos.

Odpowiedź

Pomyślna odpowiedź dowodowa zwraca wartość 200 OK. Każdy wynik zawiera jeden wpisany obiekt dowodów i cytaty, które go obsługują. Nieobsługiwane lub źle sformułowane dowody są pomijane wraz z jego cytatami. Jeśli każdy dostarczony wynik dowodu zostanie pominięty, results jest pusty.

AutoEvidenceResponse

Pole Typ Description
results tablica autoevidenceResult Elementy dowodów sparowane z cytatami w zakresie tego wyniku.
traceId ciąg Identyfikator korelacji na potrzeby debugowania i obsługi.

AutoEvidenceResult

Pole Typ Description
evidence Autoudzielnie Wygenerowane wpisane dowody.
citations tablica AutoEvidenceCitation Cytaty wspierające tylko ten wynik dowodowy.

Autoudzielnie

Obiekt dowodowy dyskryminuje type schemat content.

type content
text Dowody ciągu zwrócone dla wyników Web i News.
media/image Obiekt wyniku obrazu.
media/video Obiekt wyniku wideo.
structured/weather Obiekt pogodowy.
structured/timeZone Obiekt strefy czasowej.

Dowody tekstowe wiadomości mogą również zawierać element thumbnail z elementami url, widthi height. Zawartość ustrukturyzowana jest zgodna z tymi samymi regułami widoczności pól publicznych co odpowiednia odpowiedź wyszukiwania.

AutoEvidenceCitation

Pole Typ Description
contentSource ciąg Źródło cytatu.
title ciąg Tytuł cytatu.
url ciąg Adres URL cytatu.
lastUpdatedAt ciąg Znacznik czasu ostatniej aktualizacji.
crawledAt ciąg Znacznik czasu przeszukiwania.
language ciąg Język zawartości.
isAdult boolean Czy cytat zawiera treści dla dorosłych.

Przykładowa odpowiedź

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

Kody błędów

Kod stanu Description
200 Żądanie zakończyło się pomyślnie, w tym prawidłowe wyszukiwanie bez wyników.
400 Nieprawidłowe parametry lub nieprawidłowo sformułowany kod JSON.
401 Brak lub nieprawidłowe poświadczenia uwierzytelniania.
403 Profil uwierzytelniony nie jest włączony dla funkcji Auto.
429 Przekroczono limit szybkości lub przydziału.
500 Wewnętrzny błąd usługi.
503 Wymagana usługa jest niedostępna.
504 Żądanie przekroczyło limit czasu.

Aby zapoznać się ze schematem błędów udostępnionych i wskazówkami dotyczącymi ponawiania prób, zobacz Obsługa błędów.

Treści powiązane

  • Ostatnia aktualizacja o