Allow submiting images alongside notes in the sdk #232
Conversation
src/groundlight/client.py
Outdated
| :param image_query: Either an ImageQuery object (returned from | ||
| `submit_image_query`) or an image_query id as a |
There was a problem hiding this comment.
returned from
submit_image_query
My understanding is that we encourage users to use ask_* methods instead?
There was a problem hiding this comment.
good point. Does 'ask_ml or similar method' sound better? ask_* feels a little cheeky
src/groundlight/experimental_api.py
Outdated
| @@ -180,16 +181,26 @@ def get_notes(self, detector: Union[str, Detector]) -> Dict[str, Any]: | |||
| det_id = detector.id if isinstance(detector, Detector) else detector | |||
| return self.notes_api.get_notes(det_id) | |||
|
|
|||
| def create_note(self, detector: Union[str, Detector], note: Union[str, NoteRequest]) -> None: | |||
| def create_note(self, detector: Union[str, Detector], note: str, image: Union[str, None] = None) -> None: | |||
There was a problem hiding this comment.
nit: I though Union was replaced with |, e.g. detector: str | Detector. Maybe this doesn't work for some of the python versions we support?
There was a problem hiding this comment.
Nailed it, we still support python before 3.10
| # TODO: The openapi generator doesn't handle file submissions well at the moment, so we manually implement this | ||
| # kwargs = {"image": img_bytes} | ||
| # self.notes_api.create_note(det_id, note, **kwargs) |
There was a problem hiding this comment.
Will we ever resolve this TODO? Or is it a permanent issue? If permanent I'm not sure you need to include how we would have solved it if the generator worked.
There was a problem hiding this comment.
I very much would like to resolve the issue, but it really just doesn't make sense to sink more time right now. This may be resolved in the openapi-generator project. It shouldn't affect us until we decide we want to start porting the SDK into other languages (so not very soon)
… into note_images
We previously allowed users to create text notes for detectors. (Notes allow users to provide additional instruction for their task, which can aid human reviewers and improve ML performance). Now users can attach an image as well!