...
Code Block |
---|
{ "display": string, "entities": [ { "iterateOver" : "string", // OPTIONAL: If specified, a metadata field (nesting supported using dot notation) which is looped over to generate calls with _value/_iterator/_index "disambiguated_name" : "string", // MANDATORY: String/script, the disambiguated name of the entity "actual_name" : "string", // OPTIONAL: String/script, the actual name of the entity if different to the disambiguated name "dimension" : "string", // MANDATORY: String/script: Must be/return one of "Who", "What", "Where" "type" : "string", // MANDATORY: String/script: It is recommended to use a type from the // OpenCyc, AlchemyAPI, or OpenCalais ontologies, for compatibility with future Infinit.e features "linkdata": "string", // OPTIONAL: if present should return a comma-separated list of URLs (commas should be URL-encoded) "relevance" : "string", // OPTIONAL: String/script: Must specify/return a double/string-parsable-into-a-double "sentiment" : "string", // OPTIONAL: String/script: Must specify/return a double/string-parsable-into-a-double, by convention this is between -1.0 and 1.0. "frequency" : "string", // OPTIONAL: Must specify/return a long/string-parsable-into-a-long "geotag" : { // OPTIONAL: Format is identical to the docGeo format specified above "lat": "string", "lon": "string, "city": "string", "stateProvince": "string, "country": "string", "countryCode": "string }, "ontology_type": "string", // OPTIONAL: String/script: Only used if geotag is specified: // allows specification of the scale of the geographic entity (see below for useful link), defaults to "point" "useDocGeo": "boolean", // OPTIONAL: If true, uses any lat/long generated from the top level "docGeo" specification, defaults to false "creationCriteriaScript" : "string", // OPTIONAL: script: If populated, runs a user script function and if return value is false doesn't create the object } ] } |
...