ComputerVisionClient class

Initializes a new instance of the ComputerVisionClient class.

new ComputerVisionClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)

Parameters

credentials: ServiceClientCredentials

Property Value

Inherited From ComputerVisionClientContext.credentials

endpoint: string

Property Value

Inherited From ComputerVisionClientContext.endpoint

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.

function analyzeImage(url: string, options?: ComputerVisionClientAnalyzeImageOptionalParams): Promise<AnalyzeImageResponse>

Parameters

Returns

Promise<Models.AnalyzeImageResponse>

function analyzeImage(url: string, options: ComputerVisionClientAnalyzeImageOptionalParams, callback: ServiceCallback<ImageAnalysis>)

Parameters

function analyzeImage(url: string, callback: ServiceCallback<ImageAnalysis>)

Parameters

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.

function analyzeImageByDomain(model: string, url: string, options?: ComputerVisionClientAnalyzeImageByDomainOptionalParams): Promise<AnalyzeImageByDomainResponse>

Parameters

Returns

Promise<Models.AnalyzeImageByDomainResponse>

function analyzeImageByDomain(model: string, url: string, options: ComputerVisionClientAnalyzeImageByDomainOptionalParams, callback: ServiceCallback<DomainModelResults>)

Parameters

function analyzeImageByDomain(model: string, url: string, callback: ServiceCallback<DomainModelResults>)

Parameters

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.

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, options?: ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams): Promise<AnalyzeImageByDomainInStreamResponse>

Parameters

Returns

Promise<Models.AnalyzeImageByDomainInStreamResponse>

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, options: ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams, callback: ServiceCallback<DomainModelResults>)

Parameters

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, callback: ServiceCallback<DomainModelResults>)

Parameters

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.

function analyzeImageInStream(image: HttpRequestBody, options?: ComputerVisionClientAnalyzeImageInStreamOptionalParams): Promise<AnalyzeImageInStreamResponse>

Parameters

Returns

Promise<Models.AnalyzeImageInStreamResponse>

function analyzeImageInStream(image: HttpRequestBody, options: ComputerVisionClientAnalyzeImageInStreamOptionalParams, callback: ServiceCallback<ImageAnalysis>)

Parameters

function analyzeImageInStream(image: HttpRequestBody, callback: ServiceCallback<ImageAnalysis>)

Parameters

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. Descriptions may include results from celebrity and landmark domain models, if applicable. 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.

function describeImage(url: string, options?: ComputerVisionClientDescribeImageOptionalParams): Promise<DescribeImageResponse>

Parameters

Returns

Promise<Models.DescribeImageResponse>

function describeImage(url: string, options: ComputerVisionClientDescribeImageOptionalParams, callback: ServiceCallback<ImageDescription>)

Parameters

function describeImage(url: string, callback: ServiceCallback<ImageDescription>)

Parameters

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. Descriptions may include results from celebrity and landmark domain models, if applicable. 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.

function describeImageInStream(image: HttpRequestBody, options?: ComputerVisionClientDescribeImageInStreamOptionalParams): Promise<DescribeImageInStreamResponse>

Parameters

Returns

Promise<Models.DescribeImageInStreamResponse>

function describeImageInStream(image: HttpRequestBody, options: ComputerVisionClientDescribeImageInStreamOptionalParams, callback: ServiceCallback<ImageDescription>)

Parameters

function describeImageInStream(image: HttpRequestBody, callback: ServiceCallback<ImageDescription>)

Parameters

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.

function detectObjects(url: string, options?: ComputerVisionClientDetectObjectsOptionalParams): Promise<DetectObjectsResponse>

Parameters

Returns

Promise<Models.DetectObjectsResponse>

function detectObjects(url: string, options: ComputerVisionClientDetectObjectsOptionalParams, callback: ServiceCallback<DetectResult>)

Parameters

function detectObjects(url: string, callback: ServiceCallback<DetectResult>)

Parameters

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.

function detectObjectsInStream(image: HttpRequestBody, options?: ComputerVisionClientDetectObjectsInStreamOptionalParams): Promise<DetectObjectsInStreamResponse>

Parameters

Returns

Promise<Models.DetectObjectsInStreamResponse>

function detectObjectsInStream(image: HttpRequestBody, options: ComputerVisionClientDetectObjectsInStreamOptionalParams, callback: ServiceCallback<DetectResult>)

Parameters

function detectObjectsInStream(image: HttpRequestBody, callback: ServiceCallback<DetectResult>)

Parameters

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.

function generateThumbnail(width: number, height: number, url: string, options?: ComputerVisionClientGenerateThumbnailOptionalParams): Promise<GenerateThumbnailResponse>

Parameters

Returns

Promise<Models.GenerateThumbnailResponse>

function generateThumbnail(width: number, height: number, url: string, options: ComputerVisionClientGenerateThumbnailOptionalParams, callback: ServiceCallback<void>)

Parameters

function generateThumbnail(width: number, height: number, url: string, callback: ServiceCallback<void>)

Parameters

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.

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, options?: ComputerVisionClientGenerateThumbnailInStreamOptionalParams): Promise<GenerateThumbnailInStreamResponse>

Parameters

Returns

