Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/cognitiveservices-computervision

Package version

Index

Classes

Interfaces

Type aliases

Object literals

Type aliases

AnalyzeImageByDomainInStreamResponse

AnalyzeImageByDomainInStreamResponse: DomainModelResults & object

Contains response data for the analyzeImageByDomainInStream operation.

AnalyzeImageByDomainResponse

AnalyzeImageByDomainResponse: DomainModelResults & object

Contains response data for the analyzeImageByDomain operation.

AnalyzeImageInStreamResponse

AnalyzeImageInStreamResponse: ImageAnalysis & object

Contains response data for the analyzeImageInStream operation.

AnalyzeImageResponse

AnalyzeImageResponse: ImageAnalysis & object

Contains response data for the analyzeImage operation.

BatchReadFileInStreamResponse

BatchReadFileInStreamResponse: BatchReadFileInStreamHeaders & object

Contains response data for the batchReadFileInStream operation.

BatchReadFileResponse

BatchReadFileResponse: BatchReadFileHeaders & object

Contains response data for the batchReadFile operation.

DescribeImageInStreamResponse

DescribeImageInStreamResponse: ImageDescription & object

Contains response data for the describeImageInStream operation.

DescribeImageResponse

DescribeImageResponse: ImageDescription & object

Contains response data for the describeImage operation.

DescriptionExclude

DescriptionExclude: "Celebrities" | "Landmarks"

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

readonly
enum

{string}

Details

Details: "Celebrities" | "Landmarks"

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

readonly
enum

{string}

DetectObjectsInStreamResponse

DetectObjectsInStreamResponse: DetectResult & object

Contains response data for the detectObjectsInStream operation.

DetectObjectsResponse

DetectObjectsResponse: DetectResult & object

Contains response data for the detectObjects operation.

Gender

Gender: "Male" | "Female"

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

readonly
enum

{string}

GenerateThumbnailInStreamResponse

GenerateThumbnailInStreamResponse: object

Contains response data for the generateThumbnailInStream operation.

Type declaration

GenerateThumbnailResponse

GenerateThumbnailResponse: object

Contains response data for the generateThumbnail operation.

Type declaration

GetAreaOfInterestInStreamResponse

GetAreaOfInterestInStreamResponse: AreaOfInterestResult & object

Contains response data for the getAreaOfInterestInStream operation.

GetAreaOfInterestResponse

GetAreaOfInterestResponse: AreaOfInterestResult & object

Contains response data for the getAreaOfInterest operation.

GetReadOperationResultResponse

GetReadOperationResultResponse: ReadOperationResult & object

Contains response data for the getReadOperationResult operation.

GetTextOperationResultResponse

GetTextOperationResultResponse: TextOperationResult & object

Contains response data for the getTextOperationResult operation.

Language

Language: "en" | "es" | "ja" | "pt" | "zh"

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

readonly
enum

{string}

Language1

Language1: "en" | "es" | "ja" | "pt" | "zh"

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

readonly
enum

{string}

Language2

Language2: "en" | "es" | "ja" | "pt" | "zh"

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

readonly
enum

{string}

Language3

Language3: "en" | "es" | "ja" | "pt" | "zh"

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

readonly
enum

{string}

Language4

Language4: "en" | "es" | "ja" | "pt" | "zh"

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

readonly
enum

{string}

Language5

Language5: "en" | "es" | "ja" | "pt" | "zh"

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

readonly
enum

{string}

Language6

Language6: "en" | "es" | "ja" | "pt" | "zh"

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

readonly
enum

{string}

Language7

Language7: "en" | "es" | "ja" | "pt" | "zh"

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

readonly
enum

{string}

ListModelsResponse

ListModelsResponse: ListModelsResult & object

Contains response data for the listModels operation.

OcrLanguages

OcrLanguages: "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"

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'

readonly
enum

{string}

RecognizePrintedTextInStreamResponse

RecognizePrintedTextInStreamResponse: OcrResult & object

Contains response data for the recognizePrintedTextInStream operation.

RecognizePrintedTextResponse

