LargePersonGroupOperations class

Класс, представляющий LargePersonGroupOperations.

Конструкторы

LargePersonGroupOperations(FaceClientContext)

Создайте LargePersonGroupOperations.

Методы

create(string, string, LargePersonGroupCreateOptionalParams)

Создайте новую группу больших пользователей с указанным пользователем largePersonGroupId, именем, необязательным userData и recognitionModel.
Большая группа пользователей — это контейнер отправленных данных о пользователях, включая функцию распознавания лиц, и до 1 000 000 человек.
После создания используйте LargePersonGroup Person - Create , чтобы добавить пользователя в группу, и вызовите LargePersonGroup - Train , чтобы подготовить эту группу к face - Identify.
Образ не будет сохранен. На сервере будут храниться только извлеченные функции лица пользователя и userData до вызова LargePersonGroup Person — Delete или LargePersonGroup — Delete .
Для связи с этой большой группой пользователей необходимо указать "recognitionModel". Значение по умолчанию для "recognitionModel" — "recognition_01". Если требуется последняя модель, явно укажите нужную модель в этом параметре. Новые лица, добавленные в существующую группу больших пользователей, будут использовать модель распознавания, уже связанную с коллекцией. Существующие функции лиц в большой группе пользователей не могут быть обновлены до признаков, извлеченных другой версией модели распознавания. См. раздел Указание модели распознавания лиц.

Квота группы больших пользователей:

  • Квота подписки бесплатного уровня: 1000 больших групп пользователей.
  • Квота подписки уровня S0: 1 000 000 больших групп пользователей.
create(string, string, LargePersonGroupCreateOptionalParams, ServiceCallback<void>)
create(string, string, ServiceCallback<void>)
deleteMethod(string, RequestOptionsBase)

Удаление существующей большой группы пользователей. Сохраняемые признаки лиц всех пользователей в большой группе также будут удалены.

deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, ServiceCallback<void>)
get(string, LargePersonGroupGetOptionalParams)

Получение сведений о большой группе пользователей, включая ее имя, userData и recognitionModel. Этот API возвращает только сведения о группе больших пользователей. Вместо этого используйте LargePersonGroup Person — List для получения сведений о пользователе в группе больших пользователей.

get(string, LargePersonGroupGetOptionalParams, ServiceCallback<LargePersonGroup>)
get(string, ServiceCallback<LargePersonGroup>)
getTrainingStatus(string, RequestOptionsBase)

Получение состояния обучения большой группы пользователей (завершенных или текущих).

getTrainingStatus(string, RequestOptionsBase, ServiceCallback<TrainingStatus>)
getTrainingStatus(string, ServiceCallback<TrainingStatus>)
list(LargePersonGroupListOptionalParams)

Перечислить все существующие большие группы пользователей: largePersonGroupId, name, userData и recognitionModel.

  • Большие группы людей хранятся в алфавитном порядке largePersonGroupId.
  • Параметр start (строка, необязательно) — это предоставленное пользователем большое значениеPersonGroupId, возвращаемое записями с большими идентификаторами по сравнению со строками. Для параметра "start" задано пустое значение, указывающее на возврат из первого элемента.
  • Параметр top (int, необязательный) указывает количество возвращаемых записей. В одном вызове можно вернуть не более 1000 записей. Чтобы получить дополнительные сведения, можно указать "start" с идентификатором последнего возвращенного элемента текущего вызова.
    Например, всего 5 больших групп пользователей: "group1", ..., "group5".
    "start=&top=" вернет все 5 групп.
    "start=&top=2" возвращает "group1", "group2".
    "start=group2&top=3" возвращает "group3", "group4", "group5".
list(LargePersonGroupListOptionalParams, ServiceCallback<LargePersonGroup[]>)
list(ServiceCallback<LargePersonGroup[]>)
train(string, RequestOptionsBase)

Поставить в очередь задачу обучения большой группы пользователей. Она может быть запущена не сразу.

train(string, RequestOptionsBase, ServiceCallback<void>)
train(string, ServiceCallback<void>)
update(string, LargePersonGroupUpdateOptionalParams)

Обновление отображаемого имени и userData существующей большой группы пользователей. Свойства, которые не отображаются в тексте запроса, не обновляются.

update(string, LargePersonGroupUpdateOptionalParams, ServiceCallback<void>)
update(string, ServiceCallback<void>)

Сведения о конструкторе

LargePersonGroupOperations(FaceClientContext)

Создайте LargePersonGroupOperations.

new LargePersonGroupOperations(client: FaceClientContext)

Параметры

client
FaceClientContext

Ссылка на клиент службы.

Сведения о методе

create(string, string, LargePersonGroupCreateOptionalParams)

Создайте новую группу больших пользователей с указанным пользователем largePersonGroupId, именем, необязательным userData и recognitionModel.
Большая группа пользователей — это контейнер отправленных данных о пользователях, включая функцию распознавания лиц, и до 1 000 000 человек.
После создания используйте LargePersonGroup Person - Create , чтобы добавить пользователя в группу, и вызовите LargePersonGroup - Train , чтобы подготовить эту группу к face - Identify.
Образ не будет сохранен. На сервере будут храниться только извлеченные функции лица пользователя и userData до вызова LargePersonGroup Person — Delete или LargePersonGroup — Delete .
Для связи с этой большой группой пользователей необходимо указать "recognitionModel". Значение по умолчанию для "recognitionModel" — "recognition_01". Если требуется последняя модель, явно укажите нужную модель в этом параметре. Новые лица, добавленные в существующую группу больших пользователей, будут использовать модель распознавания, уже связанную с коллекцией. Существующие функции лиц в большой группе пользователей не могут быть обновлены до признаков, извлеченных другой версией модели распознавания. См. раздел Указание модели распознавания лиц.

Квота группы больших пользователей:

  • Квота подписки бесплатного уровня: 1000 больших групп пользователей.
  • Квота подписки уровня S0: 1 000 000 больших групп пользователей.
function create(largePersonGroupId: string, name: string, options?: LargePersonGroupCreateOptionalParams): Promise<RestResponse>

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную группу больших пользователей.

name

string

Имя, определенное пользователем, максимальная длина — 128.

options
LargePersonGroupCreateOptionalParams

Необязательные параметры

Возвращаемое значение

Promise<RestResponse>

Promise<msRest.RestResponse>

create(string, string, LargePersonGroupCreateOptionalParams, ServiceCallback<void>)

