computervision

package
v21.0.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package computervision implements the Azure ARM Computervision service API version 1.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 race.
	IsRacyContent *bool `json:"isRacyContent,omitempty"`
	// AdultScore - Score from 0 to 1 that indicates how much of adult content is 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 AzureRegions

type AzureRegions string

AzureRegions enumerates the values for azure regions.

const (
	// Australiaeast ...
	Australiaeast AzureRegions = "australiaeast"
	// Brazilsouth ...
	Brazilsouth AzureRegions = "brazilsouth"
	// Eastasia ...
	Eastasia AzureRegions = "eastasia"
	// Eastus ...
	Eastus AzureRegions = "eastus"
	// Eastus2 ...
	Eastus2 AzureRegions = "eastus2"
	// Northeurope ...
	Northeurope AzureRegions = "northeurope"
	// Southcentralus ...
	Southcentralus AzureRegions = "southcentralus"
	// Southeastasia ...
	Southeastasia AzureRegions = "southeastasia"
	// Westcentralus ...
	Westcentralus AzureRegions = "westcentralus"
	// Westeurope ...
	Westeurope AzureRegions = "westeurope"
	// Westus ...
	Westus AzureRegions = "westus"
	// Westus2 ...
	Westus2 AzureRegions = "westus2"
)

func PossibleAzureRegionsValues

func PossibleAzureRegionsValues() []AzureRegions

PossibleAzureRegionsValues returns an array of possible values for the AzureRegions const type.

type BaseClient

type BaseClient struct {
	autorest.Client
	AzureRegion AzureRegions
}

BaseClient is the base client for Computervision.

func New

func New(azureRegion AzureRegions) BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults

func NewWithoutDefaults(azureRegion AzureRegions) 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. 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. 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. 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 only provides a single domain-specific model: celebrities. 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 only provides a single domain-specific model: celebrities. 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 string, language string) (result ImageAnalysis, err error)

AnalyzeImageInStream this operation extracts a rich set of visual features based on the image content. 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. 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. 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 string, 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) DescribeImage

