Skip to content

Commit fbf0c65

Browse files
author
Ervin Papp
committed
RCB-601 fixed: events API description
1 parent b87fa07 commit fbf0c65

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

rosette/api.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,8 +1014,10 @@ def similar_terms(self, parameters):
10141014

10151015
def events(self, parameters):
10161016
"""
1017-
Topics returns events related to the provided content
1018-
:param parameters: DocumentParameters
1019-
:return: A python dictionary containing the results
1017+
Create an L{EndpointCaller} to identify events found in the texts.
1018+
@param parameters: An object specifying the data,
1019+
and possible metadata, to be processed by the 'events' identifier.
1020+
@type parameters: L{DocumentParameters} or L{str}
1021+
@return: A python dictionary containing the results of event extraction.
10201022
"""
10211023
return EndpointCaller(self, self.endpoints['EVENTS']).call(parameters)

0 commit comments

Comments
 (0)