silobreaker.documents.entities.xml

<?xml version="1.0" encoding="UTF-8"?>
<table xmlns="http://query.yahooapis.com/v1/schema/table.xsd">
    <meta>
			<author>Sebastian Spier (http://twitter.com/#!/sebastianspier/)</author>
			<description> 
				1) /documents/{query}/entities - returns entities mentioned in documents matching the query string.
				2) /documents/{query}/entities/{types} - returns entities of specific types mentioned in documents matching the query string.
				</description>
			<documentationURL>http://api.silobreaker.com/ApiReference.htm</documentationURL>
	    <sampleQuery description="eturns entities mentioned in documents matching the query string">
				SELECT * FROM {table} WHERE query="Sweden" AND apiKey="YOUR_API_KEY"
			</sampleQuery>
			<sampleQuery description="returns entities of specific types mentioned in documents matching the query string">
				SELECT * FROM {table} WHERE query="Sweden" AND types="City" AND apiKey="YOUR_API_KEY"
			</sampleQuery>
    </meta>
    <bindings>
	
		  <select itemPath="ItemListResultOfTermData.Items.TermData" produces="XML">
		      <urls>
		          <url>http://api.silobreaker.com/documents/{q}/entities/{types}</url>
		      </urls>
		      <paging model="page">
		        <start id="pageNumber" default="0" />
		        <pagesize id="pageSize" max="250" />
		        <total default="20" />
		      </paging>
		      <inputs>
							<key id="q" as="query" type="xs:string" paramType="path" required="true" />
		          <key id="apiKey" type="xs:string" paramType="query" required="true" />
							<key id="type" type="xs:string" paramType="query" default="xml" const="true" />

							<key id="entityTypeLimits" type="xs:string" paramType="path" />
							
							<!-- 
								Comma separated list of entity types that should be returned. Valid types are:
								Person
								Company
								Organization
								Keyphrase
								Country
								City
							-->
							<key id="types" type="xs:string" paramType="path" required="true"/>													
		      </inputs>
		  </select>
		
		  <select itemPath="ItemListResultOfTermData.Items.TermData" produces="XML">
		      <urls>
		          <url>http://api.silobreaker.com/documents/{q}/entities</url>
		      </urls>
		      <paging model="page">
		        <start id="pageNumber" default="0" />
		        <pagesize id="pageSize" max="250" />
		        <total default="20" />
		      </paging>
		      <inputs>
							<key id="q" as="query" type="xs:string" paramType="path" required="true" />
		          <key id="apiKey" type="xs:string" paramType="query" required="true" />
							<key id="type" type="xs:string" paramType="query" default="xml" const="true" />										
		      </inputs>
		  </select>
	
     </bindings>
</table>