APIСправочник API
Похожие продукты
POST /v1/products/similar
POST /v1/products/similar
Доступ
Требуется bearer-авторизация. Описание операции задаёт дополнительные права, роли и ограничения для сессий кабинета. Сам по себе API-ключ их не предоставляет.
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
smiles | string | да | Набор продуктов в SMILES для сравнения по сходству Morgan/Tanimoto. |
threshold | number | нет | По умолчанию: 0.5. |
limit | integer | нет | Максимальное количество записей: от 1 до 100. По умолчанию: 10. |
validated_only | boolean | нет | По умолчанию: true. |
Полная схема: SimilarProductsRequest
{
"properties": {
"smiles": {
"type": "string",
"maxLength": 10000,
"minLength": 1,
"title": "Smiles",
"description": "Product set (SMILES) to compare by Morgan/Tanimoto similarity."
},
"threshold": {
"type": "number",
"maximum": 1,
"minimum": 0.05,
"title": "Threshold",
"default": 0.5
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"description": "Maximum records, from 1 to 100.",
"default": 10
},
"validated_only": {
"type": "boolean",
"title": "Validated Only",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"smiles"
],
"title": "SimilarProductsRequest"
}Ответы
| HTTP | Описание | Тип |
|---|---|---|
| 200 | Успешный ответ | application/json: SimilarProductsResult |
| 401 | Требуется авторизация | application/problem+json: ProblemDetails |
| 402 | Недостаточно кредитов | application/problem+json: ProblemDetails |
| 403 | Доступ запрещён | application/problem+json: ProblemDetails |
| 408 | Время запроса истекло | application/problem+json: ProblemDetails |
| 413 | Превышен размер запроса | application/problem+json: ProblemDetails |
| 422 | Ошибка входных данных | application/problem+json: ProblemDetails |
| 429 | Превышен лимит | application/problem+json: ProblemDetails |
| 502 | Ошибка шлюза | application/problem+json: ProblemDetails |
| 503 | Сервис недоступен | application/problem+json: ProblemDetails |
Ответ: SimilarProductsResult
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
items | SimilarProduct[] | да | |
metric | string | да | |
fingerprint | string | да | |
threshold | number | да | |
scanned_candidates | integer | да | |
search_is_exact_over_fingerprints | boolean | да | |
is_reaction_prediction | boolean | да | |
limitation | string | да |
Полная схема
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SimilarProduct"
},
"type": "array",
"title": "Items"
},
"metric": {
"type": "string",
"const": "Tanimoto",
"title": "Metric"
},
"fingerprint": {
"type": "string",
"title": "Fingerprint"
},
"threshold": {
"type": "number",
"title": "Threshold"
},
"scanned_candidates": {
"type": "integer",
"title": "Scanned Candidates"
},
"search_is_exact_over_fingerprints": {
"type": "boolean",
"title": "Search Is Exact Over Fingerprints"
},
"is_reaction_prediction": {
"type": "boolean",
"title": "Is Reaction Prediction"
},
"limitation": {
"type": "string",
"title": "Limitation"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"items",
"metric",
"fingerprint",
"threshold",
"scanned_candidates",
"search_is_exact_over_fingerprints",
"is_reaction_prediction",
"limitation"
],
"title": "SimilarProductsResult"
}Эта страница генерируется из OpenAPI. Примеры показывают схемы, а не вымышленные успешные ответы.