AddImage - Image Search - Centre de documentation Alibaba Cloud

Décrit la syntaxe et fournit des exemples de l'opération AddImage, qui ajoute des informations d'image à une instance Image Search.

Description de l'opération

Description

Cette opération ajoute des informations d'image à une instance Image Search.

Limite de QPS

Une instance d'une capacité maximale de 100 000 images a une concurrence par défaut de 1, ce qui signifie qu'un maximum d'une requête d'ajout d'image peut être traitée par seconde. Les instances avec d'autres capacités d'images ont une concurrence par défaut de 5, ce qui signifie qu'un maximum de 5 requêtes d'ajout d'image peuvent être traitées par seconde.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

imagesearch:AddImage

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceName	string	Oui	Le nom de l'instance Image Search. Le nom peut comporter jusqu'à 20 caractères. Si vous avez acheté une instance Image Search, connectez-vous à la console Image Search pour consulter le nom de l'instance. Si vous n'avez pas acheté d'instance Image Search, reportez-vous à Activer le service et Créer une instance. Remarque Le nom de l'instance n'est pas l'identifiant de l'instance. Ne confondez pas les deux.	demoinstance1
ProductId	string	Oui	L'identifiant du produit. L'identifiant peut comporter jusqu'à 256 caractères. Remarque Un produit peut avoir plusieurs images.	2092061_1
PicName	string	Oui	Le nom de l'image. Le nom peut comporter jusqu'à 256 caractères. Remarque ProductId et PicName identifient de manière unique une image. Si vous ajoutez plusieurs images avec le même ProductId et le même PicName, seule la dernière image ajoutée est conservée. Les images ajoutées précédemment sont écrasées.	2092061_1.jpg
PicContent	string	Oui	Le contenu de l'image. La taille de l'image ne peut pas dépasser 4 Mo. Formats d'image : PNG, JPG, JPEG, BMP, GIF, WEBP, TIFF et PPM. Le temps d'attente de transmission ne peut pas dépasser 5 secondes. Pour la recherche d'images de produits et la recherche d'images génériques, la largeur et la hauteur de l'image doivent être d'au moins 100 pixels et d'au plus 4 096 pixels. L'image ne doit pas contenir d'informations de rotation. Remarque Lors d'un appel à l'aide d'un SDK : Si vous utilisez un SDK V3, vous n'avez pas besoin de définir le champ PicContent. Le SDK encapsule ce champ en tant que PicContentObject et le convertit automatiquement en encodage Base64. Pour des exemples spécifiques, reportez-vous au SDK Java. Le SDK ne prend pas en charge la transmission directe d'URL d'images. Le SDK V3 fournit une méthode alternative pour télécharger des images par URL. Pour des exemples spécifiques, reportez-vous au SDK Java. Lors d'un appel à l'aide de la plateforme OpenAPI d'Alibaba Cloud : Si vous utilisez la version 2019-03-25, définissez le champ PicContent sur l'encodage Base64 de l'image. Si vous utilisez la version 2020-12-14, cliquez pour télécharger l'image directement dans le champ PicContent.	AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
CategoryId	integer	Non	La catégorie de l'image. Pour plus d'informations, reportez-vous à la Référence des catégories. Remarque Pour la recherche d'images de produits, si vous spécifiez une catégorie, la catégorie spécifiée est utilisée. Si vous ne spécifiez pas de catégorie, le système prédit la catégorie. Le résultat de la catégorie prédite peut être obtenu à partir de la réponse. Pour la recherche d'images génériques, le système définit la catégorie sur 88888888, que vous spécifiez ou non une catégorie.	88888888
Crop	boolean	Non	Indique si l'identification du sujet doit être effectuée. Valeur par défaut : true. true : le système effectue l'identification du sujet et recherche en fonction du sujet identifié. Le résultat de l'identification du sujet peut être obtenu à partir de la réponse. false : le système n'effectue pas d'identification du sujet et recherche en fonction de l'image entière. .	true
Region	string	Non	La région du sujet de l'image, au format `x1,x2,y1,y2`, où `x1,y1` est le point supérieur gauche et `x2,y2` est le point inférieur droit. Remarque Si vous spécifiez Region, le système recherche en fonction de la région spécifiée, quelle que soit la valeur du paramètre Crop. Le paramètre Region n'a pas d'unité. Les valeurs sont basées sur les dimensions en pixels de l'image. Si l'image est mise à l'échelle, les valeurs du paramètre Region doivent être mises à l'échelle proportionnellement.	280,486,232,351
CustomContent	string	Non	Le contenu personnalisé défini par l'utilisateur. Le contenu peut comporter jusqu'à 4 096 caractères. Remarque Ce champ est renvoyé dans les résultats de requête. Par exemple, vous pouvez ajouter une description textuelle de l'image.	zidingyi
IntAttr	integer	Non	L'attribut entier. Cet attribut peut être utilisé pour filtrer les résultats de requête et est renvoyé dans les résultats de requête.	22
StrAttr	string	Non	L'attribut chaîne. L'attribut peut comporter jusqu'à 128 caractères. Cet attribut peut être utilisé pour filtrer les résultats de requête et est renvoyé dans les résultats de requête. Remarque Les caractères spéciaux tels que \¥$&% ne sont pas pris en charge.	ss
IntAttr2	integer	Non	L'attribut entier. Cet attribut peut être utilisé pour filtrer les résultats de requête et est renvoyé dans les résultats de requête.	22
StrAttr2	string	Non	L'attribut chaîne. L'attribut peut comporter jusqu'à 128 caractères. Cet attribut peut être utilisé pour filtrer les résultats de requête et est renvoyé dans les résultats de requête. Remarque Les caractères spéciaux tels que \¥$&% ne sont pas pris en charge.	ss
IntAttr3	integer	Non	L'attribut entier. Cet attribut peut être utilisé pour filtrer les résultats de requête et est renvoyé dans les résultats de requête.	33
StrAttr3	string	Non	L'attribut chaîne. L'attribut peut comporter jusqu'à 128 caractères. Cet attribut peut être utilisé pour filtrer les résultats de requête et est renvoyé dans les résultats de requête. Remarque Les caractères spéciaux tels que \¥$&% ne sont pas pris en charge.	ss
IntAttr4	integer	Non	L'attribut entier. Cet attribut peut être utilisé pour filtrer les résultats de requête et est renvoyé dans les résultats de requête.	44
StrAttr4	string	Non	L'attribut chaîne. L'attribut peut comporter jusqu'à 128 caractères. Cet attribut peut être utilisé pour filtrer les résultats de requête et est renvoyé dans les résultats de requête. Remarque Les caractères spéciaux tels que \¥$&% ne sont pas pris en charge.	ss

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Message	string	Le message d'erreur. Remarque Aucune donnée n'est renvoyée pour les requêtes réussies. Des messages d'erreur sont renvoyés pour les requêtes ayant échoué.	success
RequestId	string	L'identifiant de la requête.	E0845DE6-52AF-4B50-9F15-51ED4044E6AB
Code	integer	Le code d'erreur. 0 : succès. Différent de zéro : échec.	0
PicInfo	object	Les résultats de la prédiction de catégorie et de l'identification du sujet.
Region	string	Le résultat de l'identification du sujet. La région du sujet de l'image, au format `x1,x2,y1,y2`, où `x1,y1` est le point supérieur gauche et `x2,y2` est le point inférieur droit. Si l'utilisateur spécifie une région de sujet dans la requête, la région spécifiée est utilisée.	94,691,206,650
CategoryId	integer	Le résultat de la prédiction de catégorie. Si l'utilisateur spécifie une catégorie dans la requête, la catégorie spécifiée est utilisée.	88888888
MultiRegion	array<object>	La collection des résultats d'identification du sujet. Remarque Mettez à niveau vers la version 3.1.1 ou ultérieure pour utiliser cette fonctionnalité.
	object	Le résultat de l'identification du sujet.
