RecognizedEntityRegion interface

Package:

@azure/cognitiveservices-imagesearch

Defines a region of the image where an entity was found and a list of entities that might match it.

Properties

id	A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
matchingEntities	A list of entities that Bing believes match the entity found in the region. The entities are in descending order of confidence (see the matchConfidence field of RecognizedEntity). NOTE: This property will not be serialized. It can only be populated by the server.
readLink	The URL that returns this resource. NOTE: This property will not be serialized. It can only be populated by the server.
region	A region of the image that contains an entity. The values of the rectangle are relative to the width and height of the original image and are in the range 0.0 through 1.0. For example, if the image is 300x200 and the region's top, left corner is at point (10, 20) and the bottom, right corner is at point (290, 150), then the normalized rectangle is: Left = 0.0333333333333333, Top = 0.1, Right = 0.9666666666666667, Bottom = 0.75. For people, the region represents the person's face. NOTE: This property will not be serialized. It can only be populated by the server.
webSearchUrl	The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

matchingEntities

A list of entities that Bing believes match the entity found in the region. The entities are in descending order of confidence (see the matchConfidence field of RecognizedEntity). NOTE: This property will not be serialized. It can only be populated by the server.

matchingEntities?: RecognizedEntity[]

Property Value

RecognizedEntity[]

readLink

The URL that returns this resource. NOTE: This property will not be serialized. It can only be populated by the server.

readLink?: string

Property Value

string

region

A region of the image that contains an entity. The values of the rectangle are relative to the width and height of the original image and are in the range 0.0 through 1.0. For example, if the image is 300x200 and the region's top, left corner is at point (10, 20) and the bottom, right corner is at point (290, 150), then the normalized rectangle is: Left = 0.0333333333333333, Top = 0.1, Right = 0.9666666666666667, Bottom = 0.75. For people, the region represents the person's face. NOTE: This property will not be serialized. It can only be populated by the server.

region?: NormalizedRectangle

Property Value

NormalizedRectangle

webSearchUrl

The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: string

Property Value

string