Image Analysis - Analyze Stream
分析输入图像。 请求要么包含具有任何内容类型 ['image/*', 'application/octet-stream'] 的图像流,要么包含 JSON 有效负载,其中包含用于检索图像流的 URL 属性。
POST /imageanalysis:analyze?overload=stream&api-version=2023-04-01-preview
POST /imageanalysis:analyze?overload=stream&features={features}&model-name={model-name}&language={language}&smartcrops-aspect-ratios={smartcrops-aspect-ratios}&gender-neutral-caption={gender-neutral-caption}&api-version=2023-04-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
api-version
|
query | True |
string |
请求的 API 版本。 |
features
|
query |
请求的视觉功能:标记、对象、标题、密集Captions、读取、smartCrops、人员。 如果未指定参数“model-name”,则需要指定此参数。 |
||
gender-neutral-caption
|
query |
boolean |
用于为字幕和密集Captions 功能启用性别中性字幕的布尔标志。 如果未指定此参数,则默认值为“false”。 |
|
language
|
query |
string |
输出生成所需的语言。 如果未指定此参数,则默认值为“en”。 有关支持的语言列表,请参阅 https://aka.ms/cv-languages。 |
|
model-name
|
query |
string |
自定义训练模型的名称。 如果未指定参数“features”,则需要指定此参数。 |
|
smartcrops-aspect-ratios
|
query |
string |
用于 smartCrops 功能的纵横比列表。 纵横比是通过将目标裁剪宽度除以高度来计算的。 支持的值介于 0.75 和 1.8 之间(含)。 多个值应以逗号分隔。 如果未指定此参数,服务将返回一个具有纵横比的裁剪建议(包括 0.5 和 2.0)。 |
请求正文
Media Types: "application/octet-stream", "image/jpeg", "image/gif", "image/tiff", "image/bmp", "image/png"
名称 | 类型 | 说明 |
---|---|---|
body |
string (byte) |
图像流。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功 |
|
Other Status Codes |
错误 标头 x-ms-error-code: string |
示例
AnalyzeImageFromImageStream_CustomModel
示例请求
POST /imageanalysis:analyze?overload=stream&model-name=my_model_name&api-version=2023-04-01-preview
"Ynl0ZXM="
示例响应
{
"modelVersion": "2023-04-01-preview",
"customModelResult": {
"objectsResult": {
"values": [
{
"id": "1",
"boundingBox": {
"x": 197,
"y": 68,
"w": 356,
"h": 394
},
"tags": [
{
"name": "class1",
"confidence": 0.92431640625
}
]
},
{
"id": "2",
"boundingBox": {
"x": 0,
"y": 77,
"w": 241,
"h": 359
},
"tags": [
{
"name": "class1",
"confidence": 0.87890625
}
]
}
]
}
},
"metadata": {
"width": 660,
"height": 495
}
}
定义
名称 | 说明 |
---|---|
Adult |
描述成人内容匹配的对象。 |
Adult |
描述图像是否包含面向成人的内容和/或不雅的对象。 |
Bounding |
图像内区域的边界框。 |
Caption |
有关图像所描述的内容的简要说明。 |
Crop |
为智能裁剪标识的区域。 对于每个请求的纵横比,将返回一个区域。 |
Dense |
有关图像所描述的内容的简要说明。 |
Dense |
标题列表。 |
Detected |
描述在图像中检测到的对象。 |
Detected |
图像中检测到的人员。 |
Document |
内容行对象,由相邻的内容元素序列(如字词和选择标记)组成。 |
Document |
从输入页中提取的内容和布局元素。 |
Document |
串联内容属性的连续区域,指定为偏移量和长度。 |
Document |
表示观察到的文本样式的对象。 |
Document |
由连续字符序列组成的单词对象。 对于非空格分隔语言(如中文、日语和朝鲜语),每个字符都表示为自己的单词。 |
Error |
发生错误时返回的响应。 |
Error |
错误信息。 |
Error |
详细错误。 |
Image |
描述不同类型的图像分析的组合结果。 |
Image |
图像元数据信息,如高度和宽度。 |
Image |
描述图像的预测结果。 |
Objects |
描述图像中检测到的对象。 |
People |
描述图像是否包含人员的对象。 |
Read |
读取作的结果。 |
Smart |
智能裁剪结果。 |
Tag |
图像中的实体观察以及置信度分数。 |
Tags |
具有置信度标记的列表。 |
Visual |
请求的视觉功能:标记、对象、标题、密集Captions、读取、smartCrops、人员。 如果未指定参数“model-name”,则需要指定此参数。 |
AdultMatch
描述成人内容匹配的对象。
名称 | 类型 | 说明 |
---|---|---|
confidence |
number (double) minimum: 0maximum: 1 |
一个值,指示匹配成人内容的置信度。 |
isMatch |
boolean |
一个值,该值指示图像是否与成人内容匹配。 |
AdultResult
描述图像是否包含面向成人的内容和/或不雅的对象。
名称 | 类型 | 说明 |
---|---|---|
adult |
描述成人内容匹配的对象。 |
|
gore |
描述成人内容匹配的对象。 |
|
racy |
描述成人内容匹配的对象。 |
BoundingBox
图像内区域的边界框。
名称 | 类型 | 说明 |
---|---|---|
h |
integer (int32) minimum: 1 |
从区域左上角(以像素为单位)测量的高度。 |
w |
integer (int32) minimum: 1 |
从区域的左上角点(以像素为单位)测量的宽度。 |
x |
integer (int32) minimum: 0 |
区域左上角点的左坐标(以像素为单位)。 |
y |
integer (int32) minimum: 0 |
区域左上角点的上坐标(以像素为单位)。 |
CaptionResult
有关图像所描述的内容的简要说明。
名称 | 类型 | 说明 |
---|---|---|
confidence |
number (double) minimum: 0maximum: 1 |
服务在标题中具有的置信度级别。 |
text |
string minLength: 1 |
标题的文本。 |
CropRegion
为智能裁剪标识的区域。 对于每个请求的纵横比,将返回一个区域。
名称 | 类型 | 说明 |
---|---|---|
aspectRatio |
number (double) |
裁剪区域的纵横比。 |
boundingBox |
图像内区域的边界框。 |
DenseCaption
有关图像所描述的内容的简要说明。
名称 | 类型 | 说明 |
---|---|---|
boundingBox |
图像内区域的边界框。 |
|
confidence |
number (double) minimum: 0maximum: 1 |
服务在标题中具有的置信度级别。 |
text |
string minLength: 1 |
标题的文本。 |
DenseCaptionsResult
标题列表。
名称 | 类型 | 说明 |
---|---|---|
values |
标题列表。 |
DetectedObject
描述在图像中检测到的对象。
名称 | 类型 | 说明 |
---|---|---|
boundingBox |
图像内区域的边界框。 |
|
id |
string minLength: 1 |
检测到的对象 ID。 |
tags |
Tag[] |
检测到的对象的分类置信度。 |
DetectedPerson
图像中检测到的人员。
名称 | 类型 | 说明 |
---|---|---|
boundingBox |
图像内区域的边界框。 |
|
confidence |
number (double) minimum: 0maximum: 1 |
观察图像中人员的置信度分数,值为 0 到 1。 |
DocumentLine
内容行对象,由相邻的内容元素序列(如字词和选择标记)组成。
名称 | 类型 | 说明 |
---|---|---|
boundingBox |
number[] (double) |
线条的边界框。 |
content |
string minLength: 1 |
按阅读顺序连接包含元素的内容。 |
spans |
阅读顺序中行的位置连接内容。 |
DocumentPage
从输入页中提取的内容和布局元素。
名称 | 类型 | 说明 |
---|---|---|
angle |
number (double) |
内容以顺时针方向的一般方向,以度为单位(-180,180)。 |
height |
number (double) |
图像/PDF 的高度(以像素/英寸为单位)。 |
lines |
从页面中提取的行,可能同时包含文本元素和视觉元素。 |
|
pageNumber |
integer (int32) |
输入文档中基于 1 的页码。 |
spans |
页面在阅读顺序中连接内容的位置。 |
|
width |
number (double) |
图像/PDF 的宽度(以像素/英寸为单位)。 |
words |
从页面中提取的字词。 |
DocumentSpan
串联内容属性的连续区域,指定为偏移量和长度。
名称 | 类型 | 说明 |
---|---|---|
length |
integer (int32) |
范围所表示的内容中的字符数。 |
offset |
integer (int32) |
范围所表示的内容的从零开始的索引。 |
DocumentStyle
表示观察到的文本样式的对象。
名称 | 类型 | 说明 |
---|---|---|
confidence |
number (double) |
正确标识样式的置信度。 |
isHandwritten |
boolean |
内容是否手写。 |
spans |
样式应用于的串联内容中文本元素的位置。 |
DocumentWord
由连续字符序列组成的单词对象。 对于非空格分隔语言(如中文、日语和朝鲜语),每个字符都表示为自己的单词。
名称 | 类型 | 说明 |
---|---|---|
boundingBox |
number[] (double) |
单词的边界框。 |
confidence |
number (double) |
正确提取单词的置信度。 |
content |
string minLength: 1 |
单词的文本内容。 |
span |
串联内容属性的连续区域,指定为偏移量和长度。 |
ErrorResponse
发生错误时返回的响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误信息。 |
ErrorResponseDetails
错误信息。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
详细错误列表。 |
|
innererror |
详细错误。 |
|
message |
string |
错误信息。 |
target |
string |
错误的目标。 |
ErrorResponseInnerError
详细错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
innererror |
详细错误。 |
|
message |
string |
错误信息。 |
ImageAnalysisResult
描述不同类型的图像分析的组合结果。
名称 | 类型 | 说明 |
---|---|---|
adultResult |
描述图像是否包含面向成人的内容和/或不雅的对象。 |
|
captionResult |
有关图像所描述的内容的简要说明。 |
|
customModelResult |
描述图像的预测结果。 |
|
denseCaptionsResult |
标题列表。 |
|
metadata |
图像元数据信息,如高度和宽度。 |
|
modelVersion |
string minLength: 1 |
模型版本。 |
objectsResult |
描述图像中检测到的对象。 |
|
peopleResult |
描述图像是否包含人员的对象。 |
|
readResult |
读取作的结果。 |
|
smartCropsResult |
智能裁剪结果。 |
|
tagsResult |
具有置信度标记的列表。 |
ImageMetadataApiModel
图像元数据信息,如高度和宽度。
名称 | 类型 | 说明 |
---|---|---|
height |
integer (int32) minimum: 1 |
图像的高度(以像素为单位)。 |
width |
integer (int32) minimum: 1 |
图像的宽度(以像素为单位)。 |
ImagePredictionResult
描述图像的预测结果。
名称 | 类型 | 说明 |
---|---|---|
objectsResult |
描述图像中检测到的对象。 |
|
tagsResult |
具有置信度标记的列表。 |
ObjectsResult
描述图像中检测到的对象。
名称 | 类型 | 说明 |
---|---|---|
values |
检测到的对象数组。 |
PeopleResult
描述图像是否包含人员的对象。
名称 | 类型 | 说明 |
---|---|---|
values |
检测到的人员数组。 |
ReadResult
读取作的结果。
名称 | 类型 | 说明 |
---|---|---|
content |
string minLength: 1 |
按阅读顺序连接所有文本元素和视觉元素的字符串表示形式。 |
pages |
已分析页面的列表。 |
|
stringIndexType |
string minLength: 1 |
用于计算字符串偏移量和长度的方法包括:“textElements”、“unicodeCodePoint”、“utf16CodeUnit”等。 |
styles |
提取的字体样式。 |
SmartCropsResult
智能裁剪结果。
名称 | 类型 | 说明 |
---|---|---|
values |
用于裁剪图像的建议区域。 |
Tag
图像中的实体观察以及置信度分数。
名称 | 类型 | 说明 |
---|---|---|
confidence |
number (double) minimum: 0maximum: 1 |
观察到实体的置信度级别。 |
name |
string minLength: 1 |
实体的名称。 |
TagsResult
具有置信度标记的列表。
名称 | 类型 | 说明 |
---|---|---|
values |
Tag[] |
具有置信度标记的列表。 |
VisualFeature
请求的视觉功能:标记、对象、标题、密集Captions、读取、smartCrops、人员。 如果未指定参数“model-name”,则需要指定此参数。
值 | 说明 |
---|---|
caption | |
denseCaptions | |
objects | |
people | |
read | |
smartCrops | |
tags |