Referensi REST API Otomatis (Beta)

Note

Otomatis tersedia dalam versi beta untuk mitra eksternal yang profil aplikasinya diaktifkan untuk Otomatis. Permukaan api dan kontrak mungkin berubah.

Titik Akhir:POST https://api.microsoft.ai/v3/auto

Semua permintaan memerlukan kunci API atau token akses Microsoft Entra ID. Lihat Autentikasi untuk instruksi penyiapan.

Contoh permintaan

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 Type Default Description
query Yes string - Kueri pencarian, dari 1 hingga 1.000 karakter. site: Dukungan dan -site: operator.
language No string en Bahasa antarmuka ISO 639-1 dua huruf.
region No string US Pasar dua huruf atau kode negara/wilayah.
mode No string fast fast memprioritaskan kecepatan; advanced memprioritaskan komprehensif.
maxResponseLength No integer 30000 Panjang respons total maksimum. Nilai di bawah 1500 dijepit menjadi 1500; nilai di atas 500000 dijepit ke 500000.
location No string - Konteks geografis dalam lat:<latitude>;long:<longitude> format, misalnya lat:47.6062;long:-122.3321.
responseFilter No kumpulan string - Jenis jawaban yang memenuhi syarat: web, , news, weathertimezone, images, videos.

Jawaban

Respons bukti yang 200 OKberhasil mengembalikan . Setiap hasil berisi satu objek bukti yang diketik dan kutipan yang mendukungnya. Bukti yang tidak didukung atau salah bentuk dihilangkan bersama dengan kutipannya. Jika setiap hasil bukti yang disediakan dihilangkan, results kosong.

AutoEvidenceResponse

Field Type Description
results array AutoEvidenceResult Barang bukti dipasangkan dengan kutipan yang dilingkup ke hasil tersebut.
traceId string ID korelasi untuk penelusuran kesalahan dan dukungan.

AutoEvidenceResult

Field Type Description
evidence AutoEvidence Bukti jenis yang dihasilkan.
citations array AutoEvidenceCitation Kutipan hanya mendukung hasil bukti ini.

AutoEvidence

Diskriminator objek bukti sendiri type memilih skema content.

type content
text Bukti string yang dikembalikan untuk hasil Web dan Berita.
media/image Objek hasil gambar.
media/video Objek hasil video.
structured/weather Objek cuaca.
structured/timeZone Objek zona waktu.

Bukti teks berita juga dapat menyertakan thumbnail dengan url, width, dan height. Konten terstruktur mengikuti aturan visibilitas bidang publik yang sama dengan jawaban pencarian yang sesuai.

AutoEvidenceCitation

Field Type Description
contentSource string Sumber kutipan.
title string Judul kutipan.
url string URL Kutipan.
lastUpdatedAt string Tanda waktu terakhir diperbarui.
crawledAt string Tanda waktu rayapan.
language string Bahasa konten.
isAdult Boolean Apakah kutipan berisi konten dewasa.

Contoh tanggapan

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

Kode kesalahan

Kode status Description
200 Permintaan berhasil, termasuk pencarian yang valid tanpa hasil.
400 Parameter tidak valid atau JSON cacat.
401 Kredensial autentikasi hilang atau tidak valid.
403 Profil terautentikasi tidak diaktifkan untuk Otomatis.
429 Batas tarif atau kuota terlampaui.
500 Kegagalan layanan internal.
503 Layanan yang diperlukan tidak tersedia.
504 Waktu permintaan habis.

Untuk skema kesalahan bersama dan panduan coba lagi, lihat Penanganan kesalahan.

Konten terkait

  • Terakhir diperbarui pada