PersonGroupOperations class
Класс, представляющий PersonGroupOperations.
Конструкторы
| Person |
Создайте PersonGroupOperations. |
Методы
| create(string, string, Person |
Создайте группу пользователей с указанными personGroupId, именем, предоставленным пользователем userData и recognitionModel.
Квота группы пользователей:
|
| create(string, string, Person |
|
| create(string, string, Service |
|
| delete |
Удаление существующей группы пользователей. Сохраняемые признаки лиц всех пользователей в группе пользователей также будут удалены. |
| delete |
|
| delete |
|
| get(string, Person |
Получение имени группы пользователей, userData и recognitionModel. Чтобы получить сведения о пользователе в этой группе personGroup, используйте PersonGroup Person — List. |
| get(string, Person |
|
| get(string, Service |
|
| get |
Получение состояния обучения группы пользователей (завершенного или текущего). |
| get |
|
| get |
|
| list(Person |
Перечисление personGroupId, name, userData и recognitionModel групп пользователей.
|
| list(Person |
|
| list(Service |
|
| train(string, Request |
Постановка задачи обучения группы пользователей в очередь. Задача обучения может быть запущена не сразу. |
| train(string, Request |
|
| train(string, Service |
|
| update(string, Person |
Обновите отображаемое имя и userData существующей группы пользователей. Свойства, которые не отображаются в тексте запроса, не будут обновлены. |
| update(string, Person |
|
| update(string, Service |
Сведения о конструкторе
PersonGroupOperations(FaceClientContext)
Создайте PersonGroupOperations.
new PersonGroupOperations(client: FaceClientContext)Параметры
- client
- FaceClientContext
Ссылка на клиент службы.
Сведения о методе
create(string, string, PersonGroupCreateOptionalParams)
Создайте группу пользователей с указанными personGroupId, именем, предоставленным пользователем userData и recognitionModel.
Группа пользователей — это контейнер отправленных данных о пользователях, включая функции распознавания лиц.
После создания используйте PersonGroup Person - Create , чтобы добавить пользователей в группу, а затем вызовите PersonGroup - Train , чтобы подготовить эту группу к распознаванию лиц - идентификации.
Образ не будет сохранен. На сервере будут храниться только извлеченные признаки лица и userData, пока не будет вызван метод PersonGroup Person — Delete или PersonGroup — Delete .
Для связи с этой группой пользователей следует указать "recognitionModel". Значение по умолчанию для "recognitionModel" — "recognition_01". Если требуется последняя модель, укажите необходимую модель в этом параметре. Новые лица, добавленные в существующую группу пользователей, будут использовать модель распознавания, уже связанную с коллекцией. Существующие функции распознавания лиц в группе пользователей нельзя обновить до функций, извлеченных другой версией модели распознавания.
Квота группы пользователей:
- Квота подписки уровня "Бесплатный": 1000 групп пользователей. Каждый из них содержит до 1000 человек.
- Квота на подписку уровня S0: 1 000 000 групп пользователей. В каждом из них содержится до 10 000 человек.
- Чтобы решить проблему с идентификацией лиц в большом масштабе, рассмотрите возможность использования LargePersonGroup.
function create(personGroupId: string, name: string, options?: PersonGroupCreateOptionalParams): Promise<RestResponse>Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- name
-
string
Определяемое пользователем имя, максимальная длина составляет 128.
- options
- PersonGroupCreateOptionalParams
Необязательные параметры
Возвращаемое значение
Promise<RestResponse>
Promise<msRest.RestResponse>
create(string, string, PersonGroupCreateOptionalParams, ServiceCallback<void>)
function create(personGroupId: string, name: string, options: PersonGroupCreateOptionalParams, callback: ServiceCallback<void>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- name
-
string
Определяемое пользователем имя, максимальная длина составляет 128.
- options
- PersonGroupCreateOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
create(string, string, ServiceCallback<void>)
function create(personGroupId: string, name: string, callback: ServiceCallback<void>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- name
-
string
Определяемое пользователем имя, максимальная длина составляет 128.
- callback
-
ServiceCallback<void>
Обратный вызов
deleteMethod(string, RequestOptionsBase)
Удаление существующей группы пользователей. Сохраняемые признаки лиц всех пользователей в группе пользователей также будут удалены.
function deleteMethod(personGroupId: string, options?: RequestOptionsBase): Promise<RestResponse>Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(personGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- RequestOptionsBase
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(personGroupId: string, callback: ServiceCallback<void>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- callback
-
ServiceCallback<void>
Обратный вызов
get(string, PersonGroupGetOptionalParams)
Получение имени группы пользователей, userData и recognitionModel. Чтобы получить сведения о пользователе в этой группе personGroup, используйте PersonGroup Person — List.
function get(personGroupId: string, options?: PersonGroupGetOptionalParams): Promise<PersonGroupGetResponse>Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- PersonGroupGetOptionalParams
Необязательные параметры
Возвращаемое значение
Promise<PersonGroupGetResponse>
Promise<Models.PersonGroupGetResponse>
get(string, PersonGroupGetOptionalParams, ServiceCallback<PersonGroup>)
function get(personGroupId: string, options: PersonGroupGetOptionalParams, callback: ServiceCallback<PersonGroup>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- PersonGroupGetOptionalParams
Необязательные параметры
- callback
Обратный вызов
get(string, ServiceCallback<PersonGroup>)
function get(personGroupId: string, callback: ServiceCallback<PersonGroup>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- callback
Обратный вызов
getTrainingStatus(string, RequestOptionsBase)
Получение состояния обучения группы пользователей (завершенного или текущего).
function getTrainingStatus(personGroupId: string, options?: RequestOptionsBase): Promise<PersonGroupGetTrainingStatusResponse>Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<PersonGroupGetTrainingStatusResponse>
Promise<Models.PersonGroupGetTrainingStatusResponse>
getTrainingStatus(string, RequestOptionsBase, ServiceCallback<TrainingStatus>)
function getTrainingStatus(personGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<TrainingStatus>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
getTrainingStatus(string, ServiceCallback<TrainingStatus>)
function getTrainingStatus(personGroupId: string, callback: ServiceCallback<TrainingStatus>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- callback
Обратный вызов
list(PersonGroupListOptionalParams)
Перечисление personGroupId, name, userData и recognitionModel групп пользователей.
- Группы пользователей хранятся в алфавитном порядке personGroupId.
- Параметр start (строка, необязательный) — это предоставленное пользователем значение personGroupId, которое возвращает записи с большими идентификаторами по сравнению со строками. Для параметра start задано значение empty, чтобы указать возврат из первого элемента.
- Параметр top (int, необязательный) указывает количество возвращаемых записей. В одном вызове может быть возвращено не более 1000 записей. Чтобы получить больше, можно указать "start" с идентификатором последней возвращенной записи текущего вызова.
Например, всего 5 групп пользователей: "group1", ..., "group5".
"start=&top=" возвращает все 5 групп.
"start=&top=2" вернет "group1", "group2".
"start=group2&top=3" возвращает "group3", "group4", "group5".
function list(options?: PersonGroupListOptionalParams): Promise<PersonGroupListResponse>Параметры
- options
- PersonGroupListOptionalParams
Необязательные параметры
Возвращаемое значение
Promise<PersonGroupListResponse>
Promise<Models.PersonGroupListResponse>
list(PersonGroupListOptionalParams, ServiceCallback<PersonGroup[]>)
function list(options: PersonGroupListOptionalParams, callback: ServiceCallback<PersonGroup[]>)Параметры
- options
- PersonGroupListOptionalParams
Необязательные параметры
- callback
Обратный вызов
list(ServiceCallback<PersonGroup[]>)
function list(callback: ServiceCallback<PersonGroup[]>)Параметры
- callback
Обратный вызов
train(string, RequestOptionsBase)
Постановка задачи обучения группы пользователей в очередь. Задача обучения может быть запущена не сразу.
function train(personGroupId: string, options?: RequestOptionsBase): Promise<RestResponse>Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<RestResponse>
Promise<msRest.RestResponse>
train(string, RequestOptionsBase, ServiceCallback<void>)
function train(personGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- RequestOptionsBase
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
train(string, ServiceCallback<void>)
function train(personGroupId: string, callback: ServiceCallback<void>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- callback
-
ServiceCallback<void>
Обратный вызов
update(string, PersonGroupUpdateOptionalParams)
Обновите отображаемое имя и userData существующей группы пользователей. Свойства, которые не отображаются в тексте запроса, не будут обновлены.
function update(personGroupId: string, options?: PersonGroupUpdateOptionalParams): Promise<RestResponse>Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- PersonGroupUpdateOptionalParams
Необязательные параметры
Возвращаемое значение
Promise<RestResponse>
Promise<msRest.RestResponse>
update(string, PersonGroupUpdateOptionalParams, ServiceCallback<void>)
function update(personGroupId: string, options: PersonGroupUpdateOptionalParams, callback: ServiceCallback<void>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- options
- PersonGroupUpdateOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
update(string, ServiceCallback<void>)
function update(personGroupId: string, callback: ServiceCallback<void>)Параметры
- personGroupId
-
string
Идентификатор, ссылающийся на определенную группу пользователей.
- callback
-
ServiceCallback<void>
Обратный вызов