Analyze Image In Stream - Analyze Image In Stream

參考

服務:: Azure AI Services

API 版本:: 3.2

這項作業會根據影像內容擷取一組豐富的視覺功能。支援兩個輸入法 -- (1) 上傳影像或 (2) 指定影像 URL。在您的要求中，有選擇性參數可讓您選擇要傳回的功能。根據預設，影像類別會在響應中傳回。成功的回應將會以 JSON 傳回。如果要求失敗，回應會包含錯誤碼和訊息，以協助了解發生錯誤的原因。

POST {Endpoint}/vision/v3.2/analyze

含選擇性參數:

POST {Endpoint}/vision/v3.2/analyze?overload=stream&visualFeatures={visualFeatures}&details={details}&language={language}&descriptionExclude={descriptionExclude}&model-version={model-version}

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點。
descriptionExclude	query		DescriptionExclude[]	產生描述時關閉指定的領域模型。
details	query		Details[]	字串，表示要傳回哪些網域特定詳細數據。多個值應該以逗號分隔。有效的視覺功能類型包括：名人 - 識別影像中偵測到的名人、地標 - 識別影像中值得注意的地標。
language	query		string	輸出產生所需的語言。如果未指定此屬性，則預設值為 "en"。如需支援的語言清單，請參閱 https://aka.ms/cv-languages 。
model-version	query		string	選擇性參數，可指定 AI 模型的版本。接受的值包括：“latest”、“2021-04-01”、“2021-05-01”。預設為「latest」。。 Regex 模式: `^(latest\|\d{4}-\d{2}-\d{2})(-preview)?$`
visualFeatures	query		VisualFeatureTypes[]	字串，表示要傳回哪些視覺功能類型。多個值應該以逗號分隔。有效的視覺功能類型包括：類別 - 根據檔中定義的分類法分類影像內容。標記 - 使用與影像內容相關的詳細單字清單來標記影像。說明 - 用完整的英文句子說明映像內容。臉部 - 偵測臉部是否存在。若有的話，會產生座標、性別和年齡。 ImageType - 偵測映像是美工圖案或線條繪圖。色彩 - 決定輔色、主要色彩，以及影像是否為黑色&白色。成人 - 偵測影像在本質上是否為暴力， (描述裸體或性行為) ， (或是鑞描述極端暴力或血) 。也會偵測出性暗示內容 (也就是挑逗內容)。物件 - 偵測影像內的各種物件，包括近似位置。物品引數僅於英文版中提供。品牌 - 偵測影像內的各種品牌，包括近似位置。品牌引數僅於英文版中提供。

要求標頭

Media Types: "application/octet-stream", "multipart/form-data"

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

要求本文

Media Types: "application/octet-stream", "multipart/form-data"

名稱	類型	Description
Image	object	影像數據流。

回應

名稱	類型	Description
200 OK	ImageAnalysis	回應包含 JSON 格式的擷取特徵。以下是列舉型別的定義： ClipartType 非 - 美工圖案 = 0，模棱兩可 = 1，一般 - 美工圖案 = 2，良好 - 美工圖案 = 3。 LineDrawingTypeNon - LineDrawing = 0，LineDrawing = 1。
Other Status Codes	ComputerVisionErrorResponse	錯誤回應。

名稱

類型

Description

200 OK

ImageAnalysis

回應包含 JSON 格式的擷取特徵。以下是列舉型別的定義：

ClipartType

非 - 美工圖案 = 0，模棱兩可 = 1，一般 - 美工圖案 = 2，良好 - 美工圖案 = 3。 LineDrawingTypeNon - LineDrawing = 0，LineDrawing = 1。

Other Status Codes

ComputerVisionErrorResponse

錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

Successful AnalyzeImage request

範例要求

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/analyze?overload=stream&visualFeatures=Categories,Adult,Tags,Description,Faces,Color,ImageType,Objects,Brands&details=Celebrities,Landmarks&language=en


"{binary}"

範例回覆

狀態碼:: 200

