共用方式為


人臉識別 API

Microsoft 認知服務臉部 API 可讓您偵測、識別、分析、組織和標記相片中的臉部。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 標準 所有 Power Automate 區域
邏輯應用程式 標準 所有 Logic Apps 區域
Power Apps 標準 所有 Power Apps 區域
Power Automate(自動化服務) 標準 所有 Power Automate 區域
連絡人​​
名稱 Microsoft
URL Microsoft LogicApps 支援
Microsoft Power Automate 支援
Microsoft Power Apps 支援
連接器中繼資料
Publisher Microsoft
網站 https://azure.microsoft.com/services/cognitive-services/face/

若要使用此整合,您需要 Azure 入口網站中的 認知服務資源 。 您將獲得一個端點和一個用於驗證應用程式的金鑰。 若要建立連線,請提供帳戶金鑰、網站 URL,然後選取 建立連線。 有關連線的營運成本,請 在此處深入瞭解。

您現在已準備好開始使用此整合。

與 Microsoft Entra ID 連線

若要建立與 Microsoft Entra ID 的連線,您必須將認知服務使用者角色新增至您的帳戶才能存取。 若要使用此連線,您必須將與認知服務資源相關聯的唯一子網域輸入支援作業。

Microsoft Entra ID 驗證不支援的作業

使用 Microsoft Entra ID 驗證時, 僅支援 V2 動作。 已取代的動作會繼續與驗證搭配 Access Key 使用, 但如果與 Microsoft Entra ID 連線搭配使用,則會失敗

正在建立連線

連接器支援下列驗證類型:

API 金鑰 API 金鑰 所有區域 可共用
預設值 [已棄用] 此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。 所有區域 不可共享

API 金鑰

驗證 ID:keyBasedAuth

適用:所有地區

API 金鑰

這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件

名稱 類型 Description 為必填項目
帳戶金鑰 securestring 認知服務帳戶金鑰
網站 URL 字串 根網站網址 (範例: https://westus.api.cognitive.microsoft.com

預設值 [已棄用]

適用:所有地區

此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
API 金鑰 securestring API 金鑰
網站 URL 字串 根網站網址 (範例: https://westus.api.cognitive.microsoft.com )。如果未指定,網站網址將預設為 'https://westus.api.cognitive.microsoft.com'。

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 1200 60 秒

動作

偵測臉部

偵測影像中的人臉並傳回臉部位置,並選擇性地使用faceId、地標和屬性。

偵測臉部 (V2)

偵測影像中的人臉並傳回臉部位置,並選擇性地使用faceId、地標和屬性。

取得人員群組

擷取人員群組的資訊,包括其名稱和 userData。

取得人員群組 (V2)

擷取人員群組的資訊,包括其名稱和 userData。

取得人臉 (V2)

擷取 persistedFaceId、personId 及其所屬 personGroupId 所指定的保存面孔的相關資訊。

取得臉部清單

擷取臉部清單的資訊,包括臉部清單中的 faceListId、name、userData 和臉部。

取得臉部清單 (V2)

擷取臉部清單的資訊,包括臉部清單中的 faceListId、name、userData 和臉部。

建立人員

在指定的人員群組中建立新人員。

建立人員 (V2)

在指定的人員群組中建立新人員。

建立人員群組

使用指定的 personGroupId、名稱和使用者提供的 userData 建立新的人員群組。

建立人員群組 (V2)

使用指定的 personGroupId、名稱和使用者提供的 userData 建立新的人員群組。

建立臉部清單

使用使用者指定的 faceListId、name 和選擇性 userData 建立空白臉部清單。

建立臉部清單 (V2)

使用使用者指定的 faceListId、name 和選擇性 userData 建立空白臉部清單。

從臉上找人

驗證兩張臉是否屬於同一個人,或一張臉是否屬於一個人。

從臉部尋找人物 (V2)

驗證兩張臉是否屬於同一個人,或一張臉是否屬於一個人。

找一個人

擷取人員的資訊,包括已註冊的保存面孔、名稱和 userData。

新增人臉

為人物添加代表性面孔以進行識別。

新增人臉 (V2)

為人物添加代表性面孔以進行識別。

新增面對面清單

添加面對面列表。

新增面對面清單 (V2)

添加面對面列表。

獲取一個人 (V2)

擷取人員的資訊,包括已註冊的保存面孔、名稱和 userData。

獲得一張人臉

擷取 persistedFaceId、personId 及其所屬 personGroupId 所指定的保存面孔的相關資訊。

偵測臉部

偵測影像中的人臉並傳回臉部位置,並選擇性地使用faceId、地標和屬性。

參數

名稱 機碼 必要 類型 Description
圖片網址
url True string

影像必須是 JPEG、PNG、GIF(第一幀)或 BMP

傳回

偵測臉部 (V2)

偵測影像中的人臉並傳回臉部位置,並選擇性地使用faceId、地標和屬性。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

圖片網址
url True string

影像必須是 JPEG、PNG、GIF(第一幀)或 BMP

傳回

取得人員群組

擷取人員群組的資訊,包括其名稱和 userData。

參數

名稱 機碼 必要 類型 Description
人員群組識別碼
personGroupId True string

目標人員群組識別碼。

傳回

取得人員群組 (V2)

擷取人員群組的資訊,包括其名稱和 userData。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

人員群組識別碼
personGroupId True string

目標人員群組識別碼。

傳回

取得人臉 (V2)

擷取 persistedFaceId、personId 及其所屬 personGroupId 所指定的保存面孔的相關資訊。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

人員群組識別碼
personGroupId True string

指定包含目標人員的人員群組。

人員 ID
personId True string

指定臉部所屬的目標人物。

持久面孔 ID
persistedFaceId True string

目標的 persistedFaceId 會持續保存人員的臉部。

傳回

取得臉部清單

擷取臉部清單的資訊,包括臉部清單中的 faceListId、name、userData 和臉部。

參數

名稱 機碼 必要 類型 Description
臉部清單識別碼
faceListId True string

faceListId 的目標臉部清單。

傳回

取得臉部清單 (V2)

擷取臉部清單的資訊,包括臉部清單中的 faceListId、name、userData 和臉部。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

臉部清單識別碼
faceListId True string

faceListId 的目標臉部清單。

傳回

建立人員

在指定的人員群組中建立新人員。

參數

名稱 機碼 必要 類型 Description
人員群組識別碼
personGroupId True string

指定要建立人員的目標人員群組。

名稱
name True string

目標人員的顯示名稱。 長度上限為 128。

用戶數據
userData string

附加至人員的使用者提供資料的選用欄位。 大小限制為 16KB。

傳回

建立人員 (V2)

在指定的人員群組中建立新人員。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

人員群組識別碼
personGroupId True string

指定要建立人員的目標人員群組。

名稱
name True string

目標人員的顯示名稱。 長度上限為 128。

用戶數據
userData string

附加至人員的使用者提供資料的選用欄位。 大小限制為 16KB。

傳回

建立人員群組

使用指定的 personGroupId、名稱和使用者提供的 userData 建立新的人員群組。

參數

名稱 機碼 必要 類型 Description
人員群組識別碼
personGroupId True string

新的人員群組 ID (有效字元包括數字、小寫英文字母、'-' 和 '_')

名稱
name True string

人員群組顯示名稱。 長度上限為 128。

用戶數據
userData string

附加至人員群組的使用者提供的資料。 大小限制為 16KB。

建立人員群組 (V2)

使用指定的 personGroupId、名稱和使用者提供的 userData 建立新的人員群組。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

人員群組識別碼
personGroupId True string

新的人員群組 ID (有效字元包括數字、小寫英文字母、'-' 和 '_')

名稱
name True string

人員群組顯示名稱。 長度上限為 128。

用戶數據
userData string

附加至人員群組的使用者提供的資料。 大小限制為 16KB。

建立臉部清單

使用使用者指定的 faceListId、name 和選擇性 userData 建立空白臉部清單。

參數

名稱 機碼 必要 類型 Description
臉部清單識別碼
faceListId True string

有效字元為小寫字母或數字或「-」或「_」,長度上限為 64

臉部清單名稱
name True string

建立的人臉清單名稱,長度上限為 128。

用戶數據
userData string

臉部清單的選擇性使用者定義資料。 長度不應超過 16KB。

建立臉部清單 (V2)

使用使用者指定的 faceListId、name 和選擇性 userData 建立空白臉部清單。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

臉部清單識別碼
faceListId True string

有效字元為小寫字母或數字或「-」或「_」,長度上限為 64

臉部清單名稱
name True string

建立的人臉清單名稱,長度上限為 128。

用戶數據
userData string

臉部清單的選擇性使用者定義資料。 長度不應超過 16KB。

從臉上找人

驗證兩張臉是否屬於同一個人,或一張臉是否屬於一個人。

參數

名稱 機碼 必要 類型 Description
臉部 ID
faceId True string

偵測到的臉部的唯一 faceId。 檢測呼叫後 24 小時將過期。

人員群組識別碼
personGroupId True string

在臉部 API 中建立的人員群組識別碼 - 建立人員群組動作。

人員 ID
personId True string

在臉部 API 中建立的人員識別碼 - 建立人員動作。

傳回

從臉部尋找人物 (V2)

驗證兩張臉是否屬於同一個人,或一張臉是否屬於一個人。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

臉部 ID
faceId True string

偵測到的臉部的唯一 faceId。 檢測呼叫後 24 小時將過期。

人員群組識別碼
personGroupId True string

在臉部 API 中建立的人員群組識別碼 - 建立人員群組動作。

人員 ID
personId True string

在臉部 API 中建立的人員識別碼 - 建立人員動作。

傳回

找一個人

擷取人員的資訊,包括已註冊的保存面孔、名稱和 userData。

參數

名稱 機碼 必要 類型 Description
人員群組識別碼
personGroupId True string

指定包含目標人員的人員群組。

人員 ID
personId True string

指定目標人員。

傳回

新增人臉

為人物添加代表性面孔以進行識別。

參數

名稱 機碼 必要 類型 Description
人員群組識別碼
personGroupId True string

人員群組

人員 ID
personId True string

添加臉部的目標人物。

圖片網址
url True string

影像必須是 JPEG、PNG、GIF(第一幀)或 BMP

目標面
targetFace string

人臉矩形,用於指定要新增至人物的目標人臉,格式為targetFace=left,top,width,height

用戶數據
userData string

使用者指定的目標臉部資料,要新增用於任何目的。 長度上限為 1KB。

傳回

新增人臉 (V2)

為人物添加代表性面孔以進行識別。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

人員群組識別碼
personGroupId True string

人員群組

人員 ID
personId True string

添加臉部的目標人物。

圖片網址
url True string

影像必須是 JPEG、PNG、GIF(第一幀)或 BMP

目標面
targetFace string

人臉矩形,用於指定要新增至人物的目標人臉,格式為targetFace=left,top,width,height

用戶數據
userData string

使用者指定的目標臉部資料,要新增用於任何目的。 長度上限為 1KB。

傳回

新增面對面清單

添加面對面列表。

參數

名稱 機碼 必要 類型 Description
圖片網址
url string

影像必須是 JPEG、PNG、GIF(第一幀)或 BMP

目標面
targetFace string

人臉矩形,用於指定要新增至人物的目標人臉,格式為targetFace=left,top,width,height

用戶數據
userData string

使用者指定的目標臉部資料,要新增用於任何目的。 長度上限為 1KB。

臉部清單識別碼
faceListId True string

有效字元為小寫字母或數字或「-」或「_」,長度上限為64。

傳回

新增面對面清單 (V2)

添加面對面列表。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

圖片網址
url string

影像必須是 JPEG、PNG、GIF(第一幀)或 BMP

目標面
targetFace string

人臉矩形,用於指定要新增至人物的目標人臉,格式為targetFace=left,top,width,height

用戶數據
userData string

使用者指定的目標臉部資料,要新增用於任何目的。 長度上限為 1KB。

臉部清單識別碼
faceListId True string

有效字元為小寫字母或數字或「-」或「_」,長度上限為64。

傳回

獲取一個人 (V2)

擷取人員的資訊,包括已註冊的保存面孔、名稱和 userData。

參數

名稱 機碼 必要 類型 Description
資源子網域或區域
subdomain True string

Azure 子網域或地理區域 (例如 westus)

人員群組識別碼
personGroupId True string

指定包含目標人員的人員群組。

人員 ID
personId True string

指定目標人員。

傳回

獲得一張人臉

擷取 persistedFaceId、personId 及其所屬 personGroupId 所指定的保存面孔的相關資訊。

參數

名稱 機碼 必要 類型 Description
人員群組識別碼
personGroupId True string

指定包含目標人員的人員群組。

人員 ID
personId True string

指定臉部所屬的目標人物。

持久面孔 ID
persistedFaceId True string

目標的 persistedFaceId 會持續保存人員的臉部。

傳回

定義

偵測回應

名稱 路徑 類型 Description
臉部 ID
faceId string

偵測到的臉部的唯一 faceId。 檢測呼叫後 24 小時將過期。

前幾個
faceRectangle.top integer

影像上臉部位置的矩形區域參數。

左側
faceRectangle.left integer

影像上臉部位置的矩形區域參數。

寬度
faceRectangle.width integer

影像上臉部位置的矩形區域參數。

高度
faceRectangle.height integer

影像上臉部位置的矩形區域參數。

左瞳孔 X
faceLandmarks.pupilLeft.x float

左瞳孔的 x 座標。

左瞳孔 Y
faceLandmarks.pupilLeft.y float

左瞳孔的 y 座標。

右瞳 X
faceLandmarks.pupilRight.x float

右瞳孔的 x 坐標。

右瞳孔 Y
faceLandmarks.pupilRight.y float

右瞳孔的 y 座標。

鼻尖 X
faceLandmarks.noseTip.x float

鼻尖的 x 座標。

鼻尖 Y
faceLandmarks.noseTip.y float

鼻尖的 y 座標。

左嘴 X
faceLandmarks.mouthLeft.x float

嘴巴左側的 x 座標。

嘴左 Y
faceLandmarks.mouthLeft.y float

嘴巴左側的 y 座標。

右嘴 X
faceLandmarks.mouthRight.x float

嘴右側的 x 座標。

右嘴 Y
faceLandmarks.mouthRight.y float

嘴右側的 y 座標。

左外眉 X
faceLandmarks.eyebrowLeftOuter.x float

左眉毛外側的 x 座標。

左外眉 Y
faceLandmarks.eyebrowLeftOuter.y float

左眉毛外側的 y 座標。

左內眉 X
faceLandmarks.eyebrowLeftInner.x float

左眉毛內側的 x 座標。

左內眉 Y
faceLandmarks.eyebrowLeftInner.y float

左眉毛內側的 y 座標。

左外眼 X
faceLandmarks.eyeLeftOuter.x float

左眼外側的 x 座標。

左眼外 Y
faceLandmarks.eyeLeftOuter.y float

左眼外側的 y 座標。

左眼 X 頂部
faceLandmarks.eyeLeftTop.x float

左眼頂部的 x 座標。

左眼 Y 頂部
faceLandmarks.eyeLeftTop.y float

左眼頂部的 y 座標。

左眼 X 的底部
faceLandmarks.eyeLeftBottom.x float

左眼底部的 x 座標。

左眼 Y 的底部
faceLandmarks.eyeLeftBottom.y float

左眼底部的 y 座標。

左眼內側 X
faceLandmarks.eyeLeftInner.x float

左眼內側的 x 座標。

左眼內側 Y
faceLandmarks.eyeLeftInner.y float

左眼內側的 y 座標。

右內眉 X
faceLandmarks.eyebrowRightInner.x float

右眉毛內側的 x 座標。

右內眉 Y
faceLandmarks.eyebrowRightInner.y float

右眉毛內側的 y 座標。

右外眉 X
faceLandmarks.eyebrowRightOuter.x float

右眉毛外側的 x 座標。

右外眉 Y
faceLandmarks.eyebrowRightOuter.y float

右眉毛外側的 y 座標。

右眼內側 X
faceLandmarks.eyeRightInner.x float

右眼內側的 x 座標。

右眼內側 Y
faceLandmarks.eyeRightInner.y float

右眼內側的 y 座標。

右眼 X 頂部
faceLandmarks.eyeRightTop.x float

右眼頂部的 x 座標。

右眼 Y 頂部
faceLandmarks.eyeRightTop.y float

右眼頂部的 y 座標。

右眼 X 的底部
faceLandmarks.eyeRightBottom.x float

右眼底部的 x 座標。

右眼 Y 的底部
faceLandmarks.eyeRightBottom.y float

右眼底部的 y 座標。

右眼外側 X
faceLandmarks.eyeRightOuter.x float

右眼外側的 x 座標。

右外眼 Y
faceLandmarks.eyeRightOuter.y float

右眼外側的 y 座標。

左鼻根 X
faceLandmarks.noseRootLeft.x float

鼻根左側的 x 座標。

左鼻根 Y
faceLandmarks.noseRootLeft.y float

鼻根左側的 y 座標。

右鼻根 X
faceLandmarks.noseRootRight.x float

鼻根右側的 x 座標。

右鼻根 Y
faceLandmarks.noseRootRight.y float

鼻根右側的 y 座標。

左鼻頂部祭壇 X
faceLandmarks.noseLeftAlarTop.x float

左鼻祭壇頂部的 x 座標。

左鼻頂部祭壇 Y
faceLandmarks.noseLeftAlarTop.y float

左鼻祭壇頂部的 y 座標。

右鼻祭壇 X 頂部
faceLandmarks.noseRightAlarTop.x float

右鼻祭壇頂部的 x 座標。

右鼻頂部祭壇 Y
faceLandmarks.noseRightAlarTop.y float

右鼻祭壇頂部的 y 座標。

左鼻尖祭壇外出 X
faceLandmarks.noseLeftAlarOutTip.x float

左鼻祭壇尖端的 x 座標。

左鼻尖祭壇向外 Y
faceLandmarks.noseLeftAlarOutTip.y float

左鼻祭壇尖端的y座標/

右鼻尖祭壇 X
faceLandmarks.noseRightAlarOutTip.x float

右鼻祭壇尖端的 x 坐標。

右鼻尖祭壇向外 Y
faceLandmarks.noseRightAlarOutTip.y float

右鼻祭壇尖端的 y 座標。

上唇頂部 X
faceLandmarks.upperLipTop.x float

上唇頂部的 x 座標。

上唇 Y 頂部
faceLandmarks.upperLipTop.y float

上唇頂部的 y 座標。

上唇底部 X
faceLandmarks.upperLipBottom.x float

上唇底部的 x 座標。

上唇 Y 底部
faceLandmarks.upperLipBottom.y float

上唇底部的 y 座標。

下唇 X 頂部
faceLandmarks.underLipTop.x float

下唇頂部的 x 座標。

下唇 Y 的頂部
faceLandmarks.underLipTop.y float

下唇頂部的 y 座標。

下唇 X 底部
faceLandmarks.underLipBottom.x float

下唇底部的 x 座標。

下唇 Y 底部
faceLandmarks.underLipBottom.y float

下唇底部的 y 座標。

頭部姿勢間距
faceAttributes.headPose.pitch float

保留欄位,一律傳回 0。

頭部姿勢滾動
faceAttributes.headPose.roll float

頭部姿勢的滾動。

頭部姿勢偏航
faceAttributes.headPose.yaw float

頭部偏航姿勢。

眼鏡
faceAttributes.glasses string

眼鏡類型。

AddPersonFace回應

名稱 路徑 類型 Description
持久面孔 ID
persistedFaceId string

GetPersonGroup回應

名稱 路徑 類型 Description
人員群組識別碼
personGroupId string
名稱
name string
用戶數據
userData string

GetFaceList回應

名稱 路徑 類型 Description
持續的面孔
persistedFaces array of object
持久面孔 ID
persistedFaces.persistedFaceId string

臉部的 ID。

用戶數據
persistedFaces.userData string

使用者提供的資料附加至每張臉部。

臉部清單識別碼
faceListId string

faceListId 的目標臉部清單。

名稱
name string

臉部清單的顯示名稱。

用戶數據
userData string

附加至臉部清單的使用者提供的資料。

GetPersonFace回應

名稱 路徑 類型 Description
持久面孔 ID
persistedFaceId string
用戶數據
userData string

建立人員回應

名稱 路徑 類型 Description
人員 ID
personId string

GetPerson回應

名稱 路徑 類型 Description
人員 ID
personId string
持久化的臉部 ID
persistedFaceIds array of object
持久面孔 ID
persistedFaceIds.persistedFaceId string
名稱
name string
用戶數據
userData string

驗證回應

名稱 路徑 類型 Description
是相同的
isIdentical boolean

如果兩張臉屬於同一個人或臉屬於該人,則為真,否則為假。

信賴度
confidence float

數字表示兩張臉是否屬於同一個人,或臉部是否屬於該人的相似性信賴度。