RecognizePrintedTextResponse: OcrResult & object

Contains response data for the recognizePrintedText operation.

RecognizeTextInStreamResponse

RecognizeTextInStreamResponse: RecognizeTextInStreamHeaders & object

Contains response data for the recognizeTextInStream operation.

RecognizeTextResponse

RecognizeTextResponse: RecognizeTextHeaders & object

Contains response data for the recognizeText operation.

TagImageInStreamResponse

TagImageInStreamResponse: TagResult & object

Contains response data for the tagImageInStream operation.

TagImageResponse

TagImageResponse: TagResult & object

Contains response data for the tagImage operation.

TextOperationStatusCodes

TextOperationStatusCodes: "NotStarted" | "Running" | "Failed" | "Succeeded"

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

readonly
enum

{string}

TextRecognitionMode

TextRecognitionMode: "Handwritten" | "Printed"

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

readonly
enum

{string}

TextRecognitionResultConfidenceClass

TextRecognitionResultConfidenceClass: "High" | "Low"

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

readonly
enum

{string}

TextRecognitionResultDimensionUnit

TextRecognitionResultDimensionUnit: "pixel" | "inch"

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

readonly
enum

{string}

VisualFeatureTypes

VisualFeatureTypes: "ImageType" | "Faces" | "Adult" | "Categories" | "Color" | "Tags" | "Description" | "Objects" | "Brands"

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

readonly
enum

{string}

Object literals

Const AdultInfo

AdultInfo: object

serializedName

serializedName: string = "AdultInfo"

type

type: object

className

className: string = "AdultInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

adultScore

adultScore: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "adultScore"

type

type: object

name

name: string = "Number"

goreScore

goreScore: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "goreScore"

type

type: object

name

name: string = "Number"

isAdultContent

isAdultContent: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "isAdultContent"

type

type: object

name

name: string = "Boolean"

isGoryContent

isGoryContent: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "isGoryContent"

type

type: object

name

name: string = "Boolean"

isRacyContent

isRacyContent: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "isRacyContent"

type

type: object

name

name: string = "Boolean"

racyScore

racyScore: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "racyScore"

type

type: object

name

name: string = "Number"

Const AreaOfInterestResult

AreaOfInterestResult: object

serializedName

serializedName: string = "AreaOfInterestResult"

type

type: object

className

className: string = "AreaOfInterestResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

areaOfInterest

areaOfInterest: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "areaOfInterest"

type

type: object

className

className: string = "BoundingRect"

name

name: string = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

requestId

requestId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

Const BatchReadFileHeaders

BatchReadFileHeaders: object

serializedName

serializedName: string = "batchreadfile-headers"

type

type: object

className

className: string = "BatchReadFileHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const BatchReadFileInStreamHeaders

BatchReadFileInStreamHeaders: object

serializedName

serializedName: string = "batchreadfileinstream-headers"

type

type: object

className

className: string = "BatchReadFileInStreamHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const BoundingRect

BoundingRect: object

serializedName

serializedName: string = "BoundingRect"

type

type: object

className

className: string = "BoundingRect"

name

name: string = "Composite"

modelProperties

modelProperties: object

h

h: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "h"

type

type: object

name

name: string = "Number"

w

w: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "w"

type

type: object

name

name: string = "Number"

x

x: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "x"

type

type: object

name

name: string = "Number"

y

y: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "y"

type

type: object

name

name: string = "Number"

Const Category

Category: object

serializedName

serializedName: string = "Category"

type

type: object

className

className: string = "Category"

name

name: string = "Composite"

modelProperties

modelProperties: object

detail

detail: object

serializedName

serializedName: string = "detail"

type

type: object

className

className: string = "CategoryDetail"

name

name: string = "Composite"

name

name: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

score

score: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "score"

type

type: object

name

name: string = "Number"

Const CategoryDetail

CategoryDetail: object

serializedName

serializedName: string = "CategoryDetail"

type

type: object

className

className: string = "CategoryDetail"

name

name: string = "Composite"

modelProperties

modelProperties: object

celebrities

