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

Analyze - Image Stream

参考

服务:: Azure AI Services

API 版本:: 2024-02-01

分析输入图像。请求包含具有任何内容类型 ['image/*'， 'application/octet-stream'] 的图像流。

POST /imageanalysis:analyze?overload=stream&api-version=2024-02-01

具有可选参数:

POST /imageanalysis:analyze?overload=stream&features={features}&language={language}&smartcrops-aspect-ratios={smartcrops-aspect-ratios}&gender-neutral-caption={gender-neutral-caption}&api-version=2024-02-01

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string	请求的 API 版本。
features	query		VisualFeature[]	请求的视觉特征。必须至少指定一个视觉特征。
gender-neutral-caption	query		boolean	布尔标志，用于为 caption 和 denseCaptions 功能启用不分性别的字幕。如果未指定此参数，则默认值为“false”。
language	query		string	输出生成所需的语言。如果未指定此属性，则默认值为“en”。有关支持的语言列表，请参阅 https://aka.ms/cv-languages 。
smartcrops-aspect-ratios	query		array[]	要用于 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	图像流。

响应

名称	类型	说明
200 OK	ImageAnalysisResult	Success
Other Status Codes	ErrorResponse	错误标头 x-ms-error-code: string

名称

类型

说明

200 OK

ImageAnalysisResult

Success

Other Status Codes

ErrorResponse

错误

标头

x-ms-error-code: string

示例

ImageAnalysis_Analyze_MaximumSet_Gen

ImageAnalysis_Analyze_MinimumSet_Gen

ImageAnalysis_Analyze_MaximumSet_Gen

示例请求

HTTP

POST /imageanalysis:analyze?overload=stream&features=tags&language=zizuomdsxccdx&smartcrops-aspect-ratios=vqkmzmvchiwlxdaikxqrsbrpvyq&gender-neutral-caption=True&api-version=2024-02-01

"Ynl0ZXM="

示例响应

状态代码:: 200

{
  "captionResult": {
    "text": "wjtogwbozwgawzxikwsvs",
    "confidence": 0
  },
  "objectsResult": {
    "values": [
      {
        "id": "bcvupjoxcviiz",
        "boundingBox": {
          "x": 0,
          "y": 0,
          "w": 24,
          "h": 5
        },
        "tags": [
          {
            "name": "ikiqzvbmyrbuskhpphgjjuzvl",
            "confidence": 0
          }
        ]
      }
    ]
  },
  "readResult": {
    "blocks": [
      {
        "lines": [
          {
            "text": "ufmjctoebx",
            "boundingPolygon": [
              {
                "x": 0,
                "y": 0
              },
              {
                "x": 0,
                "y": 0
              },
              {
                "x": 0,
                "y": 0
              },
              {
                "x": 0,
                "y": 0
              }
            ],
            "words": [
              {
                "text": "cpcsgoi",
                "boundingPolygon": [
                  {
                    "x": 0,
                    "y": 0
                  },
                  {
                    "x": 0,
                    "y": 0
                  },
                  {
                    "x": 0,
                    "y": 0
                  },
                  {
                    "x": 0,
                    "y": 0
                  }
                ],
                "confidence": 0
              }
            ]
          }
        ]
      }
    ]
  },
  "denseCaptionsResult": {
    "values": [
      {
        "text": "hgvxqwxwqgtjfippp",
        "confidence": 0,
        "boundingBox": {
          "x": 0,
          "y": 0,
          "w": 24,
          "h": 5
        }
      }
    ]
  },
  "modelVersion": "lymqyonwrxckwzrsxjihbceclts",
  "metadata": {
    "width": 28,
    "height": 7
  },
  "tagsResult": {
    "values": [
      {
        "name": "ikiqzvbmyrbuskhpphgjjuzvl",
        "confidence": 0
      }
    ]
  },
  "smartCropsResult": {
    "values": [
      {
        "aspectRatio": 7,
        "boundingBox": {
          "x": 0,
          "y": 0,
          "w": 24,
          "h": 5
        }
      }
    ]
  },
  "peopleResult": {
    "values": [
      {
        "boundingBox": {
          "x": 0,
          "y": 0,
          "w": 24,
          "h": 5
        },
        "confidence": 0
      }
    ]
  }
}

