Method | Description | |
---|---|---|
AnalyzeImage ( this operations, string visualFeatures = "Categories", string details = default(string), string language = "en", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
This operation extracts a rich set of visual features based on the image content. <br> <br> 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. <br> <br> 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. <h4>Http Method</h4> POST
|
|
AnalyzeImageAsync ( this operations, string visualFeatures = "Categories", string details = default(string), string language = "en", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
This operation extracts a rich set of visual features based on the image content. <br> <br> 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. <br> <br> 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. <h4>Http Method</h4> POST
|
|
DescribeImage ( this operations, string maxCandidates = "1", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
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. <br> <br> Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. <br> <br> 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. <h4>Http Method</h4> POST
|
|
DescribeImageAsync ( this operations, string maxCandidates = "1", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
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. <br> <br> Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. <br> <br> 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. <h4>Http Method</h4> POST
|
|
GetThumbnail ( this operations, double width, double height, bool smartCropping = true, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
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 <p/> 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. <p/> Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError. <h4>Http Method</h4> POST
|
|
GetThumbnailAsync ( this operations, double width, double height, bool smartCropping = true, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
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 <p/> 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. <p/> Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError. <h4>Http Method</h4> POST
|
|
ListDomainSpecificModels ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
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. <br> <br> 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. <h4>Http Method</h4> GET
|
|
ListDomainSpecificModelsAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
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. <br> <br> 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. <h4>Http Method</h4> GET
|
|
OCR ( this operations, string language = "unk", bool detectOrientation = true, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. <p/> Upon success, the OCR results will be returned. <p/> 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. <h4>Http Method</h4> POST
|
|
OCRAsync ( this operations, string language = "unk", bool detectOrientation = true, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. <p/> Upon success, the OCR results will be returned. <p/> 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. <h4>Http Method</h4> POST
|
|
RecognizeDomainSpecificContent ( this operations, string model, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
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. <br> <br> Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. <br> <br> 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. <h4>Http Method</h4> POST
|
|
RecognizeDomainSpecificContentAsync ( this operations, string model, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
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. <br> <br> Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. <br> <br> 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. <h4>Http Method</h4> POST
|
|
TagImage ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
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. <br> <br> Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. <br> <br> 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. <h4>Http Method</h4> POST
|
|
TagImageAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
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. <br> <br> Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. <br> <br> 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. <h4>Http Method</h4> POST
|
public static AnalyzeImage ( this operations, string visualFeatures = "Categories", string details = default(string), string language = "en", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
operations | this | /// The operations group for this extension method. /// |
visualFeatures | string | /// A string indicating what visual feature types to return. Multiple values /// should be comma-separated. /// <br/>Valid visual feature types include: /// <br/> /// <ul> /// <li><b>Categories</b> - categorizes image content /// according to a taxonomy defined in documentation. </li> /// <li><b>Tags</b> - tags the image with a detailed list of /// words related to the image content. </li> /// <li><b>Description</b> - describes the image content /// with a complete English sentence. </li> /// <li><b>Faces</b> - detects if faces are present. If /// present, generate coordinates, gender and age.</li> /// <li><b >ImageType</b> - detects if image is clipart or a /// line drawing.</li> /// <li><b> Color</b> - determines the accent color, /// dominant color, and whether an image is black&white.</li> /// <li><b>Adult</b> - detects if the image is pornographic /// in nature (depicts nudity or a sex act). Sexually suggestive content is /// also detected.</li> /// </ul>. Possible values include: 'ImageType', 'Faces', 'Adult', /// 'Categories', 'Color', 'Tags', 'Description' /// |
details | string | /// A string indicating which domain-specific details to return. Multiple /// values should be comma-separated. /// <br/>Valid visual feature types include: /// <br/> /// <ul> /// <li><b >Celebrities</b> - identifies celebrities if /// detected in the image.</li> /// </ul> /// . Possible values include: 'Celebrities' /// |
language | string | /// A string indicating which language to return. The service will return /// recognition results in specified language. If this parameter is not /// specified, the default value is "en".<br /> /// Supported languages: /// <ul> /// <li><b >en</b> - English, Default.</li> /// <li><b >zh</b> - Simplified Chinese.</li> /// </ul>. Possible values include: 'en', 'zh' /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
return | void |
public static AnalyzeImageAsync ( this operations, string visualFeatures = "Categories", string details = default(string), string language = "en", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
operations | this | /// The operations group for this extension method. /// |
visualFeatures | string | /// A string indicating what visual feature types to return. Multiple values /// should be comma-separated. /// <br/>Valid visual feature types include: /// <br/> /// <ul> /// <li><b>Categories</b> - categorizes image content /// according to a taxonomy defined in documentation. </li> /// <li><b>Tags</b> - tags the image with a detailed list of /// words related to the image content. </li> /// <li><b>Description</b> - describes the image content /// with a complete English sentence. </li> /// <li><b>Faces</b> - detects if faces are present. If /// present, generate coordinates, gender and age.</li> /// <li><b >ImageType</b> - detects if image is clipart or a /// line drawing.</li> /// <li><b> Color</b> - determines the accent color, /// dominant color, and whether an image is black&white.</li> /// <li><b>Adult</b> - detects if the image is pornographic /// in nature (depicts nudity or a sex act). Sexually suggestive content is /// also detected.</li> /// </ul>. Possible values include: 'ImageType', 'Faces', 'Adult', /// 'Categories', 'Color', 'Tags', 'Description' /// |
details | string | /// A string indicating which domain-specific details to return. Multiple /// values should be comma-separated. /// <br/>Valid visual feature types include: /// <br/> /// <ul> /// <li><b >Celebrities</b> - identifies celebrities if /// detected in the image.</li> /// </ul> /// . Possible values include: 'Celebrities' /// |
language | string | /// A string indicating which language to return. The service will return /// recognition results in specified language. If this parameter is not /// specified, the default value is "en".<br /> /// Supported languages: /// <ul> /// <li><b >en</b> - English, Default.</li> /// <li><b >zh</b> - Simplified Chinese.</li> /// </ul>. Possible values include: 'en', 'zh' /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
cancellationToken | System | /// The cancellation token. /// |
return | System.Threading.Tasks.Task |
public static DescribeImage ( this operations, string maxCandidates = "1", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
operations | this | /// The operations group for this extension method. /// |
maxCandidates | string | /// Maximum number of candidate descriptions to be returned. The default is /// 1. Possible values include: '1' /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
return | void |
public static DescribeImageAsync ( this operations, string maxCandidates = "1", string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
operations | this | /// The operations group for this extension method. /// |
maxCandidates | string | /// Maximum number of candidate descriptions to be returned. The default is /// 1. Possible values include: '1' /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
cancellationToken | System | /// The cancellation token. /// |
return | System.Threading.Tasks.Task |
public static GetThumbnail ( this operations, double width, double height, bool smartCropping = true, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
operations | this | /// The operations group for this extension method. /// |
width | double | /// Width of the thumbnail. It must be between 1 and 1024. Recommended /// minimum of 50. /// |
height | double | /// Height of the thumbnail. It must be between 1 and 1024. Recommended /// minimum of 50. /// |
smartCropping | bool | /// Boolean flag for enabling smart cropping. /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
return | void |
public static GetThumbnailAsync ( this operations, double width, double height, bool smartCropping = true, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
operations | this | /// The operations group for this extension method. /// |
width | double | /// Width of the thumbnail. It must be between 1 and 1024. Recommended /// minimum of 50. /// |
height | double | /// Height of the thumbnail. It must be between 1 and 1024. Recommended /// minimum of 50. /// |
smartCropping | bool | /// Boolean flag for enabling smart cropping. /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
cancellationToken | System | /// The cancellation token. /// |
return | System.Threading.Tasks.Task |
public static ListDomainSpecificModels ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
operations | this | /// The operations group for this extension method. /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
return | void |
public static ListDomainSpecificModelsAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
operations | this | /// The operations group for this extension method. /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
cancellationToken | System | /// The cancellation token. /// |
return | System.Threading.Tasks.Task |
public static OCR ( this operations, string language = "unk", bool detectOrientation = true, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
operations | this | /// The operations group for this extension method. /// |
language | string | /// The BCP-47 language code of the text to be detected in the image.The /// default value is "unk", then the service will auto /// detect the language of the text in the image.<br /> /// <br /> /// Supported languages: /// <ul style="margin-left:.375in;direction:ltr;unicode-bidi:embed; /// margin-top:0in;margin-bottom:0in" type="disc"> /// <li>unk (AutoDetect)</li> /// <li>zh-Hans (ChineseSimplified)</li> /// <li>zh-Hant (ChineseTraditional)</li> /// <li>cs (Czech)</li> /// <li>da (Danish)</li> /// <li>nl (Dutch)</li> /// <li>en (English)</li> /// <li>fi (Finnish)</li> /// <li>fr (French)</li> /// <li>de (German)</li> /// <li>el (Greek)</li> /// <li>hu (Hungarian)</li> /// <li>it (Italian)</li> /// <li>Ja (Japanese)</li> /// <li>ko (Korean)</li> /// <li>nb (Norwegian)</li> /// <li>pl (Polish)</li> /// <li>pt (Portuguese,</li> /// <li>ru (Russian)</li> /// <li>es (Spanish)</li> /// <li>sv (Swedish)</li> /// <li>tr (Turkish)</li> /// </ul>. 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' /// |
detectOrientation | bool | /// 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). /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
return | void |
public static OCRAsync ( this operations, string language = "unk", bool detectOrientation = true, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
operations | this | /// The operations group for this extension method. /// |
language | string | /// The BCP-47 language code of the text to be detected in the image.The /// default value is "unk", then the service will auto /// detect the language of the text in the image.<br /> /// <br /> /// Supported languages: /// <ul style="margin-left:.375in;direction:ltr;unicode-bidi:embed; /// margin-top:0in;margin-bottom:0in" type="disc"> /// <li>unk (AutoDetect)</li> /// <li>zh-Hans (ChineseSimplified)</li> /// <li>zh-Hant (ChineseTraditional)</li> /// <li>cs (Czech)</li> /// <li>da (Danish)</li> /// <li>nl (Dutch)</li> /// <li>en (English)</li> /// <li>fi (Finnish)</li> /// <li>fr (French)</li> /// <li>de (German)</li> /// <li>el (Greek)</li> /// <li>hu (Hungarian)</li> /// <li>it (Italian)</li> /// <li>Ja (Japanese)</li> /// <li>ko (Korean)</li> /// <li>nb (Norwegian)</li> /// <li>pl (Polish)</li> /// <li>pt (Portuguese,</li> /// <li>ru (Russian)</li> /// <li>es (Spanish)</li> /// <li>sv (Swedish)</li> /// <li>tr (Turkish)</li> /// </ul>. 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' /// |
detectOrientation | bool | /// 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). /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
cancellationToken | System | /// The cancellation token. /// |
return | System.Threading.Tasks.Task |
public static RecognizeDomainSpecificContent ( this operations, string model, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
operations | this | /// The operations group for this extension method. /// |
model | string | /// The domain-specific content to recognize. /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
return | void |
public static RecognizeDomainSpecificContentAsync ( this operations, string model, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
operations | this | /// The operations group for this extension method. /// |
model | string | /// The domain-specific content to recognize. /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
cancellationToken | System | /// The cancellation token. /// |
return | System.Threading.Tasks.Task |
public static TagImage ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
operations | this | /// The operations group for this extension method. /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
return | void |
public static TagImageAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
operations | this | /// The operations group for this extension method. /// |
subscriptionKey | string | /// subscription key in url /// |
ocpApimSubscriptionKey | string | /// subscription key in header /// |
cancellationToken | System | /// The cancellation token. /// |
return | System.Threading.Tasks.Task |