你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ComputerVisionClient class

Extends

构造函数

ComputerVisionClient(ServiceClientCredentials, string, ServiceClientOptions)

初始化 ComputerVisionClient 类的新实例。

继承属性

credentials
endpoint

方法

analyzeImage(string, ComputerVisionClientAnalyzeImageOptionalParams)

此操作根据图像内容提取一组丰富的可视特征。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 在请求中,有一个可选参数,用于选择要返回的功能。 默认情况下,图像类别在响应中返回。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

analyzeImage(string, ComputerVisionClientAnalyzeImageOptionalParams, ServiceCallback<ImageAnalysis>)
analyzeImage(string, ServiceCallback<ImageAnalysis>)
analyzeImageByDomain(string, string, ComputerVisionClientAnalyzeImageByDomainOptionalParams)

此操作通过应用域特定的模型来识别图像中的内容。 可以使用 /models GET 请求检索计算机视觉 API 支持的域特定模型列表。 目前,该 API 提供以下域特定的模型:名人、地标。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

analyzeImageByDomain(string, string, ComputerVisionClientAnalyzeImageByDomainOptionalParams, ServiceCallback<DomainModelResults>)
analyzeImageByDomain(string, string, ServiceCallback<DomainModelResults>)
analyzeImageByDomainInStream(string, HttpRequestBody, ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams)

此操作通过应用域特定的模型来识别图像中的内容。 可以使用 /models GET 请求检索计算机视觉 API 支持的域特定模型列表。 目前,该 API 提供以下域特定的模型:名人、地标。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

analyzeImageByDomainInStream(string, HttpRequestBody, ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams, ServiceCallback<DomainModelResults>)
analyzeImageByDomainInStream(string, HttpRequestBody, ServiceCallback<DomainModelResults>)
analyzeImageInStream(HttpRequestBody, ComputerVisionClientAnalyzeImageInStreamOptionalParams)

此操作根据图像内容提取一组丰富的可视特征。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 在请求中,有一个可选参数,用于选择要返回的功能。 默认情况下,图像类别在响应中返回。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

analyzeImageInStream(HttpRequestBody, ComputerVisionClientAnalyzeImageInStreamOptionalParams, ServiceCallback<ImageAnalysis>)
analyzeImageInStream(HttpRequestBody, ServiceCallback<ImageAnalysis>)
describeImage(string, ComputerVisionClientDescribeImageOptionalParams)

此操作使用完整的句子以人类可读语言生成图像的说明。 该说明基于内容标记的集合,而这些标记也由该操作返回。 可为每个图像生成多段说明。 说明按其置信度评分排序。 说明可能包括名人和地标域模型的结果(如果适用)。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

describeImage(string, ComputerVisionClientDescribeImageOptionalParams, ServiceCallback<ImageDescription>)
describeImage(string, ServiceCallback<ImageDescription>)
describeImageInStream(HttpRequestBody, ComputerVisionClientDescribeImageInStreamOptionalParams)

此操作使用完整的句子以人类可读语言生成图像的说明。 该说明基于内容标记的集合,而这些标记也由该操作返回。 可为每个图像生成多段说明。 说明按其置信度评分排序。 说明可能包括名人和地标域模型的结果(如果适用)。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

describeImageInStream(HttpRequestBody, ComputerVisionClientDescribeImageInStreamOptionalParams, ServiceCallback<ImageDescription>)
describeImageInStream(HttpRequestBody, ServiceCallback<ImageDescription>)
detectObjects(string, ComputerVisionClientDetectObjectsOptionalParams)

对指定的图像执行对象检测。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

detectObjects(string, ComputerVisionClientDetectObjectsOptionalParams, ServiceCallback<DetectResult>)
detectObjects(string, ServiceCallback<DetectResult>)
detectObjectsInStream(HttpRequestBody, ComputerVisionClientDetectObjectsInStreamOptionalParams)

对指定的图像执行对象检测。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

detectObjectsInStream(HttpRequestBody, ComputerVisionClientDetectObjectsInStreamOptionalParams, ServiceCallback<DetectResult>)
detectObjectsInStream(HttpRequestBody, ServiceCallback<DetectResult>)
generateThumbnail(number, number, string, ComputerVisionClientGenerateThumbnailOptionalParams)

此操作使用用户指定的宽度和高度生成缩略图。 默认情况下,服务将分析图像,标识兴趣区域 (ROI),并根据 ROI 生成智能裁剪坐标。 在指定不同于输入图像的纵横比时,智能裁剪会有所帮助。 成功的响应包含缩略图二进制文件。 如果请求失败,则响应包含错误代码和消息,以帮助确定问题所在。 失败时,将返回错误代码和错误消息。 错误代码可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、InvalidThumbnailSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 之一。

generateThumbnail(number, number, string, ComputerVisionClientGenerateThumbnailOptionalParams, ServiceCallback<void>)
generateThumbnail(number, number, string, ServiceCallback<void>)
generateThumbnailInStream(number, number, HttpRequestBody, ComputerVisionClientGenerateThumbnailInStreamOptionalParams)

