Image Moderation - Find Faces Url Input

服務:

Cognitive Services

API 版本:

1.0

傳回找到的臉部清單。

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/FindFaces

含選擇性參數:

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/FindFaces?overload=url&CacheImage={CacheImage}

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的 Azure 認知服務端點 (通訊協定和主機名，例如 https://westus.api.cognitive.microsoft.com) 。
CacheImage	query		boolean	是否要保留提交的影像以供日後使用。 如果省略，預設值為 false。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string
Content-Type	True	string	內容類型。

要求本文

名稱	類型	Description
DataRepresentation	string
Value	string

回應

名稱	類型	Description
200 OK	FoundFaces	找到的臉部清單。
Other Status Codes	APIError	錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

Find Faces request

範例要求

HTTP

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/FindFaces?overload=url



{
  "DataRepresentation": "URL",
  "Value": "https://moderatorsampleimages.blob.core.windows.net/samples/img_300.jpg"
}

範例回覆

狀態碼:

200

{
  "Faces": [
    {
      "Left": 80,
      "Right": 118,
      "Top": 44,
      "Bottom": 82
    }
  ],
  "Count": 1,
  "AdvancedInfo": [],
  "Result": true,
  "Status": {
    "Code": 3000,
    "Description": "OK",
    "Exception": ""
  },
  "TrackingId": "SEA_ad975eeae1f24f81bebb40be0c3ba4fd_ContentModerator.Preview_01158625-4fea-4dd5-8f21-5e2657ea2eee"
}

定義

名稱	Description
APIError	API 傳回的錯誤資訊。
Error	錯誤本文。
Face	找到臉部的座標。
FoundFaces	要求包含找到臉部的物件。
KeyValuePair	索引鍵/值組物件屬性。
Status	狀態屬性。

APIError

API 傳回的錯誤資訊。

名稱	類型	Description
Error	Error	錯誤本文。

Error

錯誤本文。

名稱	類型	Description
Code	string
Message	string

Face

找到臉部的座標。

名稱	類型	Description
Bottom	integer	底部座標。
Left	integer	左座標。
Right	integer	右座標。
Top	integer	頂端座標。

FoundFaces

要求包含找到臉部的物件。

名稱	類型	Description
AdvancedInfo	KeyValuePair[]	進階資訊。
CacheId	string	快取標識碼。
Count	integer	找到的臉部數目。
Faces	Face[]	臉部清單。
Result	boolean	如果找到結果，則為 True。
Status	Status	評估狀態。
TrackingId	string	追蹤標識碼。

KeyValuePair

索引鍵/值組物件屬性。

名稱	類型	Description
Key	string	索引鍵參數。
Value	string	Value 參數。

Status

狀態屬性。

名稱	類型	Description
Code	integer	狀態碼。
Description	string	狀態描述。
Exception	string	例外狀況狀態。