Regenerate azure-cognitiveservices-computervision package

This commit is contained in:
Kamil Pajdzik 2019-01-30 11:58:26 -08:00
Родитель 8c41fdcc70
Коммит 1995c3cbe8
39 изменённых файлов: 523 добавлений и 636 удалений

Просмотреть файл

@ -1,6 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2018 Microsoft Copyright (c) 2019 Microsoft
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

Просмотреть файл

@ -18,12 +18,13 @@
class AdultInfo { class AdultInfo {
/** /**
* Create a AdultInfo. * Create a AdultInfo.
* @member {boolean} [isAdultContent] A value indicating if the image * @property {boolean} [isAdultContent] A value indicating if the image
* contains adult-oriented content. * contains adult-oriented content.
* @member {boolean} [isRacyContent] A value indicating if the image is racy. * @property {boolean} [isRacyContent] A value indicating if the image is
* @member {number} [adultScore] Score from 0 to 1 that indicates how much * racy.
* @property {number} [adultScore] Score from 0 to 1 that indicates how much
* the content is considered adult-oriented within the image. * the content is considered adult-oriented within the image.
* @member {number} [racyScore] Score from 0 to 1 that indicates how * @property {number} [racyScore] Score from 0 to 1 that indicates how
* suggestive is the image. * suggestive is the image.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,21 +17,21 @@
class AreaOfInterestResult { class AreaOfInterestResult {
/** /**
* Create a AreaOfInterestResult. * Create a AreaOfInterestResult.
* @member {object} [areaOfInterest] A bounding box for an area of interest * @property {object} [areaOfInterest] A bounding box for an area of interest
* inside an image. * inside an image.
* @member {number} [areaOfInterest.x] X-coordinate of the top left point of * @property {number} [areaOfInterest.x] X-coordinate of the top left point
* the area, in pixels.
* @member {number} [areaOfInterest.y] Y-coordinate of the top left point of
* the area, in pixels.
* @member {number} [areaOfInterest.w] Width measured from the top-left point
* of the area, in pixels. * of the area, in pixels.
* @member {number} [areaOfInterest.h] Height measured from the top-left * @property {number} [areaOfInterest.y] Y-coordinate of the top left point
* of the area, in pixels.
* @property {number} [areaOfInterest.w] Width measured from the top-left
* point of the area, in pixels. * point of the area, in pixels.
* @member {string} [requestId] Id of the REST API request. * @property {number} [areaOfInterest.h] Height measured from the top-left
* @member {object} [metadata] * point of the area, in pixels.
* @member {number} [metadata.width] Image width, in pixels. * @property {string} [requestId] Id of the REST API request.
* @member {number} [metadata.height] Image height, in pixels. * @property {object} [metadata]
* @member {string} [metadata.format] Image format. * @property {number} [metadata.width] Image width, in pixels.
* @property {number} [metadata.height] Image height, in pixels.
* @property {string} [metadata.format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,14 +17,14 @@
class BoundingRect { class BoundingRect {
/** /**
* Create a BoundingRect. * Create a BoundingRect.
* @member {number} [x] X-coordinate of the top left point of the area, in * @property {number} [x] X-coordinate of the top left point of the area, in
* pixels. * pixels.
* @member {number} [y] Y-coordinate of the top left point of the area, in * @property {number} [y] Y-coordinate of the top left point of the area, in
* pixels. * pixels.
* @member {number} [w] Width measured from the top-left point of the area, * @property {number} [w] Width measured from the top-left point of the area,
* in pixels.
* @member {number} [h] Height measured from the top-left point of the area,
* in pixels. * in pixels.
* @property {number} [h] Height measured from the top-left point of the
* area, in pixels.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,12 +17,12 @@
class Category { class Category {
/** /**
* Create a Category. * Create a Category.
* @member {string} [name] Name of the category. * @property {string} [name] Name of the category.
* @member {number} [score] Scoring of the category. * @property {number} [score] Scoring of the category.
* @member {object} [detail] Details of the identified category. * @property {object} [detail] Details of the identified category.
* @member {array} [detail.celebrities] An array of celebrities if any * @property {array} [detail.celebrities] An array of celebrities if any
* identified. * identified.
* @member {array} [detail.landmarks] An array of landmarks if any * @property {array} [detail.landmarks] An array of landmarks if any
* identified. * identified.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,8 +17,8 @@
class CategoryDetail { class CategoryDetail {
/** /**
* Create a CategoryDetail. * Create a CategoryDetail.
* @member {array} [celebrities] An array of celebrities if any identified. * @property {array} [celebrities] An array of celebrities if any identified.
* @member {array} [landmarks] An array of landmarks if any identified. * @property {array} [landmarks] An array of landmarks if any identified.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,19 +17,19 @@
class CelebritiesModel { class CelebritiesModel {
/** /**
* Create a CelebritiesModel. * Create a CelebritiesModel.
* @member {string} [name] Name of the celebrity. * @property {string} [name] Name of the celebrity.
* @member {number} [confidence] Confidence level for the celebrity * @property {number} [confidence] Confidence level for the celebrity
* recognition as a value ranging from 0 to 1. * recognition as a value ranging from 0 to 1.
* @member {object} [faceRectangle] Location of the identified face in the * @property {object} [faceRectangle] Location of the identified face in the
* image. * image.
* @member {number} [faceRectangle.left] X-coordinate of the top left point * @property {number} [faceRectangle.left] X-coordinate of the top left point
* of the face, in pixels. * of the face, in pixels.
* @member {number} [faceRectangle.top] Y-coordinate of the top left point of * @property {number} [faceRectangle.top] Y-coordinate of the top left point
* the face, in pixels. * of the face, in pixels.
* @member {number} [faceRectangle.width] Width measured from the top-left * @property {number} [faceRectangle.width] Width measured from the top-left
* point of the face, in pixels.
* @member {number} [faceRectangle.height] Height measured from the top-left
* point of the face, in pixels. * point of the face, in pixels.
* @property {number} [faceRectangle.height] Height measured from the
* top-left point of the face, in pixels.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,12 +17,13 @@
class CelebrityResults { class CelebrityResults {
/** /**
* Create a CelebrityResults. * Create a CelebrityResults.
* @member {array} [celebrities] List of celebrities recognized in the image. * @property {array} [celebrities] List of celebrities recognized in the
* @member {string} [requestId] Id of the REST API request. * image.
* @member {object} [metadata] * @property {string} [requestId] Id of the REST API request.
* @member {number} [metadata.width] Image width, in pixels. * @property {object} [metadata]
* @member {number} [metadata.height] Image height, in pixels. * @property {number} [metadata.width] Image width, in pixels.
* @member {string} [metadata.format] Image format. * @property {number} [metadata.height] Image height, in pixels.
* @property {string} [metadata.format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,13 +17,13 @@
class ColorInfo { class ColorInfo {
/** /**
* Create a ColorInfo. * Create a ColorInfo.
* @member {string} [dominantColorForeground] Possible dominant foreground * @property {string} [dominantColorForeground] Possible dominant foreground
* color. * color.
* @member {string} [dominantColorBackground] Possible dominant background * @property {string} [dominantColorBackground] Possible dominant background
* color. * color.
* @member {array} [dominantColors] An array of possible dominant colors. * @property {array} [dominantColors] An array of possible dominant colors.
* @member {string} [accentColor] Possible accent color. * @property {string} [accentColor] Possible accent color.
* @member {boolean} [isBWImg] A value indicating if the image is black and * @property {boolean} [isBWImg] A value indicating if the image is black and
* white. * white.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,10 +17,10 @@
class ComputerVisionError { class ComputerVisionError {
/** /**
* Create a ComputerVisionError. * Create a ComputerVisionError.
* @member {object} code The error code. * @property {object} code The error code.
* @member {string} message A message explaining the error reported by the * @property {string} message A message explaining the error reported by the
* service. * service.
* @member {string} [requestId] A unique request identifier. * @property {string} [requestId] A unique request identifier.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,12 +17,12 @@
class DetectResult { class DetectResult {
/** /**
* Create a DetectResult. * Create a DetectResult.
* @member {array} [objects] An array of detected objects. * @property {array} [objects] An array of detected objects.
* @member {string} [requestId] Id of the REST API request. * @property {string} [requestId] Id of the REST API request.
* @member {object} [metadata] * @property {object} [metadata]
* @member {number} [metadata.width] Image width, in pixels. * @property {number} [metadata.width] Image width, in pixels.
* @member {number} [metadata.height] Image height, in pixels. * @property {number} [metadata.height] Image height, in pixels.
* @member {string} [metadata.format] Image format. * @property {string} [metadata.format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,25 +17,27 @@
class DetectedObject { class DetectedObject {
/** /**
* Create a DetectedObject. * Create a DetectedObject.
* @member {object} [rectangle] Approximate location of the detected object. * @property {object} [rectangle] Approximate location of the detected
* @member {number} [rectangle.x] X-coordinate of the top left point of the * object.
* @property {number} [rectangle.x] X-coordinate of the top left point of the
* area, in pixels. * area, in pixels.
* @member {number} [rectangle.y] Y-coordinate of the top left point of the * @property {number} [rectangle.y] Y-coordinate of the top left point of the
* area, in pixels. * area, in pixels.
* @member {number} [rectangle.w] Width measured from the top-left point of * @property {number} [rectangle.w] Width measured from the top-left point of
* the area, in pixels. * the area, in pixels.
* @member {number} [rectangle.h] Height measured from the top-left point of * @property {number} [rectangle.h] Height measured from the top-left point
* the area, in pixels. * of the area, in pixels.
* @member {string} [object] Label for the object. * @property {string} [object] Label for the object.
* @member {number} [confidence] Confidence score of having observed the * @property {number} [confidence] Confidence score of having observed the
* object in the image, as a value ranging from 0 to 1. * object in the image, as a value ranging from 0 to 1.
* @member {object} [parent] The parent object, from a taxonomy perspective. * @property {object} [parent] The parent object, from a taxonomy
* perspective.
* The parent object is a more generic form of this object. For example, a * The parent object is a more generic form of this object. For example, a
* 'bulldog' would have a parent of 'dog'. * 'bulldog' would have a parent of 'dog'.
* @member {string} [parent.object] Label for the object. * @property {string} [parent.object] Label for the object.
* @member {number} [parent.confidence] Confidence score of having observed * @property {number} [parent.confidence] Confidence score of having observed
* the object in the image, as a value ranging from 0 to 1. * the object in the image, as a value ranging from 0 to 1.
* @member {object} [parent.parent] The parent object, from a taxonomy * @property {object} [parent.parent] The parent object, from a taxonomy
* perspective. * perspective.
* The parent object is a more generic form of this object. For example, a * The parent object is a more generic form of this object. For example, a
* 'bulldog' would have a parent of 'dog'. * 'bulldog' would have a parent of 'dog'.

Просмотреть файл

@ -18,12 +18,12 @@
class DomainModelResults { class DomainModelResults {
/** /**
* Create a DomainModelResults. * Create a DomainModelResults.
* @member {object} [result] Model-specific response. * @property {object} [result] Model-specific response.
* @member {string} [requestId] Id of the REST API request. * @property {string} [requestId] Id of the REST API request.
* @member {object} [metadata] * @property {object} [metadata]
* @member {number} [metadata.width] Image width, in pixels. * @property {number} [metadata.width] Image width, in pixels.
* @member {number} [metadata.height] Image height, in pixels. * @property {number} [metadata.height] Image height, in pixels.
* @member {string} [metadata.format] Image format. * @property {string} [metadata.format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,19 +17,19 @@
class FaceDescription { class FaceDescription {
/** /**
* Create a FaceDescription. * Create a FaceDescription.
* @member {number} [age] Possible age of the face. * @property {number} [age] Possible age of the face.
* @member {string} [gender] Possible gender of the face. Possible values * @property {string} [gender] Possible gender of the face. Possible values
* include: 'Male', 'Female' * include: 'Male', 'Female'
* @member {object} [faceRectangle] Rectangle in the image containing the * @property {object} [faceRectangle] Rectangle in the image containing the
* identified face. * identified face.
* @member {number} [faceRectangle.left] X-coordinate of the top left point * @property {number} [faceRectangle.left] X-coordinate of the top left point
* of the face, in pixels. * of the face, in pixels.
* @member {number} [faceRectangle.top] Y-coordinate of the top left point of * @property {number} [faceRectangle.top] Y-coordinate of the top left point
* the face, in pixels. * of the face, in pixels.
* @member {number} [faceRectangle.width] Width measured from the top-left * @property {number} [faceRectangle.width] Width measured from the top-left
* point of the face, in pixels.
* @member {number} [faceRectangle.height] Height measured from the top-left
* point of the face, in pixels. * point of the face, in pixels.
* @property {number} [faceRectangle.height] Height measured from the
* top-left point of the face, in pixels.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,13 +17,13 @@
class FaceRectangle { class FaceRectangle {
/** /**
* Create a FaceRectangle. * Create a FaceRectangle.
* @member {number} [left] X-coordinate of the top left point of the face, in * @property {number} [left] X-coordinate of the top left point of the face,
* pixels. * in pixels.
* @member {number} [top] Y-coordinate of the top left point of the face, in * @property {number} [top] Y-coordinate of the top left point of the face,
* pixels. * in pixels.
* @member {number} [width] Width measured from the top-left point of the * @property {number} [width] Width measured from the top-left point of the
* face, in pixels. * face, in pixels.
* @member {number} [height] Height measured from the top-left point of the * @property {number} [height] Height measured from the top-left point of the
* face, in pixels. * face, in pixels.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,48 +17,48 @@
class ImageAnalysis { class ImageAnalysis {
/** /**
* Create a ImageAnalysis. * Create a ImageAnalysis.
* @member {array} [categories] An array indicating identified categories. * @property {array} [categories] An array indicating identified categories.
* @member {object} [adult] An object describing whether the image contains * @property {object} [adult] An object describing whether the image contains
* adult-oriented content and/or is racy. * adult-oriented content and/or is racy.
* @member {boolean} [adult.isAdultContent] A value indicating if the image * @property {boolean} [adult.isAdultContent] A value indicating if the image
* contains adult-oriented content. * contains adult-oriented content.
* @member {boolean} [adult.isRacyContent] A value indicating if the image is * @property {boolean} [adult.isRacyContent] A value indicating if the image
* racy. * is racy.
* @member {number} [adult.adultScore] Score from 0 to 1 that indicates how * @property {number} [adult.adultScore] Score from 0 to 1 that indicates how
* much the content is considered adult-oriented within the image. * much the content is considered adult-oriented within the image.
* @member {number} [adult.racyScore] Score from 0 to 1 that indicates how * @property {number} [adult.racyScore] Score from 0 to 1 that indicates how
* suggestive is the image. * suggestive is the image.
* @member {object} [color] An object providing additional metadata * @property {object} [color] An object providing additional metadata
* describing color attributes. * describing color attributes.
* @member {string} [color.dominantColorForeground] Possible dominant * @property {string} [color.dominantColorForeground] Possible dominant
* foreground color. * foreground color.
* @member {string} [color.dominantColorBackground] Possible dominant * @property {string} [color.dominantColorBackground] Possible dominant
* background color. * background color.
* @member {array} [color.dominantColors] An array of possible dominant * @property {array} [color.dominantColors] An array of possible dominant
* colors. * colors.
* @member {string} [color.accentColor] Possible accent color. * @property {string} [color.accentColor] Possible accent color.
* @member {boolean} [color.isBWImg] A value indicating if the image is black * @property {boolean} [color.isBWImg] A value indicating if the image is
* and white. * black and white.
* @member {object} [imageType] An object providing possible image types and * @property {object} [imageType] An object providing possible image types
* matching confidence levels. * and matching confidence levels.
* @member {number} [imageType.clipArtType] Confidence level that the image * @property {number} [imageType.clipArtType] Confidence level that the image
* is a clip art. * is a clip art.
* @member {number} [imageType.lineDrawingType] Confidence level that the * @property {number} [imageType.lineDrawingType] Confidence level that the
* image is a line drawing. * image is a line drawing.
* @member {array} [tags] A list of tags with confidence level. * @property {array} [tags] A list of tags with confidence level.
* @member {object} [description] A collection of content tags, along with a * @property {object} [description] A collection of content tags, along with
* list of captions sorted by confidence level, and image metadata. * a list of captions sorted by confidence level, and image metadata.
* @member {array} [description.tags] A collection of image tags. * @property {array} [description.tags] A collection of image tags.
* @member {array} [description.captions] A list of captions, sorted by * @property {array} [description.captions] A list of captions, sorted by
* confidence level. * confidence level.
* @member {array} [faces] An array of possible faces within the image. * @property {array} [faces] An array of possible faces within the image.
* @member {array} [objects] Array of objects describing what was detected in * @property {array} [objects] Array of objects describing what was detected
* the image. * in the image.
* @member {string} [requestId] Id of the REST API request. * @property {string} [requestId] Id of the REST API request.
* @member {object} [metadata] * @property {object} [metadata]
* @member {number} [metadata.width] Image width, in pixels. * @property {number} [metadata.width] Image width, in pixels.
* @member {number} [metadata.height] Image height, in pixels. * @property {number} [metadata.height] Image height, in pixels.
* @member {string} [metadata.format] Image format. * @property {string} [metadata.format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,8 +17,8 @@
class ImageCaption { class ImageCaption {
/** /**
* Create a ImageCaption. * Create a ImageCaption.
* @member {string} [text] The text of the caption. * @property {string} [text] The text of the caption.
* @member {number} [confidence] The level of confidence the service has in * @property {number} [confidence] The level of confidence the service has in
* the caption. * the caption.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -18,13 +18,14 @@
class ImageDescription { class ImageDescription {
/** /**
* Create a ImageDescription. * Create a ImageDescription.
* @member {array} [tags] A collection of image tags. * @property {array} [tags] A collection of image tags.
* @member {array} [captions] A list of captions, sorted by confidence level. * @property {array} [captions] A list of captions, sorted by confidence
* @member {string} [requestId] Id of the REST API request. * level.
* @member {object} [metadata] * @property {string} [requestId] Id of the REST API request.
* @member {number} [metadata.width] Image width, in pixels. * @property {object} [metadata]
* @member {number} [metadata.height] Image height, in pixels. * @property {number} [metadata.width] Image width, in pixels.
* @member {string} [metadata.format] Image format. * @property {number} [metadata.height] Image height, in pixels.
* @property {string} [metadata.format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -18,8 +18,9 @@
class ImageDescriptionDetails { class ImageDescriptionDetails {
/** /**
* Create a ImageDescriptionDetails. * Create a ImageDescriptionDetails.
* @member {array} [tags] A collection of image tags. * @property {array} [tags] A collection of image tags.
* @member {array} [captions] A list of captions, sorted by confidence level. * @property {array} [captions] A list of captions, sorted by confidence
* level.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,9 +17,9 @@
class ImageMetadata { class ImageMetadata {
/** /**
* Create a ImageMetadata. * Create a ImageMetadata.
* @member {number} [width] Image width, in pixels. * @property {number} [width] Image width, in pixels.
* @member {number} [height] Image height, in pixels. * @property {number} [height] Image height, in pixels.
* @member {string} [format] Image format. * @property {string} [format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,10 +17,10 @@
class ImageTag { class ImageTag {
/** /**
* Create a ImageTag. * Create a ImageTag.
* @member {string} [name] Name of the entity. * @property {string} [name] Name of the entity.
* @member {number} [confidence] The level of confidence that the entity was * @property {number} [confidence] The level of confidence that the entity
* observed. * was observed.
* @member {string} [hint] Optional hint/details for this tag. * @property {string} [hint] Optional hint/details for this tag.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,9 +17,9 @@
class ImageType { class ImageType {
/** /**
* Create a ImageType. * Create a ImageType.
* @member {number} [clipArtType] Confidence level that the image is a clip * @property {number} [clipArtType] Confidence level that the image is a clip
* art. * art.
* @member {number} [lineDrawingType] Confidence level that the image is a * @property {number} [lineDrawingType] Confidence level that the image is a
* line drawing. * line drawing.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -16,7 +16,7 @@
class ImageUrl { class ImageUrl {
/** /**
* Create a ImageUrl. * Create a ImageUrl.
* @member {string} url Publicly reachable URL of an image. * @property {string} url Publicly reachable URL of an image.
*/ */
constructor() { constructor() {
} }

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -17,12 +17,12 @@
class LandmarkResults { class LandmarkResults {
/** /**
* Create a LandmarkResults. * Create a LandmarkResults.
* @member {array} [landmarks] List of landmarks recognized in the image. * @property {array} [landmarks] List of landmarks recognized in the image.
* @member {string} [requestId] Id of the REST API request. * @property {string} [requestId] Id of the REST API request.
* @member {object} [metadata] * @property {object} [metadata]
* @member {number} [metadata.width] Image width, in pixels. * @property {number} [metadata.width] Image width, in pixels.
* @member {number} [metadata.height] Image height, in pixels. * @property {number} [metadata.height] Image height, in pixels.
* @member {string} [metadata.format] Image format. * @property {string} [metadata.format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,8 +17,8 @@
class LandmarksModel { class LandmarksModel {
/** /**
* Create a LandmarksModel. * Create a LandmarksModel.
* @member {string} [name] Name of the landmark. * @property {string} [name] Name of the landmark.
* @member {number} [confidence] Confidence level for the landmark * @property {number} [confidence] Confidence level for the landmark
* recognition as a value ranging from 0 to 1. * recognition as a value ranging from 0 to 1.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -16,9 +16,9 @@
class Line { class Line {
/** /**
* Create a Line. * Create a Line.
* @member {array} [boundingBox] * @property {array} [boundingBox]
* @member {string} [text] * @property {string} [text]
* @member {array} [words] * @property {array} [words]
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,7 +17,7 @@
class ListModelsResult { class ListModelsResult {
/** /**
* Create a ListModelsResult. * Create a ListModelsResult.
* @member {array} [modelsProperty] An array of supported models. * @property {array} [modelsProperty] An array of supported models.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,8 +17,8 @@
class ModelDescription { class ModelDescription {
/** /**
* Create a ModelDescription. * Create a ModelDescription.
* @member {string} [name] The name of the model. * @property {string} [name] The name of the model.
* @member {array} [categories] Categories of the model. * @property {array} [categories] Categories of the model.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,10 +17,11 @@
class ObjectHierarchy { class ObjectHierarchy {
/** /**
* Create a ObjectHierarchy. * Create a ObjectHierarchy.
* @member {string} [object] Label for the object. * @property {string} [object] Label for the object.
* @member {number} [confidence] Confidence score of having observed the * @property {number} [confidence] Confidence score of having observed the
* object in the image, as a value ranging from 0 to 1. * object in the image, as a value ranging from 0 to 1.
* @member {object} [parent] The parent object, from a taxonomy perspective. * @property {object} [parent] The parent object, from a taxonomy
* perspective.
* The parent object is a more generic form of this object. For example, a * The parent object is a more generic form of this object. For example, a
* 'bulldog' would have a parent of 'dog'. * 'bulldog' would have a parent of 'dog'.
*/ */

Просмотреть файл

@ -17,14 +17,14 @@
class OcrLine { class OcrLine {
/** /**
* Create a OcrLine. * Create a OcrLine.
* @member {string} [boundingBox] Bounding box of a recognized line. The four * @property {string} [boundingBox] Bounding box of a recognized line. The
* integers represent the x-coordinate of the left edge, the y-coordinate of * four integers represent the x-coordinate of the left edge, the
* the top edge, width, and height of the bounding box, in the coordinate * y-coordinate of the top edge, width, and height of the bounding box, in
* system of the input image, after it has been rotated around its center * the coordinate system of the input image, after it has been rotated around
* according to the detected text angle (see textAngle property), with the * its center according to the detected text angle (see textAngle property),
* origin at the top-left corner, and the y-axis pointing down. * with the origin at the top-left corner, and the y-axis pointing down.
* @member {array} [words] An array of objects, where each object represents * @property {array} [words] An array of objects, where each object
* a recognized word. * represents a recognized word.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -18,13 +18,13 @@
class OcrRegion { class OcrRegion {
/** /**
* Create a OcrRegion. * Create a OcrRegion.
* @member {string} [boundingBox] Bounding box of a recognized region. The * @property {string} [boundingBox] Bounding box of a recognized region. The
* four integers represent the x-coordinate of the left edge, 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 * 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 * the coordinate system of the input image, after it has been rotated around
* its center according to the detected text angle (see textAngle property), * 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. * with the origin at the top-left corner, and the y-axis pointing down.
* @member {array} [lines] An array of recognized lines of text. * @property {array} [lines] An array of recognized lines of text.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -16,9 +16,9 @@
class OcrResult { class OcrResult {
/** /**
* Create a OcrResult. * Create a OcrResult.
* @member {string} [language] The BCP-47 language code of the text in the * @property {string} [language] The BCP-47 language code of the text in the
* image. * image.
* @member {number} [textAngle] The angle, in degrees, of the detected text * @property {number} [textAngle] The angle, in degrees, of the detected text
* with respect to the closest horizontal or vertical direction. After * with respect to the closest horizontal or vertical direction. After
* rotating the input image clockwise by this angle, the recognized text * rotating the input image clockwise by this angle, the recognized text
* lines become horizontal or vertical. In combination with the orientation * lines become horizontal or vertical. In combination with the orientation
@ -28,12 +28,12 @@ class OcrResult {
* the angle cannot be confidently detected, this property is not present. 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 * the image contains text at different angles, only part of the text will be
* recognized correctly. * recognized correctly.
* @member {string} [orientation] Orientation of the text recognized in the * @property {string} [orientation] Orientation of the text recognized in the
* image. The value (up, down, left, or right) refers to the direction that * 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 * 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 * around its center according to the detected text angle (see textAngle
* property). * property).
* @member {array} [regions] An array of objects, where each object * @property {array} [regions] An array of objects, where each object
* represents a region of recognized text. * represents a region of recognized text.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,13 +17,13 @@
class OcrWord { class OcrWord {
/** /**
* Create a OcrWord. * Create a OcrWord.
* @member {string} [boundingBox] Bounding box of a recognized word. The four * @property {string} [boundingBox] Bounding box of a recognized word. The
* integers represent the x-coordinate of the left edge, the y-coordinate of * four integers represent the x-coordinate of the left edge, the
* the top edge, width, and height of the bounding box, in the coordinate * y-coordinate of the top edge, width, and height of the bounding box, in
* system of the input image, after it has been rotated around its center * the coordinate system of the input image, after it has been rotated around
* according to the detected text angle (see textAngle property), with the * its center according to the detected text angle (see textAngle property),
* origin at the top-left corner, and the y-axis pointing down. * with the origin at the top-left corner, and the y-axis pointing down.
* @member {string} [text] String value of a recognized word. * @property {string} [text] String value of a recognized word.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -16,7 +16,7 @@
class RecognitionResult { class RecognitionResult {
/** /**
* Create a RecognitionResult. * Create a RecognitionResult.
* @member {array} [lines] * @property {array} [lines]
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,12 +17,12 @@
class TagResult { class TagResult {
/** /**
* Create a TagResult. * Create a TagResult.
* @member {array} [tags] A list of tags with confidence level. * @property {array} [tags] A list of tags with confidence level.
* @member {string} [requestId] Id of the REST API request. * @property {string} [requestId] Id of the REST API request.
* @member {object} [metadata] * @property {object} [metadata]
* @member {number} [metadata.width] Image width, in pixels. * @property {number} [metadata.width] Image width, in pixels.
* @member {number} [metadata.height] Image height, in pixels. * @property {number} [metadata.height] Image height, in pixels.
* @member {string} [metadata.format] Image format. * @property {string} [metadata.format] Image format.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -16,10 +16,10 @@
class TextOperationResult { class TextOperationResult {
/** /**
* Create a TextOperationResult. * Create a TextOperationResult.
* @member {string} [status] Status of the text operation. Possible values * @property {string} [status] Status of the text operation. Possible values
* include: 'Not Started', 'Running', 'Failed', 'Succeeded' * include: 'Not Started', 'Running', 'Failed', 'Succeeded'
* @member {object} [recognitionResult] * @property {object} [recognitionResult]
* @member {array} [recognitionResult.lines] * @property {array} [recognitionResult.lines]
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -16,8 +16,8 @@
class Word { class Word {
/** /**
* Create a Word. * Create a Word.
* @member {array} [boundingBox] * @property {array} [boundingBox]
* @member {string} [text] * @property {string} [text]
*/ */
constructor() { constructor() {
} }