此操作使用用户指定的宽度和高度生成缩略图。 默认情况下,服务将分析图像,标识兴趣区域 (ROI),并根据 ROI 生成智能裁剪坐标。 在指定不同于输入图像的纵横比时,智能裁剪会有所帮助。 成功的响应包含缩略图二进制文件。 如果请求失败,则响应包含错误代码和消息,以帮助确定问题所在。 失败时,将返回错误代码和错误消息。 错误代码可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、InvalidThumbnailSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 之一。

generateThumbnailInStream(number, number, HttpRequestBody, ComputerVisionClientGenerateThumbnailInStreamOptionalParams, ServiceCallback<void>)
generateThumbnailInStream(number, number, HttpRequestBody, ServiceCallback<void>)
getAreaOfInterest(string, ComputerVisionClientGetAreaOfInterestOptionalParams)

此操作返回围绕图像最重要区域的边框。 成功响应将以 JSON 格式返回。 如果请求失败,则响应包含错误代码和消息,以帮助确定问题所在。 失败时,将返回错误代码和错误消息。 错误代码可能是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 之一。

getAreaOfInterest(string, ComputerVisionClientGetAreaOfInterestOptionalParams, ServiceCallback<AreaOfInterestResult>)
getAreaOfInterest(string, ServiceCallback<AreaOfInterestResult>)
getAreaOfInterestInStream(HttpRequestBody, ComputerVisionClientGetAreaOfInterestInStreamOptionalParams)

此操作返回围绕图像最重要区域的边框。 成功响应将以 JSON 格式返回。 如果请求失败,则响应包含错误代码和消息,以帮助确定问题所在。 失败时,将返回错误代码和错误消息。 错误代码可能是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 之一。

getAreaOfInterestInStream(HttpRequestBody, ComputerVisionClientGetAreaOfInterestInStreamOptionalParams, ServiceCallback<AreaOfInterestResult>)
getAreaOfInterestInStream(HttpRequestBody, ServiceCallback<AreaOfInterestResult>)
getReadResult(string, RequestOptionsBase)

此接口用于获取读取操作的 OCR 结果。 应从读取接口返回的“Operation-Location”字段检索此接口的 URL。

getReadResult(string, RequestOptionsBase, ServiceCallback<ReadOperationResult>)
getReadResult(string, ServiceCallback<ReadOperationResult>)
listModels(RequestOptionsBase)

此操作返回计算机视觉 API 支持的域特定模型列表。 目前,该 API 支持以下域特定的模型:名人识别器、地标识别器。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解出错的原因。

listModels(RequestOptionsBase, ServiceCallback<ListModelsResult>)
listModels(ServiceCallback<ListModelsResult>)
read(string, ComputerVisionClientReadOptionalParams)

使用此接口获取读取操作的结果,该操作采用最先进的光学字符识别 (OCR) 算法,这些算法针对大量文本的文档进行优化。 使用 Read 接口时,响应包含一个名为“Operation-Location”的字段。 “Operation-Location”字段包含“GetReadResult”操作访问 OCR 结果时必须使用的 URL。

read(string, ComputerVisionClientReadOptionalParams, ServiceCallback<void>)
read(string, ServiceCallback<void>)
readInStream(HttpRequestBody, ComputerVisionClientReadInStreamOptionalParams)

使用此接口获取读取操作的结果,该操作采用最先进的光学字符识别 (OCR) 算法,这些算法针对大量文本的文档进行优化。 使用 Read 接口时,响应包含一个名为“Operation-Location”的字段。 “Operation-Location”字段包含“GetReadResult”操作访问 OCR 结果时必须使用的 URL。

readInStream(HttpRequestBody, ComputerVisionClientReadInStreamOptionalParams, ServiceCallback<void>)
readInStream(HttpRequestBody, ServiceCallback<void>)
recognizePrintedText(boolean, string, ComputerVisionClientRecognizePrintedTextOptionalParams)

光学字符识别 (OCR) 可以检测图像中的文本,并将识别到的字符提取到机器可用的字符流中。 成功后,将返回 OCR 结果。 失败时,将返回错误代码和错误消息。 错误代码可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage 或 InternalServerError 之一。

recognizePrintedText(boolean, string, ComputerVisionClientRecognizePrintedTextOptionalParams, ServiceCallback<OcrResult>)
recognizePrintedText(boolean, string, ServiceCallback<OcrResult>)
recognizePrintedTextInStream(boolean, HttpRequestBody, ComputerVisionClientRecognizePrintedTextInStreamOptionalParams)

光学字符识别 (OCR) 可以检测图像中的文本,并将识别到的字符提取到机器可用的字符流中。 成功后,将返回 OCR 结果。 失败时,将返回错误代码和错误消息。 错误代码可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage 或 InternalServerError 之一。

recognizePrintedTextInStream(boolean, HttpRequestBody, ComputerVisionClientRecognizePrintedTextInStreamOptionalParams, ServiceCallback<OcrResult>)
recognizePrintedTextInStream(boolean, HttpRequestBody, ServiceCallback<OcrResult>)
tagImage(string, ComputerVisionClientTagImageOptionalParams)

此操作生成与所提供图像内容相关的单词或标记列表。 计算机视觉 API 可以根据在图像中找到的对象、生物、风景或动作返回标记。 与类别不同,标记不是根据层次结构分类系统进行组织,而是对应于图像内容。 标记可以包含提示以避免歧义或提供上下文,例如标记“ascomycete”可以附带提示“fungus”。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

tagImage(string, ComputerVisionClientTagImageOptionalParams, ServiceCallback<TagResult>)
tagImage(string, ServiceCallback<TagResult>)
tagImageInStream(HttpRequestBody, ComputerVisionClientTagImageInStreamOptionalParams)

此操作生成与所提供图像内容相关的单词或标记列表。 计算机视觉 API 可以根据在图像中找到的对象、生物、风景或动作返回标记。 与类别不同,标记不是根据层次结构分类系统进行组织,而是对应于图像内容。 标记可以包含提示以避免歧义或提供上下文,例如标记“ascomycete”可以附带提示“fungus”。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

tagImageInStream(HttpRequestBody, ComputerVisionClientTagImageInStreamOptionalParams, ServiceCallback<TagResult>)
tagImageInStream(HttpRequestBody, ServiceCallback<TagResult>)

继承的方法

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

发送使用提供的 OperationSpec 填充的 HTTP 请求。

sendRequest(RequestPrepareOptions | WebResourceLike)

发送提供的 httpRequest。

构造函数详细信息

ComputerVisionClient(ServiceClientCredentials, string, ServiceClientOptions)

初始化 ComputerVisionClient 类的新实例。

new ComputerVisionClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)

参数

credentials
ServiceClientCredentials

唯一标识客户端订阅的订阅凭据。

endpoint

string

支持的认知服务终结点。

options
ServiceClientOptions

参数选项

继承属性详细信息

credentials

credentials: ServiceClientCredentials

属性值

继承自ComputerVisionClientContext.credentials

endpoint

endpoint: string

属性值

string

继承自ComputerVisionClientContext.endpoint

方法详细信息

analyzeImage(string, ComputerVisionClientAnalyzeImageOptionalParams)

此操作根据图像内容提取一组丰富的可视特征。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 在请求中,有一个可选参数,用于选择要返回的功能。 默认情况下,图像类别在响应中返回。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function analyzeImage(url: string, options?: ComputerVisionClientAnalyzeImageOptionalParams): Promise<AnalyzeImageResponse>

参数

url

string

图像的可公开访问 URL。

返回

Promise<Models.AnalyzeImageResponse>

analyzeImage(string, ComputerVisionClientAnalyzeImageOptionalParams, ServiceCallback<ImageAnalysis>)

function analyzeImage(url: string, options: ComputerVisionClientAnalyzeImageOptionalParams, callback: ServiceCallback<ImageAnalysis>)

参数

url

string

图像的可公开访问 URL。

callback

ServiceCallback<ImageAnalysis>

回调

analyzeImage(string, ServiceCallback<ImageAnalysis>)

function analyzeImage(url: string, callback: ServiceCallback<ImageAnalysis>)

参数

url

string

图像的可公开访问 URL。

callback

ServiceCallback<ImageAnalysis>

回调

analyzeImageByDomain(string, string, ComputerVisionClientAnalyzeImageByDomainOptionalParams)

此操作通过应用域特定的模型来识别图像中的内容。 可以使用 /models GET 请求检索计算机视觉 API 支持的域特定模型列表。 目前,该 API 提供以下域特定的模型:名人、地标。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function analyzeImageByDomain(model: string, url: string, options?: ComputerVisionClientAnalyzeImageByDomainOptionalParams): Promise<AnalyzeImageByDomainResponse>

参数

model

string

要识别的域特定内容。

url

string

图像的可公开访问 URL。

返回

Promise<Models.AnalyzeImageByDomainResponse>

analyzeImageByDomain(string, string, ComputerVisionClientAnalyzeImageByDomainOptionalParams, ServiceCallback<DomainModelResults>)

function analyzeImageByDomain(model: string, url: string, options: ComputerVisionClientAnalyzeImageByDomainOptionalParams, callback: ServiceCallback<DomainModelResults>)

参数

model

string

要识别的域特定内容。

url

string

图像的可公开访问 URL。

analyzeImageByDomain(string, string, ServiceCallback<DomainModelResults>)

function analyzeImageByDomain(model: string, url: string, callback: ServiceCallback<DomainModelResults>)

参数

model

string

要识别的域特定内容。

url

string

图像的可公开访问 URL。

analyzeImageByDomainInStream(string, HttpRequestBody, ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams)