{
  "categories": [
    {
      "name": "abstract_",
      "score": 0.00390625
    },
    {
      "name": "people_",
      "score": 0.83984375,
      "detail": {
        "celebrities": [
          {
            "name": "Satya Nadella",
            "faceRectangle": {
              "left": 597,
              "top": 162,
              "width": 248,
              "height": 248
            },
            "confidence": 0.999028444
          }
        ],
        "landmarks": [
          {
            "name": "Forbidden City",
            "confidence": 0.9978346
          }
        ]
      }
    }
  ],
  "adult": {
    "isAdultContent": false,
    "isRacyContent": false,
    "isGoryContent": false,
    "adultScore": 0.0934349000453949,
    "racyScore": 0.06861349195241928,
    "goreScore": 0.012872257380997575
  },
  "tags": [
    {
      "name": "person",
      "confidence": 0.9897908568382263
    },
    {
      "name": "man",
      "confidence": 0.9449388980865479
    },
    {
      "name": "outdoor",
      "confidence": 0.938492476940155
    },
    {
      "name": "window",
      "confidence": 0.8951393961906433
    },
    {
      "name": "pangolin",
      "confidence": 0.7250059783791661,
      "hint": "mammal"
    }
  ],
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      }
    ]
  },
  "requestId": "0dbec5ad-a3d3-4f7e-96b4-dfd57efe967d",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  },
  "modelVersion": "2021-04-01",
  "faces": [
    {
      "age": 44,
      "gender": "Male",
      "faceRectangle": {
        "left": 593,
        "top": 160,
        "width": 250,
        "height": 250
      }
    }
  ],
  "color": {
    "dominantColorForeground": "Brown",
    "dominantColorBackground": "Brown",
    "dominantColors": [
      "Brown",
      "Black"
    ],
    "accentColor": "873B59",
    "isBWImg": false
  },
  "imageType": {
    "clipArtType": 0,
    "lineDrawingType": 0
  },
  "objects": [
    {
      "rectangle": {
        "x": 0,
        "y": 0,
        "w": 50,
        "h": 50
      },
      "object": "tree",
      "confidence": 0.9,
      "parent": {
        "object": "plant",
        "confidence": 0.95
      }
    }
  ],
  "brands": [
    {
      "name": "Pepsi",
      "confidence": 0.857,
      "rectangle": {
        "x": 489,
        "y": 79,
        "w": 161,
        "h": 177
      }
    },
    {
      "name": "Coca-Cola",
      "confidence": 0.893,
      "rectangle": {
        "x": 216,
        "y": 55,
        "w": 171,
        "h": 372
      }
    }
  ]
}

定義

名稱	Description
AdultInfo	物件，描述影像是否包含成人導向的內容和/或猥褻。
BoundingRect	影像內區域的周框方塊。
Category	描述已識別類別的物件。
CategoryDetail	描述其他類別詳細數據的物件。
CelebritiesModel	描述可能名人識別的物件。
ColorInfo	提供描述色彩屬性之其他元數據的物件。
ComputerVisionError	API 要求錯誤。
ComputerVisionErrorCodes	錯誤碼。
ComputerVisionErrorResponse	API 錯誤回應。
ComputerVisionInnerError	API 要求錯誤的詳細數據。
ComputerVisionInnerErrorCodeValue	錯誤碼。
DescriptionExclude	產生描述時關閉指定的領域模型。
Details	字串，表示要傳回哪些網域特定詳細數據。多個值應該以逗號分隔。有效的視覺功能類型包括：名人 - 識別影像中偵測到的名人、地標 - 識別影像中值得注意的地標。
DetectedBrand	在影像中偵測到的品牌。
DetectedObject	在影像中偵測到的物件。
FaceDescription	物件，描述影像中所識別的臉部。
FaceRectangle	描述臉部矩形的物件。
Gender	臉部的可能性別。
ImageAnalysis	AnalyzeImage 作業的結果。
ImageCaption	影像標題，也就是影像描述的簡短描述。
ImageDescriptionDetails	內容標記的集合，以及依信賴等級和影像元數據排序的標題清單。
ImageMetadata	影像元數據。
ImageTag	影像中的實體觀察，以及信賴分數。
ImageType	物件，提供可能的影像類型和比對信賴等級。
LandmarksModel	影像中辨識的地標。
ObjectHierarchy	在影像內偵測到的物件。
VisualFeatureTypes	字串，表示要傳回哪些視覺功能類型。多個值應該以逗號分隔。有效的視覺功能類型包括：類別 - 根據檔中定義的分類法分類影像內容。標記 - 使用與影像內容相關的詳細單字清單來標記影像。說明 - 用完整的英文句子說明映像內容。臉部 - 偵測臉部是否存在。若有的話，會產生座標、性別和年齡。 ImageType - 偵測映像是美工圖案或線條繪圖。色彩 - 決定輔色、主要色彩，以及影像是否為黑色&白色。成人 - 偵測影像在本質上是否為暴力， (描述裸體或性行為) ， (或是鑞描述極端暴力或血) 。也會偵測出性暗示內容 (也就是挑逗內容)。物件 - 偵測影像內的各種物件，包括近似位置。物品引數僅於英文版中提供。品牌 - 偵測影像內的各種品牌，包括近似位置。品牌引數僅於英文版中提供。

AdultInfo

物件，描述影像是否包含成人導向的內容和/或猥褻。

