ImageInfo interface

Package:

@azure/cognitiveservices-visualsearch

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.

Properties

cropArea	A JSON object consisting of coordinates specifying the four corners of a cropped rectangle within the input image. Use the crop area to identify the region of interest in the image. You can apply the crop area to the images specified using the imageInsightsToken or url fields, or an image binary specified in an image form data.
imageInsightsToken	An image insights token. To get the insights token, call one of the Image Search APIs (for example, /images/search). In the search results, the Image object's imageInsightsToken field contains the token. The imageInsightsToken and url fields mutually exclusive; do not specify both. Do not specify an insights token if the request includes the image form data.
url	The URL of the input image. The imageInsightsToken and url fields are mutually exclusive; do not specify both. Do not specify the URL if the request includes the image form data.

Property Details

cropArea

A JSON object consisting of coordinates specifying the four corners of a cropped rectangle within the input image. Use the crop area to identify the region of interest in the image. You can apply the crop area to the images specified using the imageInsightsToken or url fields, or an image binary specified in an image form data.

cropArea?: CropArea

Property Value

CropArea

imageInsightsToken

An image insights token. To get the insights token, call one of the Image Search APIs (for example, /images/search). In the search results, the Image object's imageInsightsToken field contains the token. The imageInsightsToken and url fields mutually exclusive; do not specify both. Do not specify an insights token if the request includes the image form data.

imageInsightsToken?: string

Property Value

string

url

The URL of the input image. The imageInsightsToken and url fields are mutually exclusive; do not specify both. Do not specify the URL if the request includes the image form data.

url?: string

Property Value

string