此操作通过应用域特定的模型来识别图像中的内容。 可以使用 /models GET 请求检索计算机视觉 API 支持的域特定模型列表。 目前,该 API 提供以下域特定的模型:名人、地标。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, options?: ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams): Promise<AnalyzeImageByDomainInStreamResponse>

参数

model

string

要识别的域特定内容。

image
HttpRequestBody

图像流。

返回

Promise<Models.AnalyzeImageByDomainInStreamResponse>

analyzeImageByDomainInStream(string, HttpRequestBody, ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams, ServiceCallback<DomainModelResults>)

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, options: ComputerVisionClientAnalyzeImageByDomainInStreamOptionalParams, callback: ServiceCallback<DomainModelResults>)

参数

model

string

要识别的域特定内容。

image
HttpRequestBody

图像流。

analyzeImageByDomainInStream(string, HttpRequestBody, ServiceCallback<DomainModelResults>)

function analyzeImageByDomainInStream(model: string, image: HttpRequestBody, callback: ServiceCallback<DomainModelResults>)

参数

model

string

要识别的域特定内容。

image
HttpRequestBody

图像流。

analyzeImageInStream(HttpRequestBody, ComputerVisionClientAnalyzeImageInStreamOptionalParams)

此操作根据图像内容提取一组丰富的可视特征。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 在请求中,有一个可选参数,用于选择要返回的功能。 默认情况下,图像类别在响应中返回。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function analyzeImageInStream(image: HttpRequestBody, options?: ComputerVisionClientAnalyzeImageInStreamOptionalParams): Promise<AnalyzeImageInStreamResponse>

参数

image
HttpRequestBody

图像流。

返回

Promise<Models.AnalyzeImageInStreamResponse>

analyzeImageInStream(HttpRequestBody, ComputerVisionClientAnalyzeImageInStreamOptionalParams, ServiceCallback<ImageAnalysis>)

function analyzeImageInStream(image: HttpRequestBody, options: ComputerVisionClientAnalyzeImageInStreamOptionalParams, callback: ServiceCallback<ImageAnalysis>)

参数

image
HttpRequestBody

图像流。

callback

ServiceCallback<ImageAnalysis>

回调

analyzeImageInStream(HttpRequestBody, ServiceCallback<ImageAnalysis>)

function analyzeImageInStream(image: HttpRequestBody, callback: ServiceCallback<ImageAnalysis>)

参数

image
HttpRequestBody

图像流。

callback

ServiceCallback<ImageAnalysis>

回调

describeImage(string, ComputerVisionClientDescribeImageOptionalParams)

此操作使用完整的句子以人类可读语言生成图像的说明。 该说明基于内容标记的集合,而这些标记也由该操作返回。 可为每个图像生成多段说明。 说明按其置信度评分排序。 说明可能包括名人和地标域模型的结果(如果适用)。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function describeImage(url: string, options?: ComputerVisionClientDescribeImageOptionalParams): Promise<DescribeImageResponse>

参数

url

string

图像的可公开访问 URL。

返回

Promise<Models.DescribeImageResponse>

describeImage(string, ComputerVisionClientDescribeImageOptionalParams, ServiceCallback<ImageDescription>)

function describeImage(url: string, options: ComputerVisionClientDescribeImageOptionalParams, callback: ServiceCallback<ImageDescription>)

参数

url

string

图像的可公开访问 URL。

describeImage(string, ServiceCallback<ImageDescription>)

function describeImage(url: string, callback: ServiceCallback<ImageDescription>)

参数

url

string

图像的可公开访问 URL。

describeImageInStream(HttpRequestBody, ComputerVisionClientDescribeImageInStreamOptionalParams)

此操作使用完整的句子以人类可读语言生成图像的说明。 该说明基于内容标记的集合,而这些标记也由该操作返回。 可为每个图像生成多段说明。 说明按其置信度评分排序。 说明可能包括名人和地标域模型的结果(如果适用)。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function describeImageInStream(image: HttpRequestBody, options?: ComputerVisionClientDescribeImageInStreamOptionalParams): Promise<DescribeImageInStreamResponse>

参数

image
HttpRequestBody

图像流。

返回

Promise<Models.DescribeImageInStreamResponse>

describeImageInStream(HttpRequestBody, ComputerVisionClientDescribeImageInStreamOptionalParams, ServiceCallback<ImageDescription>)

function describeImageInStream(image: HttpRequestBody, options: ComputerVisionClientDescribeImageInStreamOptionalParams, callback: ServiceCallback<ImageDescription>)

参数

image
HttpRequestBody

图像流。

describeImageInStream(HttpRequestBody, ServiceCallback<ImageDescription>)

function describeImageInStream(image: HttpRequestBody, callback: ServiceCallback<ImageDescription>)

参数

image
HttpRequestBody

图像流。

detectObjects(string, ComputerVisionClientDetectObjectsOptionalParams)

对指定的图像执行对象检测。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function detectObjects(url: string, options?: ComputerVisionClientDetectObjectsOptionalParams): Promise<DetectObjectsResponse>

参数

url

string

