База знаний

Полнотекстовый и векторный поиск, граф знаний.

Рассчитать аналитику

Авторизация

АвторизацияBearer <токен>

В: header

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/knowledge/analytics/compute"

{
  "property1": null,
  "property2": null
}

Список баз знаний

Авторизация

АвторизацияBearer <токен>

В: header

Тело ответа

`application/json`

curl -X GET "https://loading/api/v1/knowledge/bases"

[
  {
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "folderId": "string",
    "id": "string",
    "name": "string",
    "teamId": "string",
    "property1": null,
    "property2": null
  }
]

Создать базу знаний

Авторизация

АвторизацияBearer <токен>

В: header

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

description?string

Описание базы знаний

Длинаlength <= 2000

folderId?|

Папка; null — корень

Форматuuid

name*string

Название базы знаний

Длина1 <= length <= 255

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/knowledge/bases" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "createdAt": "string",
  "createdBy": "string",
  "description": "string",
  "folderId": "string",
  "id": "string",
  "name": "string",
  "teamId": "string",
  "property1": null,
  "property2": null
}

Получить базу знаний

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

baseId*string

Идентификатор базы знаний

Тело ответа

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/knowledge/bases/string"

{
  "createdAt": "string",
  "createdBy": "string",
  "description": "string",
  "folderId": "string",
  "id": "string",
  "name": "string",
  "teamId": "string",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Обновить базу знаний

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

baseId*string

Идентификатор базы знаний

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

description?|

Новое описание (null — удалить)

Длинаlength <= 2000

name?string

Новое название

Длина1 <= length <= 255

Тело ответа

`application/json`

curl -X PATCH "https://loading/api/v1/knowledge/bases/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "createdAt": "string",
  "createdBy": "string",
  "description": "string",
  "folderId": "string",
  "id": "string",
  "name": "string",
  "teamId": "string",
  "property1": null,
  "property2": null
}

Удалить базу знаний

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

baseId*string

Идентификатор базы знаний

Тело ответа

`application/json`

curl -X DELETE "https://loading/api/v1/knowledge/bases/string"

{
  "ok": true
}

Список источников базы знаний

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

baseId*string

Идентификатор базы знаний

Тело ответа

`application/json`

curl -X GET "https://loading/api/v1/knowledge/bases/string/sources"

[
  {
    "chunkCount": 0,
    "createdAt": "string",
    "errorMessage": "string",
    "fileSize": 0,
    "id": "string",
    "knowledgeBaseId": "string",
    "mimeType": "string",
    "name": "string",
    "processedAt": "string",
    "status": "string",
    "type": "string",
    "url": "string",
    "property1": null,
    "property2": null
  }
]

Добавить источник из файла

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

baseId*string

Идентификатор базы знаний

Тело запроса

multipart/form-data

TypeScript-определения

Используйте тип request body в TypeScript.

file*file

Файл PDF, DOCX, XLSX, TXT, MD или CSV

Форматbinary

name?string

Название источника; по умолчанию имя файла

Тело ответа

`application/json`

`application/problem+json`

curl -X POST "https://loading/api/v1/knowledge/bases/string/sources/file" \  -F file="string"

{
  "chunkCount": 0,
  "createdAt": "string",
  "errorMessage": "string",
  "fileSize": 0,
  "id": "string",
  "knowledgeBaseId": "string",
  "mimeType": "string",
  "name": "string",
  "processedAt": "string",
  "status": "string",
  "type": "string",
  "url": "string",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Добавить несколько источников из файлов

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

baseId*string

Идентификатор базы знаний

Тело запроса

multipart/form-data

TypeScript-определения

Используйте тип request body в TypeScript.

files*array<>

Файлы для индексации

Тело ответа

`application/json`

`application/problem+json`

curl -X POST "https://loading/api/v1/knowledge/bases/string/sources/files" \  -F files="[    \"string\"  ]"

{
  "errors": [
    {
      "error": "string",
      "name": "string"
    }
  ],
  "sources": [
    {
      "chunkCount": 0,
      "createdAt": "string",
      "errorMessage": "string",
      "fileSize": 0,
      "id": "string",
      "knowledgeBaseId": "string",
      "mimeType": "string",
      "name": "string",
      "processedAt": "string",
      "status": "string",
      "type": "string",
      "url": "string",
      "property1": null,
      "property2": null
    }
  ]
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Добавить источник из текста

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

baseId*string

Идентификатор базы знаний

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

name*string

Название источника

Длина1 <= length <= 255

text*string

Текст для индексации

Длина1 <= length

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/knowledge/bases/string/sources/text" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "text": "string"  }'

{
  "chunkCount": 0,
  "createdAt": "string",
  "errorMessage": "string",
  "fileSize": 0,
  "id": "string",
  "knowledgeBaseId": "string",
  "mimeType": "string",
  "name": "string",
  "processedAt": "string",
  "status": "string",
  "type": "string",
  "url": "string",
  "property1": null,
  "property2": null
}

Добавить источник по URL

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

baseId*string

Идентификатор базы знаний

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

name*string

Название источника

Длина1 <= length <= 255

url*string

HTTPS-адрес страницы для индексации

Форматuri

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/knowledge/bases/string/sources/url" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "url": "http://example.com"  }'

{
  "chunkCount": 0,
  "createdAt": "string",
  "errorMessage": "string",
  "fileSize": 0,
  "id": "string",
  "knowledgeBaseId": "string",
  "mimeType": "string",
  "name": "string",
  "processedAt": "string",
  "status": "string",
  "type": "string",
  "url": "string",
  "property1": null,
  "property2": null
}

Список сообществ

Авторизация

АвторизацияBearer <токен>

В: header

Тело ответа

`application/json`

curl -X GET "https://loading/api/v1/knowledge/communities"

[
  {
    "id": "string",
    "summary": "string",
    "property1": null,
    "property2": null
  }
]

Определить и описать сообщества

Авторизация

АвторизацияBearer <токен>

В: header

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/knowledge/communities/detect"

[
  {
    "id": "string",
    "summary": "string",
    "property1": null,
    "property2": null
  }
]

Text-to-Cypher запрос (вопрос на естественном языке)

Авторизация

АвторизацияBearer <токен>

В: header

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

question*string

Вопрос к графу знаний на естественном языке

Тело ответа

`application/json`

`application/problem+json`

curl -X POST "https://loading/api/v1/knowledge/cypher" \  -H "Content-Type: application/json" \  -d '{    "question": "string"  }'

{
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Граф знаний команды

Авторизация

АвторизацияBearer <токен>

В: header

Тело ответа

`application/json`

curl -X GET "https://loading/api/v1/knowledge/graph"

{
  "edges": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "nodes": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "property1": null,
  "property2": null
}

Поиск по базе знаний

Авторизация

АвторизацияBearer <токен>

В: header

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

aiAnalysis?boolean

Добавить ИИ-разбор результатов

collections?array<>

Где искать: источники баз знаний, документы, записи реестров

filters?

Фильтры по атрибутам знаний

graphDepth?integer

Глубина обхода графа связей, 0–5

Диапазон0 <= value <= 5

knowledgeBaseIds?array<>

Ограничить поиск этими базами знаний

limit?integer

Максимум результатов, до 50

Диапазон1 <= value <= 50

query*string

Поисковый запрос на естественном языке

Длина1 <= length <= 2000

strategy?string

Стратегия: vector — по смыслу, graph — по связям, hybrid — комбинированная

Значение в"vector" | "graph" | "hybrid"

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/knowledge/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'

{
  "results": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "property1": null,
  "property2": null
}

Получить источник

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

sourceId*string

Идентификатор источника

Тело ответа

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/knowledge/sources/string"

{
  "chunkCount": 0,
  "createdAt": "string",
  "errorMessage": "string",
  "fileSize": 0,
  "id": "string",
  "knowledgeBaseId": "string",
  "mimeType": "string",
  "name": "string",
  "processedAt": "string",
  "status": "string",
  "type": "string",
  "url": "string",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Удалить источник

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

sourceId*string

Идентификатор источника

Тело ответа

`application/json`

curl -X DELETE "https://loading/api/v1/knowledge/sources/string"

{
  "ok": true
}

Получить чанки источника

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

sourceId*string

Идентификатор источника

Тело ответа

`application/json`

curl -X GET "https://loading/api/v1/knowledge/sources/string/chunks"

[
  {
    "id": "string",
    "text": "string",
    "property1": null,
    "property2": null
  }
]

Переобработать источник

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

sourceId*string

Идентификатор источника

Тело ответа

`application/json`

curl -X POST "https://loading/api/v1/knowledge/sources/string/reprocess"

{
  "chunkCount": 0,
  "createdAt": "string",
  "errorMessage": "string",
  "fileSize": 0,
  "id": "string",
  "knowledgeBaseId": "string",
  "mimeType": "string",
  "name": "string",
  "processedAt": "string",
  "status": "string",
  "type": "string",
  "url": "string",
  "property1": null,
  "property2": null
}

База знаний

200application/json

200application/json

201application/json

200application/json

404application/problem+json

200application/json

200application/json

200application/json

201application/json

400application/problem+json

201application/json

400application/problem+json

201application/json

201application/json

200application/json

200application/json

200application/json

400application/problem+json

200application/json

200application/json

200application/json

404application/problem+json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/problem+json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/problem+json`

`application/json`

`application/json`

`application/json`

`application/problem+json`

`application/json`

`application/json`

`application/json`