MedAssist
MedAssist · GPT-Aktionen
paperAI
Lets the user find scientific papers
GET /ai/searchFind papers based on keywords
Ursprüngliches API-Schema
{
"openapi": "3.1.0",
"info": {
"title": "paperAI",
"description": "Lets the user find scientific papers",
"version": "v1"
},
"servers": [
{
"url": "https://oa.mg"
}
],
"paths": {
"/ai/search": {
"get": {
"operationId": "search",
"summary": "Find papers based on keywords",
"parameters": [
{
"name": "search",
"in": "query",
"description": "keywords that should appear in paper title, fulltext, body text, abstract",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "The sort order for results. Valid values are cited_by_count:desc or publication_year:desc. To fetch latest papers, use publication_year:desc value. Use cited_by_count:desc to find the most popular or most cited papers. Excluding this value does a relevance based search.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "query",
"in": "query",
"description": "The user query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/searchResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"searchResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"Meta": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"db_response_time_ms": {
"type": "integer",
"description": "The database response time in milliseconds."
},
"page": {
"type": "integer",
"description": "The current page number."
},
"per_page": {
"type": "integer",
"description": "The number of results per page."
}
}
},
"Result": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the work."
},
"doi": {
"type": "string",
"description": "The DOI of the work."
},
"title": {
"type": "string",
"description": "The title of the work."
},
"relevance_score": {
"type": "number",
"description": "The relevance_score is based on text similarity to your search term. It also includes a weighting term for citation counts. More highly-cited entities score higher, all else being equal."
},
"publication_year": {
"type": "integer",
"description": "The year this work was published."
},
"publication_date": {
"type": "string",
"description": "The day when this work was published, formatted as an ISO 8601 date. Where different publication dates exist, we select the earliest available date of electronic publication."
},
"ids": {
"$ref": "#/components/schemas/Ids",
"description": "The different identifiers of the work."
},
"language": {
"type": "string",
"description": "The language of the work."
},
"primary_location": {
"$ref": "#/components/schemas/PrimaryLocation",
"description": "The primary location of the work. The primary_location is where you can find the best (closest to the version of record) copy of this work. For a peer-reviewed journal article, this would be a full text published version, hosted by the publisher at the article’s DOI URL."
},
"type": {
"type": "string"
},
"open_access": {
"$ref": "#/components/schemas/OpenAccess"
},
"authorships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Authorship"
}
},
"corresponding_author_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"corresponding_institution_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"apc_list": {
"type": "array",
"items": {
"type": "string"
}
},
"apc_paid": {
"type": "boolean"
},
"cited_by_count": {
"type": "integer"
},
"biblio": {
"$ref": "#/components/schemas/Biblio"
},
"is_retracted": {
"type": "boolean"
},
"is_paratext": {
"type": "boolean"
},
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Concept"
}
},
"mesh": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mesh"
}
},
"locations_count": {
"type": "integer"
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
},
"best_oa_location": {
"$ref": "#/components/schemas/BestOaLocation"
},
"grants": {
"type": "array",
"items": {
"type": "object"
}
},
"referenced_works": {
"type": "array",
"items": {
"type": "string"
}
},
"related_works": {
"type": "array",
"items": {
"type": "string"
}
},
"ngrams_url": {
"type": "string"
},
"abstract": {
"type": "string",
"description": "The paper’s abstract"
},
"oamgLink": {
"type": "string",
"description": "A link to the paper on OA.mg"
},
"cited_by_api_url": {
"type": "string"
},
"counts_by_year": {
"type": "array",
"items": {
"type": "object"
}
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
}
}
},
"Ids": {
"type": "object",
"properties": {
"openalex": {
"type": "string"
},
"doi": {
"type": "string",
"description": "The DOI for the work. This is the Canonical External ID for works"
},
"mag": {
"type": "string",
"description": "The Microsoft Academic Graph ID)"
},
"pmid": {
"type": "string",
"description": "The Pubmed Identifier)"
},
"pmcid": {
"type": "string",
"description": "The Pubmed Central identifier)"
}
}
},
"PrimaryLocation": {
"type": "object",
"description": "A Location object with the primary location of this work. The primary_location is where you can find the best (closest to the version of record) copy of this work. For a peer-reviewed journal article, this would be a full text published version, hosted by the publisher at the article’s DOI URL.",
"properties": {
"is_oa": {
"type": "boolean",
"description": "True if this work is Open Access (OA). There are many ways to define OA. We use the definition of having a URL where you can read the fulltext of this work without needing to pay money or log in."
},
"host_type": {
"type": "string"
},
"version": {
"type": "string"
},
"url_for_pdf": {
"description": "A URL where you can find this location as a PDF.",
"type": "string"
},
"url_for_landing_page": {
"type": "string"
},
"pmh_id": {
"type": "string"
},
"repository_id": {
"type": "string"
},
"repository_name": {
"type": "string"
},
"repository_url": {
"type": "string"
},
"repository_institution_id": {
"type": "string"
},
"journal_id": {
"type": "string"
},
"journal_name": {
"type": "string"
},
"journal_issns": {
"type": "array",
"items": {
"type": "string"
}
},
"journal_is_oa": {
"type": "boolean"
}
}
},
"OpenAccess": {
"type": "object",
"description": "Information about the access status of this work.",
"properties": {
"is_oa": {
"type": "boolean",
"description": "True if this work is Open Access (OA)."
},
"oa_status": {
"type": "string",
"description": "The Open Access (OA) status of this work. Possible values are Gold (Published in an OA journal that is indexed by the DOAJ), Green (Toll-access on the publisher landing page, but there is a free copy in an OA repository), Hybrid (Free under an open license in a toll-access journal), Bronze (Free to read on the publisher landing page, but without any identifiable license.) Closed (All other articles that are not open access)"
}
}
},
"Authorship": {
"type": "object",
"properties": {
"author_id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"middle_initial": {
"type": "string"
},
"last_name": {
"type": "string"
},
"initials": {
"type": "string"
},
"corresponding": {
"type": "boolean"
},
"affiliation_id": {
"type": "string"
},
"affiliation": {
"type": "string"
},
"affiliation_ror_id": {
"type": "string"
},
"affiliation_free_text": {
"type": "string"
}
}
},
"Biblio": {
"type": "object",
"properties": {
"citation_count": {
"type": "integer"
},
"reference_count": {
"type": "integer"
},
"issue": {
"type": "string"
},
"journal": {
"type": "string"
},
"pages": {
"type": "string"
},
"volume": {
"type": "string"
}
}
},
"Concept": {
"type": "object",
"properties": {
"concept_id": {
"type": "string"
},
"concept_name": {
"type": "string"
},
"concept_url": {
"type": "string"
}
}
},
"Mesh": {
"type": "object",
"properties": {
"major_topic": {
"type": "boolean"
},
"mesh_id": {
"type": "string"
},
"mesh_heading": {
"type": "string"
},
"mesh_url": {
"type": "string"
}
}
},
"Location": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"lat": {
"type": "number"
},
"lon": {
"type": "number"
},
"geonames_id": {
"type": "string"
},
"wikidata_qid": {
"type": "string"
},
"place_id": {
"type": "string"
},
"bbox": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"BestOaLocation": {
"type": "object",
"properties": {
"is_oa": {
"type": "boolean"
},
"host_type": {
"type": "string"
},
"version": {
"type": "string"
},
"url_for_pdf": {
"type": "string",
"description": "A URL where you can find this location as a PDF."
},
"url_for_landing_page": {
"type": "string"
},
"pmh_id": {
"type": "string"
},
"repository_id": {
"type": "string"
},
"repository_name": {
"type": "string"
},
"repository_url": {
"type": "string"
},
"repository_institution_id": {
"type": "string"
},
"journal_id": {
"type": "string"
},
"journal_name": {
"type": "string"
},
"journal_issns": {
"type": "array",
"items": {
"type": "string"
}
},
"journal_is_oa": {
"type": "boolean"
}
}
}
}
}
}