ImageAnalysis_Analyze_MinimumSet_Gen

示例请求

HTTP

POST /imageanalysis:analyze?overload=stream&api-version=2024-02-01

"Ynl0ZXM="

示例响应

状态代码:: 200

{
  "modelVersion": "lymqyonwrxckwzrsxjihbceclts",
  "metadata": {
    "width": 28,
    "height": 7
  }
}

定义

名称	说明
BoundingBox	图像内部区域的边框。
CaptionResult	图像所描述的内容的简要说明。
ContentTag	图像中的实体观察值以及置信度分数。
CropRegion	为智能裁剪标识的区域。将为每个请求的纵横比返回一个区域。
DenseCaption	图像所描述的内容的简要说明。
DenseCaptionsResult	标题列表。
DetectedObject	描述在图像中检测到的对象。
DetectedPerson	在图像中检测到的人员。
DetectedTextBlock	检测到的文本块。
DetectedTextLine	检测到的文本行。
DetectedTextWord	由连续字符序列组成的检测到的单词。对于非空格分隔语言（如中文、日语和朝鲜语），每个字符都表示为自己的单词。
ErrorResponse	发生错误时返回的响应。
ErrorResponseDetails	错误信息。
ErrorResponseInnerError	详细错误。
ImageAnalysisResult	描述不同类型的图像分析的组合结果。
ImageMetadata	图像元数据信息，例如高度和宽度。
ImagePoint	表示图像中某个点的对象。
ObjectsResult	描述图像中检测到的对象。
PeopleResult	描述图像是否包含人员的对象。
ReadResult	读取操作的结果。
SmartCropsResult	智能裁剪结果。
TagsResult	具有置信度级别的标记列表。
VisualFeature	请求的视觉特征。必须至少指定一个视觉特征。

BoundingBox

图像内部区域的边框。

名称	类型	说明
h	integer	从区域左上角点测得的高度（以像素为单位）。
w	integer	从区域左上角点测得的宽度（以像素为单位）。
x	integer	区域左上角点的左坐标（以像素为单位）。
y	integer	区域左上角点的上坐标（以像素为单位）。

CaptionResult

图像所描述的内容的简要说明。

名称	类型	说明
confidence	number	服务在标题中的置信度级别。置信度分数的范围在 0.0 到 1.0 (非独占) ，值越高表示匹配置信度越高。
text	string	标题的文本。

ContentTag

图像中的实体观察值以及置信度分数。

名称	类型	说明
confidence	number	观察到实体的置信度。置信度分数的范围在 0.0 到 1.0 (非独占) ，值越高表示匹配置信度越高。
name	string	实体的名称。

CropRegion

为智能裁剪标识的区域。将为每个请求的纵横比返回一个区域。

名称	类型	说明
aspectRatio	number	裁剪区域的纵横比。
boundingBox	BoundingBox	图像内部区域的边框。

DenseCaption

图像所描述的内容的简要说明。

名称	类型	说明
boundingBox	BoundingBox	图像内部区域的边框。
confidence	number	服务在标题中的置信度级别。置信度分数的范围在 0.0 到 1.0 (非独占) ，值越高表示匹配置信度越高。
text	string	标题的文本。

DenseCaptionsResult

标题列表。

名称	类型	说明
values	DenseCaption[]	标题列表。

DetectedObject

描述在图像中检测到的对象。

名称	类型	说明
boundingBox	BoundingBox	图像内部区域的边框。
id	string	检测到的对象 ID。
tags	ContentTag[]	检测到的对象的分类置信度。

DetectedPerson

在图像中检测到的人员。

名称	类型	说明
boundingBox	BoundingBox	图像内部区域的边框。
confidence	number	观察到图像中的人的置信度分数。置信度分数的范围在 0.0 到 1.0 (非独占) ，值越高表示匹配置信度越高。

DetectedTextBlock

检测到的文本块。

名称	类型	说明
lines	DetectedTextLine[]	文本块中的文本行列表。