图像的可公开访问 URL。

返回

Promise<Models.DetectObjectsResponse>

detectObjects(string, ComputerVisionClientDetectObjectsOptionalParams, ServiceCallback<DetectResult>)

function detectObjects(url: string, options: ComputerVisionClientDetectObjectsOptionalParams, callback: ServiceCallback<DetectResult>)

参数

url

string

图像的可公开访问 URL。

callback

ServiceCallback<DetectResult>

回调

detectObjects(string, ServiceCallback<DetectResult>)

function detectObjects(url: string, callback: ServiceCallback<DetectResult>)

参数

url

string

图像的可公开访问 URL。

callback

ServiceCallback<DetectResult>

回调

detectObjectsInStream(HttpRequestBody, ComputerVisionClientDetectObjectsInStreamOptionalParams)

对指定的图像执行对象检测。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function detectObjectsInStream(image: HttpRequestBody, options?: ComputerVisionClientDetectObjectsInStreamOptionalParams): Promise<DetectObjectsInStreamResponse>

参数

image
HttpRequestBody

图像流。

返回

Promise<Models.DetectObjectsInStreamResponse>

detectObjectsInStream(HttpRequestBody, ComputerVisionClientDetectObjectsInStreamOptionalParams, ServiceCallback<DetectResult>)

function detectObjectsInStream(image: HttpRequestBody, options: ComputerVisionClientDetectObjectsInStreamOptionalParams, callback: ServiceCallback<DetectResult>)

参数

image
HttpRequestBody

图像流。

callback

ServiceCallback<DetectResult>

回调

detectObjectsInStream(HttpRequestBody, ServiceCallback<DetectResult>)

function detectObjectsInStream(image: HttpRequestBody, callback: ServiceCallback<DetectResult>)

参数

image
HttpRequestBody

图像流。

callback

ServiceCallback<DetectResult>

回调

generateThumbnail(number, number, string, ComputerVisionClientGenerateThumbnailOptionalParams)

此操作使用用户指定的宽度和高度生成缩略图。 默认情况下,服务将分析图像,标识兴趣区域 (ROI),并根据 ROI 生成智能裁剪坐标。 在指定不同于输入图像的纵横比时,智能裁剪会有所帮助。 成功的响应包含缩略图二进制文件。 如果请求失败,则响应包含错误代码和消息,以帮助确定问题所在。 失败时,将返回错误代码和错误消息。 错误代码可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、InvalidThumbnailSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 之一。

function generateThumbnail(width: number, height: number, url: string, options?: ComputerVisionClientGenerateThumbnailOptionalParams): Promise<GenerateThumbnailResponse>

参数

width

number

缩略图的宽度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

height

number

缩略图的高度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

url

string

图像的可公开访问 URL。

返回

Promise<Models.GenerateThumbnailResponse>

generateThumbnail(number, number, string, ComputerVisionClientGenerateThumbnailOptionalParams, ServiceCallback<void>)

function generateThumbnail(width: number, height: number, url: string, options: ComputerVisionClientGenerateThumbnailOptionalParams, callback: ServiceCallback<void>)

参数

width

number

缩略图的宽度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

height

number

缩略图的高度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

url

string

图像的可公开访问 URL。

callback

ServiceCallback<void>

回调

generateThumbnail(number, number, string, ServiceCallback<void>)

function generateThumbnail(width: number, height: number, url: string, callback: ServiceCallback<void>)

参数

width

number

缩略图的宽度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

height

number

缩略图的高度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

url

string

图像的可公开访问 URL。

callback

ServiceCallback<void>

回调

generateThumbnailInStream(number, number, HttpRequestBody, ComputerVisionClientGenerateThumbnailInStreamOptionalParams)

此操作使用用户指定的宽度和高度生成缩略图。 默认情况下,服务将分析图像,标识兴趣区域 (ROI),并根据 ROI 生成智能裁剪坐标。 在指定不同于输入图像的纵横比时,智能裁剪会有所帮助。 成功的响应包含缩略图二进制文件。 如果请求失败,则响应包含错误代码和消息,以帮助确定问题所在。 失败时,将返回错误代码和错误消息。 错误代码可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、InvalidThumbnailSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 之一。

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, options?: ComputerVisionClientGenerateThumbnailInStreamOptionalParams): Promise<GenerateThumbnailInStreamResponse>

参数

width

number

缩略图的宽度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

height

number

缩略图的高度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

image
HttpRequestBody

图像流。

返回

Promise<Models.GenerateThumbnailInStreamResponse>

generateThumbnailInStream(number, number, HttpRequestBody, ComputerVisionClientGenerateThumbnailInStreamOptionalParams, ServiceCallback<void>)

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, options: ComputerVisionClientGenerateThumbnailInStreamOptionalParams, callback: ServiceCallback<void>)

参数

width

number

缩略图的宽度(以像素为单位)。 它必须介于 1 和 1024 之间。 建议的最小值为 50。

height

number

