Change Details

==== User Story >====== As a mobile reader (familiar with editing on my device) >====== When I am reading an article with no images >====== I want to see any image(s) that could be used to illustrate the article, >====== so that I can both gain a better understanding of the topic, as well as contribute to helping others who read the article in the future. === Acceptance Criteria [] Given I have made a request with a single page, `cat`, I expect to see the image suggestions for that page [] Given I have made a request with n pages, (`cat`, `dog`, ...) I expect to see the list of pages and their respective image suggestions [] Only required for ImageMatchAlgo, and not MediaSearch Hygiene [] API Documentation is published and viewable [] Tests related to ACs are written and pass ==== Example Request/Response **Request** GET `/image-suggestions/v0/wikipedia/en/pages/1,2` **Response** HTTP 200 ``` { "pages": [ { "project": "enwiki", "page": "Cat", "suggestions": [ { "filename": "Mountain Lion.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } }, { "filename": "Bengal Tiger.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } } }, { "project": "enwiki", "page": "Dog", "suggestions": [ { "filename": "Poodle.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } }, { "filename": "Shiba Inu.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } } } ] } ``` === Open Questions [x] Are we able to query suggestions by `page_id` or just `page_title`? Both are available [x] If title is only available, should we require the request to have a payload of pages? or keep inline as URI parameter [x] Is image information like `original_size` or `thumbnail` currently available via the dataset? No === Subtasks []

==== User Story >====== As a mobile reader (familiar with editing on my device) >====== When I am reading an article with no images >====== I want to see any image(s) that could be used to illustrate the article, >====== so that I can both gain a better understanding of the topic, as well as contribute to helping others who read the article in the future. === Acceptance Criteria [] Given I have made a request with a single page ID, `1234`, I expect to see the image suggestions for that page [] Given I have made a request with n page IDs, (`1234`, `5678`, ...) I expect to see the list of pages and their respective image suggestions [] Defined the upper bound of the "n # of pages" [] Include `page_id` as part of the response payload [] Only required for ImageMatchAlgo, and not MediaSearch Hygiene [] API Documentation is published and viewable [] Tests related to ACs are written and pass ==== Example Request/Response **Request** GET `/image-suggestions/v0/wikipedia/en/pages/1,2` **Response** HTTP 200 ``` { "pages": [ { "project": "enwiki", "page": "Cat", "suggestions": [ { "filename": "Mountain Lion.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } }, { "filename": "Bengal Tiger.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } } }, { "project": "enwiki", "page": "Dog", "suggestions": [ { "filename": "Poodle.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } }, { "filename": "Shiba Inu.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } } } ] } ``` === Open Questions [x] Are we able to query suggestions by `page_id` or just `page_title`? Both are available [x] If title is only available, should we require the request to have a payload of pages? or keep inline as URI parameter [x] Is image information like `original_size` or `thumbnail` currently available via the dataset? No === Subtasks []

==== User Story >====== As a mobile reader (familiar with editing on my device) >====== When I am reading an article with no images >====== I want to see any image(s) that could be used to illustrate the article, >====== so that I can both gain a better understanding of the topic, as well as contribute to helping others who read the article in the future. === Acceptance Criteria [] Given I have made a request with a single page ID, `cat``1234`, I expect to see the image suggestions for that page [] Given I have made a request with n page IDs, (`cat``1234`, `dog``5678`, ...) I expect to see the list of pages and their respective image suggestions [] Defined the upper bound of the "n # of pages" [] Include `page_id` as part of the response payload [] Only required for ImageMatchAlgo, and not MediaSearch Hygiene [] API Documentation is published and viewable [] Tests related to ACs are written and pass ==== Example Request/Response **Request** GET `/image-suggestions/v0/wikipedia/en/pages/1,2` **Response** HTTP 200 ``` { "pages": [ { "project": "enwiki", "page": "Cat", "suggestions": [ { "filename": "Mountain Lion.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } }, { "filename": "Bengal Tiger.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } } }, { "project": "enwiki", "page": "Dog", "suggestions": [ { "filename": "Poodle.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } }, { "filename": "Shiba Inu.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { "model_version": 1.0 } } } } ] } ``` === Open Questions [x] Are we able to query suggestions by `page_id` or just `page_title`? Both are available [x] If title is only available, should we require the request to have a payload of pages? or keep inline as URI parameter [x] Is image information like `original_size` or `thumbnail` currently available via the dataset? No === Subtasks []