# Протокол

## Оглавление

- [deviceapis/device/v1/deviceapis_device_fr_v1.proto](#deviceapis_device_v1_deviceapis_device_fr_v1-proto)
    - [FacerecService](#deviceapis-device-v1-FacerecService)
  
    - [EditFacerecRequest](#deviceapis-device-v1-EditFacerecRequest)
    - [EditFacerecResponse](#deviceapis-device-v1-EditFacerecResponse)
    - [EditFacerecResponse.Error](#deviceapis-device-v1-EditFacerecResponse-Error)
    - [Facerec](#deviceapis-device-v1-Facerec)
    - [GetFacerecRequest](#deviceapis-device-v1-GetFacerecRequest)
    - [GetFacerecResponse](#deviceapis-device-v1-GetFacerecResponse)
  


## [Схема классов](/svg/protos/key/deviceapis/device/v1/deviceapis_device_fr_v1.proto.svg)
<a href="/svg/protos/key/deviceapis/device/v1/deviceapis_device_fr_v1.proto.svg"><img src="/svg/protos/key/deviceapis/device/v1/deviceapis_device_fr_v1.proto.svg" alt="/svg/protos/key/deviceapis/device/v1/deviceapis_device_fr_v1.proto.svg" style="height:100%;"></a>




<a name="deviceapis_device_v1_deviceapis_device_fr_v1-proto"></a>

## [deviceapis/device/v1/deviceapis_device_fr_v1.proto](/protos/key/deviceapis/device/v1/deviceapis_device_fr_v1.proto)
Сервис управления настройками Face Recognition


<a name="deviceapis-device-v1-FacerecService"></a>

### FacerecService
 Сервис управления настройками Face Recognition

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="deviceapis-device-v1-EditFacerec"></a> [EditFacerec](#deviceapis-device-v1-EditFacerec) | Метод редактирования настроек Face Recognition | [deviceapis.device.v1.EditFacerecRequest](#deviceapis-device-v1-EditFacerecRequest) | [deviceapis.device.v1.EditFacerecResponse](#deviceapis-device-v1-EditFacerecResponse) |
| <a id="deviceapis-device-v1-GetFacerec"></a> [GetFacerec](#deviceapis-device-v1-GetFacerec) | Метод получения настроек Face Recognition | [deviceapis.device.v1.GetFacerecRequest](#deviceapis-device-v1-GetFacerecRequest) | [deviceapis.device.v1.GetFacerecResponse](#deviceapis-device-v1-GetFacerecResponse) |

 <!-- end services -->


<a name="deviceapis-device-v1-EditFacerecRequest"></a>


### [EditFacerecRequest](#deviceapis-device-v1-EditFacerecRequest)
 Запрос редактирования настроек Face Recognition


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditFacerecRequest-data"></a> [data](#deviceapis-device-v1-EditFacerecRequest-data) | Настройки Face Recognition |    [deviceapis.device.v1.Facerec](#deviceapis-device-v1-Facerec) | REQUIRED|
| <a id="deviceapis-device-v1-EditFacerecRequest-update_mask"></a> [update_mask](#deviceapis-device-v1-EditFacerecRequest-update_mask) | Маска полей обновления |    [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="deviceapis-device-v1-EditFacerecResponse"></a>


### [EditFacerecResponse](#deviceapis-device-v1-EditFacerecResponse)
 Ответ на запрос редактирования настроек Face Recognition


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditFacerecResponse-error"></a> [error](#deviceapis-device-v1-EditFacerecResponse-error) | Ошибка |  optional  [deviceapis.device.v1.EditFacerecResponse.Error](#deviceapis-device-v1-EditFacerecResponse-Error) | <nil>|






<a name="deviceapis-device-v1-EditFacerecResponse-Error"></a>


### [EditFacerecResponse.Error](#deviceapis-device-v1-EditFacerecResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditFacerecResponse-Error-validation"></a> [validation](#deviceapis-device-v1-EditFacerecResponse-Error-validation) | Ошибка валидации |  optional  [deviceapis.device.v1.ValidationError](#deviceapis-device-v1-ValidationError) | <nil>|






<a name="deviceapis-device-v1-Facerec"></a>


### [Facerec](#deviceapis-device-v1-Facerec)
 Настройки Face Recognition


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-Facerec-is_enabled"></a> [is_enabled](#deviceapis-device-v1-Facerec-is_enabled) | Флаг включения Face Recognition |    [bool](#scalar-types) | REQUIRED|
| <a id="deviceapis-device-v1-Facerec-main_address"></a> [main_address](#deviceapis-device-v1-Facerec-main_address) | Адрес |    [string](#scalar-types) | REQUIRED|
| <a id="deviceapis-device-v1-Facerec-alt_address"></a> [alt_address](#deviceapis-device-v1-Facerec-alt_address) | Альтернативный адрес |    [string](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Facerec-request"></a> [request](#deviceapis-device-v1-Facerec-request) | Путь запроса к серверу |    [string](#scalar-types) | REQUIRED|
| <a id="deviceapis-device-v1-Facerec-authorization"></a> [authorization](#deviceapis-device-v1-Facerec-authorization) | Токен |    [string](#scalar-types) | REQUIRED|
| <a id="deviceapis-device-v1-Facerec-groups"></a> [groups](#deviceapis-device-v1-Facerec-groups) | Идентификаторы групп профилей в identix |  repeated  [string](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Facerec-relay_index"></a> [relay_index](#deviceapis-device-v1-Facerec-relay_index) | Индекс реле. Диапазон: 1..32767 |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Facerec-send_interval"></a> [send_interval](#deviceapis-device-v1-Facerec-send_interval) | Интервал отправки, миллисекунд |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Facerec-face_liveness"></a> [face_liveness](#deviceapis-device-v1-Facerec-face_liveness) | Доступность FR |    [float](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Facerec-min_face_size"></a> [min_face_size](#deviceapis-device-v1-Facerec-min_face_size) | Минимальный размер лица, пикселей |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Facerec-max_face_size"></a> [max_face_size](#deviceapis-device-v1-Facerec-max_face_size) | Максимальный размер лица, пикселей |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-Facerec-add_size"></a> [add_size](#deviceapis-device-v1-Facerec-add_size) | Добавление размера, процентов |    [int32](#scalar-types) | <nil>|






<a name="deviceapis-device-v1-GetFacerecRequest"></a>


### [GetFacerecRequest](#deviceapis-device-v1-GetFacerecRequest)
 Запрос получения настроек Face Recognition






<a name="deviceapis-device-v1-GetFacerecResponse"></a>


### [GetFacerecResponse](#deviceapis-device-v1-GetFacerecResponse)
 Ответ на запрос получения настроек Face Recognition


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-GetFacerecResponse-data"></a> [data](#deviceapis-device-v1-GetFacerecResponse-data) | Настройки Face Recognition |  optional  [deviceapis.device.v1.Facerec](#deviceapis-device-v1-Facerec) | <nil>|





 <!-- end messages -->

 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |