Check credit/licence/caption are pulled from correct place

jamieu commented 9 months ago

Now that we have media we need to check this values and mappings are correct, we also seem to be missing 'credit' do we still need that?

live: https://collection.sciencemuseumgroup.org.uk/objects/co65065/the-munition-girls-oil-painting dev: http://localhost:8000/objects/co65065/

Using iBase ID 27827 (Painting, The Munition Girls, by Alexander Stanhope Forbes) as an example (see API response here)

We seem to be missing "credit": "Science Museum Group Collection", (see live index below). Do we still need this field/value?
Do the mappings in the screenshot below make sense?

Index	iBase	CIIM	Example	Note
legal.right.copyright	Copyright Contact Details	legal.rights.copyright	© The Board of Trustees of the Science Museum	currently `legal rights.details` in current index
legal.right.usage_terms (current / drop)	'Free Text' notes on Licence (don't use on website)	legal.rights.usage_terms	CC-BY-NC-SA 4.0	'Free Text' notes on Licence, not for web use
licence (new value)	Licence (`"licence": null` in iBase API response;)	??	CC-BY-NC-SA 4.0	Need Example Record / Takes Place of legal.right.usage_terms in driving 'image licence block' & logic / awaiting migration 15th Feb+ / needs adding to CIIM & Index
title.value[type=caption] (current / drop)	`caption` (this is 'record title' in iBase, so not for public use)	title.value[type=caption]	Painting, The Munition Girls, by Alexander Stanhope Forbes	We no longer want to use this value?
CO caption (new value)	`COLLECTIONS_ONLINE_CAPTION`	??	Painting, The Munition Girls, by Alexander Stanhope Forbes	`COLLECTIONS_ONLINE_CAPTION` needs adding to iBase API / needs adding to CIIM & Index / Fallback to the Mimsy title for this page (effectively repeat the page title under the image, poss. truncated)
Credit (missing / add)	Credit Line	Can't see it in CIIM	Science Museum Group Collection	previously named `credit` in public index and labeled `"credit":"Science Museum Group Collection"` in API response / KI need to extract `credit` from iBase API to CIIM and add to public index /

See also https://github.com/TheScienceMuseum/collectionsonline/issues/1549 and https://github.com/TheScienceMuseum/collectionsonline/issues/1548 as these may be related. Be good to package up any index changes here (and in those issues) into a single KI ticket.

dev

"multimedia": [{
        "@admin": {
            "uid": "i447",
            "id": "media-447",
            "source": "smgi",
            "uuid": "2a0fcc6b-3abf-33c6-a1e8-e8e14829d7ea"
        },
        "@processed": <snip>
        "@type": "image",
        "legal": {
            "rights": [{
                "copyright": "© The Board of Trustees of the Science Museum",
                "usage_terms": "CC-BY-NC-SA 4.0"
            }]
        },
        "title": [{
            "type": "caption",
            "value": "Painting, The Munition Girls, by Alexander Stanhope Forbes"
        }],
        "@entity": "reference"
    },
    {
        "@admin": {
            "uid": "i27827",
            "id": "media-27827",
            "source": "smgi",
            "uuid": "1ce723f4-187e-3116-a7be-8b51e4e9687f"
        },
        "@processed": <snip>
        "@type": "image",
        "legal": {
            "rights": [{
                "copyright": "© The Board of Trustees of the Science Museum",
                "usage_terms": "CC-BY-NC-SA 4.0"
            }]
        },
        "title": [{
            "type": "caption",
            "value": "Painting, The Munition Girls, by Alexander Stanhope Forbes"
        }],
        "@entity": "reference"
    }
],

live

     "multimedia": [
        {
          "@link": {
            "type": "reference"
          },
          "admin": {
            "id": "media-447",
            "source": "smgi",
            "uid": "i447",
            "uuid": "2a0fcc6b-3abf-33c6-a1e8-e8e14829d7ea"
          },
          "credit": "Science Museum Group Collection",
          "enhancement": {
            "rekognition": [
              {
                "labels": [
                  {
                    "details": {
                      "confidence": 99.489136
                    },
                    "value": "Human"
                  },
                  {
                    "details": {
                      "confidence": 99.489136,
                      "instances": [
                        {
                          "confidence": "99.489136",
                          "region": {
                            "height": 0.42084736,
                            "left": 0.5892196,
                            "top": 0.56236404,
                            "type": "bounding box",
                            "width": 0.39375854
                          }
                        }
                      ]
                    },
                    "value": "Person"
                  },
                  {
                    "details": {
                      "confidence": 96.528046
                    },
                    "value": "Art"
                  },
                  {
                    "details": {
                      "confidence": 96.528046,
                      "instances": [
                        {
                          "confidence": "96.528046",
                          "region": {
                            "height": 0.9982639,
                            "left": 0,
                            "top": 0,
                            "type": "bounding box",
                            "width": 0.9986014
                          }
                        }
                      ],
                      "parents": [
                        {
                          "value": "Art"
                        }
                      ]
                    },
                    "value": "Painting"
                  },
                  {
                    "details": {
                      "confidence": 83.85019
                    },
                    "value": "Building"
                  },
                  {
                    "details": {
                      "confidence": 79.25054
                    },
                    "value": "Workshop"
                  }
                ],
                "source": "amazon rekognition"
              }
            ]
          },
          "for_sale": "0",
          "identifier": [
            {
              "type": "iBase id",
              "value": "447"
            }
          ],
          "priority": "0.5",
          "processed": <snip>
          "for_sale": "0",
          "identifier": [
            {
              "type": "iBase id",
              "value": "27827"
            }
          ],
          "priority": "0.5",
          "processed": snip
          "public_view": "1",
          "publish": "1",
          "sort": "2015-06-09 04:31:44.0",
          "source": {
            "legal": {
              "rights": [
                {
                  "details": "© The Board of Trustees of the Science Museum",
                  "usage_terms": "CC-BY-NC-SA 4.0"
                }
              ]
            },
            "title": [
              {
                "type": "caption",
                "value": "Painting, The Munition Girls, by Alexander Stanhope Forbes"
              },
              {
                "type": "main title",
                "value": "Painting, The Munition Girls, by Alexander Stanhope Forbes, 1918. From a colour transparency in the Science Museum"
              }
            ]
          },
          "traffic_light": "Green",
          "type": {
            "base": "media",
            "type": "image"
          }
        }
      ],

Other notes:

[1] The CIIM holds two title values, one is the actual iBase record title I assume and one is a field named caption. We seem to be using caption.

See API response for 27827 here

jamieu commented 9 months ago

legal.rights.usage_terms

I believe use of this should have been superseded by the new ‘License’ field in iBase, which was added to the index during the iBase upgrade in Phase 1 of CO 2.0.

Do we need logic to fall back to using ‘usage_terms’ if License is blank though?

Unknown

There is an update waiting to take place in iBase to parse and clean license info from the Rights Usage Terms field into the new License field.

jamieu commented 9 months ago

UPDATE 7th Feb (LB):

legal.right.usage_terms / licence

We should be using "licence": null in iBase API response to hold (constrained list of) CC licences going forward.

As for the plan, both Licence and Rights Usage Terms will continue to be used in iBase, with the Licence holding a specific set of licences (from a controlled list) whilst Rights Usage Terms will continue to host more detailed/complex licencing information where necessary.

caption

title.value[type=caption] / COLLECTIONS_ONLINE_CAPTION

This field (COLLECTIONS_ONLINE_CAPTION) was intended to host captions that were applicable to specific images, rather than repeating the title info, as the original caption was doing.

It appears that during the upgrade to iBase, all/most data from the ‘Caption’ field was copied across to this field which was not the goal, so we may need to clear most of the data out in iBase first. That would then leave ‘Caption’ as a native iBase field that’s just used for the iBase frontend UI, to caption thumbnails, the ‘Title’ field to represent the object title, and the ‘Collections Online Caption’ to host captions that uniquely described a certain image.

Q. Clarify the order of fallback for what we display as the caption texrt under an image.

SHOWSTOPPER: We are not seeing COLLECTIONS_ONLINE_CAPTION in the iBase API response, despite seeing it in iBase UI

jamieu commented 9 months ago

credit line

previously named credit in public index and labeled "credit":"Science Museum Group Collection" in API response

[ ] KI to extract credit field to CIIM ( "credit":"Science Museum Group Collection" from iBase API response) [AP: JU / KI]
[ ] KI to add credit to public ES index [AP: JU / KI]

licence/right.usage_terms

Example of record with new CC 'licence' field
"licence":"CC BY-NC-SA 4.0"} http://medialibrary.sciencemuseum.ac.uk/api/v2/items/3563

[ ] licence needs extracting (from iBase API) into CIIM and pushed to public index. [AP: KI / JU]
[ ] Drop current legal.right.usage_terms (no longer is use) [AP: KI / JU]
[ ] licence needs plumbing in, in place of current legal.right.usage_terms to drive CC licence block/logic [AP: JU]

caption

[ ] COLLECTIONS_ONLINE_CAPTION needs adding to iBase API [AP: AH / iBase]
[ ] COLLECTIONS_ONLINE_CAPTION needs extracting (from API) into CIIM and pushed to public index [AP: JU / KI]
[ ] Ordering: Collections Online Caption > Title (current page/mimsy) [AP: JU]

jamieu commented 9 months ago

In progress KI #5229, awaiting index update & testing + minor refactoring

jamieu commented 9 months ago

http://localhost:8000/objects/co8829091

Need example with a CC licence to test

Also credit is now an array?

Example - co8829091/ media-555502

The screenshot here is of the multimedia block on the object, where you can see there is credit, position and then usage_rights is removed Licence is actually already being pulled in but in this record the licence value is null.

jamieu commented 8 months ago

CC licence (constrained): multimedia.legal.rights.licence (was multimedia.legal.right.usage_terms) Credit: multimedia.credit (no change) Copyright: multimedia.legal.rights.copyright (was multimedia.legal.right.details) Caption: multimedia.title.caption (same as before, but now populated with COLLECTIONS_ONLINE_CAPTION)