Promise<Models.GenerateThumbnailInStreamResponse>

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, options: ComputerVisionClientGenerateThumbnailInStreamOptionalParams, callback: ServiceCallback<void>)

Parameters

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, callback: ServiceCallback<void>)

Parameters

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.

function getAreaOfInterest(url: string, options?: ComputerVisionClientGetAreaOfInterestOptionalParams): Promise<GetAreaOfInterestResponse>

Parameters

Returns

Promise<Models.GetAreaOfInterestResponse>

function getAreaOfInterest(url: string, options: ComputerVisionClientGetAreaOfInterestOptionalParams, callback: ServiceCallback<AreaOfInterestResult>)

Parameters

function getAreaOfInterest(url: string, callback: ServiceCallback<AreaOfInterestResult>)

Parameters

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.

function getAreaOfInterestInStream(image: HttpRequestBody, options?: ComputerVisionClientGetAreaOfInterestInStreamOptionalParams): Promise<GetAreaOfInterestInStreamResponse>

Parameters

Returns

Promise<Models.GetAreaOfInterestInStreamResponse>

function getAreaOfInterestInStream(image: HttpRequestBody, options: ComputerVisionClientGetAreaOfInterestInStreamOptionalParams, callback: ServiceCallback<AreaOfInterestResult>)

Parameters

function getAreaOfInterestInStream(image: HttpRequestBody, callback: ServiceCallback<AreaOfInterestResult>)

Parameters

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 Read interface.

function getReadResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadResultResponse>

Parameters

Returns

Promise<Models.GetReadResultResponse>

function getReadResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadOperationResult>)

Parameters

function getReadResult(operationId: string, callback: ServiceCallback<ReadOperationResult>)

Parameters

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.

function listModels(options?: RequestOptionsBase): Promise<ListModelsResponse>

Parameters

Returns

Promise<Models.ListModelsResponse>

function listModels(options: RequestOptionsBase, callback: ServiceCallback<ListModelsResult>)

Parameters

function listModels(callback: ServiceCallback<ListModelsResult>)

Parameters

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 interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.​

function read(url: string, options?: ComputerVisionClientReadOptionalParams): Promise<ReadResponse>

Parameters

Returns

Promise<Models.ReadResponse>

function read(url: string, options: ComputerVisionClientReadOptionalParams, callback: ServiceCallback<void>)

Parameters

function read(url: string, callback: ServiceCallback<void>)

Parameters

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 interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.​

function readInStream(image: HttpRequestBody, options?: ComputerVisionClientReadInStreamOptionalParams): Promise<ReadInStreamResponse>

Parameters

Returns

Promise<Models.ReadInStreamResponse>

function readInStream(image: HttpRequestBody, options: ComputerVisionClientReadInStreamOptionalParams, callback: ServiceCallback<void>)

Parameters

function readInStream(image: HttpRequestBody, callback: ServiceCallback<void>)

Parameters

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.

function recognizePrintedText(detectOrientation: boolean, url: string, options?: ComputerVisionClientRecognizePrintedTextOptionalParams): Promise<RecognizePrintedTextResponse>

Parameters

Returns

Promise<Models.RecognizePrintedTextResponse>

function recognizePrintedText(detectOrientation: boolean, url: string, options: ComputerVisionClientRecognizePrintedTextOptionalParams, callback: ServiceCallback<OcrResult>)

Parameters

function recognizePrintedText(detectOrientation: boolean, url: string, callback: ServiceCallback<OcrResult>)

Parameters

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.

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, options?: ComputerVisionClientRecognizePrintedTextInStreamOptionalParams): Promise<RecognizePrintedTextInStreamResponse>

Parameters

Returns

Promise<Models.RecognizePrintedTextInStreamResponse>

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, options: ComputerVisionClientRecognizePrintedTextInStreamOptionalParams, callback: ServiceCallback<OcrResult>)

Parameters

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, callback: ServiceCallback<OcrResult>)

Parameters

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 "ascomycete" may be accompanied by the hint "fungus". 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.

function tagImage(url: string, options?: ComputerVisionClientTagImageOptionalParams): Promise<TagImageResponse>

Parameters

Returns

Promise<Models.TagImageResponse>

function tagImage(url: string, options: ComputerVisionClientTagImageOptionalParams, callback: ServiceCallback<TagResult>)

Parameters

function tagImage(url: string, callback: ServiceCallback<TagResult>)

Parameters

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 "ascomycete" may be accompanied by the hint "fungus". 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.

function tagImageInStream(image: HttpRequestBody, options?: ComputerVisionClientTagImageInStreamOptionalParams): Promise<TagImageInStreamResponse>

Parameters

Returns

Promise<Models.TagImageInStreamResponse>

function tagImageInStream(image: HttpRequestBody, options: ComputerVisionClientTagImageInStreamOptionalParams, callback: ServiceCallback<TagResult>)

Parameters

function tagImageInStream(image: HttpRequestBody, callback: ServiceCallback<TagResult>)

Parameters

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

Parameters

Returns

Inherited From ComputerVisionClientContext.sendOperationRequest

Send the provided httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Parameters

Returns

Inherited From ComputerVisionClientContext.sendRequest