func (client BaseClient) DescribeImage(ctx context.Context, imageURL ImageURL, maxCandidates string, 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 string, 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 string, 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 string, 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) 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. Parameters: width - width of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50. height - height of the thumbnail. 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. Parameters: width - width of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50. height - height of the thumbnail. 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) 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 Handwritten 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 only supports one domain-specific model: a celebrity 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 printed 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 printed 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, detectHandwriting *bool) (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 Handwritten Text Operation Result operation. Parameters: imageURL - a JSON document with a URL pointing to the image that is to be analyzed. detectHandwriting - if 'true' is specified, handwriting recognition is performed. If this parameter is set to 'false' or is not specified, printed text recognition is performed.

func (BaseClient) RecognizeTextInStream

func (client BaseClient) RecognizeTextInStream(ctx context.Context, imageParameter io.ReadCloser, detectHandwriting *bool) (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 Handwritten Text Operation Result operation. Parameters: imageParameter - an image stream. detectHandwriting - if 'true' is specified, handwriting recognition is performed. If this parameter is set to 'false' or is not specified, printed text recognition is performed.

func (BaseClient) RecognizeTextInStreamPreparer

func (client BaseClient) RecognizeTextInStreamPreparer(ctx context.Context, imageParameter io.ReadCloser, detectHandwriting *bool) (*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, detectHandwriting *bool) (*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. 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. 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 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 *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"`
}

CategoryDetail an object describing additional category details.

type CelebritiesModel

type CelebritiesModel struct {
	// Name - Name of the celebrity.
	Name *string `json:"name,omitempty"`
	// Confidence - Level of confidence ranging from 0 to 1.
	Confidence    *float64       `json:"confidence,omitempty"`
	FaceRectangle *FaceRectangle `json:"faceRectangle,omitempty"`
}

CelebritiesModel an object describing possible celebrity identification.

type CelebrityResults

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

CelebrityResults list of celebrities recognized in the image.

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 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. Possible values include: 'InvalidImageURL', 'InvalidImageFormat', 'InvalidImageSize', 'NotSupportedVisualFeature', 'NotSupportedImage', 'InvalidDetails', 'NotSupportedLanguage', 'BadArgument', 'FailedToProcess', 'Timeout', 'InternalServerError', 'Unspecified', 'StorageException'
	Code ErrorCodes `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 ...

type ErrorCodes

type ErrorCodes string

ErrorCodes enumerates the values for error codes.

const (
	// BadArgument ...
	BadArgument ErrorCodes = "BadArgument"
	// FailedToProcess ...
	FailedToProcess ErrorCodes = "FailedToProcess"
	// InternalServerError ...
	InternalServerError ErrorCodes = "InternalServerError"
	// InvalidDetails ...
	InvalidDetails ErrorCodes = "InvalidDetails"
	// InvalidImageFormat ...
	InvalidImageFormat ErrorCodes = "InvalidImageFormat"
	// InvalidImageSize ...
	InvalidImageSize ErrorCodes = "InvalidImageSize"
	// InvalidImageURL ...
	InvalidImageURL ErrorCodes = "InvalidImageUrl"
	// NotSupportedImage ...
	NotSupportedImage ErrorCodes = "NotSupportedImage"
	// NotSupportedLanguage ...
	NotSupportedLanguage ErrorCodes = "NotSupportedLanguage"
	// NotSupportedVisualFeature ...
	NotSupportedVisualFeature ErrorCodes = "NotSupportedVisualFeature"
	// StorageException ...
	StorageException ErrorCodes = "StorageException"
	// Timeout ...
	Timeout ErrorCodes = "Timeout"
	// Unspecified ...
	Unspecified ErrorCodes = "Unspecified"
)

func PossibleErrorCodesValues

func PossibleErrorCodesValues() []ErrorCodes

PossibleErrorCodesValues returns an array of possible values for the ErrorCodes const type.

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 *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.
	Left *int32 `json:"left,omitempty"`
	// Top - Y-coordinate of the top left point of the face.
	Top *int32 `json:"top,omitempty"`
	// Width - Width measured from the top-left point of the face.
	Width *int32 `json:"width,omitempty"`
	// Height - Height measured from the top-left point of the face.
	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      *AdultInfo  `json:"adult,omitempty"`
	Color      *ColorInfo  `json:"color,omitempty"`
	ImageType  *ImageType  `json:"imageType,omitempty"`
	// Tags - A list of tags with confidence level.
	Tags        *[]ImageTag              `json:"tags,omitempty"`
	Description *ImageDescriptionDetails `json:"description,omitempty"`
	// Faces - An array of possible faces within the image.
	Faces *[]FaceDescription `json:"faces,omitempty"`
	// RequestID - Id of the request for tracking purposes.
	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 `json:"description,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"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,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
	Width *int32 `json:"width,omitempty"`
	// Height - Image height
	Height *int32 `json:"height,omitempty"`
	// Format - Image format
	Format *string `json:"format,omitempty"`
}

ImageMetadata image metadata

type ImageTag

type ImageTag struct {
	// Name - The tag value
	Name *string `json:"name,omitempty"`
	// Confidence - The level of confidence the service has in the caption
	Confidence *float64 `json:"confidence,omitempty"`
}

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

type ImageType

type ImageType struct {
	// ClipArtType - Confidence level that the image is a clip art.
	ClipArtType *float64 `json:"clipArtType,omitempty"`
	// LineDrawingType - Confidence level that the image is a line drawing.
	LineDrawingType *float64 `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 *[]LandmarkResultsLandmarksItem `json:"landmarks,omitempty"`
	// RequestID - Id of the REST API request.
	RequestID *string        `json:"requestId,omitempty"`
	Metadata  *ImageMetadata `json:"metadata,omitempty"`
}

LandmarkResults list of landmarks recognized in the image.

type LandmarkResultsLandmarksItem

type LandmarkResultsLandmarksItem struct {
	// Name - Name of the landmark.
	Name *string `json:"name,omitempty"`
	// Confidence - Confidence level for the landmark recognition.
	Confidence *float64 `json:"confidence,omitempty"`
}

LandmarkResultsLandmarksItem a landmark recognized in the image

type Line

type Line struct {
	BoundingBox *[]int32 `json:"boundingBox,omitempty"`
	Text        *string  `json:"text,omitempty"`
	Words       *[]Word  `json:"words,omitempty"`
}

Line ...

type ListModelsResult

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

ListModelsResult result of the List Domain Models operation.

type ModelDescription

type ModelDescription struct {
	Name       *string   `json:"name,omitempty"`
	Categories *[]string `json:"categories,omitempty"`
}

ModelDescription an object describing supported model by name and categories.

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       *[]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 RecognitionResult

type RecognitionResult struct {
	Lines *[]Line `json:"lines,omitempty"`
}

RecognitionResult ...

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 *RecognitionResult       `json:"recognitionResult,omitempty"`
}

TextOperationResult ...

type TextOperationStatusCodes

type TextOperationStatusCodes string

TextOperationStatusCodes enumerates the values for text operation status codes.

const (
	// Failed ...
	Failed TextOperationStatusCodes = "Failed"
	// NotStarted ...
	NotStarted TextOperationStatusCodes = "Not Started"
	// 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 VisualFeatureTypes

type VisualFeatureTypes string

VisualFeatureTypes enumerates the values for visual feature types.

const (
	// VisualFeatureTypesAdult ...
	VisualFeatureTypesAdult VisualFeatureTypes = "Adult"
	// VisualFeatureTypesCategories ...
	VisualFeatureTypesCategories VisualFeatureTypes = "Categories"
	// VisualFeatureTypesColor ...
	VisualFeatureTypesColor VisualFeatureTypes = "Color"
	// VisualFeatureTypesDescription ...
	VisualFeatureTypesDescription VisualFeatureTypes = "Description"
	// VisualFeatureTypesFaces ...
	VisualFeatureTypesFaces VisualFeatureTypes = "Faces"
	// VisualFeatureTypesImageType ...
	VisualFeatureTypesImageType VisualFeatureTypes = "ImageType"
	// 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 *[]int32 `json:"boundingBox,omitempty"`
	Text        *string  `json:"text,omitempty"`
}

Word ...

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL