SpotXml

SpotXml is how we call the XML format generated as output by /candidates and parsed as input by SpotXmlParser.

<annotation text="Brazilian oil giant Petrobras and U.S. oilfield service company Halliburton have signed a technological cooperation agreement, Petrobras announced Monday. The two companies agreed on three projects: studies on contamination of fluids in oil wells, laboratory simulation of well production, and research on solidification of salt and carbon dioxide formations, said Petrobras. Twelve other projects are still under negotiation.">
<surfaceForm name="oil" offset="10"/>
<surfaceForm name="company" offset="56"/>
<surfaceForm name="Halliburton" offset="64"/>
<surfaceForm name="oil" offset="237"/>
<surfaceForm name="other" offset="383"/>
</annotation>

If you want to run Phrase Spotting on your own, and send over your spots for us to disambiguate, you can encode them in this XML format and use the parameter &spotter=SpotXmlParser when sending the input to us. See: Custom Spotting

TODO: Expand this entry to explain what each element in the XML means.