缩略图的高度(以像素为单位)。 它必须介于 1 到 1024 之间。 建议的最小值为 50。

image
HttpRequestBody

图像流。

callback

ServiceCallback<void>

回调

generateThumbnailInStream(number, number, HttpRequestBody, ServiceCallback<void>)

function generateThumbnailInStream(width: number, height: number, image: HttpRequestBody, callback: ServiceCallback<void>)

参数

width

number

缩略图的宽度(以像素为单位)。 它必须介于 1 到 1024 之间。 建议的最小值为 50。

height

number

缩略图的高度(以像素为单位)。 它必须介于 1 到 1024 之间。 建议的最小值为 50。

image
HttpRequestBody

图像流。

callback

ServiceCallback<void>

回调

getAreaOfInterest(string, ComputerVisionClientGetAreaOfInterestOptionalParams)

此操作返回围绕图像最重要区域的边框。 成功响应将以 JSON 格式返回。 如果请求失败,则响应包含错误代码和消息,以帮助确定问题所在。 失败时,将返回错误代码和错误消息。 错误代码可能是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 之一。

function getAreaOfInterest(url: string, options?: ComputerVisionClientGetAreaOfInterestOptionalParams): Promise<GetAreaOfInterestResponse>

参数

url

string

图像的可公开访问 URL。

返回

Promise<Models.GetAreaOfInterestResponse>

getAreaOfInterest(string, ComputerVisionClientGetAreaOfInterestOptionalParams, ServiceCallback<AreaOfInterestResult>)

function getAreaOfInterest(url: string, options: ComputerVisionClientGetAreaOfInterestOptionalParams, callback: ServiceCallback<AreaOfInterestResult>)

参数

url

string

图像的可公开访问 URL。

getAreaOfInterest(string, ServiceCallback<AreaOfInterestResult>)

function getAreaOfInterest(url: string, callback: ServiceCallback<AreaOfInterestResult>)

参数

url

string

图像的可公开访问 URL。

getAreaOfInterestInStream(HttpRequestBody, ComputerVisionClientGetAreaOfInterestInStreamOptionalParams)

此操作返回围绕图像最重要区域的边框。 成功响应将以 JSON 格式返回。 如果请求失败,则响应包含错误代码和消息,以帮助确定问题所在。 失败时,将返回错误代码和错误消息。 错误代码可能是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、FailedToProcess、Timeout 或 InternalServerError 之一。

function getAreaOfInterestInStream(image: HttpRequestBody, options?: ComputerVisionClientGetAreaOfInterestInStreamOptionalParams): Promise<GetAreaOfInterestInStreamResponse>

参数

image
HttpRequestBody

图像流。

返回

Promise<Models.GetAreaOfInterestInStreamResponse>

getAreaOfInterestInStream(HttpRequestBody, ComputerVisionClientGetAreaOfInterestInStreamOptionalParams, ServiceCallback<AreaOfInterestResult>)

function getAreaOfInterestInStream(image: HttpRequestBody, options: ComputerVisionClientGetAreaOfInterestInStreamOptionalParams, callback: ServiceCallback<AreaOfInterestResult>)

参数

image
HttpRequestBody

图像流。

getAreaOfInterestInStream(HttpRequestBody, ServiceCallback<AreaOfInterestResult>)

function getAreaOfInterestInStream(image: HttpRequestBody, callback: ServiceCallback<AreaOfInterestResult>)

参数

image
HttpRequestBody

图像流。

getReadResult(string, RequestOptionsBase)

此接口用于获取读取操作的 OCR 结果。 应从读取接口返回的“Operation-Location”字段检索此接口的 URL。

function getReadResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadResultResponse>

参数

operationId

string

在“读取”接口的响应中返回的读取操作的 ID。

options
RequestOptionsBase

可选参数

返回

Promise<Models.GetReadResultResponse>

getReadResult(string, RequestOptionsBase, ServiceCallback<ReadOperationResult>)

function getReadResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadOperationResult>)

参数

operationId

string

在“读取”接口的响应中返回的读取操作的 ID。

options
RequestOptionsBase

可选参数

getReadResult(string, ServiceCallback<ReadOperationResult>)

function getReadResult(operationId: string, callback: ServiceCallback<ReadOperationResult>)

参数

operationId

string

在“读取”接口的响应中返回的读取操作的 ID。

listModels(RequestOptionsBase)

此操作返回计算机视觉 API 支持的域特定模型列表。 目前,该 API 支持以下域特定的模型:名人识别器、地标识别器。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解出错的原因。

function listModels(options?: RequestOptionsBase): Promise<ListModelsResponse>

参数

options
RequestOptionsBase

可选参数

返回

Promise<Models.ListModelsResponse>

listModels(RequestOptionsBase, ServiceCallback<ListModelsResult>)

function listModels(options: RequestOptionsBase, callback: ServiceCallback<ListModelsResult>)

参数

options
RequestOptionsBase

可选参数

listModels(ServiceCallback<ListModelsResult>)

