get session id within a recipe

[ines (Ines Montani)]

Hi! The session ID is only assigned when a user opens the app and makes a request to the server requesting a new batch of questions. There's not currently an in-recipe way to access it, because it's only available once the stream is already executing. So if you want fine-grained control like this within the recipe script, you'd currently have to use separate instances of Prodigy with different datasets, or the same dataset and sessions / annotator names / etc. set via the command line. This thread shows a flexible solution for this:

Setting session name as a config or CLI option

Ah, so if I understand the use case correctly, you want to attach additional meta info to the data you're annotating that's preserved when you merge datasets? Recipes support a get_session_id function that was initially added to override the default timestamp session IDs (e.g. if you're starting Prodigy instances programmatically and end up with multiple sessions per second). So in a custom recipe, you could add a command-line argument for the annotator name and then "get_session_id": lambda: …

(I've been thinking about ways to make session-aware streams work without breaking backwards compatibility. Maybe we could introduce another callback that's executed when a session ID is assigned.)

@AnnaAnia

I'm traying to access the session_id via the controller but the import from your docs doesn't work

Ah, this should be from prodigy.core import Controller. Will fix that. However, using it like this wouldn't work for your use case, since the Controller is the base class, and what you're looking for is the instance of the controller used for your current Prodigy session.