Informations de référence sur l’API REST automatique (bêta)

Note

Auto est disponible en version bêta pour les partenaires externes dont le profil d’application est activé pour Auto. La surface et le contrat de l’API peuvent changer.

Point de terminaison :POST https://api.microsoft.ai/v3/auto

Toutes les requêtes nécessitent une clé API ou un jeton d’accès Microsoft Entra ID. Consultez l’authentification pour obtenir des instructions de configuration.

Exemple de requête

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

Paramètre Required Type Default Description
query Yes string - Requête de recherche, de 1 à 1 000 caractères. Prend en charge site: et -site: opérateurs.
language Non string en Langage d’interface ISO 639-1 à deux lettres.
region Non string US Marché à deux lettres ou code pays/région.
mode Non string fast fast hiérarchise la vitesse ; advanced hiérarchise l’exhaustivité.
maxResponseLength Non integer 30000 Longueur maximale de la réponse totale. Les valeurs inférieures à 1500 sont limitées à 1500 ; les valeurs supérieures à 500000 sont limitées à 5 00000.
location Non string - Contexte géographique au lat:<latitude>;long:<longitude> format, par exemple lat:47.6062;long:-122.3321.
responseFilter Non tableau de chaînes de caractères - Types de réponses éligibles : web, , weathernewstimezone, images, videos.

Response

Une réponse de preuve réussie retourne 200 OK. Chaque résultat contient un objet de preuve typé et les citations qui le prennent en charge. Les preuves non prises en charge ou mal formées sont omises avec ses citations. Si chaque résultat de preuve fourni est omis, results est vide.

AutoEvidenceResponse

Champ Type Description
results tableau d’AutoEvidenceResult Éléments de preuve associés à des citations délimitées à ce résultat.
traceId string ID de corrélation pour le débogage et la prise en charge.

AutoEvidenceResult

Champ Type Description
evidence AutoEvidence Preuve typée générée.
citations tableau d’AutoEvidenceCitation Citations soutenant uniquement ce résultat de preuve.

AutoEvidence

Le propre type discriminateur de l’objet de preuve sélectionne le schéma de content.

type content
text Preuve de chaîne retournée pour les résultats Web et Actualités.
media/image Objet résultat de l’image.
media/video Objet de résultat vidéo.
structured/weather Objet Weather.
structured/timeZone Objet de fuseau horaire.

La preuve de texte d’actualités peut également inclure une thumbnail avec url, widthet height. Le contenu structuré suit les mêmes règles de visibilité de champ public que sa réponse de recherche correspondante.

AutoEvidenceCitation

Champ Type Description
contentSource string Source de citation.
title string Titre de la citation.
url string URL de citation.
lastUpdatedAt string Horodatage mis à jour pour la dernière fois.
crawledAt string Horodatage d’analyse.
language string Langue du contenu.
isAdult boolean Indique si la citation contient du contenu pour adultes.

Exemple de réponse

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

Codes d’erreur

Code de statut Description
200 La requête a réussi, y compris une recherche valide sans résultats.
400 Paramètres non valides ou JSON mal formés.
401 Informations d’identification d’authentification manquantes ou non valides.
403 Le profil authentifié n’est pas activé pour Auto.
429 Limite de taux ou de quota dépassée.
500 Échec du service interne.
503 Un service requis n’est pas disponible.
504 La demande a expiré.

Pour connaître le schéma d’erreur partagé et les instructions de nouvelle tentative, consultez Gestion des erreurs.

Contenu connexe

  • Dernière mise à jour :