SearchImageByName - Image Search - Centre de documentation Alibaba Cloud

Cette rubrique décrit la syntaxe et fournit des exemples pour l'opération SearchByName, qui permet d'interroger les informations d'image dans une instance Image Search par nom.

Description de l'opération

Description de l'opération.

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:SearchImageByName

get

*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.	demoinstance1
ProductId	string	Oui	L'identifiant du produit.	2092061_1
PicName	string	Oui	Le nom de l'image.	2092061_1.jpg
CategoryId	integer	Non	La catégorie de produit. Pour plus d'informations, consultez Référence des catégories.	88888888
Num	integer	Non	Le nombre de résultats à renvoyer. Valeurs valides : 1 à 100. Valeur par défaut : 10.	10
Start	integer	Non	La position de départ des résultats à renvoyer. Valeurs valides : 0 à 499. Valeur par défaut : 0.	0
Filter	string	Non	La condition de filtrage. Le champ int_attr prend en charge les opérateurs suivants : in, not in, supérieur à (>), supérieur ou égal à (>=), inférieur à (<), inférieur ou égal à (<=) et égal à (=). Le champ str_attr prend en charge les opérateurs suivants : in, not in, égal à (=) et différent de (!=). Plusieurs conditions peuvent être reliées à l'aide de AND et OR.	int_attr>=100
DistinctProductId	boolean	Non	Indique si les résultats doivent être dédupliqués en fonction de ProductId.	false
ScoreThreshold	string	Non	Le seuil de score de similarité. Si vous spécifiez ce paramètre, seules les images dont le score de similarité est supérieur ou égal au seuil sont renvoyées. Valeurs valides : 0,00 à 1,00. Jusqu'à deux décimales sont prises en charge. Valeur par défaut : 0,00.	0.50

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
Msg	string	Le message d'erreur.	success
Head	object	La vue d'ensemble des résultats de recherche.
DocsFound	integer	Le nombre de résultats renvoyés.	10
DocsReturn	integer	Le nombre de résultats correspondants dans l'instance.	10000
SearchTime	integer	La durée de la recherche, en millisecondes.	95
RequestId	string	L'identifiant de la requête.	36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1
Auctions	array<object>	Les descriptions de tous les produits renvoyés.
	object	Les paramètres de l'image.
ProductId	string	L'identifiant du produit.	2092061_1
PicName	string	Le nom de l'image.	2092061_1.jpg
CategoryId	integer	La catégorie de l'image.	20
SortExprValues	string	Les informations de notation du système.	5.37633353624177e+24;0
CustomContent	string	Le contenu personnalisé défini par l'utilisateur.	zidingyi
Score	number	Le score de similarité de l'image. Valeurs valides : 0 à 1.	1
IntAttr	integer	L'attribut entier.	2
IntAttr2	integer	L'attribut entier.	20
StrAttr	string	L'attribut de chaîne.	ss
StrAttr2	string	L'attribut de chaîne.	test
StrAttr3	string	L'attribut de chaîne. La longueur maximale est de 128 caractères. Ce champ peut être utilisé pour le filtrage lors des requêtes et est renvoyé dans les résultats de requête.	test
StrAttr4	string	L'attribut de chaîne. La longueur maximale est de 128 caractères. Ce champ peut être utilisé pour le filtrage lors des requêtes et est renvoyé dans les résultats de requête.	test
IntAttr3	integer	L'attribut entier. Ce champ peut être utilisé pour le filtrage lors des requêtes et est renvoyé dans les résultats de requête.	1
IntAttr4	integer	L'attribut entier. Ce champ peut être utilisé pour le filtrage lors des requêtes et est renvoyé dans les résultats de requête.	1
Code	integer	Le code d'erreur. Valeurs valides :	0
PicInfo	object	Les informations telles que la prédiction de catégorie et les résultats d'identification du sujet.
Region	string	Le résultat de l'identification du sujet.	280,486,232,351
CategoryId	integer	Le résultat de la prédiction de catégorie.	20
MultiRegion	array<object>	La collection d'identification de sujets.
	object	La collection de sujets.
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.	280,486,232,351
AllCategories	array<object>	Les informations sur toutes les catégories prises en charge par le système.
	object	Les informations de catégorie.
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

{
  "Msg": "success",
  "Head": {
    "DocsFound": 10,
    "DocsReturn": 10000,
    "SearchTime": 95
  },
  "RequestId": "36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1",
  "Auctions": [
    {
      "ProductId": "2092061_1",
      "PicName": "2092061_1.jpg",
      "CategoryId": 20,
      "SortExprValues": "5.37633353624177e+24;0",
      "CustomContent": "zidingyi",
      "Score": 1,
      "IntAttr": 2,
      "IntAttr2": 20,
      "StrAttr": "ss",
      "StrAttr2": "test",
      "StrAttr3": "test",
      "StrAttr4": "test",
      "IntAttr3": 1,
      "IntAttr4": 1
    }
  ],
  "Code": 0,
  "PicInfo": {
    "Region": "280,486,232,351",
    "CategoryId": 20,
    "MultiRegion": [
      {
        "Region": "280,486,232,351"
      }
    ],
    "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	TimeoutForTransferImage	Timeout after 5 seconds waiting for images transfer to complete.
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	InvalidPicList	The specified pic_list parameter is invalid.
400	NoSpecifiedPic	he 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 start is inavlid.
400	InvalidNumParameter	The specified parameter num 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 2 * 1024 * 1024.
400	InvalidStrAttr4	The specified parameter StrAttr4 is not valid.	Invalid StrAttr4
400	InvalidStrAttr3	The specified parameter StrAttr3 is not valid.	Invalid StrAttr3
400	InvalidStrAttr2	The specified parameter StrAttr2 is not valid.	Invalid
400	InvalidIntAttr4	The specified parameter IntAttr4 is not valid.	Invalid
400	InvalidIntAttr3	The specified parameter IntAttr3 is not valid.	Invalid IntAttr3
400	InvalidIntAttr2	The specified parameter IntAttr2 is not valid.	Invalid IntAttr2
400	UnsupportedOperationType	The specified action is not supported.
400	UnsupportedInstanceType	The instance type is not supported.
500	InternalError	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.
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.