Documentation for Calais 4.0 entities and events?
Posted on: Sat, 04/18/2009 - 18:36
Hi!
Where can one find the documentation for Calais 4.0 entities and events?
The URL http://opencalais.com/APIresponses seems to describe the Calais 3.1 events and entities. For instance, there is an entry that describes ManagementChange but no entry for EmploymentChange.
I have seen the Excel file that describes differences between Calais 3.1 and Calais 4.0 and I have also seen the RDFS file, but none of these contain information on the required vs optional status for event attributes which is something that I am very interested in.
Basicaly I would like to know which event attributes are guaranteed to be present when a specific event is detected by Calais.
Thanks,
Lars
Trackback URL for this post:
http://www.opencalais.com/trackback/20367
Lars -
The documentation does specify whether an attribute is mandatory or optional. However the documentation is generated by humans, and hence you may find some inaccuracies from time to time ;)
So, it would help if you could send us an example or two of sentences that generated results 'not as advertised'. We would then assess whether it's a documentation glitch or something in the service.
Regards,
Michal,
I have visited http://opencalais.com/documentation/calais-web-service-api and I cannot find any information about event attributes, at least not on whether they are mandatory or optional. At http://opencalais.com/documentation/calais-web-service-api/interpreting-... there are a few examples of output, and at http://opencalais.com/documentation/calais-web-service-api/rdfs there is the RDFS description, but this only specifies if an attribute can be part of an event at all, not whether it is mandatory or optional.
Anyway, one of the texts that our software ran across was taken from a site called Globes. The text is : "Blue Square eyes haredi market with appointment. The supermarket chain has appointed a Degel Hatorah Jerusalem councilman as CEO of the Shefa Shuk chain." This generated the following employmentchange event:
As can be seen, no c:person attribute is present. Since I have not been able to locate the documentation for the EmploymentChange event I am not sure if this is a bug or not but I know that c:person was a mandatory attribute of the old ManagementChange event.
Lars
Lars -
According to the documentation for Employment Change: "One of the following: Company, Organization or Position, is required. Company and Organization are mutually exclusive. Only one of the two can be used." So indeed Person isn't a mandatory attribute.
The URL I was referring you to is the root page for all our documentation. For entities, facts and events details you need to browse to the following URL: http://opencalais.com/documentation/calais-web-service-api/api-metadata/....
And these are the bread crumbs: Calais Web Service API > API Metadata - English > Entity/Fact/Event Index and Definitions.
Regards,
Michal
Hi Lars,
Sorry for the confusion. With the release of R4 we've 'renovated' the Web Service documentation (but apparently overlooked redirecting the old URL to the new area).
You can find the brand new Web Service documentation here:
http://opencalais.com/documentation/calais-web-service-api
And in general the full documentation area is now located here:
http://opencalais.com/documentation/opencalais-documentation
Michal
Hi Michal,
Can we make any assumptions about the guaranteed presence of event attributes?
For instance, our code assumes that when we get an EmploymentChange event, the c:person attribute will be present. Similarly, we assume that the c:businessrelationtype attribute is always present in BusinessRelation events. However, it seems we have been getting EmploymentChange events without c:person and BusinessRelation events without c:businessrelationtype.
Should we change our code so that it makes no assumptions about the guaranteed presence of certain (the mandatory) event attributes?
Thx,
Lars