computervision

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 6, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package computervision implements the Azure ARM Computervision service API version 2.0.

The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AdultInfo 

type AdultInfo struct {
	// IsAdultContent - A value indicating if the image contains adult-oriented content.
	IsAdultContent *bool `json:"isAdultContent,omitempty"`
	// IsRacyContent - A value indicating if the image is racy.
	IsRacyContent *bool `json:"isRacyContent,omitempty"`
	// AdultScore - Score from 0 to 1 that indicates how much the content is considered adult-oriented within the image.
	AdultScore *float64 `json:"adultScore,omitempty"`
	// RacyScore - Score from 0 to 1 that indicates how suggestive is the image.
	RacyScore *float64 `json:"racyScore,omitempty"`
}

AdultInfo an object describing whether the image contains adult-oriented content and/or is racy.

type AreaOfInterestResult 

type AreaOfInterestResult struct {
	autorest.Response `json:"-"`
	// AreaOfInterest - READ-ONLY; A bounding box for an area of interest inside an image.
	AreaOfInterest *BoundingRect `json:"areaOfInterest,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

AreaOfInterestResult result of AreaOfInterest operation.

func (AreaOfInterestResult) MarshalJSON 

func (aoir AreaOfInterestResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AreaOfInterestResult.

type BaseClient 

type BaseClient struct {
	autorest.Client
	Endpoint string
}

BaseClient is the base client for Computervision.

func New 

func New(endpoint string) BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults 

func NewWithoutDefaults(endpoint string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

func (BaseClient) AnalyzeImage 

func (client BaseClient) AnalyzeImage(ctx context.Context, imageURL ImageURL, visualFeatures []VisualFeatureTypes, details []Details, language string) (result ImageAnalysis, err error)

AnalyzeImage this operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: imageURL - a JSON document with a URL pointing to the image that is to be analyzed. visualFeatures - a string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English. details - a string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image. language - the desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.

func (BaseClient) AnalyzeImageByDomain 

func (client BaseClient) AnalyzeImageByDomain(ctx context.Context, model string, imageURL ImageURL, language string) (result DomainModelResults, err error)

AnalyzeImageByDomain this operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: model - the domain-specific content to recognize. imageURL - a JSON document with a URL pointing to the image that is to be analyzed. language - the desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.

func (BaseClient) AnalyzeImageByDomainInStream 

func (client BaseClient) AnalyzeImageByDomainInStream(ctx context.Context, model string, imageParameter io.ReadCloser, language string) (result DomainModelResults, err error)

AnalyzeImageByDomainInStream this operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: model - the domain-specific content to recognize. imageParameter - an image stream. language - the desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.

func (BaseClient) AnalyzeImageByDomainInStreamPreparer 

func (client BaseClient) AnalyzeImageByDomainInStreamPreparer(ctx context.Context, model string, imageParameter io.ReadCloser, language string) (*http.Request, error)

AnalyzeImageByDomainInStreamPreparer prepares the AnalyzeImageByDomainInStream request.

func (BaseClient) AnalyzeImageByDomainInStreamResponder 

func (client BaseClient) AnalyzeImageByDomainInStreamResponder(resp *http.Response) (result DomainModelResults, err error)

AnalyzeImageByDomainInStreamResponder handles the response to the AnalyzeImageByDomainInStream request. The method always closes the http.Response Body.

func (BaseClient) AnalyzeImageByDomainInStreamSender 

func (client BaseClient) AnalyzeImageByDomainInStreamSender(req *http.Request) (*http.Response, error)

AnalyzeImageByDomainInStreamSender sends the AnalyzeImageByDomainInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) AnalyzeImageByDomainPreparer 

func (client BaseClient) AnalyzeImageByDomainPreparer(ctx context.Context, model string, imageURL ImageURL, language string) (*http.Request, error)

AnalyzeImageByDomainPreparer prepares the AnalyzeImageByDomain request.

func (BaseClient) AnalyzeImageByDomainResponder 

func (client BaseClient) AnalyzeImageByDomainResponder(resp *http.Response) (result DomainModelResults, err error)

AnalyzeImageByDomainResponder handles the response to the AnalyzeImageByDomain request. The method always closes the http.Response Body.

func (BaseClient) AnalyzeImageByDomainSender 

func (client BaseClient) AnalyzeImageByDomainSender(req *http.Request) (*http.Response, error)

AnalyzeImageByDomainSender sends the AnalyzeImageByDomain request. The method will close the http.Response Body if it receives an error.

func (BaseClient) AnalyzeImageInStream 

func (client BaseClient) AnalyzeImageInStream(ctx context.Context, imageParameter io.ReadCloser, visualFeatures []VisualFeatureTypes, details []Details, language string) (result ImageAnalysis, err error)

AnalyzeImageInStream this operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: imageParameter - an image stream. visualFeatures - a string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English. details - a string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image. language - the desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.

func (BaseClient) AnalyzeImageInStreamPreparer 

func (client BaseClient) AnalyzeImageInStreamPreparer(ctx context.Context, imageParameter io.ReadCloser, visualFeatures []VisualFeatureTypes, details []Details, language string) (*http.Request, error)

AnalyzeImageInStreamPreparer prepares the AnalyzeImageInStream request.

func (BaseClient) AnalyzeImageInStreamResponder 

func (client BaseClient) AnalyzeImageInStreamResponder(resp *http.Response) (result ImageAnalysis, err error)

AnalyzeImageInStreamResponder handles the response to the AnalyzeImageInStream request. The method always closes the http.Response Body.

func (BaseClient) AnalyzeImageInStreamSender 

func (client BaseClient) AnalyzeImageInStreamSender(req *http.Request) (*http.Response, error)

AnalyzeImageInStreamSender sends the AnalyzeImageInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) AnalyzeImagePreparer 

func (client BaseClient) AnalyzeImagePreparer(ctx context.Context, imageURL ImageURL, visualFeatures []VisualFeatureTypes, details []Details, language string) (*http.Request, error)

AnalyzeImagePreparer prepares the AnalyzeImage request.

func (BaseClient) AnalyzeImageResponder 

func (client BaseClient) AnalyzeImageResponder(resp *http.Response) (result ImageAnalysis, err error)

AnalyzeImageResponder handles the response to the AnalyzeImage request. The method always closes the http.Response Body.

func (BaseClient) AnalyzeImageSender 

func (client BaseClient) AnalyzeImageSender(req *http.Request) (*http.Response, error)

AnalyzeImageSender sends the AnalyzeImage request. The method will close the http.Response Body if it receives an error.

func (BaseClient) BatchReadFile 

func (client BaseClient) BatchReadFile(ctx context.Context, imageURL ImageURL) (result autorest.Response, err error)

BatchReadFile use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadOperationResult' operation to access OCR results.​ Parameters: imageURL - a JSON document with a URL pointing to the image that is to be analyzed.

func (BaseClient) BatchReadFileInStream 

func (client BaseClient) BatchReadFileInStream(ctx context.Context, imageParameter io.ReadCloser) (result autorest.Response, err error)

BatchReadFileInStream use this interface to get the result of a Read Document operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read Document interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'Get Read Result operation' to access OCR results.​ Parameters: imageParameter - an image stream.

func (BaseClient) BatchReadFileInStreamPreparer 

func (client BaseClient) BatchReadFileInStreamPreparer(ctx context.Context, imageParameter io.ReadCloser) (*http.Request, error)

BatchReadFileInStreamPreparer prepares the BatchReadFileInStream request.

func (BaseClient) BatchReadFileInStreamResponder 

func (client BaseClient) BatchReadFileInStreamResponder(resp *http.Response) (result autorest.Response, err error)

BatchReadFileInStreamResponder handles the response to the BatchReadFileInStream request. The method always closes the http.Response Body.

func (BaseClient) BatchReadFileInStreamSender 

func (client BaseClient) BatchReadFileInStreamSender(req *http.Request) (*http.Response, error)

BatchReadFileInStreamSender sends the BatchReadFileInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) BatchReadFilePreparer 

func (client BaseClient) BatchReadFilePreparer(ctx context.Context, imageURL ImageURL) (*http.Request, error)

BatchReadFilePreparer prepares the BatchReadFile request.

func (BaseClient) BatchReadFileResponder 

func (client BaseClient) BatchReadFileResponder(resp *http.Response) (result autorest.Response, err error)

BatchReadFileResponder handles the response to the BatchReadFile request. The method always closes the http.Response Body.

func (BaseClient) BatchReadFileSender 

func (client BaseClient) BatchReadFileSender(req *http.Request) (*http.Response, error)

BatchReadFileSender sends the BatchReadFile request. The method will close the http.Response Body if it receives an error.

func (BaseClient) DescribeImage 

func (client BaseClient) DescribeImage(ctx context.Context, imageURL ImageURL, maxCandidates *int32, language string) (result ImageDescription, err error)

DescribeImage this operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: imageURL - a JSON document with a URL pointing to the image that is to be analyzed. maxCandidates - maximum number of candidate descriptions to be returned. The default is 1. language - the desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.

func (BaseClient) DescribeImageInStream 

func (client BaseClient) DescribeImageInStream(ctx context.Context, imageParameter io.ReadCloser, maxCandidates *int32, language string) (result ImageDescription, err error)

DescribeImageInStream this operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: imageParameter - an image stream. maxCandidates - maximum number of candidate descriptions to be returned. The default is 1. language - the desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.

func (BaseClient) DescribeImageInStreamPreparer 

func (client BaseClient) DescribeImageInStreamPreparer(ctx context.Context, imageParameter io.ReadCloser, maxCandidates *int32, language string) (*http.Request, error)

DescribeImageInStreamPreparer prepares the DescribeImageInStream request.

func (BaseClient) DescribeImageInStreamResponder 

func (client BaseClient) DescribeImageInStreamResponder(resp *http.Response) (result ImageDescription, err error)

DescribeImageInStreamResponder handles the response to the DescribeImageInStream request. The method always closes the http.Response Body.

func (BaseClient) DescribeImageInStreamSender 

func (client BaseClient) DescribeImageInStreamSender(req *http.Request) (*http.Response, error)

DescribeImageInStreamSender sends the DescribeImageInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) DescribeImagePreparer 

func (client BaseClient) DescribeImagePreparer(ctx context.Context, imageURL ImageURL, maxCandidates *int32, language string) (*http.Request, error)

DescribeImagePreparer prepares the DescribeImage request.

func (BaseClient) DescribeImageResponder 

func (client BaseClient) DescribeImageResponder(resp *http.Response) (result ImageDescription, err error)

DescribeImageResponder handles the response to the DescribeImage request. The method always closes the http.Response Body.

func (BaseClient) DescribeImageSender 

func (client BaseClient) DescribeImageSender(req *http.Request) (*http.Response, error)

DescribeImageSender sends the DescribeImage request. The method will close the http.Response Body if it receives an error.

func (BaseClient) DetectObjects 

func (client BaseClient) DetectObjects(ctx context.Context, imageURL ImageURL) (result DetectResult, err error)

DetectObjects performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: imageURL - a JSON document with a URL pointing to the image that is to be analyzed.

func (BaseClient) DetectObjectsInStream 

func (client BaseClient) DetectObjectsInStream(ctx context.Context, imageParameter io.ReadCloser) (result DetectResult, err error)

DetectObjectsInStream performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: imageParameter - an image stream.

func (BaseClient) DetectObjectsInStreamPreparer 

func (client BaseClient) DetectObjectsInStreamPreparer(ctx context.Context, imageParameter io.ReadCloser) (*http.Request, error)

DetectObjectsInStreamPreparer prepares the DetectObjectsInStream request.

func (BaseClient) DetectObjectsInStreamResponder 

func (client BaseClient) DetectObjectsInStreamResponder(resp *http.Response) (result DetectResult, err error)

DetectObjectsInStreamResponder handles the response to the DetectObjectsInStream request. The method always closes the http.Response Body.

func (BaseClient) DetectObjectsInStreamSender 

func (client BaseClient) DetectObjectsInStreamSender(req *http.Request) (*http.Response, error)

DetectObjectsInStreamSender sends the DetectObjectsInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) DetectObjectsPreparer 

func (client BaseClient) DetectObjectsPreparer(ctx context.Context, imageURL ImageURL) (*http.Request, error)

DetectObjectsPreparer prepares the DetectObjects request.

func (BaseClient) DetectObjectsResponder 

func (client BaseClient) DetectObjectsResponder(resp *http.Response) (result DetectResult, err error)

DetectObjectsResponder handles the response to the DetectObjects request. The method always closes the http.Response Body.

func (BaseClient) DetectObjectsSender 

func (client BaseClient) DetectObjectsSender(req *http.Request) (*http.Response, error)

DetectObjectsSender sends the DetectObjects request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GenerateThumbnail 

func (client BaseClient) GenerateThumbnail(ctx context.Context, width int32, height int32, imageURL ImageURL, smartCropping *bool) (result ReadCloser, err error)

GenerateThumbnail this operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError. Parameters: width - width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50. height - height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50. imageURL - a JSON document with a URL pointing to the image that is to be analyzed. smartCropping - boolean flag for enabling smart cropping.

func (BaseClient) GenerateThumbnailInStream 

func (client BaseClient) GenerateThumbnailInStream(ctx context.Context, width int32, height int32, imageParameter io.ReadCloser, smartCropping *bool) (result ReadCloser, err error)

GenerateThumbnailInStream this operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError. Parameters: width - width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50. height - height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50. imageParameter - an image stream. smartCropping - boolean flag for enabling smart cropping.

func (BaseClient) GenerateThumbnailInStreamPreparer 

func (client BaseClient) GenerateThumbnailInStreamPreparer(ctx context.Context, width int32, height int32, imageParameter io.ReadCloser, smartCropping *bool) (*http.Request, error)

GenerateThumbnailInStreamPreparer prepares the GenerateThumbnailInStream request.

func (BaseClient) GenerateThumbnailInStreamResponder 

func (client BaseClient) GenerateThumbnailInStreamResponder(resp *http.Response) (result ReadCloser, err error)

GenerateThumbnailInStreamResponder handles the response to the GenerateThumbnailInStream request. The method always closes the http.Response Body.

func (BaseClient) GenerateThumbnailInStreamSender 

func (client BaseClient) GenerateThumbnailInStreamSender(req *http.Request) (*http.Response, error)

GenerateThumbnailInStreamSender sends the GenerateThumbnailInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GenerateThumbnailPreparer 

func (client BaseClient) GenerateThumbnailPreparer(ctx context.Context, width int32, height int32, imageURL ImageURL, smartCropping *bool) (*http.Request, error)

GenerateThumbnailPreparer prepares the GenerateThumbnail request.

func (BaseClient) GenerateThumbnailResponder 

func (client BaseClient) GenerateThumbnailResponder(resp *http.Response) (result ReadCloser, err error)

GenerateThumbnailResponder handles the response to the GenerateThumbnail request. The method always closes the http.Response Body.

func (BaseClient) GenerateThumbnailSender 

func (client BaseClient) GenerateThumbnailSender(req *http.Request) (*http.Response, error)

GenerateThumbnailSender sends the GenerateThumbnail request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GetAreaOfInterest 

func (client BaseClient) GetAreaOfInterest(ctx context.Context, imageURL ImageURL) (result AreaOfInterestResult, err error)

GetAreaOfInterest this operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError. Parameters: imageURL - a JSON document with a URL pointing to the image that is to be analyzed.

func (BaseClient) GetAreaOfInterestInStream 

func (client BaseClient) GetAreaOfInterestInStream(ctx context.Context, imageParameter io.ReadCloser) (result AreaOfInterestResult, err error)

GetAreaOfInterestInStream this operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError. Parameters: imageParameter - an image stream.

func (BaseClient) GetAreaOfInterestInStreamPreparer 

func (client BaseClient) GetAreaOfInterestInStreamPreparer(ctx context.Context, imageParameter io.ReadCloser) (*http.Request, error)

GetAreaOfInterestInStreamPreparer prepares the GetAreaOfInterestInStream request.

func (BaseClient) GetAreaOfInterestInStreamResponder 

func (client BaseClient) GetAreaOfInterestInStreamResponder(resp *http.Response) (result AreaOfInterestResult, err error)

GetAreaOfInterestInStreamResponder handles the response to the GetAreaOfInterestInStream request. The method always closes the http.Response Body.

func (BaseClient) GetAreaOfInterestInStreamSender 

func (client BaseClient) GetAreaOfInterestInStreamSender(req *http.Request) (*http.Response, error)

GetAreaOfInterestInStreamSender sends the GetAreaOfInterestInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GetAreaOfInterestPreparer 

func (client BaseClient) GetAreaOfInterestPreparer(ctx context.Context, imageURL ImageURL) (*http.Request, error)

GetAreaOfInterestPreparer prepares the GetAreaOfInterest request.

func (BaseClient) GetAreaOfInterestResponder 

func (client BaseClient) GetAreaOfInterestResponder(resp *http.Response) (result AreaOfInterestResult, err error)

GetAreaOfInterestResponder handles the response to the GetAreaOfInterest request. The method always closes the http.Response Body.

func (BaseClient) GetAreaOfInterestSender 

func (client BaseClient) GetAreaOfInterestSender(req *http.Request) (*http.Response, error)

GetAreaOfInterestSender sends the GetAreaOfInterest request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GetReadOperationResult 

func (client BaseClient) GetReadOperationResult(ctx context.Context, operationID string) (result ReadOperationResult, err error)

GetReadOperationResult this interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Batch Read File interface. Parameters: operationID - id of read operation returned in the response of the 'Batch Read File' interface.

func (BaseClient) GetReadOperationResultPreparer 

func (client BaseClient) GetReadOperationResultPreparer(ctx context.Context, operationID string) (*http.Request, error)

GetReadOperationResultPreparer prepares the GetReadOperationResult request.

func (BaseClient) GetReadOperationResultResponder 

func (client BaseClient) GetReadOperationResultResponder(resp *http.Response) (result ReadOperationResult, err error)

GetReadOperationResultResponder handles the response to the GetReadOperationResult request. The method always closes the http.Response Body.

func (BaseClient) GetReadOperationResultSender 

func (client BaseClient) GetReadOperationResultSender(req *http.Request) (*http.Response, error)

GetReadOperationResultSender sends the GetReadOperationResult request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GetTextOperationResult 

func (client BaseClient) GetTextOperationResult(ctx context.Context, operationID string) (result TextOperationResult, err error)

GetTextOperationResult this interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface. Parameters: operationID - id of the text operation returned in the response of the 'Recognize Text'

func (BaseClient) GetTextOperationResultPreparer 

func (client BaseClient) GetTextOperationResultPreparer(ctx context.Context, operationID string) (*http.Request, error)

GetTextOperationResultPreparer prepares the GetTextOperationResult request.

func (BaseClient) GetTextOperationResultResponder 

func (client BaseClient) GetTextOperationResultResponder(resp *http.Response) (result TextOperationResult, err error)

GetTextOperationResultResponder handles the response to the GetTextOperationResult request. The method always closes the http.Response Body.

func (BaseClient) GetTextOperationResultSender 

func (client BaseClient) GetTextOperationResultSender(req *http.Request) (*http.Response, error)

GetTextOperationResultSender sends the GetTextOperationResult request. The method will close the http.Response Body if it receives an error.

func (BaseClient) ListModels 

func (client BaseClient) ListModels(ctx context.Context) (result ListModelsResult, err error)

ListModels this operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

func (BaseClient) ListModelsPreparer 

func (client BaseClient) ListModelsPreparer(ctx context.Context) (*http.Request, error)

ListModelsPreparer prepares the ListModels request.

func (BaseClient) ListModelsResponder 

func (client BaseClient) ListModelsResponder(resp *http.Response) (result ListModelsResult, err error)

ListModelsResponder handles the response to the ListModels request. The method always closes the http.Response Body.

func (BaseClient) ListModelsSender 

func (client BaseClient) ListModelsSender(req *http.Request) (*http.Response, error)

ListModelsSender sends the ListModels request. The method will close the http.Response Body if it receives an error.

func (BaseClient) RecognizePrintedText 

func (client BaseClient) RecognizePrintedText(ctx context.Context, detectOrientation bool, imageURL ImageURL, language OcrLanguages) (result OcrResult, err error)

RecognizePrintedText optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError. Parameters: detectOrientation - whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down). imageURL - a JSON document with a URL pointing to the image that is to be analyzed. language - the BCP-47 language code of the text to be detected in the image. The default value is 'unk'.

func (BaseClient) RecognizePrintedTextInStream 

func (client BaseClient) RecognizePrintedTextInStream(ctx context.Context, detectOrientation bool, imageParameter io.ReadCloser, language OcrLanguages) (result OcrResult, err error)

RecognizePrintedTextInStream optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError. Parameters: detectOrientation - whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down). imageParameter - an image stream. language - the BCP-47 language code of the text to be detected in the image. The default value is 'unk'.

func (BaseClient) RecognizePrintedTextInStreamPreparer 

func (client BaseClient) RecognizePrintedTextInStreamPreparer(ctx context.Context, detectOrientation bool, imageParameter io.ReadCloser, language OcrLanguages) (*http.Request, error)

RecognizePrintedTextInStreamPreparer prepares the RecognizePrintedTextInStream request.

func (BaseClient) RecognizePrintedTextInStreamResponder 

func (client BaseClient) RecognizePrintedTextInStreamResponder(resp *http.Response) (result OcrResult, err error)

RecognizePrintedTextInStreamResponder handles the response to the RecognizePrintedTextInStream request. The method always closes the http.Response Body.

func (BaseClient) RecognizePrintedTextInStreamSender 

func (client BaseClient) RecognizePrintedTextInStreamSender(req *http.Request) (*http.Response, error)

RecognizePrintedTextInStreamSender sends the RecognizePrintedTextInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) RecognizePrintedTextPreparer 

func (client BaseClient) RecognizePrintedTextPreparer(ctx context.Context, detectOrientation bool, imageURL ImageURL, language OcrLanguages) (*http.Request, error)

RecognizePrintedTextPreparer prepares the RecognizePrintedText request.

func (BaseClient) RecognizePrintedTextResponder 

func (client BaseClient) RecognizePrintedTextResponder(resp *http.Response) (result OcrResult, err error)

RecognizePrintedTextResponder handles the response to the RecognizePrintedText request. The method always closes the http.Response Body.

func (BaseClient) RecognizePrintedTextSender 

func (client BaseClient) RecognizePrintedTextSender(req *http.Request) (*http.Response, error)

RecognizePrintedTextSender sends the RecognizePrintedText request. The method will close the http.Response Body if it receives an error.

func (BaseClient) RecognizeText 

func (client BaseClient) RecognizeText(ctx context.Context, imageURL ImageURL, mode TextRecognitionMode) (result autorest.Response, err error)

RecognizeText recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation. Parameters: imageURL - a JSON document with a URL pointing to the image that is to be analyzed. mode - type of text to recognize.

func (BaseClient) RecognizeTextInStream 

func (client BaseClient) RecognizeTextInStream(ctx context.Context, imageParameter io.ReadCloser, mode TextRecognitionMode) (result autorest.Response, err error)

RecognizeTextInStream recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation. Parameters: imageParameter - an image stream. mode - type of text to recognize.

func (BaseClient) RecognizeTextInStreamPreparer 

func (client BaseClient) RecognizeTextInStreamPreparer(ctx context.Context, imageParameter io.ReadCloser, mode TextRecognitionMode) (*http.Request, error)

RecognizeTextInStreamPreparer prepares the RecognizeTextInStream request.

func (BaseClient) RecognizeTextInStreamResponder 

func (client BaseClient) RecognizeTextInStreamResponder(resp *http.Response) (result autorest.Response, err error)

RecognizeTextInStreamResponder handles the response to the RecognizeTextInStream request. The method always closes the http.Response Body.

func (BaseClient) RecognizeTextInStreamSender 

func (client BaseClient) RecognizeTextInStreamSender(req *http.Request) (*http.Response, error)

RecognizeTextInStreamSender sends the RecognizeTextInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) RecognizeTextPreparer 

func (client BaseClient) RecognizeTextPreparer(ctx context.Context, imageURL ImageURL, mode TextRecognitionMode) (*http.Request, error)

RecognizeTextPreparer prepares the RecognizeText request.

func (BaseClient) RecognizeTextResponder 

func (client BaseClient) RecognizeTextResponder(resp *http.Response) (result autorest.Response, err error)

RecognizeTextResponder handles the response to the RecognizeText request. The method always closes the http.Response Body.

func (BaseClient) RecognizeTextSender 

func (client BaseClient) RecognizeTextSender(req *http.Request) (*http.Response, error)

RecognizeTextSender sends the RecognizeText request. The method will close the http.Response Body if it receives an error.

func (BaseClient) TagImage 

func (client BaseClient) TagImage(ctx context.Context, imageURL ImageURL, language string) (result TagResult, err error)

TagImage this operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "cello" may be accompanied by the hint "musical instrument". All tags are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: imageURL - a JSON document with a URL pointing to the image that is to be analyzed. language - the desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.

func (BaseClient) TagImageInStream 

func (client BaseClient) TagImageInStream(ctx context.Context, imageParameter io.ReadCloser, language string) (result TagResult, err error)

TagImageInStream this operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "cello" may be accompanied by the hint "musical instrument". All tags are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong. Parameters: imageParameter - an image stream. language - the desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.

func (BaseClient) TagImageInStreamPreparer 

func (client BaseClient) TagImageInStreamPreparer(ctx context.Context, imageParameter io.ReadCloser, language string) (*http.Request, error)

TagImageInStreamPreparer prepares the TagImageInStream request.

func (BaseClient) TagImageInStreamResponder 

func (client BaseClient) TagImageInStreamResponder(resp *http.Response) (result TagResult, err error)

TagImageInStreamResponder handles the response to the TagImageInStream request. The method always closes the http.Response Body.

func (BaseClient) TagImageInStreamSender 

func (client BaseClient) TagImageInStreamSender(req *http.Request) (*http.Response, error)

TagImageInStreamSender sends the TagImageInStream request. The method will close the http.Response Body if it receives an error.

func (BaseClient) TagImagePreparer 

func (client BaseClient) TagImagePreparer(ctx context.Context, imageURL ImageURL, language string) (*http.Request, error)

TagImagePreparer prepares the TagImage request.

func (BaseClient) TagImageResponder 

func (client BaseClient) TagImageResponder(resp *http.Response) (result TagResult, err error)

TagImageResponder handles the response to the TagImage request. The method always closes the http.Response Body.

func (BaseClient) TagImageSender 

func (client BaseClient) TagImageSender(req *http.Request) (*http.Response, error)

TagImageSender sends the TagImage request. The method will close the http.Response Body if it receives an error.

type BoundingRect 

type BoundingRect struct {
	// X - X-coordinate of the top left point of the area, in pixels.
	X *int32 `json:"x,omitempty"`
	// Y - Y-coordinate of the top left point of the area, in pixels.
	Y *int32 `json:"y,omitempty"`
	// W - Width measured from the top-left point of the area, in pixels.
	W *int32 `json:"w,omitempty"`
	// H - Height measured from the top-left point of the area, in pixels.
	H *int32 `json:"h,omitempty"`
}

BoundingRect a bounding box for an area inside an image.

type Category 

type Category struct {
	// Name - Name of the category.
	Name *string `json:"name,omitempty"`
	// Score - Scoring of the category.
	Score *float64 `json:"score,omitempty"`
	// Detail - Details of the identified category.
	Detail *CategoryDetail `json:"detail,omitempty"`
}

Category an object describing identified category.

type CategoryDetail 

type CategoryDetail struct {
	// Celebrities - An array of celebrities if any identified.
	Celebrities *[]CelebritiesModel `json:"celebrities,omitempty"`
	// Landmarks - An array of landmarks if any identified.
	Landmarks *[]LandmarksModel `json:"landmarks,omitempty"`
}

CategoryDetail an object describing additional category details.

type CelebritiesModel 

type CelebritiesModel struct {
	// Name - Name of the celebrity.
	Name *string `json:"name,omitempty"`
	// Confidence - Confidence level for the celebrity recognition as a value ranging from 0 to 1.
	Confidence *float64 `json:"confidence,omitempty"`
	// FaceRectangle - Location of the identified face in the image.
	FaceRectangle *FaceRectangle `json:"faceRectangle,omitempty"`
}

CelebritiesModel an object describing possible celebrity identification.

type CelebrityResults 

type CelebrityResults struct {
	// Celebrities - List of celebrities recognized in the image.
	Celebrities *[]CelebritiesModel `json:"celebrities,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

CelebrityResults result of domain-specific classifications for the domain of celebrities.

type ColorInfo 

type ColorInfo struct {
	// DominantColorForeground - Possible dominant foreground color.
	DominantColorForeground *string `json:"dominantColorForeground,omitempty"`
	// DominantColorBackground - Possible dominant background color.
	DominantColorBackground *string `json:"dominantColorBackground,omitempty"`
	// DominantColors - An array of possible dominant colors.
	DominantColors *[]string `json:"dominantColors,omitempty"`
	// AccentColor - Possible accent color.
	AccentColor *string `json:"accentColor,omitempty"`
	// IsBWImg - A value indicating if the image is black and white.
	IsBWImg *bool `json:"isBWImg,omitempty"`
}

ColorInfo an object providing additional metadata describing color attributes.

type Details 

type Details string

Details enumerates the values for details. 

const (
	// Celebrities ...
	Celebrities Details = "Celebrities"
	// Landmarks ...
	Landmarks Details = "Landmarks"
)

func PossibleDetailsValues 

func PossibleDetailsValues() []Details

PossibleDetailsValues returns an array of possible values for the Details const type.

type DetectResult 

type DetectResult struct {
	autorest.Response `json:"-"`
	// Objects - READ-ONLY; An array of detected objects.
	Objects *[]DetectedObject `json:"objects,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

DetectResult result of a DetectImage call.

func (DetectResult) MarshalJSON 

func (dr DetectResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DetectResult.

type DetectedBrand 

type DetectedBrand struct {
	// Name - READ-ONLY; Label for the brand.
	Name *string `json:"name,omitempty"`
	// Confidence - READ-ONLY; Confidence score of having observed the brand in the image, as a value ranging from 0 to 1.
	Confidence *float64 `json:"confidence,omitempty"`
	// Rectangle - READ-ONLY; Approximate location of the detected brand.
	Rectangle *BoundingRect `json:"rectangle,omitempty"`
}

DetectedBrand a brand detected in an image.

func (DetectedBrand) MarshalJSON 

func (db DetectedBrand) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DetectedBrand.

type DetectedObject 

type DetectedObject struct {
	// Rectangle - READ-ONLY; Approximate location of the detected object.
	Rectangle *BoundingRect `json:"rectangle,omitempty"`
	// Object - Label for the object.
	Object *string `json:"object,omitempty"`
	// Confidence - Confidence score of having observed the object in the image, as a value ranging from 0 to 1.
	Confidence *float64 `json:"confidence,omitempty"`
	// Parent - The parent object, from a taxonomy perspective.
	// The parent object is a more generic form of this object.  For example, a 'bulldog' would have a parent of 'dog'.
	Parent *ObjectHierarchy `json:"parent,omitempty"`
}

DetectedObject an object detected in an image.

func (DetectedObject) MarshalJSON 

func (do DetectedObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DetectedObject.

type DomainModelResults 

type DomainModelResults struct {
	autorest.Response `json:"-"`
	// Result - Model-specific response.
	Result interface{} `json:"result,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

DomainModelResults result of image analysis using a specific domain model including additional metadata.

type Error 

type Error struct {
	// Code - The error code.
	Code interface{} `json:"code,omitempty"`
	// Message - A message explaining the error reported by the service.
	Message *string `json:"message,omitempty"`
	// RequestID - A unique request identifier.
	RequestID *string `json:"requestId,omitempty"`
}

Error details about the API request error.

type FaceDescription 

type FaceDescription struct {
	// Age - Possible age of the face.
	Age *int32 `json:"age,omitempty"`
	// Gender - Possible gender of the face. Possible values include: 'Male', 'Female'
	Gender Gender `json:"gender,omitempty"`
	// FaceRectangle - Rectangle in the image containing the identified face.
	FaceRectangle *FaceRectangle `json:"faceRectangle,omitempty"`
}

FaceDescription an object describing a face identified in the image.

type FaceRectangle 

type FaceRectangle struct {
	// Left - X-coordinate of the top left point of the face, in pixels.
	Left *int32 `json:"left,omitempty"`
	// Top - Y-coordinate of the top left point of the face, in pixels.
	Top *int32 `json:"top,omitempty"`
	// Width - Width measured from the top-left point of the face, in pixels.
	Width *int32 `json:"width,omitempty"`
	// Height - Height measured from the top-left point of the face, in pixels.
	Height *int32 `json:"height,omitempty"`
}

FaceRectangle an object describing face rectangle.

type Gender 

type Gender string

Gender enumerates the values for gender. 

const (
	// Female ...
	Female Gender = "Female"
	// Male ...
	Male Gender = "Male"
)

func PossibleGenderValues 

func PossibleGenderValues() []Gender

PossibleGenderValues returns an array of possible values for the Gender const type.

type ImageAnalysis 

type ImageAnalysis struct {
	autorest.Response `json:"-"`
	// Categories - An array indicating identified categories.
	Categories *[]Category `json:"categories,omitempty"`
	// Adult - An object describing whether the image contains adult-oriented content and/or is racy.
	Adult *AdultInfo `json:"adult,omitempty"`
	// Color - An object providing additional metadata describing color attributes.
	Color *ColorInfo `json:"color,omitempty"`
	// ImageType - An object providing possible image types and matching confidence levels.
	ImageType *ImageType `json:"imageType,omitempty"`
	// Tags - A list of tags with confidence level.
	Tags *[]ImageTag `json:"tags,omitempty"`
	// Description - A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.
	Description *ImageDescriptionDetails `json:"description,omitempty"`
	// Faces - An array of possible faces within the image.
	Faces *[]FaceDescription `json:"faces,omitempty"`
	// Objects - Array of objects describing what was detected in the image.
	Objects *[]DetectedObject `json:"objects,omitempty"`
	// Brands - Array of brands detected in the image.
	Brands *[]DetectedBrand `json:"brands,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

ImageAnalysis result of AnalyzeImage operation.

type ImageCaption 

type ImageCaption struct {
	// Text - The text of the caption.
	Text *string `json:"text,omitempty"`
	// Confidence - The level of confidence the service has in the caption.
	Confidence *float64 `json:"confidence,omitempty"`
}

ImageCaption an image caption, i.e. a brief description of what the image depicts.

type ImageDescription 

type ImageDescription struct {
	autorest.Response `json:"-"`
	// ImageDescriptionDetails - A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.
	*ImageDescriptionDetails `json:"description,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

ImageDescription a collection of content tags, along with a list of captions sorted by confidence level, and image metadata.

func (ImageDescription) MarshalJSON 

func (ID ImageDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ImageDescription.

func (*ImageDescription) UnmarshalJSON 

func (ID *ImageDescription) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ImageDescription struct.

type ImageDescriptionDetails 

type ImageDescriptionDetails struct {
	// Tags - A collection of image tags.
	Tags *[]string `json:"tags,omitempty"`
	// Captions - A list of captions, sorted by confidence level.
	Captions *[]ImageCaption `json:"captions,omitempty"`
}

ImageDescriptionDetails a collection of content tags, along with a list of captions sorted by confidence level, and image metadata.

type ImageMetadata 

type ImageMetadata struct {
	// Width - Image width, in pixels.
	Width *int32 `json:"width,omitempty"`
	// Height - Image height, in pixels.
	Height *int32 `json:"height,omitempty"`
	// Format - Image format.
	Format *string `json:"format,omitempty"`
}

ImageMetadata image metadata.

type ImageTag 

type ImageTag struct {
	// Name - Name of the entity.
	Name *string `json:"name,omitempty"`
	// Confidence - The level of confidence that the entity was observed.
	Confidence *float64 `json:"confidence,omitempty"`
	// Hint - Optional hint/details for this tag.
	Hint *string `json:"hint,omitempty"`
}

ImageTag an entity observation in the image, along with the confidence score.

type ImageType 

type ImageType struct {
	// ClipArtType - Confidence level that the image is a clip art.
	ClipArtType *int32 `json:"clipArtType,omitempty"`
	// LineDrawingType - Confidence level that the image is a line drawing.
	LineDrawingType *int32 `json:"lineDrawingType,omitempty"`
}

ImageType an object providing possible image types and matching confidence levels.

type ImageURL 

type ImageURL struct {
	// URL - Publicly reachable URL of an image.
	URL *string `json:"url,omitempty"`
}

ImageURL ...

type LandmarkResults 

type LandmarkResults struct {
	// Landmarks - List of landmarks recognized in the image.
	Landmarks *[]LandmarksModel `json:"landmarks,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

LandmarkResults result of domain-specific classifications for the domain of landmarks.

type LandmarksModel 

type LandmarksModel struct {
	// Name - Name of the landmark.
	Name *string `json:"name,omitempty"`
	// Confidence - Confidence level for the landmark recognition as a value ranging from 0 to 1.
	Confidence *float64 `json:"confidence,omitempty"`
}

LandmarksModel a landmark recognized in the image.

type Line 

type Line struct {
	// BoundingBox - Bounding box of a recognized line.
	BoundingBox *[]float64 `json:"boundingBox,omitempty"`
	// Text - The text content of the line.
	Text *string `json:"text,omitempty"`
	// Words - List of words in the text line.
	Words *[]Word `json:"words,omitempty"`
}

Line an object representing a recognized text line.

type ListModelsResult 

type ListModelsResult struct {
	autorest.Response `json:"-"`
	// ModelsProperty - READ-ONLY; An array of supported models.
	ModelsProperty *[]ModelDescription `json:"models,omitempty"`
}

ListModelsResult result of the List Domain Models operation.

func (ListModelsResult) MarshalJSON 

func (lmr ListModelsResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ListModelsResult.

type ModelDescription 

type ModelDescription struct {
	// Name - The name of the model.
	Name *string `json:"name,omitempty"`
	// Categories - Categories of the model.
	Categories *[]string `json:"categories,omitempty"`
}

ModelDescription an object describing supported model by name and categories.

type ObjectHierarchy 

type ObjectHierarchy struct {
	// Object - Label for the object.
	Object *string `json:"object,omitempty"`
	// Confidence - Confidence score of having observed the object in the image, as a value ranging from 0 to 1.
	Confidence *float64 `json:"confidence,omitempty"`
	// Parent - The parent object, from a taxonomy perspective.
	// The parent object is a more generic form of this object.  For example, a 'bulldog' would have a parent of 'dog'.
	Parent *ObjectHierarchy `json:"parent,omitempty"`
}

ObjectHierarchy an object detected inside an image.

type OcrLanguages 

type OcrLanguages string

OcrLanguages enumerates the values for ocr languages. 

const (
	// Ar ...
	Ar OcrLanguages = "ar"
	// Cs ...
	Cs OcrLanguages = "cs"
	// Da ...
	Da OcrLanguages = "da"
	// De ...
	De OcrLanguages = "de"
	// El ...
	El OcrLanguages = "el"
	// En ...
	En OcrLanguages = "en"
	// Es ...
	Es OcrLanguages = "es"
	// Fi ...
	Fi OcrLanguages = "fi"
	// Fr ...
	Fr OcrLanguages = "fr"
	// Hu ...
	Hu OcrLanguages = "hu"
	// It ...
	It OcrLanguages = "it"
	// Ja ...
	Ja OcrLanguages = "ja"
	// Ko ...
	Ko OcrLanguages = "ko"
	// Nb ...
	Nb OcrLanguages = "nb"
	// Nl ...
	Nl OcrLanguages = "nl"
	// Pl ...
	Pl OcrLanguages = "pl"
	// Pt ...
	Pt OcrLanguages = "pt"
	// Ro ...
	Ro OcrLanguages = "ro"
	// Ru ...
	Ru OcrLanguages = "ru"
	// Sk ...
	Sk OcrLanguages = "sk"
	// SrCyrl ...
	SrCyrl OcrLanguages = "sr-Cyrl"
	// SrLatn ...
	SrLatn OcrLanguages = "sr-Latn"
	// Sv ...
	Sv OcrLanguages = "sv"
	// Tr ...
	Tr OcrLanguages = "tr"
	// Unk ...
	Unk OcrLanguages = "unk"
	// ZhHans ...
	ZhHans OcrLanguages = "zh-Hans"
	// ZhHant ...
	ZhHant OcrLanguages = "zh-Hant"
)

func PossibleOcrLanguagesValues 

func PossibleOcrLanguagesValues() []OcrLanguages

PossibleOcrLanguagesValues returns an array of possible values for the OcrLanguages const type.

type OcrLine 

type OcrLine struct {
	// BoundingBox - Bounding box of a recognized line. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.
	BoundingBox *string `json:"boundingBox,omitempty"`
	// Words - An array of objects, where each object represents a recognized word.
	Words *[]OcrWord `json:"words,omitempty"`
}

OcrLine an object describing a single recognized line of text.

type OcrRegion 

type OcrRegion struct {
	// BoundingBox - Bounding box of a recognized region. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.
	BoundingBox *string `json:"boundingBox,omitempty"`
	// Lines - An array of recognized lines of text.
	Lines *[]OcrLine `json:"lines,omitempty"`
}

OcrRegion a region consists of multiple lines (e.g. a column of text in a multi-column document).

type OcrResult 

type OcrResult struct {
	autorest.Response `json:"-"`
	// Language - The BCP-47 language code of the text in the image.
	Language *string `json:"language,omitempty"`
	// TextAngle - The angle, in degrees, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.
	TextAngle *float64 `json:"textAngle,omitempty"`
	// Orientation - Orientation of the text recognized in the image. The value (up, down, left, or right) refers to the direction that the top of the recognized text is facing, after the image has been rotated around its center according to the detected text angle (see textAngle property).
	Orientation *string `json:"orientation,omitempty"`
	// Regions - An array of objects, where each object represents a region of recognized text.
	Regions *[]OcrRegion `json:"regions,omitempty"`
}

OcrResult ...

type OcrWord 

type OcrWord struct {
	// BoundingBox - Bounding box of a recognized word. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.
	BoundingBox *string `json:"boundingBox,omitempty"`
	// Text - String value of a recognized word.
	Text *string `json:"text,omitempty"`
}

OcrWord information on a recognized word.

type ReadCloser 

type ReadCloser struct {
	autorest.Response `json:"-"`
	Value             *io.ReadCloser `json:"value,omitempty"`
}

ReadCloser ...

type ReadOperationResult 

type ReadOperationResult struct {
	autorest.Response `json:"-"`
	// Status - Status of the read operation. Possible values include: 'NotStarted', 'Running', 'Failed', 'Succeeded'
	Status TextOperationStatusCodes `json:"status,omitempty"`
	// RecognitionResults - An array of text recognition result of the read operation.
	RecognitionResults *[]TextRecognitionResult `json:"recognitionResults,omitempty"`
}

ReadOperationResult OCR result of the read operation.

type TagResult 

type TagResult struct {
	autorest.Response `json:"-"`
	// Tags - A list of tags with confidence level.
	Tags *[]ImageTag `json:"tags,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

TagResult the results of a image tag operation, including any tags and image metadata.

type TextOperationResult 

type TextOperationResult struct {
	autorest.Response `json:"-"`
	// Status - Status of the text operation. Possible values include: 'NotStarted', 'Running', 'Failed', 'Succeeded'
	Status TextOperationStatusCodes `json:"status,omitempty"`
	// RecognitionResult - Text recognition result of the text operation.
	RecognitionResult *TextRecognitionResult `json:"recognitionResult,omitempty"`
}

TextOperationResult result of recognition text operation.

type TextOperationStatusCodes 

type TextOperationStatusCodes string

TextOperationStatusCodes enumerates the values for text operation status codes. 

const (
	// Failed ...
	Failed TextOperationStatusCodes = "Failed"
	// NotStarted ...
	NotStarted TextOperationStatusCodes = "NotStarted"
	// Running ...
	Running TextOperationStatusCodes = "Running"
	// Succeeded ...
	Succeeded TextOperationStatusCodes = "Succeeded"
)

func PossibleTextOperationStatusCodesValues 

func PossibleTextOperationStatusCodesValues() []TextOperationStatusCodes

PossibleTextOperationStatusCodesValues returns an array of possible values for the TextOperationStatusCodes const type.

type TextRecognitionMode 

type TextRecognitionMode string

TextRecognitionMode enumerates the values for text recognition mode. 

const (
	// Handwritten ...
	Handwritten TextRecognitionMode = "Handwritten"
	// Printed ...
	Printed TextRecognitionMode = "Printed"
)

func PossibleTextRecognitionModeValues 

func PossibleTextRecognitionModeValues() []TextRecognitionMode

PossibleTextRecognitionModeValues returns an array of possible values for the TextRecognitionMode const type.

type TextRecognitionResult 

type TextRecognitionResult struct {
	// Page - The 1-based page number of the recognition result.
	Page *int32 `json:"page,omitempty"`
	// ClockwiseOrientation - The orientation of the image in degrees in the clockwise direction. Range between [0, 360).
	ClockwiseOrientation *float64 `json:"clockwiseOrientation,omitempty"`
	// Width - The width of the image in pixels or the PDF in inches.
	Width *float64 `json:"width,omitempty"`
	// Height - The height of the image in pixels or the PDF in inches.
	Height *float64 `json:"height,omitempty"`
	// Unit - The unit used in the Width, Height and BoundingBox. For images, the unit is 'pixel'. For PDF, the unit is 'inch'. Possible values include: 'Pixel', 'Inch'
	Unit TextRecognitionResultDimensionUnit `json:"unit,omitempty"`
	// Lines - A list of recognized text lines.
	Lines *[]Line `json:"lines,omitempty"`
}

TextRecognitionResult an object representing a recognized text region

type TextRecognitionResultConfidenceClass 

type TextRecognitionResultConfidenceClass string

TextRecognitionResultConfidenceClass enumerates the values for text recognition result confidence class. 

const (
	// High ...
	High TextRecognitionResultConfidenceClass = "High"
	// Low ...
	Low TextRecognitionResultConfidenceClass = "Low"
)

func PossibleTextRecognitionResultConfidenceClassValues 

func PossibleTextRecognitionResultConfidenceClassValues() []TextRecognitionResultConfidenceClass

PossibleTextRecognitionResultConfidenceClassValues returns an array of possible values for the TextRecognitionResultConfidenceClass const type.

type TextRecognitionResultDimensionUnit 

type TextRecognitionResultDimensionUnit string

TextRecognitionResultDimensionUnit enumerates the values for text recognition result dimension unit. 

const (
	// Inch ...
	Inch TextRecognitionResultDimensionUnit = "inch"
	// Pixel ...
	Pixel TextRecognitionResultDimensionUnit = "pixel"
)

func PossibleTextRecognitionResultDimensionUnitValues 

func PossibleTextRecognitionResultDimensionUnitValues() []TextRecognitionResultDimensionUnit

PossibleTextRecognitionResultDimensionUnitValues returns an array of possible values for the TextRecognitionResultDimensionUnit const type.

type VisualFeatureTypes 

type VisualFeatureTypes string

VisualFeatureTypes enumerates the values for visual feature types. 

const (
	// VisualFeatureTypesAdult ...
	VisualFeatureTypesAdult VisualFeatureTypes = "Adult"
	// VisualFeatureTypesBrands ...
	VisualFeatureTypesBrands VisualFeatureTypes = "Brands"
	// VisualFeatureTypesCategories ...
	VisualFeatureTypesCategories VisualFeatureTypes = "Categories"
	// VisualFeatureTypesColor ...
	VisualFeatureTypesColor VisualFeatureTypes = "Color"
	// VisualFeatureTypesDescription ...
	VisualFeatureTypesDescription VisualFeatureTypes = "Description"
	// VisualFeatureTypesFaces ...
	VisualFeatureTypesFaces VisualFeatureTypes = "Faces"
	// VisualFeatureTypesImageType ...
	VisualFeatureTypesImageType VisualFeatureTypes = "ImageType"
	// VisualFeatureTypesObjects ...
	VisualFeatureTypesObjects VisualFeatureTypes = "Objects"
	// VisualFeatureTypesTags ...
	VisualFeatureTypesTags VisualFeatureTypes = "Tags"
)

func PossibleVisualFeatureTypesValues 

func PossibleVisualFeatureTypesValues() []VisualFeatureTypes

PossibleVisualFeatureTypesValues returns an array of possible values for the VisualFeatureTypes const type.

type Word 

type Word struct {
	// BoundingBox - Bounding box of a recognized word.
	BoundingBox *[]float64 `json:"boundingBox,omitempty"`
	// Text - The text content of the word.
	Text *string `json:"text,omitempty"`
	// Confidence - Qualitative confidence measure. Possible values include: 'High', 'Low'
	Confidence TextRecognitionResultConfidenceClass `json:"confidence,omitempty"`
}

Word an object representing a recognized word.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.