名稱	類型	Description
adultScore	number	從 0 到 1 的分數，指出內容在影像中視為成人導向的程度。
goreScore	number	從 0 到 1 的分數，指出 gory 是影像的方式。
isAdultContent	boolean	值，指出影像是否包含成人導向的內容。
isGoryContent	boolean	值，指出影像是否為 Gory。
isRacyContent	boolean	值，指出影像是否不雅。
racyScore	number	從 0 到 1 的分數，指出影像的建議程度。

BoundingRect

影像內區域的周框方塊。

名稱	類型	Description
h	integer	以像素為單位，從區域左上方點測量的高度。
w	integer	從區域左上方點測量的寬度，以像素為單位。
x	integer	區域左上方點的 X 座標，以像素為單位。
y	integer	區域左上方點的 Y 座標，以像素為單位。

名稱	類型	Description
detail	CategoryDetail	已識別類別的詳細數據。
name	string	類別名稱。
score	number	類別的評分。

CategoryDetail

描述其他類別詳細數據的物件。

名稱	類型	Description
celebrities	CelebritiesModel[]	如果已識別任何名人，則為名人數組。
landmarks	LandmarksModel[]	如果識別任何地標，則為地標數位列。

CelebritiesModel

描述可能名人識別的物件。

名稱	類型	Description
confidence	number	名人辨識的信賴等級，其值為 0 到 1。
faceRectangle	FaceRectangle	影像中識別臉部的位置。
name	string	名人的名稱。

ColorInfo

提供描述色彩屬性之其他元數據的物件。

名稱	類型	Description
accentColor	string	可能的輔色。
dominantColorBackground	string	可能的主要背景色彩。
dominantColorForeground	string	可能的主要前景色彩。
dominantColors	string[]	可能的主要色彩陣列。
isBWImg	boolean	值，指出影像是否為黑白。

ComputerVisionError

API 要求錯誤。

名稱	類型	Description
code	ComputerVisionErrorCodes	錯誤碼。
innererror	ComputerVisionInnerError	內部錯誤包含更明確的資訊。
message	string	說明服務所報告錯誤的訊息。

ComputerVisionErrorCodes

錯誤碼。

名稱	類型	Description
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
ServiceUnavailable	string

ComputerVisionErrorResponse

API 錯誤回應。

名稱	類型	Description
error	ComputerVisionError	錯誤內容。

ComputerVisionInnerError

API 要求錯誤的詳細數據。

名稱	類型	Description
code	ComputerVisionInnerErrorCodeValue	錯誤碼。
message	string	錯誤訊息。

ComputerVisionInnerErrorCodeValue

錯誤碼。

名稱	類型	Description
BadArgument	string
CancelledRequest	string
DetectFaceError	string
FailedToProcess	string
InternalServerError	string
InvalidDetails	string
InvalidImageFormat	string
InvalidImageSize	string
InvalidImageUrl	string
InvalidModel	string
InvalidThumbnailSize	string
NotSupportedFeature	string
NotSupportedImage	string
NotSupportedLanguage	string
NotSupportedVisualFeature	string
StorageException	string
Timeout	string
Unspecified	string
UnsupportedMediaType	string

DescriptionExclude

產生描述時關閉指定的領域模型。

名稱	類型	Description
Celebrities	string
Landmarks	string

Details

字串，表示要傳回哪些網域特定詳細數據。多個值應該以逗號分隔。有效的視覺功能類型包括：名人 - 識別影像中偵測到的名人、地標 - 識別影像中值得注意的地標。

名稱	類型	Description
Celebrities	string
Landmarks	string

DetectedBrand

在影像中偵測到的品牌。

名稱	類型	Description
confidence	number	在影像中觀察到品牌信賴分數，其值為 0 到 1。
name	string	品牌標籤。
rectangle	BoundingRect	偵測到品牌的近似位置。

DetectedObject

在影像中偵測到的物件。

名稱	類型	Description
confidence	number	在影像中觀察到物件的信賴分數，其值為0到1。
object	string	對象的標籤。
parent	ObjectHierarchy	父物件，從分類法的觀點來看。父對像是這個物件的較泛型形式。例如，'bulldog' 的父系為 'dog'。
rectangle	BoundingRect	偵測到物件的近似位置。

FaceDescription

物件，描述影像中所識別的臉部。

名稱	類型	Description
age	integer	臉部的可能年齡。
faceRectangle	FaceRectangle	影像中含有已識別臉部的矩形。
gender	Gender	臉部的可能性別。

FaceRectangle

描述臉部矩形的物件。

名稱	類型	Description
height	integer	從臉部左上方點測量的高度，以像素為單位。
left	integer	臉部左上方點的 X 座標，以像素為單位。
top	integer	臉部左上方點的 Y 座標，以像素為單位。
width	integer	從臉部左上方點測量的寬度，以像素為單位。

