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 up to 250 page IDs, (1234, 5678, ...) I expect to see the list of pages and their respective image suggestions
- 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?id=1234,5678
Response
HTTP 200
{ "pages": [ { "project": "enwiki", "page_id": "1234", "page": "Cat", "suggestions": [ { "filename": "Mountain Lion.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { } } }, { "filename": "Bengal Tiger.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { } } } }, { "project": "enwiki", "page_id": "5678", "page": "Dog", "suggestions": [ { "filename": "Poodle.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { } } }, { "filename": "Shiba Inu.jpg", "confidence_rating": "low", "source": { "name": "ima", "details": { } } } } ] }
Open Questions
- Are we able to query suggestions by page_id or just page_title?
Both are available
- If title is only available, should we require the request to have a payload of pages? or keep inline as URI parameter
- Is image information like original_size or thumbnail currently available via the dataset?
No
- Which wikis will this first solution cover for growth?
- Arabic
- Czech
- Vietnamese
- Bengali
- Spanish
- Portuguese
- Persian
- Turkish
Subtasks
- @BPirkle @nnikkhoui Define the response time