celebrities: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "celebrities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CelebritiesModel"

name

name: string = "Composite"

landmarks

landmarks: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "landmarks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LandmarksModel"

name

name: string = "Composite"

Const CelebritiesModel

CelebritiesModel: object

serializedName

serializedName: string = "CelebritiesModel"

type

type: object

className

className: string = "CelebritiesModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "confidence"

type

type: object

name

name: string = "Number"

faceRectangle

faceRectangle: object

serializedName

serializedName: string = "faceRectangle"

type

type: object

className

className: string = "FaceRectangle"

name

name: string = "Composite"

name

name: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const CelebrityResults

CelebrityResults: object

serializedName

serializedName: string = "CelebrityResults"

type

type: object

className

className: string = "CelebrityResults"

name

name: string = "Composite"

modelProperties

modelProperties: object

celebrities

celebrities: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "celebrities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CelebritiesModel"

name

name: string = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

requestId

requestId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

Const ColorInfo

ColorInfo: object

serializedName

serializedName: string = "ColorInfo"

type

type: object

className

className: string = "ColorInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

accentColor

accentColor: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "accentColor"

type

type: object

name

name: string = "String"

dominantColorBackground

dominantColorBackground: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "dominantColorBackground"

type

type: object

name

name: string = "String"

dominantColorForeground

dominantColorForeground: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "dominantColorForeground"

type

type: object

name

name: string = "String"

dominantColors

dominantColors: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "dominantColors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

isBWImg

isBWImg: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "isBWImg"

type

type: object

name

name: string = "Boolean"

Const ComputerVisionError

ComputerVisionError: object

serializedName

serializedName: string = "ComputerVisionError"

type

type: object

className

className: string = "ComputerVisionError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "Object"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

Const DetectResult

DetectResult: object

serializedName

serializedName: string = "DetectResult"

type

type: object

className

className: string = "DetectResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

objects

objects: object

nullable

nullable: boolean = true

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "objects"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DetectedObject"

name

name: string = "Composite"

requestId

requestId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

Const DetectedBrand

DetectedBrand: object

serializedName

serializedName: string = "DetectedBrand"

type

type: object

className

className: string = "DetectedBrand"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "confidence"

type

type: object

name

name: string = "Number"

name

name: object

nullable

nullable: boolean = true

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

rectangle

rectangle: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "rectangle"

type

type: object

className

className: string = "BoundingRect"

name

name: string = "Composite"

Const DetectedObject

DetectedObject: object

serializedName

serializedName: string = "DetectedObject"

type

type: object

className

className: string = "DetectedObject"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "confidence"

type

type: object

name

name: string = "Number"

object

object: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "object"

type

type: object

name

name: string = "String"

parent

parent: object

serializedName

serializedName: string = "parent"

type

type: object

className

className: string = "ObjectHierarchy"

name

name: string = "Composite"

rectangle

rectangle: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "rectangle"

type

type: object

className

className: string = "BoundingRect"

name

name: string = "Composite"

Const DomainModelResults

DomainModelResults: object

serializedName

serializedName: string = "DomainModelResults"

type

type: object

className

className: string = "DomainModelResults"

name

name: string = "Composite"

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

requestId

requestId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

name

name: string = "Object"

Const FaceDescription

FaceDescription: object

serializedName

serializedName: string = "FaceDescription"

type

type: object

className

className: string = "FaceDescription"

name

name: string = "Composite"

modelProperties

modelProperties: object

age

age: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "age"

type

type: object

name

name: string = "Number"

faceRectangle

faceRectangle: object

serializedName

serializedName: string = "faceRectangle"

type

type: object

className

className: string = "FaceRectangle"

name

name: string = "Composite"

gender

gender: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "gender"

type

type: object

allowedValues

allowedValues: string[] = ["Male","Female"]

name

name: string = "Enum"

Const FaceRectangle

FaceRectangle: object

serializedName

serializedName: string = "FaceRectangle"

type

type: object

className

className: string = "FaceRectangle"

name

name: string = "Composite"

modelProperties

modelProperties: object

height

height: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "height"

type

type: object

name

name: string = "Number"

left

left: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "left"

type

type: object

name

name: string = "Number"

top

top: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "top"

type

type: object

name

name: string = "Number"

width

width: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "width"

type

type: object

name

name: string = "Number"

Const ImageAnalysis

ImageAnalysis: object

serializedName

serializedName: string = "ImageAnalysis"

type

type: object

className

className: string = "ImageAnalysis"

name

name: string = "Composite"

modelProperties

modelProperties: object

adult

adult: object

serializedName

serializedName: string = "adult"

type

type: object

className

className: string = "AdultInfo"

name

name: string = "Composite"

brands

brands: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "brands"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DetectedBrand"

name

name: string = "Composite"

categories

categories: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "categories"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Category"

name

name: string = "Composite"

color

color: object

serializedName

serializedName: string = "color"

type

type: object

className

className: string = "ColorInfo"

name

name: string = "Composite"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

className

className: string = "ImageDescriptionDetails"

name

name: string = "Composite"

faces

faces: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "faces"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "FaceDescription"

name

name: string = "Composite"

imageType

imageType: object

serializedName

serializedName: string = "imageType"

type

type: object

className

className: string = "ImageType"

name

name: string = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

objects

objects: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "objects"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DetectedObject"

name

name: string = "Composite"

requestId

requestId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

tags

tags: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ImageTag"

name

name: string = "Composite"

Const ImageCaption

ImageCaption: object

serializedName

serializedName: string = "ImageCaption"

type

type: object

className

className: string = "ImageCaption"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "confidence"

type

type: object

name

name: string = "Number"

text

text: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const ImageDescription

ImageDescription: object

serializedName

serializedName: string = "ImageDescription"

type

type: object

className

className: string = "ImageDescription"

name

name: string = "Composite"

modelProperties

modelProperties: object

captions

captions: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "description.captions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ImageCaption"

name

name: string = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

requestId

requestId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

tags

tags: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "description.tags"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const ImageDescriptionDetails

ImageDescriptionDetails: object

serializedName

serializedName: string = "ImageDescriptionDetails"

type

type: object

className

className: string = "ImageDescriptionDetails"

name

name: string = "Composite"

modelProperties

modelProperties: object

captions

captions: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "captions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ImageCaption"

name

name: string = "Composite"

tags

tags: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const ImageMetadata

ImageMetadata: object

serializedName

serializedName: string = "ImageMetadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

modelProperties

modelProperties: object

format

format: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "format"

type

type: object

name

name: string = "String"

height

height: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "height"

type

type: object

name

name: string = "Number"

width

width: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "width"

type

type: object

name

name: string = "Number"

Const ImageTag

ImageTag: object

serializedName

serializedName: string = "ImageTag"

type

type: object

className

className: string = "ImageTag"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "confidence"

type

type: object

name

name: string = "Number"

hint

hint: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "hint"

type

type: object

name

name: string = "String"

name

name: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const ImageType

ImageType: object

serializedName

serializedName: string = "ImageType"

type

type: object

className

className: string = "ImageType"

name

name: string = "Composite"

modelProperties

modelProperties: object

clipArtType

clipArtType: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "clipArtType"

type

type: object

name

name: string = "Number"

lineDrawingType

lineDrawingType: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "lineDrawingType"

type

type: object

name

name: string = "Number"

Const ImageUrl

ImageUrl: object

serializedName

serializedName: string = "ImageUrl"

type

type: object

className

className: string = "ImageUrl"

name

name: string = "Composite"

modelProperties

modelProperties: object

url

url: object

required

required: boolean = true

serializedName

serializedName: string = "url"

type

type: object

name

name: string = "String"

Const LandmarkResults

LandmarkResults: object

serializedName

serializedName: string = "LandmarkResults"

type

type: object

className

className: string = "LandmarkResults"

name

name: string = "Composite"

modelProperties

modelProperties: object

landmarks

landmarks: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "landmarks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LandmarksModel"

name

name: string = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

requestId

requestId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

Const LandmarksModel

LandmarksModel: object

serializedName

serializedName: string = "LandmarksModel"

type

type: object

className

className: string = "LandmarksModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "confidence"

type

type: object

name

name: string = "Number"

name

name: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const Line

Line: object

serializedName

serializedName: string = "Line"

type

type: object

className

className: string = "Line"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

serializedName

serializedName: string = "boundingBox"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

text

text: object

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

words

words: object

serializedName

serializedName: string = "words"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Word"

name

name: string = "Composite"

Const ListModelsResult

ListModelsResult: object

serializedName

serializedName: string = "ListModelsResult"

type

type: object

className

className: string = "ListModelsResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

modelsProperty

modelsProperty: object

nullable

nullable: boolean = true

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "models"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ModelDescription"

name

name: string = "Composite"

Const ModelDescription

ModelDescription: object

serializedName

serializedName: string = "ModelDescription"

type

type: object

className

className: string = "ModelDescription"

name

name: string = "Composite"

modelProperties

modelProperties: object

categories

categories: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "categories"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

name

name: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const ObjectHierarchy

ObjectHierarchy: object

serializedName

serializedName: string = "ObjectHierarchy"

type

type: object

className

className: string = "ObjectHierarchy"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "confidence"

type

type: object

name

name: string = "Number"

object

object: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "object"

type

type: object

name

name: string = "String"

parent

parent: object

serializedName

serializedName: string = "parent"

type

type: object

className

className: string = "ObjectHierarchy"

name

name: string = "Composite"

Const OcrLine

OcrLine: object

serializedName

serializedName: string = "OcrLine"

type

type: object

className

className: string = "OcrLine"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "boundingBox"

type

type: object

name

name: string = "String"

words

words: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "words"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "OcrWord"

name

name: string = "Composite"

Const OcrRegion

OcrRegion: object

serializedName

serializedName: string = "OcrRegion"

type

type: object

className

className: string = "OcrRegion"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "boundingBox"

type

type: object

name

name: string = "String"

lines

lines: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "lines"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "OcrLine"

name

name: string = "Composite"

Const OcrResult

OcrResult: object

serializedName

serializedName: string = "OcrResult"

type

type: object

className

className: string = "OcrResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

language

language: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "language"

type

type: object

name

name: string = "String"

orientation

orientation: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "orientation"

type

type: object

name

name: string = "String"

regions

regions: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "regions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "OcrRegion"

name

name: string = "Composite"

textAngle

textAngle: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "textAngle"

type

type: object

name

name: string = "Number"

Const OcrWord

OcrWord: object

serializedName

serializedName: string = "OcrWord"

type

type: object

className

className: string = "OcrWord"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "boundingBox"

type

type: object

name

name: string = "String"

text

text: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const ReadOperationResult

ReadOperationResult: object

serializedName

serializedName: string = "ReadOperationResult"

type

type: object

className

className: string = "ReadOperationResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

recognitionResults

recognitionResults: object

serializedName

serializedName: string = "recognitionResults"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextRecognitionResult"

name

name: string = "Composite"

status

status: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["NotStarted","Running","Failed","Succeeded"]

name

name: string = "Enum"

Const RecognizeTextHeaders

RecognizeTextHeaders: object

serializedName

serializedName: string = "recognizetext-headers"

type

type: object

className

className: string = "RecognizeTextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const RecognizeTextInStreamHeaders

RecognizeTextInStreamHeaders: object

serializedName

serializedName: string = "recognizetextinstream-headers"

type

type: object

className

className: string = "RecognizeTextInStreamHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const TagResult

TagResult: object

serializedName

serializedName: string = "TagResult"

type

type: object

className

className: string = "TagResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "ImageMetadata"

name

name: string = "Composite"

requestId

requestId: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "requestId"

type

type: object

name

name: string = "String"

tags

tags: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ImageTag"

name

name: string = "Composite"

Const TextOperationResult

TextOperationResult: object

serializedName

serializedName: string = "TextOperationResult"

type

type: object

className

className: string = "TextOperationResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

recognitionResult

