通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Person Directories - Get

服务:
Azure AI Services
API 版本:
2025-05-01-preview

获取 person 目录属性。

GET {endpoint}/contentunderstanding/personDirectories/{personDirectoryId}?api-version=2025-05-01-preview

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string (uri)

内容理解服务终结点。
personDirectoryId
 path True

string

pattern: ^[a-zA-Z0-9._-]{1,64}$

人员目录的唯一标识符。
api-version
 query True

string

minLength: 1

要用于此操作的 API 版本。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string (uuid)

请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称 类型 说明
200 OK

PersonDirectory

请求已成功。

标头

x-ms-client-request-id: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称 说明
https://cognitiveservices.azure.com/.default

示例

Get Person Directory

示例请求

GET {endpoint}/contentunderstanding/personDirectories/myDirectory?api-version=2025-05-01-preview

示例响应

状态代码:
200 
{
  "personDirectoryId": "myDirectory",
  "description": "My person directory",
  "createdAt": "2025-05-01T18:46:36.051Z",
  "lastModifiedAt": "2025-05-01T18:46:36.051Z",
  "tags": {
    "location": "Building A",
    "type": "Access Control",
    "updatedBy": "Paul"
  },
  "personCount": 0,
  "faceCount": 0
}

定义

名称 说明
Azure.Core.Foundations.Error

错误对象。
Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。
Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
PersonDirectory

人物及其面孔目录。

Azure.Core.Foundations.Error

Object

错误对象。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
details

Azure.Core.Foundations.Error[]

导致此报告错误的特定错误的详细信息数组。
innererror

Azure.Core.Foundations.InnerError

包含与当前对象有关错误的更具体信息的对象。
message

string

有关错误的可读的表示形式。
target

string

错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称 类型 说明
error

Azure.Core.Foundations.Error

错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
innererror

Azure.Core.Foundations.InnerError

内部错误。

PersonDirectory

Object

人物及其面孔目录。

名称 类型 说明
createdAt

string (date-time)

创建 person 目录的日期和时间。
description

string

人员目录的描述。
faceCount

integer (int32)

人员目录中的人脸数。
lastModifiedAt

string (date-time)

上次修改 person 目录的日期和时间。
personCount

integer (int32)

人员目录中的人数。
personDirectoryId

string

pattern: ^[a-zA-Z0-9._-]{1,64}$

人员目录的唯一标识符。
tags

object

与 person 目录关联的标记。