Region	string	The subject identification result. The subject region of the image, in the format of x1,x2,y1,y2, where x1,y1 is the upper-left point and x2,y2 is the lower-right point. If the user specifies a subject region in the request, the specified region is used.	94,691,206,650
AllCategories	array<object>	Les informations sur toutes les catégories prises en charge par le système.
	object	Les informations sur toutes les catégories prises en charge par le système.
Name	string	The category name.	Other
Id	integer	The category ID.	88888888
Success	boolean	Indique si la requête a réussi.	true

Exemples

JSON format

{
  "Message": "success",
  "RequestId": "E0845DE6-52AF-4B50-9F15-51ED4044E6AB",
  "Code": 0,
  "PicInfo": {
    "Region": "94,691,206,650",
    "CategoryId": 88888888,
    "MultiRegion": [
      {
        "Region": "94,691,206,650"
      }
    ],
    "AllCategories": [
      {
        "Name": "Other",
        "Id": 88888888
      }
    ]
  },
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	BadRequest	The request has invalid parameters.
400	InstanceStatusError	Your instance is unavailable.
400	InvalidInstance	The specified instance name is invalid.
400	NoCaretSeperator	The body content is missing the ^ separator.
400	EmptyMeta	The body content has an empty meta field.
400	InvalidMetaItem	The meta field is invalid.
400	NoPicList	The body content is missing the pic_list parameter.
400	NoSpecifiedPic	The content of an image is not specified in the HTTP POST body.
400	NoSpecifiedSearchPic	The search image is not specified.
400	InvalidCategory	The specified category is invalid.
400	OverflowMaxResultNum	The specified number of total results exceeds the maximum of 500.
400	OverflowMaxReturnNum	The specified number of results for each request exceeds the maximum of 100.
400	InvalidStartParameter	The specified parameter s is inavlid.
400	InvalidNumParameter	The specified parameter n is invalid.
400	NoSpecifiedAddPic	The image to insert is not specified.
400	NoSpecifiedItemId	The item_id parameter is not specified.
400	InvalidIntAttr	The specified int_attr field is invalid.
400	UnsupportedPicFormat	The specified image format is invalid.
400	InvalidFilterClause	The specified filtering condition is invalid.
400	InstanceOverQuota	The number of items exceeds the limit.
400	IncorrectOrientation	The image contains incorrect rotation flags in the meta data.
400	UnsupportedPicPixels	The specified pixels is not supported.
400	SearchTimeout	The request is timed out.
400	PicNotExist	The search picture does not exist.
400	NoSpecifiedProductId	The parameter ProductId no specified.
400	NoSpecifiedPicName	The parameter PicName no specified.
400	NoSpecifiedPicContent	The parameter PicContent no specified.
400	InvalidType	The specified parameter Type is not valid.
400	InvalidProductId	The specified parameter ProductId is not valid.
400	InvalidPicName	The specified parameter PicName is not valid.
400	InvalidStrAttr	The specified parameter StrAttr is not valid.	Invalid StrAttr
400	InvalidCustomContent	The specified parameter CustomContent is not valid.
400	InvalidPicContent	The specified parameter PicContent length greater than 4 * 1024 * 1024.
400	TimeoutForTransferImage	Timeout after 5 seconds waiting for images transfer to complete.
400	InvalidPicUrl	The search picture does not exist at the specific url.
400	InvalidInstanceName	The parameter instanceName is not specified.
400	InvalidRequestId	The parameter requestId is not specified.
400	InvalidRequestIdTooLarge	The parameter requestId is too large.
400	InvalidRegion	The specific region is illegal.
400	RegionError	region.
400	InvalidStrAttr2	The specified parameter StrAttr2 is not valid.	Invalid
400	InvalidStrAttr3	The specified parameter StrAttr3 is not valid.	Invalid StrAttr3
400	InvalidStrAttr4	The specified parameter StrAttr4 is not valid.	Invalid StrAttr4
400	InvalidIntAttr2	The specified parameter IntAttr2 is not valid.	Invalid IntAttr2
400	InvalidIntAttr3	The specified parameter IntAttr3 is not valid.	Invalid IntAttr3
400	InvalidIntAttr4	The specified parameter IntAttr4 is not valid.	Invalid
400	PictureError	[download] Img Download Failed.	Picture download failed, please check the picture
400	UnsupportedOperationType	The specified action is not supported.
500	UnknownException	An internal server error occurred.
500	NetworkException	A network error occurred.
500	RequestTimeout	The request is timeout.
500	ExtractFeatureTimeout	The request was timed out while extracting features.
500	AccessEngineFailed	An error occurred while accessing the search engine.
500	InternalOssError	An internal OAS error occurred.
500	InternalSwiftError	An internal SWIFT error occurred.
500	InternalTableStoreError	An internal Table Store error occurred.
500	ConnectionDVException	Failed to obtain collection.	internalError
403	NoPermission	You are not authorized to perform this operation.
403	DeniedRequest	Your request was denied due to instance flow control.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.