recognitionResult: object

serializedName

serializedName: string = "recognitionResult"

type

type: object

className

className: string = "TextRecognitionResult"

name

name: string = "Composite"

status

status: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["NotStarted","Running","Failed","Succeeded"]

name

name: string = "Enum"

Const TextRecognitionResult

TextRecognitionResult: object

serializedName

serializedName: string = "TextRecognitionResult"

type

type: object

className

className: string = "TextRecognitionResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

clockwiseOrientation

clockwiseOrientation: object

serializedName

serializedName: string = "clockwiseOrientation"

type

type: object

name

name: string = "Number"

height

height: object

serializedName

serializedName: string = "height"

type

type: object

name

name: string = "Number"

lines

lines: object

required

required: boolean = true

serializedName

serializedName: string = "lines"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Line"

name

name: string = "Composite"

page

page: object

serializedName

serializedName: string = "page"

type

type: object

name

name: string = "Number"

unit

unit: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "unit"

type

type: object

allowedValues

allowedValues: string[] = ["pixel","inch"]

name

name: string = "Enum"

width

width: object

serializedName

serializedName: string = "width"

type

type: object

name

name: string = "Number"

Const Word

Word: object

serializedName

serializedName: string = "Word"

type

type: object

className

className: string = "Word"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

required

required: boolean = true

serializedName

serializedName: string = "boundingBox"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Number"

confidence

confidence: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "confidence"

type

type: object

allowedValues

allowedValues: string[] = ["High","Low"]

name

name: string = "Enum"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const descriptionExclude

descriptionExclude: object

collectionFormat

collectionFormat: any = msRest.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","descriptionExclude"]

mapper

mapper: object

serializedName

serializedName: string = "descriptionExclude"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Celebrities","Landmarks"]

name

name: string = "Enum"

Const details

details: object

collectionFormat

collectionFormat: any = msRest.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","details"]

mapper

mapper: object

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Celebrities","Landmarks"]

name

name: string = "Enum"

Const detectOrientation

detectOrientation: object

parameterPath

parameterPath: string = "detectOrientation"

mapper

mapper: object

defaultValue

defaultValue: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "detectOrientation"

type

type: object

name

name: string = "Boolean"

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "Endpoint"

type

type: object

name

name: string = "String"

Const height

height: object

parameterPath

parameterPath: string = "height"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "height"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1024

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const language0

language0: object

parameterPath

parameterPath: string[] = ["options","language"]

mapper

mapper: object

defaultValue

defaultValue: string = "en"

serializedName

serializedName: string = "language"

type

type: object

name

name: string = "String"

Const language1

language1: object

parameterPath

parameterPath: string[] = ["options","language"]

mapper

mapper: object

defaultValue

defaultValue: string = "unk"

serializedName

serializedName: string = "language"

type

type: object

allowedValues

allowedValues: string[] = ["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"]

name

name: string = "Enum"

Const maxCandidates

maxCandidates: object

parameterPath

parameterPath: string[] = ["options","maxCandidates"]

mapper

mapper: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "maxCandidates"

type

type: object

name

name: string = "Number"

Const mode

mode: object

parameterPath

parameterPath: string = "mode"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "mode"

type

type: object

allowedValues

allowedValues: string[] = ["Handwritten","Printed"]

name

name: string = "Enum"

Const model

model: object

parameterPath

parameterPath: string = "model"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "model"

type

type: object

name

name: string = "String"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: string = "String"

Const smartCropping

smartCropping: object

parameterPath

parameterPath: string[] = ["options","smartCropping"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "smartCropping"

type

type: object

name

name: string = "Boolean"

Const visualFeatures

visualFeatures: object

collectionFormat

collectionFormat: any = msRest.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","visualFeatures"]

mapper

mapper: object

serializedName

serializedName: string = "visualFeatures"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["ImageType","Faces","Adult","Categories","Color","Tags","Description","Objects","Brands"]

name

name: string = "Enum"

Const width

width: object

parameterPath

parameterPath: string = "width"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "width"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1024

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Generated using TypeDoc