Gender

臉部的可能性別。

名稱	類型	Description
Female	string
Male	string

ImageAnalysis

AnalyzeImage 作業的結果。

名稱	類型	Description
adult	AdultInfo	物件，描述影像是否包含成人導向的內容和/或猥褻。
brands	DetectedBrand[]	影像中偵測到的品牌陣列。
categories	Category[]	表示已識別類別的陣列。
color	ColorInfo	提供描述色彩屬性之其他元數據的物件。
description	ImageDescriptionDetails	內容標記的集合，以及依信賴等級和影像元數據排序的標題清單。
faces	FaceDescription[]	影像中可能臉部的陣列。
imageType	ImageType	物件，提供可能的影像類型和比對信賴等級。
metadata	ImageMetadata	影像元數據。
modelVersion	string	AI 模型的版本。
objects	DetectedObject[]	對象陣列，描述影像中偵測到的專案。
requestId	string	REST API 要求的標識碼。
tags	ImageTag[]	具有信賴等級的標籤清單。

ImageCaption

影像標題，也就是影像描述的簡短描述。

名稱	類型	Description
confidence	number	服務在標題中擁有的信賴等級。
text	string	標題的文字。

ImageDescriptionDetails

內容標記的集合，以及依信賴等級和影像元數據排序的標題清單。

名稱	類型	Description
captions	ImageCaption[]	依信賴等級排序的標題清單。
tags	string[]	影像標記的集合。

ImageMetadata

影像元數據。

名稱	類型	Description
format	string	影像格式。
height	integer	影像高度，以像素為單位。
width	integer	影像寬度，以像素為單位。

ImageTag

影像中的實體觀察，以及信賴分數。

名稱	類型	Description
confidence	number	觀察到實體的信賴等級。
hint	string	此標記的選擇性提示/詳細數據。
name	string	實體的名稱。

ImageType

物件，提供可能的影像類型和比對信賴等級。

名稱	類型	Description
clipArtType	integer	影像為美工圖案的信賴等級。
lineDrawingType	integer	影像為線條繪圖的信賴等級。

LandmarksModel

影像中辨識的地標。

名稱	類型	Description
confidence	number	地標辨識的信賴等級，其值為 0 到 1。
name	string	地標的名稱。

ObjectHierarchy

在影像內偵測到的物件。

名稱	類型	Description
confidence	number	在影像中觀察到物件的信賴分數，其值為0到1。
object	string	對象的標籤。
parent	ObjectHierarchy	父物件，從分類法的觀點來看。父對像是這個物件的較泛型形式。例如，'bulldog' 的父系為 'dog'。

VisualFeatureTypes

字串，表示要傳回哪些視覺功能類型。多個值應該以逗號分隔。有效的視覺功能類型包括：類別 - 根據檔中定義的分類法分類影像內容。標記 - 使用與影像內容相關的詳細單字清單來標記影像。說明 - 用完整的英文句子說明映像內容。臉部 - 偵測臉部是否存在。若有的話，會產生座標、性別和年齡。 ImageType - 偵測映像是美工圖案或線條繪圖。色彩 - 決定輔色、主要色彩，以及影像是否為黑色&白色。成人 - 偵測影像在本質上是否為暴力， (描述裸體或性行為) ， (或是鑞描述極端暴力或血) 。也會偵測出性暗示內容 (也就是挑逗內容)。物件 - 偵測影像內的各種物件，包括近似位置。物品引數僅於英文版中提供。品牌 - 偵測影像內的各種品牌，包括近似位置。品牌引數僅於英文版中提供。

名稱	類型	Description
Adult	string
Brands	string
Categories	string
Color	string
Description	string
Faces	string
ImageType	string
Objects	string
Tags	string

共用方式為

Analyze Image In Stream - Analyze Image In Stream

URI 參數

要求標頭

要求本文

回應

安全性

Ocp-Apim-Subscription-Key

範例

Successful AnalyzeImage request

範例要求

範例回覆

定義

AdultInfo

BoundingRect

Category

CategoryDetail

CelebritiesModel

ColorInfo

ComputerVisionError

ComputerVisionErrorCodes

ComputerVisionErrorResponse

ComputerVisionInnerError

ComputerVisionInnerErrorCodeValue

DescriptionExclude

Details

DetectedBrand

DetectedObject

FaceDescription

FaceRectangle

Gender

ImageAnalysis

ImageCaption

ImageDescriptionDetails

ImageMetadata

ImageTag

ImageType

LandmarksModel

ObjectHierarchy

VisualFeatureTypes

其他資源