function create(largePersonGroupId: string, name: string, options: LargePersonGroupCreateOptionalParams, callback: ServiceCallback<void>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную группу больших пользователей.

name

string

Имя, определенное пользователем, максимальная длина — 128.

options
LargePersonGroupCreateOptionalParams

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

create(string, string, ServiceCallback<void>)

function create(largePersonGroupId: string, name: string, callback: ServiceCallback<void>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную группу больших пользователей.

name

string

Имя, определенное пользователем, максимальная длина — 128.

callback

ServiceCallback<void>

Обратный вызов

deleteMethod(string, RequestOptionsBase)

Удаление существующей большой группы пользователей. Сохраняемые признаки лиц всех пользователей в большой группе также будут удалены.

function deleteMethod(largePersonGroupId: string, options?: RequestOptionsBase): Promise<RestResponse>

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную группу больших пользователей.

options
RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)

function deleteMethod(largePersonGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную группу больших пользователей.

options
RequestOptionsBase

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

deleteMethod(string, ServiceCallback<void>)

function deleteMethod(largePersonGroupId: string, callback: ServiceCallback<void>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

callback

ServiceCallback<void>

Обратный вызов

get(string, LargePersonGroupGetOptionalParams)

Получение сведений о большой группе пользователей, включая ее имя, userData и recognitionModel. Этот API возвращает только сведения о группе больших пользователей. Вместо этого используйте LargePersonGroup Person — List для получения сведений о пользователе в группе больших пользователей.

function get(largePersonGroupId: string, options?: LargePersonGroupGetOptionalParams): Promise<LargePersonGroupGetResponse>

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

options
LargePersonGroupGetOptionalParams

Необязательные параметры

Возвращаемое значение

Promise<Models.LargePersonGroupGetResponse>

get(string, LargePersonGroupGetOptionalParams, ServiceCallback<LargePersonGroup>)

function get(largePersonGroupId: string, options: LargePersonGroupGetOptionalParams, callback: ServiceCallback<LargePersonGroup>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

options
LargePersonGroupGetOptionalParams

Необязательные параметры

callback

ServiceCallback<LargePersonGroup>

Обратный вызов

get(string, ServiceCallback<LargePersonGroup>)

function get(largePersonGroupId: string, callback: ServiceCallback<LargePersonGroup>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

callback

ServiceCallback<LargePersonGroup>

Обратный вызов

getTrainingStatus(string, RequestOptionsBase)

Получение состояния обучения большой группы пользователей (завершенных или текущих).

function getTrainingStatus(largePersonGroupId: string, options?: RequestOptionsBase): Promise<LargePersonGroupGetTrainingStatusResponse>

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

options
RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<Models.LargePersonGroupGetTrainingStatusResponse>

getTrainingStatus(string, RequestOptionsBase, ServiceCallback<TrainingStatus>)

function getTrainingStatus(largePersonGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<TrainingStatus>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

options
RequestOptionsBase

Необязательные параметры

callback

ServiceCallback<TrainingStatus>

Обратный вызов

getTrainingStatus(string, ServiceCallback<TrainingStatus>)

function getTrainingStatus(largePersonGroupId: string, callback: ServiceCallback<TrainingStatus>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

callback

ServiceCallback<TrainingStatus>

Обратный вызов

list(LargePersonGroupListOptionalParams)

Перечислить все существующие большие группы пользователей: largePersonGroupId, name, userData и recognitionModel.

  • Большие группы людей хранятся в алфавитном порядке largePersonGroupId.
  • Параметр start (строка, необязательно) — это предоставленное пользователем большое значениеPersonGroupId, возвращаемое записями с большими идентификаторами по сравнению со строками. Для параметра "start" задано пустое значение, указывающее на возврат из первого элемента.
  • Параметр 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?: LargePersonGroupListOptionalParams): Promise<LargePersonGroupListResponse>

Параметры

options
LargePersonGroupListOptionalParams

Необязательные параметры

Возвращаемое значение

Promise<Models.LargePersonGroupListResponse>

list(LargePersonGroupListOptionalParams, ServiceCallback<LargePersonGroup[]>)

function list(options: LargePersonGroupListOptionalParams, callback: ServiceCallback<LargePersonGroup[]>)

Параметры

options
LargePersonGroupListOptionalParams

Необязательные параметры

callback

ServiceCallback<LargePersonGroup[]>

Обратный вызов

list(ServiceCallback<LargePersonGroup[]>)

function list(callback: ServiceCallback<LargePersonGroup[]>)

Параметры

callback

ServiceCallback<LargePersonGroup[]>

Обратный вызов

train(string, RequestOptionsBase)

Поставить в очередь задачу обучения большой группы пользователей. Она может быть запущена не сразу.

function train(largePersonGroupId: string, options?: RequestOptionsBase): Promise<RestResponse>

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

options
RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<RestResponse>

Promise<msRest.RestResponse>

train(string, RequestOptionsBase, ServiceCallback<void>)

function train(largePersonGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

options
RequestOptionsBase

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

train(string, ServiceCallback<void>)

function train(largePersonGroupId: string, callback: ServiceCallback<void>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

callback

ServiceCallback<void>

Обратный вызов

update(string, LargePersonGroupUpdateOptionalParams)

Обновление отображаемого имени и userData существующей большой группы пользователей. Свойства, которые не отображаются в тексте запроса, не обновляются.

function update(largePersonGroupId: string, options?: LargePersonGroupUpdateOptionalParams): Promise<RestResponse>

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

options
LargePersonGroupUpdateOptionalParams

Необязательные параметры

Возвращаемое значение

Promise<RestResponse>

Promise<msRest.RestResponse>

update(string, LargePersonGroupUpdateOptionalParams, ServiceCallback<void>)

function update(largePersonGroupId: string, options: LargePersonGroupUpdateOptionalParams, callback: ServiceCallback<void>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

options
LargePersonGroupUpdateOptionalParams

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

update(string, ServiceCallback<void>)

function update(largePersonGroupId: string, callback: ServiceCallback<void>)

Параметры

largePersonGroupId

string

Идентификатор, ссылающийся на определенную большую группу пользователей.

callback

ServiceCallback<void>

Обратный вызов