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

ComputerVisionClientOperationsMixin 类

继承
builtins.object
ComputerVisionClientOperationsMixin

构造函数

ComputerVisionClientOperationsMixin()

方法

analyze_image

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

analyze_image_by_domain

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

analyze_image_by_domain_in_stream

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

analyze_image_in_stream

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

describe_image

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

describe_image_in_stream

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

detect_objects

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

detect_objects_in_stream

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

generate_thumbnail

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

generate_thumbnail_in_stream

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

get_area_of_interest

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

get_area_of_interest_in_stream

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

get_read_result

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

list_models

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

read

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

read_in_stream

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

recognize_printed_text

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

recognize_printed_text_in_stream

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

tag_image

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

tag_image_in_stream

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

analyze_image

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

analyze_image(url, visual_features=None, details=None, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, **operation_config)

参数

url
str
必需

图像的可公开访问 URL。

visual_features
list[strVisualFeatureTypes]
默认值: None

一个字符串,指示要返回的视觉特征类型。 多个值应以逗号分隔。 有效的视觉特征类型包括:类别 - 根据文档中定义的分类对图像内容进行分类。 标记 - 使用与图像内容相关的字词的详细列表标记图像。 Description - 用完整的英文句子描述图像内容。 人脸 - 检测人脸是否存在。 如果存在,则生成位置、性别和年龄。 ImageType - 检测图像是剪贴画还是素描。 颜色 - 确定主题色、主要颜色以及图像是否为黑&白色。 成人 - 检测图像是否是色情性质 (描绘裸体或性行为) ,或是血腥 (描绘极端暴力或血) 。 还会检测性暗示内容(也称为不雅内容)。 对象 - 检测图像中的各种对象,包括近似位置。 Objects 参数仅以英语提供。 品牌 - 检测图像中的各种品牌,包括大致位置。 品牌参数仅以英语提供。

details
list[strDetails]
默认值: None

一个字符串,指示要返回哪些特定于域的详细信息。 多个值应以逗号分隔。 有效的视觉特征类型包括:名人 - 标识名人(如果在图像中检测到),地标 - 标识图像中的显著地标。

language
str
默认值: en

输出生成所需的语言。 如果未指定此参数,则默认值为“en”。支持的语言:en - 英语,默认。 es - 西班牙语、ja - 日语、pt - 葡萄牙语、zh - 简体中文。 可能的值包括:“en”、“es”、“ja”、“pt”、“zh”

description_exclude
list[strDescriptionExclude]
默认值: None

生成说明时关闭指定的域模型。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageAnalysis 或 ClientRawResponse(如果 raw=true)

返回类型

例外

analyze_image_by_domain

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

analyze_image_by_domain(model, url, language='en', model_version='latest', custom_headers=None, raw=False, **operation_config)

参数

model
str
必需

要识别的域特定内容。

url
str
必需

图像的可公开访问 URL。

language
str
默认值: en

输出生成所需的语言。 如果未指定此参数,则默认值为“en”。支持的语言:en - 英语,默认。 es - 西班牙语、ja - 日语、pt - 葡萄牙语、zh - 简体中文。 可能的值包括:“en”、“es”、“ja”、“pt”、“zh”

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 DomainModelResults 或 ClientRawResponse

返回类型

例外

analyze_image_by_domain_in_stream

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

