Page MenuHomePhabricator
Create Task
Maniphest T330874

[investigation] Add parsed main image to article response (timebox ~ 2 day(s))
Closed, ResolvedPublic5 Estimated Story Points
Actions

Description

Investigate what it would take to add image (string URL pointing to commons) to the article response. Go through Summary endpoint to evaluate its solution.

Acceptance Criteria

  1. Thumbnail and main image added to the schema based on the schema.org criteria.
  2. Investigate the efforts in replicating the code or writing new code from the summary endpoint.
  3. Create a new ticket(s) with implementation details on how this task needs to be completed.

Notes
Link to the summary code.
Link to the metadata collection looks like this is where API call for image happening.

Related Objects
Search...

Event Timeline

SDelbecque-WMF created this task.Mar 1 2023, 2:05 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 1 2023, 2:05 PM
SDelbecque-WMF added a parent task: T330873: {Machine Readability} Parsing Main Image.Mar 1 2023, 2:05 PM
HShaikh triaged this task as High priority.Mar 1 2023, 2:51 PM
HShaikh updated the task description. (Show Details)
HShaikh moved this task from Incoming to To Be Estimated/To Be Discussed on the Wikimedia Enterprise board.Mar 9 2023, 3:39 AM
Protsack.stephan updated the task description. (Show Details)Mar 9 2023, 9:53 AM
Protsack.stephan added a project: Wikimedia Enterprise Engineering.
HShaikh renamed this task from [investigation] Add parsed main image to article response to [investigation] Add parsed main image to article response (timebox ~ day(s)) .Mar 9 2023, 2:19 PM
HShaikh renamed this task from [investigation] Add parsed main image to article response (timebox ~ day(s)) to [investigation] Add parsed main image to article response (timebox ~ 2 day(s)) .Mar 9 2023, 2:30 PM
Felixejofre assigned this task to Anribolon.Mar 9 2023, 3:26 PM
Felixejofre set the point value for this task to 5.
HShaikh moved this task from To Be Estimated/To Be Discussed to Estimated /Discussed on the Wikimedia Enterprise board.Mar 9 2023, 3:42 PM
Protsack.stephan updated the task description. (Show Details)Mar 10 2023, 1:36 PM
Protsack.stephan moved this task from Estimated /Discussed to In Progress on the Wikimedia Enterprise board.Mar 20 2023, 2:21 PM
Felixejofre moved this task from In Progress to Machine Readability PB on the Wikimedia Enterprise board.Mar 23 2023, 1:12 PM
Anribolon added a comment.Mar 27 2023, 12:19 PM

According to the investigation we can use Schema.org representation of the image for an Article: https://schema.org/Article. An image can be represented as an ImageObject which includes content url (original image url), original image width and height and thumbnail which, in turn, also is represented as an ImageObject. Json schema representation looks like this:

{

 "$schema": "https://json-schema.org/draft/2020-12/schema",

 "$id": "image.json",

 "title": "Image",

 "description": "Representation of the image entity",

 "type": "object",

 "properties": {

     "contentUrl": {

         "type": "string"

     },

     "width": {

         "type": "number"

     },

     "height": {

       "type": "number"

     },

     "thumbnail": {

         "$ref": "file:image.json"

     }

 }

}

AVRO Schema

package schema


import "github.com/hamba/avro"



// ConfigImageObject schema configuration for ImageObject.

var ConfigImage = &Config{

	Type: ConfigTypeValue,

	Name: "Image",

	Schema: `{

		"type": "record",

		"name": "Image",

		"namespace": "wikimedia_enterprise.general.schema",

		"fields": [

			{

				"name": "contentUrl",

				"type": "string"

			},

			{

				"name": "thumbmail",

				"type": [

					"null",

					"Image"

				]

			}

			{

				"name": "width",

				"type": "int"

			},

			{

				"name": "height",

				"type": "int"

			},

		]

	}`,

	Reflection: Image{},

}



// NewImageSchema creates new article image avro schema.

func NewImageSchema() (avro.Schema, error) {

	return New(ConfigImage)

}



// Image schema for article image.

// Compliant with https://schema.org/ImageObject,

type Image struct {

	ContentUrl string `json:"contentUrl,omitempty" avro:"contentUrl"`

	Thumbnail  *Image `json:"thumbnail,omitempty" avro:"thumbnail"`

	Width      int    `json:"width,omitempty" avro:"width"`

	Height     int    `json:"height,omitempty" avro:"height"`

}

Source of the data (Wikimedia Action API)

According to the Wikimedia Actions API docs, both original image and thumbnail can be retrieved by adding a particular parameter to a request, specifically by adding pageimages parameter to the API request:

props=pageimages

In order to get both the original image and thumbnail, the request parameters should be extended with piprop parameter:

piprop=thumbnail|original

By default Action API returns a thumbnail scaled by default size (which differs from page to page). If we need a specific size of the thumbnail, it also can be achieved by adding a parameter to the API request:

pithumbsize=500 (Value “500” corresponds to width of the thumbnail.)

Example request (Click to open in a browser):

GET https://en.wikipedia.org/w/api.php?action=query&format=json&formatversion=2&prop=pageimages|pageterms&piprop=original|thumbnail&pithumbsize=300&titles=Albert%20Einstein&pilicense=any

Example Response:

{
 batchcomplete: true,
 query: {
   pages: [
     {
       pageid: 736,
       ns: 0,
       title: "Albert Einstein",
       thumbnail: {
         source: "https://upload.wikimedia.org/wikipedia/commons/thumb/3/3e/Einstein_1921_by_F_Schmutzer_-_restoration.jpg/300px-Einstein_1921_by_F_Schmutzer_-_restoration.jpg",
         width: 300,
         height: 394
       },
       original: {
         source: "https://upload.wikimedia.org/wikipedia/commons/3/3e/Einstein_1921_by_F_Schmutzer_-_restoration.jpg",
         width: 2523,
         height: 3313
       },
       terms: {
         alias: [
           "Einstein",
           "A. Einstein"
         ],
         label: [
           "Albert Einstein"
         ],
         description: [
           "German-born theoretical physicist; developer of the theory of relativity (1879–1955)"
         ]
       }
     }
   ]
 }
}

Implementation ticket: https://phabricator.wikimedia.org/T333145

Anribolon reassigned this task from Anribolon to SDelbecque-WMF.Mar 27 2023, 12:20 PM
Anribolon subscribed.
Protsack.stephan reassigned this task from SDelbecque-WMF to Anribolon.Mar 27 2023, 8:20 PM
Protsack.stephan moved this task from Machine Readability PB to Done Sprint 35 (Mar 13 - Mar 22) on the Wikimedia Enterprise board.
Protsack.stephan added a subtask: T333145: Add original image and thumbnail parsing for an article.Apr 11 2023, 4:34 PM
JArguello-WMF moved this task from Done Sprint 35 (Mar 13 - Mar 22) to Done 31 on the Wikimedia Enterprise board.Jul 14 2023, 3:28 PM
JArguello-WMF closed this task as Resolved.Jul 14 2023, 3:34 PM
JArguello-WMF closed subtask T333145: Add original image and thumbnail parsing for an article as Resolved.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits