@azure/cognitiveservices-computervision package

Classes

ComputerVisionClient
ComputerVisionClientContext

Interfaces

AdultInfo

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

AreaOfInterestResult

Result of AreaOfInterest operation.

BatchReadFileHeaders

Defines headers for BatchReadFile operation.

BatchReadFileInStreamHeaders

Defines headers for BatchReadFileInStream operation.

BoundingRect

A bounding box for an area inside an image.

Category

An object describing identified category.

CategoryDetail

An object describing additional category details.

CelebritiesModel

An object describing possible celebrity identification.

CelebrityResults

Result of domain-specific classifications for the domain of celebrities.

ColorInfo

An object providing additional metadata describing color attributes.

ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams

Optional Parameters.

ComputerVisionClientAnalyzeImageByDomainOptionalParams

Optional Parameters.

ComputerVisionClientAnalyzeImageInStreamOptionalParams

Optional Parameters.

ComputerVisionClientAnalyzeImageOptionalParams

Optional Parameters.

ComputerVisionClientDescribeImageInStreamOptionalParams

Optional Parameters.

ComputerVisionClientDescribeImageOptionalParams

Optional Parameters.

ComputerVisionClientGenerateThumbnailInStreamOptionalParams

Optional Parameters.

ComputerVisionClientGenerateThumbnailOptionalParams

Optional Parameters.

ComputerVisionClientRecognizePrintedTextInStreamOptionalParams

Optional Parameters.

ComputerVisionClientRecognizePrintedTextOptionalParams

Optional Parameters.

ComputerVisionClientTagImageInStreamOptionalParams

Optional Parameters.

ComputerVisionClientTagImageOptionalParams

Optional Parameters.

ComputerVisionError

Details about the API request error.

DetectResult

Result of a DetectImage call.

DetectedBrand

A brand detected in an image.

DetectedObject

An object detected in an image.

DomainModelResults

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

FaceDescription

An object describing a face identified in the image.

FaceRectangle

An object describing face rectangle.

ImageAnalysis

Result of AnalyzeImage operation.

ImageCaption

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

ImageDescription

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

ImageDescriptionDetails

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

ImageMetadata

Image metadata.

ImageTag

An entity observation in the image, along with the confidence score.

ImageType

An object providing possible image types and matching confidence levels.

ImageUrl

An interface representing ImageUrl.

LandmarkResults

Result of domain-specific classifications for the domain of landmarks.

LandmarksModel

A landmark recognized in the image.

Line

An object representing a recognized text line.

ListModelsResult

Result of the List Domain Models operation.

ModelDescription

An object describing supported model by name and categories.

ObjectHierarchy

An object detected inside an image.

OcrLine

An object describing a single recognized line of text.

OcrRegion

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

OcrResult

An interface representing OcrResult.

OcrWord

Information on a recognized word.

ReadOperationResult

OCR result of the read operation.

RecognizeTextHeaders

Defines headers for RecognizeText operation.

RecognizeTextInStreamHeaders

Defines headers for RecognizeTextInStream operation.

TagResult

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

TextOperationResult

Result of recognition text operation.

TextRecognitionResult

An object representing a recognized text region

Word

An object representing a recognized word.

Type Aliases

AnalyzeImageByDomainInStreamResponse

Contains response data for the analyzeImageByDomainInStream operation.

AnalyzeImageByDomainResponse

Contains response data for the analyzeImageByDomain operation.

AnalyzeImageInStreamResponse

Contains response data for the analyzeImageInStream operation.

AnalyzeImageResponse

Contains response data for the analyzeImage operation.

BatchReadFileInStreamResponse

Contains response data for the batchReadFileInStream operation.

BatchReadFileResponse

Contains response data for the batchReadFile operation.

DescribeImageInStreamResponse

Contains response data for the describeImageInStream operation.

DescribeImageResponse

Contains response data for the describeImage operation.

DescriptionExclude

Defines values for DescriptionExclude. Possible values include: 'Celebrities', 'Landmarks'

Details

Defines values for Details. Possible values include: 'Celebrities', 'Landmarks'

DetectObjectsInStreamResponse

Contains response data for the detectObjectsInStream operation.

DetectObjectsResponse

Contains response data for the detectObjects operation.

Gender

Defines values for Gender. Possible values include: 'Male', 'Female'

GenerateThumbnailInStreamResponse

Contains response data for the generateThumbnailInStream operation.

GenerateThumbnailResponse

Contains response data for the generateThumbnail operation.

GetAreaOfInterestInStreamResponse

Contains response data for the getAreaOfInterestInStream operation.

GetAreaOfInterestResponse

Contains response data for the getAreaOfInterest operation.

GetReadOperationResultResponse

Contains response data for the getReadOperationResult operation.

GetTextOperationResultResponse

Contains response data for the getTextOperationResult operation.

Language

Defines values for Language. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

Language1

Defines values for Language1. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

Language2

Defines values for Language2. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

Language3

Defines values for Language3. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

Language4

Defines values for Language4. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

Language5

Defines values for Language5. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

Language6

Defines values for Language6. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

Language7

Defines values for Language7. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

ListModelsResponse

Contains response data for the listModels operation.

OcrLanguages

Defines values for OcrLanguages. Possible values include: 'unk', 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'

RecognizePrintedTextInStreamResponse

Contains response data for the recognizePrintedTextInStream operation.

RecognizePrintedTextResponse

Contains response data for the recognizePrintedText operation.

RecognizeTextInStreamResponse

Contains response data for the recognizeTextInStream operation.

RecognizeTextResponse

Contains response data for the recognizeText operation.

TagImageInStreamResponse

Contains response data for the tagImageInStream operation.

TagImageResponse

Contains response data for the tagImage operation.

TextOperationStatusCodes

Defines values for TextOperationStatusCodes. Possible values include: 'NotStarted', 'Running', 'Failed', 'Succeeded'

TextRecognitionMode

Defines values for TextRecognitionMode. Possible values include: 'Handwritten', 'Printed'

TextRecognitionResultConfidenceClass

Defines values for TextRecognitionResultConfidenceClass. Possible values include: 'High', 'Low'

TextRecognitionResultDimensionUnit

Defines values for TextRecognitionResultDimensionUnit. Possible values include: 'pixel', 'inch'

VisualFeatureTypes

Defines values for VisualFeatureTypes. Possible values include: 'ImageType', 'Faces', 'Adult', 'Categories', 'Color', 'Tags', 'Description', 'Objects', 'Brands'