@azure/cognitiveservices-imagesearch package
Classes
| ImageSearchClient | |
| ImageSearchClientContext | |
| ImagesOperations |
Class representing a ImagesOperations. |
Interfaces
| 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. |
| Answer |
Defines an answer. |
| CollectionPage |
Defines a link to a webpage that contains a collection. |
| CreativeWork |
The most generic kind of creative work, including books, movies, photographs, software programs, etc. |
| ErrorModel |
Defines the error that occurred. |
| ErrorResponse |
The top-level response that represents a failed request. |
| Identifiable |
Defines the identity of a resource. |
| ImageGallery |
Defines a link to a webpage that contains a collection of related images. |
| ImageInsights |
The top-level object that the response includes when an image insights request succeeds. For information about requesting image insights, see the insightsToken query parameter. The modules query parameter affects the fields that Bing includes in the response. If you set modules to only Caption, then this object includes only the imageCaption field. |
| ImageInsightsImageCaption |
Defines an image's caption. |
| ImageObject |
Defines an image |
| Images |
Defines an image answer |
| ImagesDetailsOptionalParams |
Optional Parameters. |
| ImageSearchClientOptions |
An interface representing ImageSearchClientOptions. |
| 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. |
| ImagesSearchOptionalParams |
Optional Parameters. |
| ImagesTrendingOptionalParams |
Optional Parameters. |
| ImageTagsModule |
Defines the characteristics of content found in an image. |
| InsightsTag |
Defines a characteristic of the content found in the image. |
| Intangible |
A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc. |
| MediaObject |
Defines a media object. |
| NormalizedRectangle |
Defines a region of an image. The region is defined by the coordinates of the top, left corner and bottom, right corner of the region. 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. |
| PivotSuggestions |
Defines the pivot segment. |
| PropertiesItem |
Defines an item. |
| Query |
Defines a search query. |
| Rating |
Defines a rating. |
| Recipe |
Defines a cooking recipe. |
| RecipesModule |
Defines a list of recipes. |
| RecognizedEntitiesModule |
Defines a list of previously recognized entities. |
| RecognizedEntity |
Defines a recognized entity. |
| RecognizedEntityGroup |
Defines a group of previously recognized entities. |
| RecognizedEntityRegion |
Defines a region of the image where an entity was found and a list of entities that might match it. |
| RelatedCollectionsModule |
Defines a list of webpages that contain related images. |
| RelatedSearchesModule |
Defines a list of related searches. |
| Response |
Defines a response. All schemas that could be returned at the root of a response should inherit from this |
| ResponseBase |
Response base |
| SearchResultsAnswer |
Defines a search result answer. |
| StructuredValue |
An interface representing StructuredValue. |
| Thing |
Defines a thing. |
| TrendingImages |
The top-level object that the response includes when a trending images request succeeds. |
| TrendingImagesCategory |
Defines the category of trending images. |
| TrendingImagesTile |
Defines an image tile. |
| WebPage |
Defines a webpage that is relevant to the query. |
Type Aliases
| AnswerUnion |
Contains the possible cases for Answer. |
| CollectionPageUnion |
Contains the possible cases for CollectionPage. |
| 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' |
| Freshness |
Defines values for Freshness. Possible values include: 'Day', 'Week', 'Month' |
| IdentifiableUnion |
Contains the possible cases for Identifiable. |
| ImageAspect |
Defines values for ImageAspect. Possible values include: 'All', 'Square', 'Wide', 'Tall' |
| ImageColor |
Defines values for ImageColor. Possible values include: 'ColorOnly', 'Monochrome', 'Black', 'Blue', 'Brown', 'Gray', 'Green', 'Orange', 'Pink', 'Purple', 'Red', 'Teal', 'White', 'Yellow' |
| ImageContent |
Defines values for ImageContent. Possible values include: 'Face', 'Portrait' |
| ImageCropType |
Defines values for ImageCropType. Possible values include: 'Rectangular' |
| ImageInsightModule |
Defines values for ImageInsightModule. Possible values include: 'All', 'BRQ', 'Caption', 'Collections', 'Recipes', 'PagesIncluding', 'RecognizedEntities', 'RelatedSearches', 'ShoppingSources', 'SimilarImages', 'SimilarProducts', 'Tags' |
| ImageLicense |
Defines values for ImageLicense. Possible values include: 'All', 'Any', 'Public', 'Share', 'ShareCommercially', 'Modify', 'ModifyCommercially' |
| ImagesDetailsResponse |
Contains response data for the details operation. |
| ImageSize |
Defines values for ImageSize. Possible values include: 'All', 'Small', 'Medium', 'Large', 'Wallpaper' |
| ImagesSearchResponse |
Contains response data for the search operation. |
| ImagesTrendingResponse |
Contains response data for the trending operation. |
| ImageType |
Defines values for ImageType. Possible values include: 'AnimatedGif', 'Clipart', 'Line', 'Photo', 'Shopping', 'Transparent' |
| 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' |
| SearchResultsAnswerUnion |
Contains the possible cases for SearchResultsAnswer. |
| StructuredValueUnion |
Contains the possible cases for StructuredValue. |
| ThingUnion |
Contains the possible cases for Thing. |
| WebPageUnion |
Contains the possible cases for WebPage. |