document optional parameter includeRawCitations for patent processing

kermitt2 · Aug 16, 2019 · bb8cf62 · bb8cf62
1 parent 27a1eed
commit bb8cf62
Showing 1 changed file with 41 additions and 0 deletions.
diff --git a/doc/Grobid-service.md b/doc/Grobid-service.md
@@ -548,6 +548,47 @@ Response status codes:
 
 A `503` error with the default parallel mode normally means that all the threads available to GROBID are currently used. The client need to re-send the query after a wait time that will allow the server to free some threads. The wait time depends on the capacities of the server and the size of the input document, we suggest 5-10 seconds for the `processCitationPatentST36` service. 
 
+For non patent citations, it is possible to include the original raw reference string in the parsed result with the parameter `includeRawCitations` set to 1, for instance: 
+
+```bash
+curl --form input=@/home/lopez/grobid/grobid-core/src/test/resources/s/006271747.xml --form includeRawCitations=1 localhost:8070/api/processCitationPatentST36
+```
+
+```xml
+<biblStruct >
+    <analytic>
+        <title/>
+        <author>
+            <persName xmlns="http://www.tei-c.org/ns/1.0"><forename type="first">T</forename><forename type="middle">J</forename><surname>Vaughan</surname></persName>
+        </author>
+    </analytic>
+    <monogr>
+        <title level="j">Nat.Biotech</title>
+        <imprint>
+            <biblScope unit="volume">14</biblScope>
+            <biblScope unit="page" from="309" to="314" />
+            <date type="published" when="1996" />
+        </imprint>
+    </monogr>
+    <note type="raw_reference"> Vaughan, T.J. et al., Nat.Biotech., 14:309-314(1996)</note>
+</biblStruct>
+
+
+<biblStruct >
+    <monogr>
+        <title/>
+        <author>
+            <persName xmlns="http://www.tei-c.org/ns/1.0"><forename type="first">Perkin</forename><surname>Elmer</surname></persName>
+        </author>
+        <imprint>
+            <biblScope unit="volume">1</biblScope>
+            <biblScope unit="page">1000</biblScope>
+        </imprint>
+    </monogr>
+    <note type="report_type">Cat.1244-360</note>
+    <note type="raw_reference">Perkin Elmer, Cat.1244-360, 1:1000</note>
+</biblStruct>
+```
 
 #### /api/processCitationPatentPDF