# Справочник REST API Procurize.AI

**Программный доступ к вашей базе знаний – документам, опросникам, RAG и отчетам – с помощью вашего токена API.**

> **Применимо к:** Procurize.AI API v1  
> **Аутентификация:** API‑ключ через заголовок `X-API-Key` (см. [Токены API](/api-tokens/) для управления токенами)  
> **Базовый URL:** `https://api.procurize.com`

## Обзор

REST API Procurize.AI предоставляет программный доступ к ключевым функциям платформы. Он позволяет интегрировать Procurize.AI с вашими внутренними системами, автоматизировать управление базой знаний и создавать пользовательские рабочие процессы.

**Поддерживаемые модули (токен‑аутентификация):**

- [**RagArticle**](#ragarticle) – управление документами
- [**RagFaq**](#ragfaq) – управление записями FAQ
- [**RagQuery**](#ragquery) – выполнение запросов RAG

## Аутентификация

Все аутентифицированные конечные точки требуют токен API, передаваемый в заголовке запроса.

| Заголовок | Значение |
|-----------|----------|
| `X-API-Key` | `<YOUR_API_TOKEN>` |

**Пример:**
```bash
curl -X GET "https://api.procurize.com/v1/..." \
  -H "X-API-Key: your-api-token-here"
```

> 💡 Токены привязаны к вашей организации – вам не нужно указывать идентификатор организации в запросе.

## Базовый URL

Все конечные точки REST API находятся под:
```
https://api.procurize.com
```

## Обработка ошибок

API использует стандартные коды состояния HTTP.

| Код | Значение |
|-----|----------|
| `200 OK` | Запрос выполнен успешно |
| `201 Created` | Ресурс успешно создан |
| `204 No Content` | Запрос выполнен успешно, тело ответа отсутствует |
| `400 Bad Request` | Недопустимые параметры или некорректный запрос |
| `401 Unauthorized` | Отсутствует или недействителен токен API |
| `403 Forbidden` | Токен не имеет прав для этого действия |
| `404 Not Found` | Ресурс не найден |
| `500 Internal Server Error` | Неожиданная ошибка сервера |

Ответы об ошибках включают машинно‑читаемый код ошибки и человекочитаемое сообщение.

## Справочник модулей

### RagArticle

#### GET /questionnaire/rag/articles/summary

**Краткое описание:** Сводка для главной страницы

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| proj | query | string (uuid) | Нет | Идентификатор проекта. |

**Ответ (200):**
```json
{
  "active": 5
}
```

---

#### GET /questionnaire/rag/articles/total

**Краткое описание:** Количество статей

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| q | query | string | Нет | Фильтр по названию или коду статьи. |
| state | query | array | Нет | Фильтр по статусам. |
| project | query | array | Нет | Фильтр по проектам. |
| type | query | array | Нет | Фильтр по типам документов. |

**Ответ (200):**
```json
42
```

---

#### GET /questionnaire/rag/articles/list

**Краткое описание:** Получить список статей

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| q | query | string | Нет | Фильтр по названию или коду статьи. |
| state | query | array | Нет | Фильтр по статусам. |
| project | query | array | Нет | Фильтр по проектам. |
| type | query | array | Нет | Фильтр по типам документов. |
| s | query | string | Нет | Поле сортировки. |
| asc | query | boolean | Нет | Сортировка по возрастанию. |
| ps | query | integer (int32) | Нет | Размер страницы. |
| p | query | integer (int32) | Нет | Номер страницы (начиная с 1). |

**Ответ (200):**
```json
{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 42,
    "totalPages": 5
  },
  "items": [
    {
      "code": "ART-001",
      "org": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Article Title",
      "description": "Article description",
      "documentTypes": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Type Name",
          "plural": "Type Names",
          "count": 5
        }
      ],
      "size": 150,
      "revision": {
        "id": "00000000-0000-0000-0000-000000000000",
        "collectionId": "00000000-0000-0000-0000-000000000000",
        "rev": 3,
        "date": "2025-01-15T10:30:00Z",
        "author": {
          "id": "user123",
          "name": "John Doe",
          "email": "john.doe@example.com",
          "login": "johndoe",
          "ra": true
        },
        "authorName": "John Doe",
        "analysisSummary": {
          "id": "00000000-0000-0000-0000-000000000000",
          "initiator": {
            "id": "user123",
            "name": "John Doe",
            "email": "john.doe@example.com",
            "login": "johndoe",
            "ra": true
          },
          "created": "2025-01-15T10:30:00Z",
          "state": "Completed",
          "stateDate": "2025-01-15T10:35:00Z",
          "stateDetails": "Analysis completed successfully",
          "operationId": "op-12345"
        }
      },
      "type": "Article",
      "state": "Active",
      "projects": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "items": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "isShared": false
    }
  ]
}
```

---

#### POST /questionnaire/rag/file-to-md

**Краткое описание:** Возвращает Markdown‑контент из файла

**Тело запроса (multipart/form-data):**
```json
{
  "url": "https://example.com/file.pdf",
  "file": "binary"
}
```

**Ответ (200):**
```json
"Markdown content from file"
```

---

#### POST /questionnaire/rag/article/create

**Краткое описание:** Создать статью

**Тело запроса (multipart/form-data):**
```json
{
  "code": "ART-001",
  "name": "Article Title",
  "description": "Article description",
  "content": "# Article Content\n\nThis is the article content.",
  "url": "https://example.com/file.pdf",
  "file": "binary"
}
```

**Ответ (200):**
```json
{
  "code": "ART-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Article Title",
  "description": "Article description",
  "documentTypes": null,
  "size": 150,
  "revision": null,
  "type": "Article",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}
```

---

#### GET /questionnaire/rag/article/check

**Краткое описание:** Проверить существование статьи.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код статьи. |

**Ответ (200):**
```json
true
```

---

#### GET /questionnaire/rag/article-info

**Краткое описание:** Получить информацию о статье по коду.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код статьи. |

**Ответ (200):**
```json
{
  "code": "ART-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Article Title",
  "description": "Article description",
  "documentTypes": null,
  "size": 150,
  "revision": null,
  "type": "Article",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}
```

---

#### GET /questionnaire/rag/article

**Краткое описание:** Получить содержимое статьи по коду

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код статьи. |
| format | query | string | Нет | Если `true`, возвращает HTML‑контент в теле ответа. Иначе — Markdown. |
| split | query | boolean | Нет | Если `true`, возвращает контент, разделённый на RAG‑элементы. |
| css | query | boolean | Нет | Если `true`, возвращает HTML/PDF с CSS. |

**Ответ (200):**
```json
"# Article Title\n\nThis is the article content in Markdown format."
```

#### POST /questionnaire/rag/article

**Краткое описание:** Обновить метаданные статьи

**Тело запроса:**
```json
{
  "code": "ART-001",
  "name": "Updated Article Title",
  "description": "Updated description",
  "projects": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "documentTypes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Type Name",
      "plural": "Type Names"
    }
  ],
  "isShared": true,
  "state": "Active"
}
```

**Ответ (200):**
```json
{}
```

#### DELETE /questionnaire/rag/article

**Краткое описание:** Удалить статью

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код статьи. |

---

#### GET /questionnaire/rag/article/pdf

**Краткое описание:** Получить статью в формате PDF по коду

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код статьи. |

**Ответ (200):**
```json
(pdf binary)
```

---

#### GET /questionnaire/rag/article/content

**Краткое описание:** Получить содержимое статьи

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код статьи. |

**Ответ (200):**
```json
{
  "content": "# Article Title\n\nContent here."
}
```

---

#### POST /questionnaire/rag/article/content

**Краткое описание:** Обновить содержимое статьи

**Тело запроса (multipart/form-data):**
```json
{
  "code": "ART-001",
  "content": "# Updated Content",
  "file": "binary"
}
```

---

#### POST /questionnaire/rag/plural

**Краткое описание:** Получить множественную форму существительного

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| noun | query | string | Нет | Существительное для множественной формы. |

**Ответ (200):**
```json
{
  "plural": "Articles"
}
```

---

#### POST /questionnaire/rag/article/find-types

**Краткое описание:** Проанализировать статью с помощью ИИ и вернуть их типы

**Тело запроса (multipart/form-data):**
```json
{
  "code": "ART-001",
  "content": "# Article Content"
}
```

**Ответ (200):**
```json
[
  {
    "plural": "Types"
  }
]
```

---

#### POST /questionnaire/rag/article/format-with-ai

**Краткое описание:** Форматировать содержимое статьи с помощью ИИ

**Тело запроса (multipart/form-data):**
```json
{
  "code": "ART-001",
  "content": "# Article Content"
}
```

**Ответ (200):**
```json
{
  "formattedContent": "# Formatted Article Content"
}
```

---

#### POST /questionnaire/rag/article/improve-on-suggestions

**Краткое описание:** Улучшить документ на основе предложений

**Тело запроса (multipart/form-data):**
```json
{
  "suggestions": [
    {
      "sectionTitle": "Introduction",
      "suggestion": "Add more details here."
    }
  ],
  "code": "ART-001",
  "content": "# Article Content"
}
```

**Ответ (200):**
```json
{
  "improvedContent": "# Improved Content"
}
```

---

#### GET /questionnaire/rag/article/parts

**Краткое описание:** Возвращает список частей статьи

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| id | query | array | Да | Список частей статьи. |

**Ответ (200):**
```json
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "code": "part-1",
    "title": "Introduction",
    "orderNumber": 1,
    "content": "Introduction content."
  }
]
```

---

#### GET /questionnaire/rag/article/revisions

**Краткое описание:** Возвращает список ревизий статьи

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код статьи. |

**Ответ (200):**
```json
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "collectionId": "00000000-0000-0000-0000-000000000000",
    "rev": 1,
    "date": "2025-01-15T10:30:00Z",
    "author": {
      "id": "user123",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "login": "johndoe",
      "ra": true
    },
    "authorName": "John Doe",
    "analysisSummary": {
      "id": "00000000-0000-0000-0000-000000000000",
      "initiator": {
        "id": "user123",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "login": "johndoe",
        "ra": true
      },
      "created": "2025-01-15T10:30:00Z",
      "state": "Completed",
      "stateDate": "2025-01-15T10:35:00Z",
      "stateDetails": "Analysis completed",
      "operationId": "op-12345"
    }
  }
]
```

---

#### GET /questionnaire/rag/article/revisions/info/{id}

**Краткое описание:** Получить информацию о ревизии статьи

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| id | path | string (uuid) | Да | Идентификатор ревизии. |

**Ответ (200):**
```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "collectionId": "00000000-0000-0000-0000-000000000000",
  "rev": 1,
  "date": "2025-01-15T10:30:00Z",
  "author": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "authorName": "John Doe",
  "analysisSummary": {
    "id": "00000000-0000-0000-0000-000000000000",
    "initiator": {
      "id": "user123",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "login": "johndoe",
      "ra": true
    },
    "created": "2025-01-15T10:30:00Z",
    "state": "Completed",
    "stateDate": "2025-01-15T10:35:00Z",
    "stateDetails": "Analysis completed",
    "operationId": "op-12345"
  }
}
```

---

#### GET /questionnaire/rag/article/revisions/{id}

**Краткое описание:** Получить содержимое ревизии статьи

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| id | path | string (uuid) | Да | Идентификатор ревизии. |

**Ответ (200):**
```json
"# Article Revision Content\n\nPrevious version."
```

---

#### GET /questionnaire/rag/article/analyze

**Краткое описание:** Проанализировать содержимое статьи с помощью ИИ

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код статьи. |
| rev | query | integer (int32) | Нет | Номер ревизии. |
| force | query | boolean | Нет | Принудительно создать новый анализ и удалить предыдущий незавершённый результат, если он существует. |

**Ответ (200):**
```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "initiator": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "created": "2025-01-15T10:30:00Z",
  "state": "Completed",
  "stateDate": "2025-01-15T10:35:00Z",
  "stateDetails": "Analysis completed",
  "operationId": "op-12345"
}
```

---

#### GET /questionnaire/rag/article/analyze/{id}

**Краткое описание:** Получить результат анализа статьи

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| id | path | string (uuid) | Да | Идентификатор анализа. |

**Ответ (200):**
```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "initiator": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "created": "2025-01-15T10:30:00Z",
  "state": "Completed",
  "stateDate": "2025-01-15T10:35:00Z",
  "stateDetails": "Analysis completed",
  "operationId": "op-12345",
  "fragments": [
    "fragment-1",
    "fragment-2"
  ],
  "ownInconcies": "Own inconsistencies found",
  "ragInconcies": "RAG inconsistencies found",
  "proposals": "Improvement proposals"
}
```

---

#### GET /questionnaire/rag/messages/list

**Краткое описание:** Список всех сообщений

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| id | query | string (uuid) | Да | Идентификатор коллекции RAG. |
| item | query | string (uuid) | Нет | Идентификатор элемента RAG. |
| message | query | string (uuid) | Нет | Идентификатор сообщения. |
| asc | query | boolean | Нет | Сортировка по возрастанию. |
| ps | query | integer (int32) | Нет | Размер страницы. |
| p | query | integer (int32) | Нет | Номер страницы (начиная с 1). |

**Ответ (200):**
```json
{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 5,
    "totalPages": 1
  },
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "replyTo": null,
      "questionnaire": null,
      "section": null,
      "question": null,
      "ragCollection": "00000000-0000-0000-0000-000000000000",
      "ragItem": "00000000-0000-0000-0000-000000000000",
      "targetId": "00000000-0000-0000-0000-000000000000",
      "targetType": "Question",
      "targetNum": 1,
      "author": {
        "id": "user123",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "login": "johndoe",
        "ra": true
      },
      "text": "Message content",
      "created": "2025-01-15T10:30:00Z",
      "updated": "2025-01-15T10:30:00Z",
      "replies": 0
    }
  ]
}
```

---

#### POST /questionnaire/rag/messages/add

**Краткое описание:** Добавить новое сообщение

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| id | query | string (uuid) | Да | Идентификатор коллекции RAG. |
| item | query | string (uuid) | Нет | Идентификатор элемента RAG. |
| message | query | string (uuid) | Нет | Идентификатор сообщения‑ответа. |

**Тело запроса:**
```json
{
  "text": "New message content"
}
```

**Ответ (200):**
```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "replyTo": null,
  "questionnaire": null,
  "section": null,
  "question": null,
  "ragCollection": "00000000-0000-0000-0000-000000000000",
  "ragItem": "00000000-0000-0000-0000-000000000000",
  "targetId": "00000000-0000-0000-0000-000000000000",
  "targetType": "Question",
  "targetNum": 1,
  "author": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "text": "New message content",
  "created": "2025-01-15T10:30:00Z",
  "updated": "2025-01-15T10:30:00Z",
  "replies": 0
}
```

---

#### POST /questionnaire/rag/message

**Краткое описание:** Обновить существующее сообщение

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| c | query | string (uuid) | Да | Идентификатор коллекции RAG. |
| id | query | string (uuid) | Да | Идентификатор сообщения. |

**Тело запроса:**
```json
{
  "text": "Updated message content"
}
```

**Ответ (200):**
```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "replyTo": null,
  "questionnaire": null,
  "section": null,
  "question": null,
  "ragCollection": "00000000-0000-0000-0000-000000000000",
  "ragItem": "00000000-0000-0000-0000-000000000000",
  "targetId": "00000000-0000-0000-0000-000000000000",
  "targetType": "Question",
  "targetNum": 1,
  "author": {
    "id": "user123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "ra": true
  },
  "text": "Updated message content",
  "created": "2025-01-15T10:30:00Z",
  "updated": "2025-01-15T10:45:00Z",
  "replies": 0
}
```

#### DELETE /questionnaire/rag/message

**Краткое описание:** Удалить существующее сообщение

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| id | query | string (uuid) | Да | Идентификатор сообщения. |

**Ответ (200):**
```json
{}
```

---

### RagFaq

#### GET /questionnaire/rag/faq-collections/summary

**Краткое описание:** Сводка для главной страницы

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| proj | query | string (uuid) | Нет | Идентификатор проекта. |

**Ответ (200):**
```json
{
  "active": 3
}
```

---

#### GET /questionnaire/rag/faq-collections/total

**Краткое описание:** Количество коллекций FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| q | query | string | Нет | Фильтр по названию или коду коллекции. |
| state | query | array | Нет | Фильтр по статусам. |
| project | query | array | Нет | Фильтр по проектам. |

**Ответ (200):**
```json
3
```

---

#### GET /questionnaire/rag/faq-collections/list

**Краткое описание:** Получить список коллекций FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| q | query | string | Нет | Фильтр по названию или коду коллекции. |
| state | query | array | Нет | Фильтр по статусам. |
| project | query | array | Нет | Фильтр по проектам. |
| s | query | string | Нет | Поле сортировки. |
| asc | query | boolean | Нет | Сортировка по возрастанию. |
| ps | query | integer (int32) | Нет | Размер страницы. |
| p | query | integer (int32) | Нет | Номер страницы (начиная с 1). |

**Ответ (200):**
```json
{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 3,
    "totalPages": 1
  },
  "items": [
    {
      "code": "FAQ-001",
      "org": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "FAQ Collection",
      "description": "FAQ collection description",
      "documentTypes": null,
      "size": 5,
      "revision": null,
      "type": "Faq",
      "state": "Active",
      "projects": null,
      "items": null,
      "isShared": false
    }
  ]
}
```

---

#### GET /questionnaire/rag/faq-collections/find-items

**Краткое описание:** Найти элементы FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| q | query | string | Да | Фильтр по вопросу. |
| project | query | string (uuid) | Нет | Фильтр по проекту. |
| ps | query | integer (int32) | Нет | Размер страницы. |
| p | query | integer (int32) | Нет | Номер страницы (начиная с 1). |

**Ответ (200):**
```json
{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 5,
    "totalPages": 1
  },
  "items": [
    {
      "index": 0,
      "question": "What is this product?",
      "answer": "This is a great product.",
      "comment": "Product FAQ",
      "state": "Active"
    }
  ]
}
```

---

#### POST /questionnaire/rag/faq-collection/create

**Краткое описание:** Создать новую коллекцию FAQ.

**Тело запроса (multipart/form-data):**
```json
{
  "code": "FAQ-001",
  "name": "FAQ Collection",
  "description": "FAQ collection description",
  "content": "Content here",
  "file": "binary"
}
```

**Ответ (200):**
```json
{
  "code": "FAQ-001",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "FAQ Collection",
  "description": "FAQ collection description",
  "documentTypes": null,
  "size": 5,
  "revision": null,
  "type": "Faq",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}
```

---

#### POST /questionnaire/rag/faq-collection

**Краткое описание:** Обновить метаданные коллекции FAQ.

**Тело запроса:**
```json
{
  "code": "FAQ-001",
  "name": "Updated FAQ Collection",
  "description": "Updated description",
  "projects": null,
  "documentTypes": null,
  "isShared": false,
  "state": "Active"
}
```

#### DELETE /questionnaire/rag/faq-collection

**Краткое описание:** Удалить коллекцию FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код коллекции. |

#### GET /questionnaire/rag/faq-collection

**Краткое описание:** Получить коллекцию FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код коллекции. |

**Ответ (200):**
```json
{
  "code": "FAQ-001",
  "org": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "FAQ Collection",
  "description": "FAQ collection description",
  "documentTypes": null,
  "size": 5,
  "revision": null,
  "type": "Faq",
  "state": "Active",
  "projects": null,
  "items": null,
  "isShared": false
}
```

---

#### GET /questionnaire/rag/faq-collection/check

**Краткое описание:** Проверить существование коллекции FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код коллекции. |

**Ответ (200):**
```json
true
```

---

#### GET /questionnaire/rag/faq-collection/items-total

**Краткое описание:** Количество элементов FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код коллекции. |
| q | query | string | Нет | Фильтр по содержимому элемента FAQ. |

**Тело запроса:**
```json
["Active", "Default"]
```

**Ответ (200):**
```json
5
```

---

#### GET /questionnaire/rag/faq-collection/items

**Краткое описание:** Получить список элементов FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код коллекции. |
| q | query | string | Нет | Фильтр по содержимому элемента FAQ. |
| state | query | array | Нет | Фильтр по статусам. |
| s | query | string | Нет | Поле сортировки. |
| asc | query | boolean | Нет | Сортировка по возрастанию. |
| ps | query | integer (int32) | Нет | Размер страницы. |
| p | query | integer (int32) | Нет | Номер страницы (начиная с 1). |

**Ответ (200):**
```json
{
  "paging": {
    "pageNumber": 1,
    "pageSize": 10,
    "total": 5,
    "totalPages": 1
  },
  "items": [
    {
      "index": 0,
      "question": "What is this product?",
      "answer": "This is a great product.",
      "comment": "Product FAQ",
      "state": "Active"
    }
  ]
}
```

---

#### POST /questionnaire/rag/faq-collection/item/create

**Краткое описание:** Создать новый элемент FAQ.

**Тело запроса:**
```json
{
  "code": "FAQ-001",
  "index": 0,
  "question": "What is this product?",
  "answer": "This is a great product.",
  "comment": "Product FAQ",
  "state": "Active"
}
```

**Ответ (200):**
```json
{
  "index": 0,
  "question": "What is this product?",
  "answer": "This is a great product.",
  "comment": "Product FAQ",
  "state": "Active"
}
```

---

#### GET /questionnaire/rag/faq-collection/item

**Краткое описание:** Получить элемент FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код коллекции. |
| index | query | integer (int32) | Да | Нулевой индекс элемента FAQ в коллекции. |

**Ответ (200):**
```json
{
  "index": 0,
  "question": "What is this product?",
  "answer": "This is a great product.",
  "comment": "Product FAQ",
  "state": "Active"
}
```

#### POST /questionnaire/rag/faq-collection/item

**Краткое описание:** Обновить элемент FAQ.

**Тело запроса:**
```json
{
  "code": "FAQ-001",
  "index": 0,
  "newIndex": 1,
  "question": "Updated question?",
  "answer": "Updated answer.",
  "comment": "Updated comment",
  "state": "Active"
}
```

#### DELETE /questionnaire/rag/faq-collection/item

**Краткое описание:** Удалить элемент FAQ.

**Параметры:**
| Имя | В | Тип | Обязательно | Описание |
|-----|---|-----|--------------|----------|
| code | query | string | Да | Код коллекции. |
| index | query | integer (int32) | Да | Нулевой индекс элемента FAQ в коллекции. |

---

### RagQuery

#### POST /questionnaire/rag/query

**Краткое описание:** Выполнить запрос в базе знаний RAG

**Тело запроса:**
```json
{
  "project": "00000000-0000-0000-0000-000000000000",
  "excludeCollections": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "question": "What is this product?",
  "yourCompanyName": "Acme Corp",
  "yourCompanyAlias": "Acme",
  "customerName": "John Doe",
  "options": [
    "option1",
    "option2"
  ],
  "multiselect": false,
  "nArticles": 5,
  "nFaqs": 3,
  "threshold": 0.5,
  "debug": false,
  "withJustification": true,
  "withConfidenceLevel": true,
  "withFragments": true,
  "nAttempts": 3
}
```

**Ответ (200):**
```json
{
  "attempt": 1,
  "preparedQuery": {
    "original": "What is this product?",
    "enhanced": "What is this product and its features?"
  },
  "ragItems": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "distance": 0.25
    }
  ],
  "question": "What is this product?",
  "generalInstructions": "Based on the knowledge base, here is the answer:",
  "text": "This product is a great solution for your needs.",
  "explanation": "The answer was found in multiple sources with high confidence."
}
```

---

#### POST /questionnaire/rag/query-stream

**Краткое описание:** Выполнить запрос в базе знаний RAG (стрим)

**Тело запроса:**
```json
{
  "project": "00000000-0000-0000-0000-000000000000",
  "excludeCollections": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "question": "What is this product?",
  "yourCompanyName": "Acme Corp",
  "yourCompanyAlias": "Acme",
  "customerName": "John Doe",
  "options": [
    "option1",
    "option2"
  ],
  "multiselect": false,
  "nArticles": 5,
  "nFaqs": 3,
  "threshold": 0.5,
  "debug": false,
  "withJustification": true,
  "withConfidenceLevel": true,
  "withFragments": true,
  "nAttempts": 3
}
```

**Ответ (200):**
```json
[
  {
    "text": "This product is a great solution",
    "fragments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "part": 1,
        "distance": 0.25,
        "type": "Article",
        "code": "ART-001",
        "title": "Product Title",
        "fragment": "Product content fragment"
      }
    ]
  },
  {
    "text": " for your needs.",
    "fragments": []
  }
]
```

---

#### POST /questionnaire/rag/query-fragments

**Краткое описание:** Выполнить запрос в базе знаний RAG (фрагменты)

**Тело запроса:**
```json
{
  "project": "00000000-0000-0000-0000-000000000000",
  "exclude_documents": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "query": "What is this product?",
  "top_k": 5,
  "similarity_threshold": 0.5,
  "prepare_query": true
}
```

**Ответ (200):**
```json
{
  "results": [
    {
      "document_id": "00000000-0000-0000-0000-000000000000",
      "document_code": "ART-001",
      "document_title": "Product Title",
      "revision": 3,
      "chunk_index": 0,
      "content": "Product content fragment",
      "metadata": {
        "author": "John Doe",
        "created_at": "2025-01-15T10:30:00Z",
        "last_updated_at": "2025-01-15T10:35:00Z",
        "doc_categories": [
          "Product",
          "Information"
        ]
      },
      "similarity_score": 0.85
    }
  ]
}
```

## Связанные статьи

- [Токены API – генерация и управление](/api-tokens/) – как создавать и управлять токенами  
- [Запрос к ИИ с вашей базой знаний](/ask-ai-with-your-knowledge-base/) – использование запросов RAG