次の方法で共有


Person Directory Operations - Get Person

Person Directory からユーザーの名前と userData を取得します。

GET {endpoint}/face/{apiVersion}/persons/{personId}

URI パラメーター

名前 / 必須 説明
apiVersion
path True

string

API バージョン

endpoint
path True

string

uri

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。

personId
path True

string

uuid

ユーザーのユーザー ID。

応答

名前 説明
200 OK

PersonDirectoryPerson

呼び出しが成功すると、そのユーザーの情報が返されます。

Other Status Codes

FaceErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Azure AI Face サブスクリプションの秘密鍵。

型: apiKey
/: header

AADToken

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://api.example.com/oauth2/authorize
Token URL (トークン URL): https://api.example.com/oauth2/token

スコープ

名前 説明
https://cognitiveservices.azure.com/.default

Get Person from PeronDirectory

要求のサンプル

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5

応答のサンプル

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
  "name": "your_person_name",
  "userData": "your_user_data"
}

定義

名前 説明
FaceError

エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages

FaceErrorResponse

エラーの詳細を含む応答。

PersonDirectoryPerson

person ディレクトリのユーザー リソース

FaceError

エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages

名前 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。

message

string

エラーの人間が判読できる表現。

FaceErrorResponse

エラーの詳細を含む応答。

名前 説明
error

FaceError

エラー オブジェクト。

PersonDirectoryPerson

person ディレクトリのユーザー リソース

名前 説明
name

string

ユーザー定義の名前。最大長は 128 です。

personId

string

ユーザーのユーザー ID。

userData

string

省略可能なユーザー定義データ。 長さは 16K を超えないようにしてください。