Person Directory Operations - Update Person
人物の name または userData を更新します。
PATCH {endpoint}/face/{apiVersion}/persons/{personId}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API バージョン |
endpoint
|
path | True |
string uri |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。 |
person
|
path | True |
string uuid |
ユーザーのユーザー ID。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
name |
string |
ユーザー定義名、最大長は 128 です。 |
userData |
string |
省略可能なユーザー定義データ。 長さは 16K を超えてはなりません。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 Headers x-ms-error-code: string |
セキュリティ
Ocp-Apim-Subscription-Key
Azure AI Face サブスクリプションの秘密鍵。
Type:
apiKey
In:
header
AADToken
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://api.example.com/oauth2/authorize
Token URL:
https://api.example.com/oauth2/token
Scopes
名前 | 説明 |
---|---|
https://cognitiveservices.azure.com/.default |
例
Update Person in PersonDirectory
Sample Request
PATCH {endpoint}/face/v1.1-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5
{
"name": "your_person_name",
"userData": "your_user_data"
}
Sample Response
定義
名前 | 説明 |
---|---|
Face |
error オブジェクト。 Face Service によって返されるエラー コードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages |
Face |
エラーの詳細を含む応答。 |
FaceError
error オブジェクト。 Face Service によって返されるエラー コードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |