Otomatik REST API başvurusu (Beta)

Note

Otomatik, uygulama profili Otomatik için etkinleştirilen dış iş ortakları için beta sürümünde kullanılabilir. API yüzeyi ve sözleşmesi değişebilir.

Bitiş noktası:POST https://api.microsoft.ai/v3/auto

Tüm istekler için bir API anahtarı veya Microsoft Entra ID erişim belirteci gerekir. Kurulum yönergeleri için bkz. Kimlik doğrulaması .

Numune isteği

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

Parametre Required Tür Default Description
query Yes string - 1 ile 1.000 karakter arası arama sorgusu. -site: Ve işleçlerini desteklersite:.
language No string en İki harfli ISO 639-1 arabirim dili.
region No string US İki harfli pazar veya ülke/bölge kodu.
mode No string fast fast hızı önceliklendirir; advanced kapsamlılığa öncelik sağlar.
maxResponseLength No integer 30000 Maksimum toplam yanıt uzunluğu. 1500'in altındaki değerler 1500'e sıkıştırılır; 500000'in üzerindeki değerler 500000'e sıkıştırılır.
location No string - Biçimindeki lat:<latitude>;long:<longitude> coğrafi bağlam, örneğin lat:47.6062;long:-122.3321.
responseFilter No stringler dizisi - Uygun yanıt türleri: web, news, timezone, weather, images, videos.

Response

Başarılı bir kanıt yanıtı döndürür 200 OK. Her sonuç, bir türlenmiş kanıt nesnesi ve onu destekleyen alıntılar içerir. Desteklenmeyen veya yanlış biçimlendirilmiş kanıtlar, alıntılarıyla birlikte atlanır. Sağlanan her kanıt sonucu atlanırsa boş results olur.

AutoEvidenceResponse

Field Tür Description
results AutoEvidenceResult dizisi Bu sonucun kapsamı alıntılarla eşleştirilmiş kanıt öğeleri.
traceId string Hata ayıklama ve destek için bağıntı kimliği.

AutoEvidenceResult

Field Tür Description
evidence AutoEvidence Yazılan kanıt oluşturuldu.
citations AutoEvidenceCitation dizisi Yalnızca bu kanıt sonucunu destekleyen alıntılar.

AutoEvidence

Kanıt nesnesinin kendi type ayırıcısı şemasını contentseçer.

type content
text Web ve Haber sonuçları için dize kanıtı döndürüldü.
media/image Görüntü sonuç nesnesi.
media/video Video sonuç nesnesi.
structured/weather Hava durumu nesnesi.
structured/timeZone Saat dilimi nesnesi.

Haber metni kanıtı, , widthve heightile urlde thumbnail içerebilir. Yapılandırılmış içerik, ilgili arama yanıtıyla aynı genel alan görünürlüğü kurallarını izler.

AutoEvidenceCitation

Field Tür Description
contentSource string Alıntı kaynağı.
title string Alıntı başlığı.
url string Alıntı URL'si.
lastUpdatedAt string Son güncelleştirme zaman damgası.
crawledAt string Gezinme zaman damgası.
language string İçerik dili.
isAdult boolean Alıntının yetişkinlere açık içerik içerip içermediği.

Örnek yanıt

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

Hata kodları

Durum kodu Description
200 sonuç içermeyen geçerli bir arama da dahil olmak üzere istek başarılı oldu.
400 Geçersiz parametreler veya hatalı biçimlendirilmiş JSON.
401 Kimlik doğrulaması kimlik bilgileri eksik veya geçersiz.
403 Kimliği doğrulanmış profil Otomatik için etkinleştirilmedi.
429 Hız veya kota sınırı aşıldı.
500 İç hizmet hatası.
503 Gerekli bir hizmet kullanılamıyor.
504 İstek zaman aşımına uğradı.

Paylaşılan hata şeması ve yeniden deneme kılavuzu için bkz. Hata işleme.

İlgili içerik

  • Son güncelleştirme: