sciwing.api.routers¶

citation_intent_clf¶

sciwing.api.routers.citation_intent_clf.classify_citation_intent(citation: str)¶

End point to classify a citation intent into `Background`, `Method`, `Result Comparison`

Parameters:	citation (str) – String containing the citation to another work
Returns:	`{"tags": Predicted tag for the citation, "citation": the citation itself}`
Return type:	JSON

i2b2¶

sciwing.api.routers.i2b2.return_tags(text: str)¶

Tags the text that you send according to i2b2 model with problem, treatment and tests

Parameters:	text (str) – The text to be tagged
Returns:	`{tags: Predicted tags, text_tokens: Tokens in the text }`
Return type:	JSON

parscit¶

sciwing.api.routers.parscit.tag_citation_string(citation: str)¶

End point to tag parse a reference string to their constituent parts.

Parameters:	citation (str) – The reference string to be parsed.
Returns:	`{"tags": Predicted tags, "text_tokens": Tokenized citation string}`
Return type:	JSON

pdf_pipeline¶

sciwing.api.routers.pdf_pipeline.pdf_pipeline(file: <sphinx.ext.autodoc.importer._MockObject object at 0x7f32f2c31550> = <sphinx.ext.autodoc.importer._MockObject object>)¶

Parses the file and returns various analytics about the pdf

Parameters:	file (File) – A File stream
Returns:	Returns a JSON where the key can be a section in the document with value as the text of the document. It can also be other information such as parsed reference strings in the document, or normalised section headers of the document. This is a feature in development. Be careful in using this.
Return type:	JSON

sectlabel¶

sciwing.api.routers.sectlabel.extract_pdf(file: <sphinx.ext.autodoc.importer._MockObject object at 0x7f32f2b12a90> = <sphinx.ext.autodoc.importer._MockObject object>)¶

Extracts the abstract from a scholarly article

Parameters:	file (uploadFile) – Byte Stream of a file uploaded.
Returns:	`{"abstract": The abstract found in the scholarly document}`
Return type:	JSON

sciwing.api.routers.sectlabel.process_pdf(file: <sphinx.ext.autodoc.importer._MockObject object at 0x7f32f2b12a90> = <sphinx.ext.autodoc.importer._MockObject object>)¶

Classifies every line in the document to the logical section of the document. The logical section can be title, author, email, section header, subsection header etc

Parameters:	file (File) – The Bytestream of a file to be uploaded
Returns:	`{"labels": [(line, label)]}`
Return type:	JSON