Informations de référence sur l’API REST Recherche d’images

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

Exemple de demande :

curl -X POST "https://api.microsoft.ai/v3/search/images" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H 'content-type: application/json' \
  -d '{
    "query": "cats",
    "maxResults": 2,
    "language": "en",
    "region": "US"
  }'

Parameters

Paramètre Required Type Default Description
query Yes string - Chaîne de requête de recherche. La longueur maximale est de 1 000 caractères.
maxResults Non integer 30 Nombre maximal de résultats à retourner. La valeur par défaut est 30 et la valeur maximale est 30.
language Non string « en » Code de langue ISO 639-1 de 2 lettres pour la langue de l’interface dans les résultats de recherche. Consultez les langues prises en charge pour obtenir la liste complète.
region Non string "US" Code pays/région de 2 lettres pour lequel les résultats doivent provenir (par exemple, « US », « JP », « CN »). Consultez les régions prises en charge pour obtenir la liste complète.
aspectRatio Non string(enum) - Filtrez les images par rapport d’aspect. Valeurs : « carré » (à peu près 1:1), « large » (hauteur de largeur > ), « hauteur » ( > largeur). Lorsqu’il n’est pas défini, aucun filtrage n’est appliqué.
color Non string(enum) - Filtrez les images par couleur d’image. Valeurs : « colorOnly » (uniquement retourner des images de couleur), « monochrome » (uniquement retourner des images noires et blanches). Lorsqu’il n’est pas défini, aucun filtrage n’est appliqué.
safeSearch Non string(enum) « strict » Niveau de filtrage de recherche sécurisé. Valeurs : « off », « strict ». La valeur par défaut est « strict ».
imageSize Non string(enum) - Filtrez les images par catégorie de taille. Valeurs : « small » (<200x200px), « medium » (largeur ou hauteur 200-500px), « large » (largeur ou hauteur >=500px), « extraLarge » (>1024x768px). Peut également utiliser des contraintes de pixels (maxHeight, minHeight, maxWidth, minWidth) pour les limites personnalisées ; Les contraintes de pixels sont prioritaires sur imageSize lorsqu’elles sont en conflit. Lorsqu’il n’est pas défini, aucun filtrage n’est appliqué.
watermarkFree Non boolean faux Exclure des images avec filigrane. La valeur par défaut est false.
maxHeight Non integer - Hauteur maximale de l’image en pixels. Utilisé avec imageSize pour les limites personnalisées.
minHeight Non integer - Hauteur minimale de l’image en pixels.
maxWidth Non integer - Largeur maximale de l’image en pixels.
minWidth Non integer - Largeur minimale de l’image en pixels.

En-têtes de requête

Champ Type Description
host string Hôte pour Microsoft API IA : api.microsoft.ai.
x-apikey ou autorisation string Votre clé API ou votre jeton d’accès Entra ID pour l’authentification.
type de contenu string Type MIME du corps de la requête. Utilisez application/json.

Response

ImagesResponse

Champ Type Description
imageResults tableau d’ImageResult Liste des résultats de l’image.
instrumentationClickBase string URL de base pour cliquer sur les requêtes ping. Ajoutez une instrumentationSuffix valeur à partir d’un élément de résultat pour former l’URL ping complète. Présente uniquement pour les applications avec l’indicateur de profil EnableInstrumentationPing. Remarque : les clics utilisateur peuvent également être enregistrés à l’aide de la redirection d’URL. Lorsque la redirection est activée, aucune action n’est nécessaire pour journaliser les clics utilisateur et instrumentationClickBase ne sera pas incluse dans la réponse. Consultez le guide d’instrumentation pour obtenir des instructions de configuration.
instrumentationCitationBase string URL de base pour les requêtes ping du journal LLM. Ajoutez une charge utile DATA pour former l’URL ping complète. Présente uniquement pour les applications avec l’indicateur de profil EnableInstrumentationPing.
traceId string ID de trace pour le débogage et le suivi.

ImageResult

Champ Type Description
title string Titre de l’image.
url string URL source de l’image. Pour les utilisateurs chinois avec la redirection d’URL activée, ce champ contient plutôt la même URL de redirection que clickUrl.
domain string Hôte de destination pour le résultat. Retourné uniquement pour les utilisateurs chinois avec redirection d’URL activée.
hostPageUrl string URL de la page web qui héberge l’image.
caption string Description générée de l’image.
width integer Largeur de l’image, en pixels.
height integer Hauteur de l’image, en pixels.
thumbnailUrl string URL de la source miniature de l’image.
lastUpdatedAt string La dernière date mise à jour de l’image suit ISO8601 format.
isAdult boolean Indique si le contenu est un contenu pour adultes.
clickUrl string URL de redirection qui proxie le clic via Bing. Présente uniquement lorsque la redirection en un clic est activée.
instrumentationSuffix string Suffixe à ajouter à la base d’URL ping d’instrumentation pour cet élément de résultat. Utilisé comme valeur K pour l’URL ping d’instrumentation et la clickUrl redirection. Présent lorsque le test ping d’instrumentation est activé.

Codes d’erreur

Code de statut Catégorie d’erreur Description Causes courantes
200 Success La demande a abouti. -
400 Demande incorrecte Paramètres de requête non valides. Champs obligatoires manquants, valeurs de paramètre non valides, JSON mal formé
401 Unauthorized Échec ou absence de l’authentification. Clé API non valide, en-tête x-apikey manquant
403 Interdit Informations d’identification valides, mais autorisations insuffisantes. La clé API ne dispose pas des autorisations requises
410 Non disponible (Gone) HTTPS requis. Requête effectuée sur HTTP au lieu de HTTPS
415 Type de média non pris en charge Type de contenu non pris en charge. En-tête de type de contenu manquant ou incorrect
429 Trop de demandes Limite de débit dépassée. Trop de requêtes dans la fenêtre de temps
500 Erreur interne du serveur Erreur de serveur inattendue. Problème de serveur temporaire
503 Service indisponible Service temporairement indisponible. Pannes de maintenance ou temporaires
504 Délai d’expiration de la passerelle La requête a expiré. Délai d’expiration du service en amont

Pour obtenir des instructions détaillées sur la gestion des erreurs, consultez Gestion des erreurs.

Voir aussi :Recherche devidéos recherchede vidéos Recherche | dans recherched’actualités | | RECHERCHE | MCP

  • Dernière mise à jour :