DetectedTextLine

检测到的文本行。

名称	类型	说明
boundingPolygon	ImagePoint[]	文本行的边界多边形。
text	string	检测到的文本行的文本内容。
words	DetectedTextWord[]	文本行中的单词列表。

DetectedTextWord

由连续字符序列组成的检测到的单词。对于非空格分隔语言（如中文、日语和朝鲜语），每个字符都表示为自己的单词。

名称	类型	说明
boundingPolygon	ImagePoint[]	单词的边界多边形。
confidence	number	检测到单词的置信度。置信度分数的范围在 0.0 到 1.0 (非独占) ，值越高表示匹配置信度越高。
text	string	单词的文本内容。

ErrorResponse

发生错误时返回的响应。

名称	类型	说明
error	ErrorResponseDetails	错误信息。

ErrorResponseDetails

错误信息。

名称	类型	说明
code	string	错误代码。
details	ErrorResponseDetails[]	详细错误列表。
innererror	ErrorResponseInnerError	详细错误。
message	string	错误消息。
target	string	错误的目标。

ErrorResponseInnerError

详细错误。

名称	类型	说明
code	string	错误代码。
innererror	ErrorResponseInnerError	详细错误。
message	string	错误消息。

ImageAnalysisResult

描述不同类型的图像分析的组合结果。

名称	类型	说明
captionResult	CaptionResult	图像所描述的内容的简要说明。
denseCaptionsResult	DenseCaptionsResult	标题列表。
metadata	ImageMetadata	图像元数据信息，例如高度和宽度。
modelVersion	string	模型版本。
objectsResult	ObjectsResult	描述图像中检测到的对象。
peopleResult	PeopleResult	描述图像是否包含人员的对象。
readResult	ReadResult	读取操作的结果。
smartCropsResult	SmartCropsResult	智能裁剪结果。
tagsResult	TagsResult	具有置信度级别的标记列表。

ImageMetadata

图像元数据信息，例如高度和宽度。

名称	类型	说明
height	integer	图像的高度（以像素为单位）。
width	integer	图像的宽度（以像素为单位）。

ImagePoint

表示图像中某个点的对象。

名称	类型	说明
x	integer	此点的 x 坐标。
y	integer	此点的 y 坐标。

ObjectsResult

描述图像中检测到的对象。

名称	类型	说明
values	DetectedObject[]	检测到的对象数组。

PeopleResult

描述图像是否包含人员的对象。

名称	类型	说明
values	DetectedPerson[]	检测到的人员数组。

ReadResult

读取操作的结果。

名称	类型	说明
blocks	DetectedTextBlock[]	文本块的列表。

SmartCropsResult

智能裁剪结果。

名称	类型	说明
values	CropRegion[]	建议用于裁剪图像的区域。

TagsResult

具有置信度级别的标记列表。

名称	类型	说明
values	ContentTag[]	具有置信度级别的标记列表。

VisualFeature

请求的视觉特征。必须至少指定一个视觉特征。

名称	类型	说明
caption	string	摘要图像内容的说明或标题。
denseCaptions	string	提供图像内容的深入说明的详细标题。
objects	string	在图像中识别和标记的特定对象。
people	string	检测和分析图像中的人员。
read	string	从图像中提取的文本内容，例如标志或标签。
smartCrops	string	自动生成的裁剪版本的图像，专注于重要内容。
tags	string	表示图像中检测到的对象的视觉标记。

通过

Analyze - Image Stream

URI 参数

请求正文

响应

示例

ImageAnalysis_Analyze_MaximumSet_Gen

示例请求

示例响应

ImageAnalysis_Analyze_MinimumSet_Gen

示例请求

示例响应

定义

BoundingBox

CaptionResult

ContentTag

CropRegion

DenseCaption

DenseCaptionsResult

DetectedObject

DetectedPerson

DetectedTextBlock

DetectedTextLine

DetectedTextWord

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

ImageAnalysisResult

ImageMetadata

ImagePoint

ObjectsResult

PeopleResult

ReadResult

SmartCropsResult

TagsResult

VisualFeature

其他资源