Edit

class ImageAnalysis::ImageAnalysisResultDetails

Represents additional information related to an image analysis result.

This includes the raw JSON response from the service, and other details related to the service connection and image source.

Members

GetResultId

Syntax: public inline std::string GetResultId ( ) const;

Gets a unique identifier from the Vision Service, associated with this result.

Returns

The result ID string.

GetResultId

Syntax: public template< > inline AI::Core::_detail::enable_if_w_or_string_t< T > GetResultId ( ) const;

Gets a unique identifier from the Vision Service, associated with this result.

Returns

The unique ID string.

GetJsonResult

Syntax: public inline std::string GetJsonResult ( );

Gets the JSON response payload from the Vision Service that was deserialized to create the provided ImageAnalysisResult.

Returns

A JSON string.

GetImageId

Syntax: public inline std::string GetImageId ( ) const;

Gets the identifier of the analyzed image. This could be the full-path image file name, the image URL, or an empty string, depending on how the VisionSource was created. It will be an empty string if the image was passed in as a byte array.

Returns

The image ID string.

GetConnectionUrl

Syntax: public inline std::string GetConnectionUrl ( ) const;

Gets the full URL used to connect to the Image Analysis service to get these results. It includes the query URL parameters.

Returns

The connection URL.

FromResult

Syntax: public inline static std::shared_ptr< ImageAnalysisResultDetails > FromResult ( const std::shared_ptr< ImageAnalysisResult > & result );

Return an instance of the ImageAnalysisResultDetails from a given ImageAnalysisResult object. This is the only way to construct the ImageAnalysisResultDetails object.

Parameters

  • result The image analysis result

Returns

An instance of ImageAnalysisResultDetails containing the result details