{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-cognitiveservices-computervision","description":"Computer Vision API","version":"1.0","base_url":"","endpoints":9,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Computer Vision API\n@version 1.0\n@auth ApiKey Ocp-Apim-Subscription-Key in header\n@endpoints 9\n@toc models(2), analyze(1), generateThumbnail(1), ocr(1), describe(1), tag(1), recognizeText(1), textOperations(1)\n\n@group models\n@endpoint GET /models\n@desc This operation returns the list of domain-specific models that are supported by the Computer Vision API.  Currently, the API only supports one domain-specific model: a celebrity recognizer. A successful response will be returned in JSON.  If the request failed, the response will contain an error code and a message to help understand what went wrong.\n@returns(200) List of available domain models.\n\n@endgroup\n\n@group analyze\n@endpoint POST /analyze\n@desc 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.\n@optional {visualFeatures: any # A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include:Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white.Adult - detects if the image is pornographic in nature (depicts nudity or a sex act).  Sexually suggestive content is also detected., details: any # A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include:Celebrities - identifies celebrities if detected in the image., language: any # The desired language for output generation. If this parameter is not specified, the default value is \"en\".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.}\n@returns(200) The response include the extracted features in JSON format.Here is the definitions for enumeration typesClipartTypeNon-clipart = 0,  ambiguous = 1, normal-clipart = 2, good-clipart = 3.LineDrawingTypeNon-LineDrawing = 0,LineDrawing = 1.\n\n@endgroup\n\n@group generateThumbnail\n@endpoint POST /generateThumbnail\n@desc 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.\n@required {width: any # Width of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50., height: any # Height of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50.}\n@optional {smartCropping: any # Boolean flag for enabling smart cropping.}\n@returns(200) The generated thumbnail in binary format.\n\n@endgroup\n\n@group ocr\n@endpoint POST /ocr\n@desc Optical Character Recognition (OCR) detects printed text in an image and extracts the recognized characters into a machine-usable character stream.   Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage,  NotSupportedLanguage, or InternalServerError.\n@required {detectOrientation: any # Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).}\n@optional {language: any # The BCP-47 language code of the text to be detected in the image. The default value is 'unk'}\n@returns(200) The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words.textAngleThe angle, in degrees, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.\n\n@endgroup\n\n@group describe\n@endpoint POST /describe\n@desc This operation generates a description of an image in human readable language with complete sentences.  The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image.  Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL.A successful response will be returned in JSON.  If the request failed, the response will contain an error code and a message to help understand what went wrong.\n@optional {maxCandidates: any # Maximum number of candidate descriptions to be returned.  The default is 1., language: any # The desired language for output generation. If this parameter is not specified, the default value is \"en\".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.}\n@returns(200) Image description object.\n\n@endgroup\n\n@group tag\n@endpoint POST /tag\n@desc This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag 'cello' may be accompanied by the hint 'musical instrument'. All tags are in English.\n@optional {language: any # The desired language for output generation. If this parameter is not specified, the default value is \"en\".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.}\n@returns(200) Image tags object.\n\n@endgroup\n\n@group models\n@endpoint POST /models/{model}/analyze\n@desc This operation recognizes content within an image by applying a domain-specific model.  The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request.  Currently, the API only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON.  If the request failed, the response will contain an error code and a message to help understand what went wrong.\n@required {model: any # The domain-specific content to recognize.}\n@optional {language: any # The desired language for output generation. If this parameter is not specified, the default value is \"en\".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.}\n@returns(200) Analysis result based on the domain model\n\n@endgroup\n\n@group recognizeText\n@endpoint POST /recognizeText\n@desc Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Handwritten Text Operation Result operation.\n@optional {detectHandwriting: any # If 'true' is specified, handwriting recognition is performed. If this parameter is set to 'false' or is not specified, printed text recognition is performed.}\n@returns(202) The service has accepted the request and will start processing later. It will return Accepted immediately and include an Operation-Location header. Client side should further query the operation status using the URL specified in this header. The operation ID will expire in 48 hours.\n\n@endgroup\n\n@group textOperations\n@endpoint GET /textOperations/{operationId}\n@desc This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface.\n@required {operationId: any # Id of the text operation returned in the response of the 'Recognize Handwritten Text'}\n@returns(200) Returns the operation status.\n\n@endgroup\n\n@end\n"}