> For the complete documentation index, see [llms.txt](https://doc.ozforensics.com/oz-knowledge-ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/use-cases/collection.md).

# Проверка по коллекции фотографий (Collection)

Алгоритм проверки Collection предназначен для проверки присутствия человека по базе заранее загруженных фотографий. В качестве источника для сравнения можно использовать изображение и/или фрагмент видео.

Порядок действий описан ниже.

1\. Авторизуйтесь. Параметры передаются в json-запросе в составе credentials. См. статьи [Коллекции Postman](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/postman.md) и [Аутентификация](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/autentifikaciya-i-obrabotka-dannykh/tokens.md).

2\. Поместите видеофайл в папку, как описано [здесь](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/autentifikaciya-i-obrabotka-dannykh/zagruzka-mediafailov.md).

Пример заполнения `payload` для видео:

{% code title="payload" %}

```javascript
{
  "media:tags": {
    "video1": [
      "video_selfie",
      "video_selfie_scan",
      "orientation_portrait"
    ]
  }
}
```

{% endcode %}

3\. Запустите анализ: `POST/api/folders/{{folder_id}}/analyses/`

В типе анализа должно быть указано `collection`.

{% code title="request body" %}

```javascript
{
    "analyses": [{
    "type": "collection",
    "collection_id": "your_image_database_id",
    "source_media": ["идентификатор_медиафайла_источника"]
  }]
}
```

{% endcode %}

В `source_media` указывается `media_id` из ответа предыдущего запроса. Это опционально, если требуется проверить одно из двух заранее загруженных в папку видео.

Сохраните `analysis_id` из ответа.

4а. Через некоторое время п[роверьте результат](https://apidoc.ozforensics.com/#tag/Analyses/paths/~1api~1analyses~1{analysis_id}/get). Дождитесь, когда поля `resolution_status` и `resolution` изменят статус на любой, кроме `PROCESSING`, — этот статус и будет результатом.

4б. Еще один вариант: добавьте [вебхук](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/autentifikaciya-i-obrabotka-dannykh/ispolzovanie-vebkhukov-dlya-polucheniya-rezultatov.md), который обратится к вашему сайту по завершении анализа. В payload запроса добавьте нужный адрес в поле `resolution_endpoint`:

```javascript
{    
    "resolution_endpoint": "address.com",
    {
    .... // информация о папке и т.д.
    }
}
```

В запросе вебхука будет содержаться информация о папке и связанных с ней анализах.

Подробно статусы анализов описаны [здесь](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/statuses.md).

Если вы хотите узнать, с кем именно из вашей базы фотографий совпало лицо с медиафайла, который вы только что загрузили, найдите в ответе анализ `collection`, в нем `results_media`, где и будет идентификатор нужной вам персоны `person_id`. Чтобы получить информацию об этой персоне, вызовите метод `GET /api/collections/{{collection_id}}/persons/{{person_id}}`, указав идентификаторы вашей коллекции и персоны в ней.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/use-cases/collection.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