function listModels(callback: ServiceCallback<ListModelsResult>)

参数

read(string, ComputerVisionClientReadOptionalParams)

使用此接口获取读取操作的结果,该操作采用最先进的光学字符识别 (OCR) 算法,这些算法针对大量文本的文档进行优化。 使用 Read 接口时,响应包含一个名为“Operation-Location”的字段。 “Operation-Location”字段包含“GetReadResult”操作访问 OCR 结果时必须使用的 URL。

function read(url: string, options?: ComputerVisionClientReadOptionalParams): Promise<ReadResponse>

参数

url

string

图像的可公开访问 URL。

返回

Promise<ReadResponse>

Promise<Models.ReadResponse>

read(string, ComputerVisionClientReadOptionalParams, ServiceCallback<void>)

function read(url: string, options: ComputerVisionClientReadOptionalParams, callback: ServiceCallback<void>)

参数

url

string

图像的可公开访问 URL。

callback

ServiceCallback<void>

回调

read(string, ServiceCallback<void>)

function read(url: string, callback: ServiceCallback<void>)

参数

url

string

图像的可公开访问 URL。

callback

ServiceCallback<void>

回调

readInStream(HttpRequestBody, ComputerVisionClientReadInStreamOptionalParams)

使用此接口获取读取操作的结果,该操作采用最先进的光学字符识别 (OCR) 算法,这些算法针对大量文本的文档进行优化。 使用 Read 接口时,响应包含一个名为“Operation-Location”的字段。 “Operation-Location”字段包含“GetReadResult”操作访问 OCR 结果时必须使用的 URL。

function readInStream(image: HttpRequestBody, options?: ComputerVisionClientReadInStreamOptionalParams): Promise<ReadInStreamResponse>

参数

image
HttpRequestBody

图像流。

返回

Promise<Models.ReadInStreamResponse>

readInStream(HttpRequestBody, ComputerVisionClientReadInStreamOptionalParams, ServiceCallback<void>)

function readInStream(image: HttpRequestBody, options: ComputerVisionClientReadInStreamOptionalParams, callback: ServiceCallback<void>)

参数

image
HttpRequestBody

图像流。

callback

ServiceCallback<void>

回调

readInStream(HttpRequestBody, ServiceCallback<void>)

function readInStream(image: HttpRequestBody, callback: ServiceCallback<void>)

参数

image
HttpRequestBody

图像流。

callback

ServiceCallback<void>

回调

recognizePrintedText(boolean, string, ComputerVisionClientRecognizePrintedTextOptionalParams)

光学字符识别 (OCR) 可以检测图像中的文本,并将识别到的字符提取到机器可用的字符流中。 成功后,将返回 OCR 结果。 失败时,将返回错误代码和错误消息。 错误代码可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage 或 InternalServerError 之一。

function recognizePrintedText(detectOrientation: boolean, url: string, options?: ComputerVisionClientRecognizePrintedTextOptionalParams): Promise<RecognizePrintedTextResponse>

参数

detectOrientation

boolean

是否检测图像中的文本方向。 使用 detectOrientation=true,OCR 服务会尝试检测图像方向并在进一步处理 ((例如,如果图像方向是倒置) )之前对其进行更正。

url

string

图像的可公开访问 URL。

返回

Promise<Models.RecognizePrintedTextResponse>

recognizePrintedText(boolean, string, ComputerVisionClientRecognizePrintedTextOptionalParams, ServiceCallback<OcrResult>)

function recognizePrintedText(detectOrientation: boolean, url: string, options: ComputerVisionClientRecognizePrintedTextOptionalParams, callback: ServiceCallback<OcrResult>)

参数

detectOrientation

boolean

是否检测图像中的文本方向。 使用 detectOrientation=true,OCR 服务会尝试检测图像方向并在进一步处理 ((例如,如果图像方向是倒置) )之前对其进行更正。

url

string

图像的可公开访问 URL。

callback

ServiceCallback<OcrResult>

回调

recognizePrintedText(boolean, string, ServiceCallback<OcrResult>)

function recognizePrintedText(detectOrientation: boolean, url: string, callback: ServiceCallback<OcrResult>)

参数

detectOrientation

boolean

是否检测图像中的文本方向。 使用 detectOrientation=true,OCR 服务会尝试检测图像方向并在进一步处理 ((例如,如果图像方向是倒置) )之前对其进行更正。

url

string

图像的可公开访问 URL。

callback

ServiceCallback<OcrResult>

回调

recognizePrintedTextInStream(boolean, HttpRequestBody, ComputerVisionClientRecognizePrintedTextInStreamOptionalParams)

光学字符识别 (OCR) 可以检测图像中的文本,并将识别到的字符提取到机器可用的字符流中。 成功后,将返回 OCR 结果。 失败时,将返回错误代码和错误消息。 错误代码可以是 InvalidImageUrl、InvalidImageFormat、InvalidImageSize、NotSupportedImage、NotSupportedLanguage 或 InternalServerError 之一。

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, options?: ComputerVisionClientRecognizePrintedTextInStreamOptionalParams): Promise<RecognizePrintedTextInStreamResponse>

参数

detectOrientation

boolean

是否检测图像中的文本方向。 使用 detectOrientation=true 时,OCR 服务会尝试检测图像方向,并在进一步处理 (之前对其进行更正,例如,如果图像方向是倒置) 。

image
HttpRequestBody

图像流。

返回

Promise<Models.RecognizePrintedTextInStreamResponse>

recognizePrintedTextInStream(boolean, HttpRequestBody, ComputerVisionClientRecognizePrintedTextInStreamOptionalParams, ServiceCallback<OcrResult>)

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, options: ComputerVisionClientRecognizePrintedTextInStreamOptionalParams, callback: ServiceCallback<OcrResult>)

参数

detectOrientation

boolean

是否检测图像中的文本方向。 使用 detectOrientation=true 时,OCR 服务会尝试检测图像方向,并在进一步处理 (之前对其进行更正,例如,如果图像方向是倒置) 。

image
HttpRequestBody

图像流。

callback

ServiceCallback<OcrResult>

回调

recognizePrintedTextInStream(boolean, HttpRequestBody, ServiceCallback<OcrResult>)

function recognizePrintedTextInStream(detectOrientation: boolean, image: HttpRequestBody, callback: ServiceCallback<OcrResult>)

参数

detectOrientation

boolean

是否检测图像中的文本方向。 使用 detectOrientation=true 时,OCR 服务会尝试检测图像方向,并在进一步处理 (之前对其进行更正,例如,如果图像方向是倒置) 。

image
HttpRequestBody

图像流。

callback

ServiceCallback<OcrResult>

回调

tagImage(string, ComputerVisionClientTagImageOptionalParams)

此操作生成与所提供图像内容相关的单词或标记列表。 计算机视觉 API 可以根据在图像中找到的对象、生物、风景或动作返回标记。 与类别不同,标记不是根据层次结构分类系统进行组织,而是对应于图像内容。 标记可以包含提示以避免歧义或提供上下文,例如标记“ascomycete”可以附带提示“fungus”。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function tagImage(url: string, options?: ComputerVisionClientTagImageOptionalParams): Promise<TagImageResponse>

参数

url

string

图像的可公开访问 URL。

返回

Promise<TagImageResponse>

Promise<Models.TagImageResponse>

tagImage(string, ComputerVisionClientTagImageOptionalParams, ServiceCallback<TagResult>)

function tagImage(url: string, options: ComputerVisionClientTagImageOptionalParams, callback: ServiceCallback<TagResult>)

参数

url

string

图像的可公开访问 URL。

callback

ServiceCallback<TagResult>

回调

tagImage(string, ServiceCallback<TagResult>)

function tagImage(url: string, callback: ServiceCallback<TagResult>)

参数

url

string

图像的可公开访问 URL。

callback

ServiceCallback<TagResult>

回调

tagImageInStream(HttpRequestBody, ComputerVisionClientTagImageInStreamOptionalParams)

此操作生成与所提供图像内容相关的单词或标记列表。 计算机视觉 API 可以根据在图像中找到的对象、生物、风景或动作返回标记。 与类别不同,标记不是根据层次结构分类系统进行组织,而是对应于图像内容。 标记可以包含提示以避免歧义或提供上下文,例如标记“ascomycete”可以附带提示“fungus”。 支持两种输入方法 -- (1) 上传图像; (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含一个错误代码和一条消息,以帮助了解问题所在。

function tagImageInStream(image: HttpRequestBody, options?: ComputerVisionClientTagImageInStreamOptionalParams): Promise<TagImageInStreamResponse>

参数

image
HttpRequestBody

图像流。

返回

Promise<Models.TagImageInStreamResponse>

tagImageInStream(HttpRequestBody, ComputerVisionClientTagImageInStreamOptionalParams, ServiceCallback<TagResult>)

function tagImageInStream(image: HttpRequestBody, options: ComputerVisionClientTagImageInStreamOptionalParams, callback: ServiceCallback<TagResult>)

参数

image
HttpRequestBody

图像流。

callback

ServiceCallback<TagResult>

回调

tagImageInStream(HttpRequestBody, ServiceCallback<TagResult>)

function tagImageInStream(image: HttpRequestBody, callback: ServiceCallback<TagResult>)

参数

image
HttpRequestBody

图像流。

callback

ServiceCallback<TagResult>

回调

继承的方法详细信息

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

发送使用提供的 OperationSpec 填充的 HTTP 请求。

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

参数

operationArguments
OperationArguments

将从中填充 HTTP 请求的模板化值的参数。

operationSpec
OperationSpec

用于填充 httpRequest 的 OperationSpec。

callback

ServiceCallback<any>

收到响应时要调用的回调。

返回

Promise<RestResponse>

继承自ComputerVisionClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

发送提供的 httpRequest。

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

参数

返回

继承自ComputerVisionClientContext.sendRequest