@azure/cognitiveservices-visualsearch package
Classes
| Images |
Class representing a Images. |
| VisualSearchClient | |
| VisualSearchClientContext | |
Interfaces
| Action |
Defines an action. |
| AggregateOffer |
Defines a list of offers from merchants that are related to the image. |
| AggregateRating |
Defines the metrics that indicate how well an item was rated by others. |
| CreativeWork |
The most generic kind of creative work, including books, movies, photographs, software programs, etc. |
| CropArea |
A JSON object consisting of coordinates specifying the four corners of a cropped rectangle within the input image. |
| ErrorModel |
Defines the error that occurred. |
| ErrorResponse |
The top-level response that represents a failed request. |
| Filters |
A key-value object consisting of filters that may be specified to limit the results returned by the API. Current available filters: site. |
| Identifiable |
Defines the identity of a resource. |
| ImageAction |
Defines an image action. |
| ImageEntityAction |
Defines an entity action. |
| ImageInfo |
A JSON object that identities the image to get insights of . It also includes the optional crop area that you use to identify the region of interest in the image. |
| ImageKnowledge |
Defines a visual search API response. |
| ImageModuleAction |
Defines an image list action. |
| ImageObject |
Defines an image. |
| ImageRecipesAction |
Defines an recipe action. |
| ImageRelatedSearchesAction |
Defines an related search action. |
| ImageShoppingSourcesAction |
Defines a shopping sources action. |
| ImagesImageMetadata |
Defines a count of the number of websites where you can shop or perform other actions related to the image. |
| ImagesModule |
Defines a list of images. |
| ImagesVisualSearchOptionalParams |
Optional Parameters. |
| ImageTag |
A visual search tag. |
| ImageTagRegion |
Defines an image region relevant to the ImageTag. |
| Intangible |
A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc. |
| KnowledgeRequest |
A JSON object containing information about the request, such as filters for the resulting actions. |
| MediaObject |
Defines a media object. |
| NormalizedQuadrilateral |
Defines a region of an image. The region is a convex quadrilateral defined by coordinates of its top left, top right, bottom left, and bottom right points. The coordinates are fractional values of the original image's width and height in the range 0.0 through 1.0. |
| Offer |
Defines a merchant's offer. |
| Organization |
Defines an organization. |
| Person |
Defines a person. |
| Point2D |
Defines a 2D point with X and Y coordinates. |
| PropertiesItem |
Defines an item. |
| Query |
Defines a search query. |
| Rating |
Defines a rating. |
| Recipe |
Defines a cooking recipe. |
| RecipesModule |
Defines a list of recipes. |
| RelatedSearchesModule |
Defines a list of related searches. |
| Response |
Defines a response. All schemas that return at the root of the response must inherit from this object. |
| ResponseBase |
Response base. |
| StructuredValue |
An interface representing StructuredValue. |
| Thing |
Defines a thing. |
| VisualSearchClientOptions |
An interface representing VisualSearchClientOptions. |
| VisualSearchRequest |
A JSON object that contains information about the image to get insights of. Specify this object only in a knowledgeRequest form data. |
Type Aliases
| ActionUnion |
Contains the possible cases for Action. |
| CreativeWorkUnion |
Contains the possible cases for CreativeWork. |
| Currency |
Defines values for Currency. Possible values include: 'USD', 'CAD', 'GBP', 'EUR', 'COP', 'JPY', 'CNY', 'AUD', 'INR', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'FJD', 'FKP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SRD', 'SSP', 'STD', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMW' |
| ErrorCode |
Defines values for ErrorCode. Possible values include: 'None', 'ServerError', 'InvalidRequest', 'RateLimitExceeded', 'InvalidAuthorization', 'InsufficientAuthorization' |
| ErrorSubCode |
Defines values for ErrorSubCode. Possible values include: 'UnexpectedError', 'ResourceError', 'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue', 'HttpNotAllowed', 'Blocked', 'AuthorizationMissing', 'AuthorizationRedundancy', 'AuthorizationDisabled', 'AuthorizationExpired' |
| IdentifiableUnion |
Contains the possible cases for Identifiable. |
| ImageActionUnion |
Contains the possible cases for ImageAction. |
| ImagesVisualSearchResponse |
Contains response data for the visualSearch operation. |
| IntangibleUnion |
Contains the possible cases for Intangible. |
| ItemAvailability |
Defines values for ItemAvailability. Possible values include: 'Discontinued', 'InStock', 'InStoreOnly', 'LimitedAvailability', 'OnlineOnly', 'OutOfStock', 'PreOrder', 'SoldOut' |
| MediaObjectUnion |
Contains the possible cases for MediaObject. |
| OfferUnion |
Contains the possible cases for Offer. |
| PropertiesItemUnion |
Contains the possible cases for PropertiesItem. |
| RatingUnion |
Contains the possible cases for Rating. |
| ResponseBaseUnion |
Contains the possible cases for ResponseBase. |
| ResponseUnion |
Contains the possible cases for Response. |
| SafeSearch |
Defines values for SafeSearch. Possible values include: 'Off', 'Moderate', 'Strict' |
| StructuredValueUnion |
Contains the possible cases for StructuredValue. |
| ThingUnion |
Contains the possible cases for Thing. |