concrete.services.results.ResultsServerService module¶

class concrete.services.results.ResultsServerService.Client(iprot, oprot=None)¶

Bases: concrete.services.Service.Client, concrete.services.results.ResultsServerService.Iface

getLatestSearchResult(userId)¶: Get the most recent search results for a user

Parameters:

- userId

getNextChunk(sessionId)¶: Get next chunk of data to annotate

The client should use the Retriever service to access the data

Parameters:

- sessionId

getSearchResult(searchResultId)¶: Get a search result object

Parameters:

- searchResultId

getSearchResults(taskType, limit)¶: Get a list of search results for a particular annotation task

Set the limit to 0 to get all relevant search results

Parameters:

- taskType

- limit

getSearchResultsByUser(taskType, userId, limit)¶: 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

Parameters:

- taskType

- userId

- limit

recv_getLatestSearchResult()¶

recv_getNextChunk()¶

recv_getSearchResult()¶

recv_getSearchResults()¶

recv_getSearchResultsByUser()¶

recv_registerSearchResult()¶

recv_startSession()¶

recv_stopSession()¶

recv_submitAnnotation()¶

registerSearchResult(result, taskType)¶: 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.

Parameters:

- result

- taskType

send_getLatestSearchResult(userId)¶

send_getNextChunk(sessionId)¶

send_getSearchResult(searchResultId)¶

send_getSearchResults(taskType, limit)¶

send_getSearchResultsByUser(taskType, userId, limit)¶

send_registerSearchResult(result, taskType)¶

send_startSession(searchResultId, taskType)¶

send_stopSession(sessionId)¶

send_submitAnnotation(sessionId, unitId, communication)¶

startSession(searchResultId, taskType)¶: Start an annotation session

Returns a session id used in future session calls

Parameters:

- searchResultId

- taskType

stopSession(sessionId)¶: Stops an annotation session

Parameters:

- sessionId

submitAnnotation(sessionId, unitId, communication)¶: Submit an annotation for a session

Parameters:

- sessionId

- unitId

- communication

class concrete.services.results.ResultsServerService.Iface¶

Bases: concrete.services.Service.Iface

getLatestSearchResult(userId)¶: Get the most recent search results for a user

Parameters:

- userId

getNextChunk(sessionId)¶: Get next chunk of data to annotate

The client should use the Retriever service to access the data

Parameters:

- sessionId

getSearchResult(searchResultId)¶: Get a search result object

Parameters:

- searchResultId

getSearchResults(taskType, limit)¶: Get a list of search results for a particular annotation task

Set the limit to 0 to get all relevant search results

Parameters:

- taskType

- limit

getSearchResultsByUser(taskType, userId, limit)¶: 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

Parameters:

- taskType

- userId

- limit

registerSearchResult(result, taskType)¶: 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.

Parameters:

- result

- taskType

startSession(searchResultId, taskType)¶: Start an annotation session

Returns a session id used in future session calls

Parameters:

- searchResultId

- taskType

stopSession(sessionId)¶: Stops an annotation session

Parameters:

- sessionId

submitAnnotation(sessionId, unitId, communication)¶: Submit an annotation for a session

Parameters:

- sessionId

- unitId

- communication

class concrete.services.results.ResultsServerService.Processor(handler)¶

Bases: concrete.services.Service.Processor, concrete.services.results.ResultsServerService.Iface, thrift.Thrift.TProcessor

on_message_begin(func)¶

process(iprot, oprot)¶

process_getLatestSearchResult(seqid, iprot, oprot)¶

process_getNextChunk(seqid, iprot, oprot)¶

process_getSearchResult(seqid, iprot, oprot)¶

process_getSearchResults(seqid, iprot, oprot)¶

process_getSearchResultsByUser(seqid, iprot, oprot)¶

process_registerSearchResult(seqid, iprot, oprot)¶

process_startSession(seqid, iprot, oprot)¶

process_stopSession(seqid, iprot, oprot)¶

process_submitAnnotation(seqid, iprot, oprot)¶

class concrete.services.results.ResultsServerService.getLatestSearchResult_args(userId=None)¶

Bases: object

Attributes:

- userId

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getLatestSearchResult_result(success=None, ex=None)¶

Bases: object

Attributes:

- success
- ex

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getNextChunk_args(sessionId=None)¶

Bases: object

Attributes:

- sessionId

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getNextChunk_result(success=None, ex=None)¶

Bases: object

Attributes:

- success
- ex

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getSearchResult_args(searchResultId=None)¶

Bases: object

Attributes:

- searchResultId

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getSearchResult_result(success=None, ex=None)¶

Bases: object

Attributes:

- success
- ex

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getSearchResultsByUser_args(taskType=None, userId=None, limit=None)¶

Bases: object

Attributes:

- taskType
- userId
- limit

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getSearchResultsByUser_result(success=None, ex=None)¶

Bases: object

Attributes:

- success
- ex

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getSearchResults_args(taskType=None, limit=None)¶

Bases: object

Attributes:

- taskType
- limit

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.getSearchResults_result(success=None, ex=None)¶

Bases: object

Attributes:

- success
- ex

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.registerSearchResult_args(result=None, taskType=None)¶

Bases: object

Attributes:

- result
- taskType

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.registerSearchResult_result(ex=None)¶

Bases: object

Attributes:

- ex

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.startSession_args(searchResultId=None, taskType=None)¶

Bases: object

Attributes:

- searchResultId
- taskType

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.startSession_result(success=None, ex=None)¶

Bases: object

Attributes:

- success
- ex

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.stopSession_args(sessionId=None)¶

Bases: object

Attributes:

- sessionId

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.stopSession_result(ex=None)¶

Bases: object

Attributes:

- ex

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.submitAnnotation_args(sessionId=None, unitId=None, communication=None)¶

Bases: object

Attributes:

- sessionId
- unitId
- communication

read(iprot)¶

validate()¶

write(oprot)¶

class concrete.services.results.ResultsServerService.submitAnnotation_result(ex=None)¶

Bases: object

Attributes:

- ex

read(iprot)¶

validate()¶

write(oprot)¶