Thrift module: results

Module Services Data types Constants
results ResultsServerService

Services

Service: ResultsServerService

extends services.Service

Function: ResultsServerService.registerSearchResult 

void registerSearchResult(search.SearchResult result,
                          services.AnnotationTaskType taskType)
    throws services.ServicesException

Register the specified search result for annotation.

If a name has not been assigned to the search query, one will be generated.
This service also requires that the user_id field be populated in the SearchQuery.

Function: ResultsServerService.getSearchResults 

list<search.SearchResult> getSearchResults(services.AnnotationTaskType taskType,
                                           i32 limit)
    throws services.ServicesException

Get a list of search results for a particular annotation task
Set the limit to 0 to get all relevant search results

Function: ResultsServerService.getSearchResultsByUser 

list<search.SearchResult> getSearchResultsByUser(services.AnnotationTaskType taskType,
                                                 string userId,
                                                 i32 limit)
    throws services.ServicesException

Get a list of search results for a particular annotation task filtered by a user id
Set the limit to 0 to get all relevant search results

Function: ResultsServerService.getLatestSearchResult 

search.SearchResult getLatestSearchResult(string userId)
    throws services.ServicesException

Get the most recent search results for a user

Function: ResultsServerService.getSearchResult 

search.SearchResult getSearchResult(uuid.UUID searchResultId)
    throws services.ServicesException

Get a search result object

Function: ResultsServerService.startSession 

uuid.UUID startSession(uuid.UUID searchResultId,
                       services.AnnotationTaskType taskType)
    throws services.ServicesException

Start an annotation session
Returns a session id used in future session calls

Function: ResultsServerService.stopSession 

void stopSession(uuid.UUID sessionId)
    throws services.ServicesException

Stops an annotation session

Function: ResultsServerService.getNextChunk 

list<services.AnnotationUnitIdentifier> getNextChunk(uuid.UUID sessionId)
    throws services.ServicesException

Get next chunk of data to annotate
The client should use the Retriever service to access the data

Function: ResultsServerService.submitAnnotation 

void submitAnnotation(uuid.UUID sessionId,
                      services.AnnotationUnitIdentifier unitId,
                      communication.Communication communication)
    throws services.ServicesException

Submit an annotation for a session