Ctrl K
Back to Discovery
Litmaps
Holen Sie sich Hilfe bei der Erkundung der wissenschaftlichen Literatur. Finden Sie relevante Arbeiten und generieren Sie Mindmaps der Literatur.
Tool Parameters
healthCheck
fetchArticles
keywordSearch
getSearch
createSearch
getSearchResultBySearchResultId
getArticleById
Health Check
| Parameter | Type |
|---|---|
No data | |
JSON Schema
json
[
{
"description": "Health Check",
"name": "healthCheck",
"parameters": {
"properties": {},
"type": "object"
}
},
{
"description": "Fetch articles by ID",
"name": "fetchArticles",
"parameters": {
"properties": {
"_requestBody": {
"type": "object",
"description": "Filter objects, can either be {\"field\": \"field-name\", \"direction\": \"ascending/descending\"} or {\"search\": \"query\"}",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"filters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"fedges",
"authors",
"title",
"bedges",
"date"
]
},
"direction": {
"type": "string",
"enum": [
"ascending",
"descending"
]
}
}
},
{
"type": "object",
"properties": {
"search": {
"type": "string",
"example": "Peroxiredoxin"
}
}
},
{
"type": "object",
"properties": {
"startDate": {
"type": "string",
"example": "2010-01-01T00:00:00.000Z"
},
"endDate": {
"type": "string",
"example": "2021-01-01T00:00:00.000Z"
}
}
}
]
}
},
"showArticleDetails": {
"type": "boolean",
"example": true
},
"page": {
"type": "number",
"example": 1
},
"per": {
"type": "number",
"example": 100
}
}
}
},
"type": "object"
}
},
{
"description": "Get Keyword Search Result",
"name": "keywordSearch",
"parameters": {
"properties": {
"query": {
"type": "string"
},
"page": {
"type": "integer"
},
"per": {
"type": "integer"
},
"useReranker": {
"type": "boolean",
"example": false
},
"showArticleDetails": {
"type": "boolean",
"default": false
},
"searchEngine": {
"type": "string",
"enum": [
"litmaps",
"semantic_scholar"
]
}
},
"required": [
"query",
"useReranker"
],
"type": "object"
}
},
{
"description": "Get Search",
"name": "getSearch",
"parameters": {
"properties": {
"searchId": {
"type": "string",
"example": "3c72bfd6-1501-4fbc-9a19-848596a69374"
},
"type": {
"type": "string",
"enum": [
"seed"
]
}
},
"required": [
"searchId",
"type"
],
"type": "object"
}
},
{
"description": "Create Search",
"name": "createSearch",
"parameters": {
"properties": {
"_requestBody": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"deep",
"shallow",
"seed"
]
},
"articleIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"collectionIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"hiddenArticleIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"example": "2001-01-01"
},
"endDate": {
"type": "string",
"example": "2021-01-01"
}
}
},
"keywordFilterString": {
"type": "string",
"example": "Human peroxiredoxin 3"
}
}
}
}
}
}
},
"type": "object"
}
},
{
"description": "Get Search Result by Search Result Id",
"name": "getSearchResultBySearchResultId",
"parameters": {
"properties": {
"searchResultId": {
"type": "string",
"example": "3c72bfd6-1501-4fbc-9a19-848596a69374"
},
"type": {
"type": "string",
"enum": [
"seed"
]
}
},
"required": [
"searchResultId",
"type"
],
"type": "object"
}
},
{
"description": "Fetch article by ID",
"name": "getArticleById",
"parameters": {
"properties": {
"id": {
"type": "integer",
"default": 123
}
},
"required": [
"id"
],
"type": "object"
}
}
]