analyze_image_by_domain_in_stream(model, image, language='en', model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

model
str
必需

要识别的域特定内容。

image
Generator
必需

图像流。

language
str
默认值: en

输出生成所需的语言。 如果未指定此参数,则默认值为“en”。支持的语言:en - 英语,默认。 es - 西班牙语、ja - 日语、pt - 葡萄牙语、zh - 简体中文。 可能的值包括:“en”、“es”、“ja”、“pt”、“zh”

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

如果 raw=true,则 DomainModelResults 或 ClientRawResponse

返回类型

例外

analyze_image_in_stream

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

analyze_image_in_stream(image, visual_features=None, details=None, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

image
Generator
必需

图像流。

visual_features
list[strVisualFeatureTypes]
默认值: None

一个字符串,指示要返回的视觉特征类型。 多个值应以逗号分隔。 有效的视觉特征类型包括:类别 - 根据文档中定义的分类对图像内容进行分类。 标记 - 使用与图像内容相关的字词的详细列表标记图像。 Description - 用完整的英文句子描述图像内容。 人脸 - 检测人脸是否存在。 如果存在,则生成位置、性别和年龄。 ImageType - 检测图像是剪贴画还是素描。 颜色 - 确定主题色、主要颜色以及图像是否为黑&白色。 成人 - 检测图像是否是色情性质 (描绘裸体或性行为) ,或是血腥 (描绘极端暴力或血) 。 还会检测性暗示内容(也称为不雅内容)。 对象 - 检测图像中的各种对象,包括近似位置。 Objects 参数仅以英语提供。 品牌 - 检测图像中的各种品牌,包括大致位置。 品牌参数仅以英语提供。

details
list[strDetails]
默认值: None

一个字符串,指示要返回哪些特定于域的详细信息。 多个值应以逗号分隔。 有效的视觉特征类型包括:名人 - 标识名人(如果在图像中检测到),地标 - 标识图像中的显著地标。

language
str
默认值: en

输出生成所需的语言。 如果未指定此参数,则默认值为“en”。支持的语言:en - 英语,默认。 es - 西班牙语、ja - 日语、pt - 葡萄牙语、zh - 简体中文。 可能的值包括:“en”、“es”、“ja”、“pt”、“zh”

description_exclude
list[strDescriptionExclude]
默认值: None

生成说明时关闭指定的域模型。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

ImageAnalysis 或 ClientRawResponse(如果 raw=true)

返回类型

例外

describe_image

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

describe_image(url, max_candidates=1, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, **operation_config)

参数

url
str
必需

图像的可公开访问 URL。

max_candidates
int
默认值: 1

要返回的候选说明的最大数目。 默认值为 1。

language
str
默认值: en

输出生成所需的语言。 如果未指定此参数,则默认值为“en”。支持的语言:en - 英语,默认。 es - 西班牙语、ja - 日语、pt - 葡萄牙语、zh - 简体中文。 可能的值包括:“en”、“es”、“ja”、“pt”、“zh”

description_exclude
list[strDescriptionExclude]
默认值: None

生成说明时关闭指定的域模型。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 ImageDescription 或 ClientRawResponse

返回类型

例外

describe_image_in_stream

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

describe_image_in_stream(image, max_candidates=1, language='en', description_exclude=None, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

image
Generator
必需

图像流。

max_candidates
int
默认值: 1

要返回的候选说明的最大数目。 默认值为 1。

language
str
默认值: en

输出生成所需的语言。 如果未指定此参数,则默认值为“en”。支持的语言:en - 英语,默认。 es - 西班牙语、ja - 日语、pt - 葡萄牙语、zh - 简体中文。 可能的值包括:“en”、“es”、“ja”、“pt”、“zh”

description_exclude
list[strDescriptionExclude]
默认值: None

生成说明时关闭指定的域模型。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

如果 raw=true,则 ImageDescription 或 ClientRawResponse

返回类型

例外

detect_objects

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

detect_objects(url, model_version='latest', custom_headers=None, raw=False, **operation_config)

参数

url
str
必需

图像的可公开访问 URL。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 DetectResult 或 ClientRawResponse

返回类型

例外

detect_objects_in_stream

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

detect_objects_in_stream(image, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

image
Generator
必需

图像流。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

如果 raw=true,则 DetectResult 或 ClientRawResponse

返回类型

例外

generate_thumbnail

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

generate_thumbnail(width, height, url, smart_cropping=False, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

width
int
必需

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

height
int
必需

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

url
str
必需

图像的可公开访问 URL。

smart_cropping
bool
默认值: False

用于启用智能裁剪的布尔标志。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

object 或 ClientRawResponse(如果 raw=true)

返回类型

例外

generate_thumbnail_in_stream

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

generate_thumbnail_in_stream(width, height, image, smart_cropping=False, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

width
int
必需

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

height
int
必需

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

image
Generator
必需

图像流。

smart_cropping
bool
默认值: False

用于启用智能裁剪的布尔标志。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

object 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_area_of_interest

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

get_area_of_interest(url, model_version='latest', custom_headers=None, raw=False, **operation_config)

参数

url
str
必需

图像的可公开访问 URL。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 AreaOfInterestResult 或 ClientRawResponse

返回类型

例外

get_area_of_interest_in_stream

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

get_area_of_interest_in_stream(image, model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

image
Generator
必需

图像流。

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

如果 raw=true,则 AreaOfInterestResult 或 ClientRawResponse

返回类型

例外

get_read_result

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

get_read_result(operation_id, custom_headers=None, raw=False, **operation_config)

参数

operation_id
str
必需

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

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ReadOperationResult 或 ClientRawResponse(如果 raw=true)

返回类型

例外

list_models

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

list_models(custom_headers=None, raw=False, **operation_config)

参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 ListModelsResult 或 ClientRawResponse

返回类型

例外

read

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

read(url, language=None, pages=None, model_version='latest', reading_order='basic', custom_headers=None, raw=False, **operation_config)

参数

url
str
必需

图像的可公开访问 URL。

language
strOcrDetectionLanguage
默认值: None

文档中文本的 BCP-47 语言代码。 Read 支持自动语言识别和多语言文档,因此仅当你想要强制以该特定语言处理文档时,才提供语言代码。 有关支持的语言列表,请参阅 https://aka.ms/ocr-languages 。 可能的值包括:“af”、“ast”、“bi”、 'br', 'ca', 'ceb', 'ch', 'co', 'crh', 'cs', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fil', 'fj', 'fr', 'fur', 'fy', 'ga', 'gd', 'gil', 'gl', 'gv', 'hni', 'hsb', 'ht', 'hu', 'ia', 'id', 'it', 'iu', 'ja', 'jv', 'kaa', 'kac' 'kea', 'kha', 'kl', 'ko', 'ku', 'kw', 'lb', 'ms', 'mww', 'nap', 'nl', 'no', 'oc', 'pl', 'pt', 'quc', 'rm', 'sco', 'sl', 'sq', 'sv', 'sw', 'tet', 'tr', 'tt', 'uz', 'vo', 'wae', 'yua', 'za', 'zh-Hans', 'zh-Hant', 'zu'

pages
list[str]
默认值: None

多页文档的自定义页码 (PDF/TIFF) ,输入要获取 OCR 结果的页码。 对于一系列页面,请使用连字符。 用逗号分隔每个页面或区域。

model_version
str
默认值: latest

可选参数,用于指定用于文本提取的 OCR 模型的版本。 接受的值为:“latest”、“latest-preview”、“2021-04-12”。 默认为“latest”。

reading_order
str
默认值: basic

可选参数,用于指定在对提取文本元素进行排序时应应用哪种读取顺序算法。 可以是“基本”或“自然”。 如果未指定,将默认为“basic”

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则为 None 或 ClientRawResponse

返回类型

None,

例外

read_in_stream

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

read_in_stream(image, language=None, pages=None, model_version='latest', reading_order='basic', custom_headers=None, raw=False, callback=None, **operation_config)

参数

image
Generator
必需

图像流。

language
strOcrDetectionLanguage
默认值: None

文档中文本的 BCP-47 语言代码。 Read 支持自动语言识别和多语言文档,因此仅当你想要强制以该特定语言处理文档时,才提供语言代码。 有关支持的语言列表,请参阅 https://aka.ms/ocr-languages 。 可能的值包括:“af”、“ast”、“bi”、 'br', 'ca', 'ceb', 'ch', 'co', 'crh', 'cs', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fil', 'fj', 'fr', 'fur', 'fy', 'ga', 'gd', 'gil', 'gl', 'gv', 'hni', 'hsb', 'ht', 'hu', 'ia', 'id', 'it', 'iu', 'ja', 'jv', 'kaa', 'kac' 'kea', 'kha', 'kl', 'ko', 'ku', 'kw', 'lb', 'ms', 'mww', 'nap', 'nl', 'no', 'oc', 'pl', 'pt', 'quc', 'rm', 'sco', 'sl', 'sq', 'sv', 'sw', 'tet', 'tr', 'tt', 'uz', 'vo', 'wae', 'yua', 'za', 'zh-Hans', 'zh-Hant', 'zu'

pages
list[str]
默认值: None

多页文档的自定义页码 (PDF/TIFF) ,输入要获取 OCR 结果的页码。 对于一系列页面,请使用连字符。 用逗号分隔每个页面或区域。

model_version
str
默认值: latest

可选参数,用于指定用于文本提取的 OCR 模型的版本。 接受的值为:“latest”、“latest-preview”、“2021-04-12”。 默认为“latest”。

reading_order
str
默认值: basic

可选参数,用于指定在对提取文本元素进行排序时应应用哪种读取顺序算法。 可以是“基本”或“自然”。 如果未指定,将默认为“basic”

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

如果 raw=true,则为 None 或 ClientRawResponse

返回类型

None,

例外

recognize_printed_text

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

recognize_printed_text(url, detect_orientation=True, language='unk', model_version='latest', custom_headers=None, raw=False, **operation_config)

参数

detect_orientation
bool
默认值: True

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

url
str
必需

图像的可公开访问 URL。

language
strOcrLanguages
默认值: unk

图像中要检测的文本的 BCP-47 语言代码。 默认值为“unk”。 可能的值包括:“unk”、“zh-Hans”、“zh-Hant”、 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 OcrResult 或 ClientRawResponse

返回类型

例外

recognize_printed_text_in_stream

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

recognize_printed_text_in_stream(image, detect_orientation=True, language='unk', model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

detect_orientation
bool
默认值: True

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

image
Generator
必需

图像流。

language
strOcrLanguages
默认值: unk

图像中要检测的文本的 BCP-47 语言代码。 默认值为“unk”。 可能的值包括:“unk”、“zh-Hans”、“zh-Hant”、 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

如果 raw=true,则 OcrResult 或 ClientRawResponse

返回类型

例外

tag_image

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

tag_image(url, language='en', model_version='latest', custom_headers=None, raw=False, **operation_config)

参数

url
str
必需

图像的可公开访问 URL。

language
str
默认值: en

输出生成所需的语言。 如果未指定此参数,则默认值为“en”。支持的语言:en - 英语,默认。 es - 西班牙语、ja - 日语、pt - 葡萄牙语、zh - 简体中文。 可能的值包括:“en”、“es”、“ja”、“pt”、“zh”

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 TagResult 或 ClientRawResponse

返回类型

例外

tag_image_in_stream

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

tag_image_in_stream(image, language='en', model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config)

参数

image
Generator
必需

图像流。

language
str
默认值: en

输出生成所需的语言。 如果未指定此参数,则默认值为“en”。支持的语言:en - 英语,默认。 es - 西班牙语、ja - 日语、pt - 葡萄牙语、zh - 简体中文。 可能的值包括:“en”、“es”、“ja”、“pt”、“zh”

model_version
str
默认值: latest

用于指定 AI 模型版本的可选参数。 接受的值为:“latest”、“2021-04-01”。 默认为“latest”。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节和响应对象。 如果数据正在上传,响应将为“无”。

operation_config
必需

操作配置替代

返回

如果 raw=true,则 TagResult 或 ClientRawResponse

返回类型

例外