# SmartCiteCon **Repository Path**: irlab/SmartCiteCon ## Basic Information - **Project Name**: SmartCiteCon - **Description**: A semantic citation context extraction tool for academic literature. Provide citation context extraction of academic documents in PDF format and XML format in accordance with Plosone data set standards - **Primary Language**: Java - **License**: MIT - **Default Branch**: master - **Homepage**: http://114.55.101.144/ - **GVP Project**: No ## Statistics - **Stars**: 2 - **Forks**: 1 - **Created**: 2019-08-14 - **Last Updated**: 2024-04-26 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # SmartCiteCon ## **Description** A semantic citation context extraction tool for academic literature. Provide citation context extraction of academic documents in PDF format and XML format in accordance with Plosone data set standards ## **Installation** 1. Install Java8 2. Download the following compressed package and unzip the link: https://pan.baidu.com/s/1PPARTNc0NipZ7bKaNmsupg extraction code: ixj4 3. Go to the grobid-0.5.6 folder, open the console under this folder and run the command ：gradlew run 4. Open the console under the folder containing the jar package and run the command ：java -jar smart_cite-1.0.0-SNAPSHOT.jar ## **Interface Description** Note: The uploaded file must be an academic paper and must conform to the supported file format The file formats supported by SCC are: XML of Plosone database, XML of TEI format, Json data conforming to GORC data format ### /Extract Function: Extract the citation context of a single paper Request method: POST Request address: /extract Request parameters: | method | request type | response type | parameters | reqirement | description| |---|---|---|---|---|---| |post|multipart/form-data|application/json|file|required|Pending file| Example request: ```ftl curl --location --request POST 'http://localhost:8080/extract' --form 'file=@/E://FileStorage/File/2020-05/pdf/CO13_1p014.pdf' ``` Return parameter: code|message|data|action ---|---|---|--- 0|Success|JsonObject|displays the received data 100|File error, please upload the correct file|null|prompt error message 500|server error|null|prompt error message Return result： ```json { "code": 0, "msg": "extract successfully", "data": { "fileName": "asset_id=10.1371%2Fjournal.pone.0000039.XML", "refTags": [ { "reference": { "volume": "67", "article_title": "Behavioral study of obedience.", "issue": "null", "fpage": "371", "year": "1963", "id": "pone.0000039-Milgram1", "label": "null", "source": "Journal of Abnormal and Social Psychology", "lpage": "378", "authors": [ { "surName": "Milgram", "givenName": "null" } ] }, "sentence": { "id": 2, "text": "He showed that in a social structure with recognised lines of authority, ordinary people could be relatively easily persuaded to give what seemed to be even lethal electric shocks to another randomly chosen person , ." }, "contextList": [ { "id": 1, "text": "In an attempt to understand events in which people carry out horrific acts against their fellows Stanley Milgram carried out a series of experiments in the 1960s at Yale University that directly attempted to investigate whether ordinary people might obey the orders of an authority figure to cause pain to a stranger." }, { "id": 3, "text": "His results are often cited today, for example, recently in helping to explain how people become embroiled in organised prisoner abuse and even suicide bombings ." }, { "id": 4, "text": "However, his study also ignited a far-reaching debate about the ethics of deception and of putting subjects in a highly distressing situation in the course of research , , and as a result this line of research is no longer amenable to direct experimental studies." }, { "id": 5, "text": "Milgram's paradigm was an experiment that subjects were led to believe was a study of the effects of punishment on learning." }, { "id": 6, "text": "The subjects, referred to as Teachers, were asked to administer electric shocks of increasing voltages to another subject (the Learner) whenever he gave a wrong answer in a word-memory experiment." } ], "id": 1, "text": "[1]" }, { "reference": { "volume": "null", "article_title": "null", "issue": "null", "fpage": "null", "year": "1974", "id": "pone.0000039-Milgram2", "label": "null", "source": "Obedience to Authority:", "lpage": "null", "authors": [ { "surName": "Milgram", "givenName": "null" } ] }, "sentence": { "id": 2, "text": "He showed that in a social structure with recognised lines of authority, ordinary people could be relatively easily persuaded to give what seemed to be even lethal electric shocks to another randomly chosen person , ." }, "contextList": [ { "id": 1, "text": "In an attempt to understand events in which people carry out horrific acts against their fellows Stanley Milgram carried out a series of experiments in the 1960s at Yale University that directly attempted to investigate whether ordinary people might obey the orders of an authority figure to cause pain to a stranger." }, { "id": 3, "text": "His results are often cited today, for example, recently in helping to explain how people become embroiled in organised prisoner abuse and even suicide bombings ." }, { "id": 4, "text": "However, his study also ignited a far-reaching debate about the ethics of deception and of putting subjects in a highly distressing situation in the course of research , , and as a result this line of research is no longer amenable to direct experimental studies." }, { "id": 5, "text": "Milgram's paradigm was an experiment that subjects were led to believe was a study of the effects of punishment on learning." }, { "id": 6, "text": "The subjects, referred to as Teachers, were asked to administer electric shocks of increasing voltages to another subject (the Learner) whenever he gave a wrong answer in a word-memory experiment." } ], "id": 2, "text": "[2]" } ] } } ``` ### /Batch Extraction Function: Batch extract citation contexts of multiple papers Request method: POST Request address: /batchExtract Request parameters: | method | request type | response type | parameters | reqirement | description| |---|---|---|---|---|---| |post|multipart/form-data|application/json|file|required|Pending zip file| Example request: ```ftl curl --location --request POST 'http://localhost:8080/batchExtract' --form 'file=@/E:/temp/plos/computer_science/3(done).zip' ``` Return parameter: code|message|data|action ---|---|---|--- 0|Success|JsonObject|displays the received data 100|File error, please upload the correct file|null|prompt error message 500|server error|null|prompt error message Return result： ```json { "code": 0, "msg": "Successful extraction", "data": [ { "fileName": "asset_id=10.1371%2Fjournal.pone.0000039.XML", "refTags": [ { "reference": { "volume": "67", "article_title": "Behavioral study of obedience.", "issue": "null", "fpage": "371", "year": "1963", "id": "pone.0000039-Milgram1", "label": "null", "source": "Journal of Abnormal and Social Psychology", "lpage": "378", "authors": [ { "surName": "Milgram", "givenName": "null" } ] }, "sentence": { "id": 2, "text": "He showed that in a social structure with recognised lines of authority, ordinary people could be relatively easily persuaded to give what seemed to be even lethal electric shocks to another randomly chosen person , ." }, "contextList": [ { "id": 1, "text": "In an attempt to understand events in which people carry out horrific acts against their fellows Stanley Milgram carried out a series of experiments in the 1960s at Yale University that directly attempted to investigate whether ordinary people might obey the orders of an authority figure to cause pain to a stranger." }, { "id": 3, "text": "His results are often cited today, for example, recently in helping to explain how people become embroiled in organised prisoner abuse and even suicide bombings ." }, { "id": 4, "text": "However, his study also ignited a far-reaching debate about the ethics of deception and of putting subjects in a highly distressing situation in the course of research , , and as a result this line of research is no longer amenable to direct experimental studies." }, { "id": 5, "text": "Milgram's paradigm was an experiment that subjects were led to believe was a study of the effects of punishment on learning." }, { "id": 6, "text": "The subjects, referred to as Teachers, were asked to administer electric shocks of increasing voltages to another subject (the Learner) whenever he gave a wrong answer in a word-memory experiment." } ], "id": 1, "text": "[1]" },... ] },... ] } ``` ### /localExtract Function: Extract the citation context of all papers in the folder note: 1. The folder must be on the local server 2. The files in the folder must be in the format supported by SCC 3. The processing results are stored in the output folder at the same level as the jar package 4. Please do not shut down the service before processing Request method: GET Request address: /localExtract Request parameters: | method | request type | response type | parameters | reqirement | description| |---|---|---|---|---|---| |get|||path|required|Folder path containing pending files| Example request: ```ftl curl --location --request GET 'http://localhost:8080/localExtract?path=/home/guochenrui/smart_cite/3000' ``` Return parameter: No parameters. Just issue a request, without waiting for the return parameter. ### /count/contextNum Function: Count the number of ICC and ECC in the result file Request method: GET Request address: /count/contextNum Request parameters: | method | request type | response type | parameters | reqirement | description| |---|---|---|---|---|---| |get| | |outputFolder|unrequired|The path of the folder containing the result, the default is the output folder| Example request: ```ftl curl --location --request GET 'http://localhost:8080/count/contextNum?outputFolder=E:\code\smart_cite\output\json' ``` Return parameter: code|message|data|action ---|---|---|--- 0|Success|JsonObject|displays the received data 100|File error, please upload the correct file|null|prompt error message 500|server error|null|prompt error message Return result： ```json { "code": 0, "msg": "extract successfully", "data": { "ECC": 1605695, "ICC": 10215848, "FileNum": 33319 } } ``` ## **Other Instructions** 1. Default request port: 8080 2. Upload file size ≤ 10M 3. The configuration file is located in the resource folder at the same level as the jar package. You can modify the default port and other parameters according to your situation.