MessageThreadCursor

toloka.streaming.cursor.MessageThreadCursor | Source code

MessageThreadCursor(
self,
toloka_client: Union[TolokaClient, AsyncTolokaClient],
time_lag: timedelta = ...,
folder: Union[str, Folder, List[Union[str, Folder]], None] = None,
folder_ne: Union[str, Folder, List[Union[str, Folder]], None] = None,
id_lt: Optional[str] = None,
id_lte: Optional[str] = None,
id_gt: Optional[str] = None,
id_gte: Optional[str] = None,
created_lt: Optional[datetime] = None,
created_lte: Optional[datetime] = None,
created_gt: Optional[datetime] = None,
created_gte: Optional[datetime] = None
)

Iterator over messages by create time.

Parameters description

ParametersTypeDescription
toloka_clientUnion[TolokaClient, AsyncTolokaClient]

TolokaClient object that is being used to search messages.

requestMessageThreadSearchRequest

Base request to search messages.

_time_lag-

Time lag between cursor time field upper bound and real time. Default is 1 minute. This lag is required to keep cursor consistent. Lowering this value will make cursor process events faster, but raises probability of missing some events in case of concurrent operations.

Examples:

Iterate over all messages.

it = MessageThreadCursor(toloka_client=toloka_client)
all_messages = list(it)
# ... new messages could appear ...
new_messages = list(it) # Contains only new messages, appeared since the previous call.

Last updated: August 28, 2023

Toloka-Kit
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming