Format of "resultGroup" entry from the PP Response Format is unclear

[pstoehr]

Based on the documentation we assumed that a resultGroup entry is either empty or it consists of documentBadge entries.
But the PP also returns results where a resultGroup entry consists of an empty resultGroup and an additional documentBadge entry.

Is a resultGroup defined as a list/array of documentBadges or can it contain in addition resultGroup recursively?

Endpoint:
https://eexcess-dev.joanneum.at/eexcess-privacy-proxy-issuer-1.0-SNAPSHOT/issuer/recommend

Example:
{
"provider": "federated",
"totalResults": 10,
"partnerResponseState": [
{
"systemID": "Deutsche Digitale Bibliothek",
"success": true
},
{
"systemID": "Europeana",
"success": true
},
{
"systemID": "Kierling",
"success": true
},
{
"systemID": "Mendeley",
"success": true
},
{
"systemID": "KIMPortal",
"success": true
},
{
"systemID": "Wissenmedia",
"success": true
},
{
"systemID": "ZBW",
"success": true
}
],
"queryID": "1892381444",
"result": [
{
"resultGroup": [

  ],
  "documentBadge": {
    "id": "\/15601\/1A2F29EC74657344CDDAE26B6E41BEF8805D66AD",
    "uri": "http:\/\/europeana.eu\/resolve\/record\/15601\/1A2F29EC74657344CDDAE26B6E41BEF8805D66AD",
    "provider": "Europeana"
  },
  "mediaType": "IMAGE",
  "previewImage": "http:\/\/europeanastatic.eu\/api\/image?uri=http%3A%2F%2Fwww.oucs.ox.ac.uk%2Fww1lit%2Fdb%2Finline.php%3FCISOROOT%3D%2Fgwa%26CISOPTR%3D7811&size=LARGE&type=IMAGE",
  "title": "Certificate of baptism for George Moore",
  "date": "unknown",
  "language": "en",
  "licence": "http:\/\/www.europeana.eu\/rights\/rr-f\/",
  "generatingQuery": "(giving AND birth)"
},
{
  "resultGroup": [

  ],
  "documentBadge": {
    "id": "10010251042",
    "uri": "http:\/\/www.econbiz.de\/Record\/10010251042",
    "provider": "ZBW"
  },
  "mediaType": "text",
  "title": "From giving birth to paid labor : the effects of adult education for prime-aged mothers",
  "date": "2014-01-01",
  "language": "de",
  "licence": "restricted",
  "generatingQuery": "giving AND birth"
},
{
  "resultGroup": [
    {
      "resultGroup": [

      ],
      "documentBadge": {
        "id": "\/2022343\/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF",
        "uri": "http:\/\/europeana.eu\/resolve\/record\/2022343\/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF",
        "provider": "Europeana"
      },
      "mediaType": "IMAGE",
      "previewImage": "http:\/\/europeanastatic.eu\/api\/image?uri=http%3A%2F%2Fwww.culturegrid.org.uk%2Fdpp%2Fresource%2F3075231%2Fstream%2Fthumbnail_image_jpeg&size=LARGE&type=IMAGE",
      "title": "Netsuke in form of women giving birth",
      "date": "1900-01-01",
      "language": "en",
      "licence": "http:\/\/www.europeana.eu\/rights\/rr-f\/",
      "generatingQuery": "(giving AND birth)"
    }
  ],
  "documentBadge": {
    "id": "\/2022343\/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF",
    "uri": "http:\/\/europeana.eu\/resolve\/record\/2022343\/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF",
    "provider": "Europeana"
  },
  "mediaType": "IMAGE",
  "previewImage": "http:\/\/europeanastatic.eu\/api\/image?uri=http%3A%2F%2Fwww.culturegrid.org.uk%2Fdpp%2Fresource%2F3075231%2Fstream%2Fthumbnail_image_jpeg&size=LARGE&type=IMAGE",
  "title": "Netsuke in form of women giving birth",
  "date": "1701-01-01",
  "language": "en",
  "licence": "http:\/\/www.europeana.eu\/rights\/rr-f\/",
  "generatingQuery": "(giving AND birth)"
},
{
  "resultGroup": [
    {
      "resultGroup": [

      ],
      "documentBadge": {
        "id": "10005762130",
        "uri": "http:\/\/www.econbiz.de\/Record\/10005762130",
        "provider": "ZBW"
      },
      "mediaType": "text",
      "title": "From Giving Birth to Paid Labor: The Effects of Adult Education for Prime-Aged Mothers",
      "description": "Women without work after childbirth are at risk of losing their connection to the labor market. However, they may participate in adult education programs. We analyze the effect of this on the duration to work and on the wage rate, by applying conditional difference-in-differences approaches. We use Swedish matched longitudinal register data sets covering the full population. The Swedish adult education program is unprecedented in its size, and enrollment is universally available at virtually no cost. We focus on low-skilled women who have recently given birth. We take account of program accessibility, selection issues, course heterogeneity, the income received during adult education, parental leave, and child care fees. To understand the enrollment decision from the mothers' point of view, we use the estimates to calibrate a job search model.",
      "date": "2008-07-01",
      "language": "de",
      "licence": "restricted",
      "generatingQuery": "giving AND birth"
    }
  ],
  "documentBadge": {
    "id": "10010277323",
    "uri": "http:\/\/www.econbiz.de\/Record\/10010277323",
    "provider": "ZBW"
  },
  "mediaType": "text",
  "title": "From giving birth to paid labor: the effects of adult education for prime-aged mothers",
  "description": "Women without work after childbirth are at risk of losing their connection to the labor market. However, they may participate in adult education programs. We analyze the effect of this on the duration to work and on the wage rate, by applying conditional difference-in-differences approaches. We use Swedish matched longitudinal register data sets covering the full population. The Swedish adult education program is unprecedented in its size, and enrollment is universally available at virtually no cost. We focus on low-skilled women who have recently given birth. We take account of program accessibility, selection issues, course heterogeneity, the income received during adult education, parental leave, and child care fees. To understand the enrollment decision from the mothers' point of view, we use the estimates to calibrate a job search model.",
  "date": "2008-01-01",
  "language": "de",
  "licence": "restricted",
  "generatingQuery": "giving AND birth"
},
{
  "resultGroup": [

  ],
  "documentBadge": {
    "id": "OOJ5TVRHHPQQA7W2K2XZOH52RZU5OFH2",
    "uri": "https:\/\/www.deutsche-digitale-bibliothek.de\/item\/OOJ5TVRHHPQQA7W2K2XZOH52RZU5OFH2",
    "provider": "Deutsche Digitale Bibliothek"
  },
  "mediaType": "text",
  "title": "Der zuk\u00fcnftige Bedarf an Pflegearbeitskr\u00e4ften in Deutschland: Modellrechnungen f\u00fcr die Bundesl\u00e4nder bis zum Jahr 2020",
  "date": "unknown",
  "language": "unknown",
  "licence": "https:\/\/creativecommons.org\/publicdomain\/zero\/1.0\/",
  "generatingQuery": "giving AND birth"
},
{
  "resultGroup": [
    {
      "resultGroup": [

      ],
      "documentBadge": {
        "id": "10010464454",
        "uri": "http:\/\/www.econbiz.de\/Record\/10010464454",
        "provider": "ZBW"
      },
      "mediaType": "text",
      "title": "From giving birth to paid labor: The effects of adult education for prime-aged mothers",
      "description": "Women without work after childbirth are at risk of losing their connection to the labor market. However, they may participate in adult education programs. We analyze the effect of this on the duration to work and on the wage rate, by applying conditional difference-in-differences approaches. We use Swedish matched longitudinal register data sets covering the full population. The Swedish adult education program is unprecedented in its size, and enrollment is universally available at virtually no cost. We focus on low-skilled women who have recently given birth. We take account of program accessibility, selection issues, course heterogeneity, the income received during adult education, parental leave, and child care fees. Adult education shows positive effects for the unemployed with respect to both the employment probability and wages. To explain the actual program participation rate, we model the enrollment decision from the mothers' point of view, using the estimates to calibrate a job search model. We conclude that non-pecuniary factors cause mothers not to enter adult education.",
      "date": "2014-01-01",
      "language": "de",
      "licence": "restricted",
      "generatingQuery": "giving AND birth"
    }
  ],
  "documentBadge": {
    "id": "10010747874",
    "uri": "http:\/\/www.econbiz.de\/Record\/10010747874",
    "provider": "ZBW"
  },
  "mediaType": "text",
  "title": "From giving birth to paid labor: the effects of adult education for prime-aged mothers",
  "description": "Women without work after childbirth are at risk of losing their connection to the labor market. However, they may participate in adult education programs. We analyze the effect of this on the duration to work and on the wage rate, by applying conditional difference-in-differences approaches. We use Swedish matched longitudinal register data sets covering the full population. The Swedish adult education program is unprecedented in its size, and enrollment is universally available at virtually no cost. We focus on low-skilled women who have recently given birth. We take account of program accessibility, selection issues, course heterogeneity, the income received during adult education, parental leave, and child care fees. Adult education shows positive effects for the unemployed with respect to both the employment probability and wages. To explain the actual program participation rate, we model the enrollment decision from the mothers\u00b4 point of view, using the estimates to calibrate a job search model. We conclude that non-pecuniary factors cause mothers non to enter adult education.",
  "date": "2014-02-25",
  "language": "de",
  "licence": "restricted",
  "generatingQuery": "giving AND birth"
},
{
  "resultGroup": [

  ],
  "documentBadge": {
    "id": "UPCTV57OVPPBON4IK2AU4ZWSBBC42RXI",
    "uri": "https:\/\/www.deutsche-digitale-bibliothek.de\/item\/UPCTV57OVPPBON4IK2AU4ZWSBBC42RXI",
    "provider": "Deutsche Digitale Bibliothek"
  },
  "mediaType": "text",
  "title": "The future demand for long-term carers in Germany: model calculations for the Federal L\u00e4nder until 2020",
  "date": "unknown",
  "language": "unknown",
  "licence": "https:\/\/creativecommons.org\/publicdomain\/zero\/1.0\/",
  "generatingQuery": "giving AND birth"
},
{
  "resultGroup": [

  ],
  "documentBadge": {
    "id": "TPKUV2M2KJ2DUZ6XUPCLARUZDN3553P4",
    "uri": "https:\/\/www.deutsche-digitale-bibliothek.de\/item\/TPKUV2M2KJ2DUZ6XUPCLARUZDN3553P4",
    "provider": "Deutsche Digitale Bibliothek"
  },
  "mediaType": "text",
  "title": "Modern monarchs and democracy : Thailand's Bhumibol Adulyadej and Juan Carlos of Spain",
  "date": "unknown",
  "language": "unknown",
  "licence": "https:\/\/creativecommons.org\/publicdomain\/zero\/1.0\/",
  "generatingQuery": "giving AND birth"
},
{
  "resultGroup": [
    {
      "resultGroup": [

      ],
      "documentBadge": {
        "id": "\/09307\/5B02896BF6545EFC9651F43D5810E42EFCAE774B",
        "uri": "http:\/\/europeana.eu\/resolve\/record\/09307\/5B02896BF6545EFC9651F43D5810E42EFCAE774B",
        "provider": "Europeana"
      },
      "mediaType": "TEXT",
      "previewImage": "http:\/\/europeanastatic.eu\/api\/image?uri=http%3A%2F%2Fremote.jewishmuseum.org.uk%3A83%2FCollectionImage%2FLow%2520Res%2Fphoto%2520archive%2F1454.67.jpg&size=LARGE&type=TEXT",
      "title": "Martin Thau's birth certificate",
      "date": "1920-01-01",
      "language": "en",
      "licence": "http:\/\/www.europeana.eu\/rights\/rr-f\/",
      "generatingQuery": "(giving AND birth)"
    }
  ],
  "documentBadge": {
    "id": "\/09307\/5B02896BF6545EFC9651F43D5810E42EFCAE774B",
    "uri": "http:\/\/europeana.eu\/resolve\/record\/09307\/5B02896BF6545EFC9651F43D5810E42EFCAE774B",
    "provider": "Europeana"
  },
  "mediaType": "TEXT",
  "previewImage": "http:\/\/europeanastatic.eu\/api\/image?uri=http%3A%2F%2Fremote.jewishmuseum.org.uk%3A83%2FCollectionImage%2FLow%2520Res%2Fphoto%2520archive%2F1454.67.jpg&size=LARGE&type=TEXT",
  "title": "Martin Thau's birth certificate",
  "date": "1924-01-01",
  "language": "en",
  "licence": "http:\/\/www.europeana.eu\/rights\/rr-f\/",
  "generatingQuery": "(giving AND birth)"
},
{
  "resultGroup": [

  ],
  "documentBadge": {
    "id": "10011276148",
    "uri": "http:\/\/www.econbiz.de\/Record\/10011276148",
    "provider": "ZBW"
  },
  "mediaType": "text",
  "title": "SUCCESS OF VAGINAL BIRTH AFTER CESAREAN",
  "description": "Purpose:This study is conducted to determine the factors that facilitate and hinder vaginal birth after cesarean by specifying emotions, opinions and experiences about delivery of women that gave vaginal birth after cesarean and using birth stories which those women told in the Facebook group \u201cVaginal Birth After Cesarean\u201d to support each other.Material and Method:The study is a quantitative one. Since it aims to study and present vaginal birth after cesarean in detail in a point of view that depends on the experiences of the participants, it is planned in a phenomenological pattern. The data is gathered from the documents that are based on the birth stories of the participants and analysed using document analysis method. In the research, birth stories of 16 women who had been members of the \u201cVaginal Birth After Cesarean\u201d group in Facebook which is one of the social media environments, given a successful vaginal birth, shared their birth stories in the group, and accepted to participate in the research were used as documents. Findings:In the study, the stories that the participants experienced in the duration between the stage in which the participants decided to give vaginal birth and the time in which they actually gave vaginal birth are presented by their own expressions. The data gathered from the stories that participants shared is analysed using content analysis method, coded and themes are created. The data acquired from the emotions, ideas and experiences of the women who have given vaginal birth after cesarean about vaginal birth is analysed under four main titles (themes) which are \u201cthe time at which decision to give vaginal birth after cesarean is given\u201d, \u201cpreparation stage before the birth (hindering and facilitating factors)\u201d, birth stage (hindering and facilitating factors and medical intervention)\u201d, and \u201cdefinition of the experience of the vaginal birth after cesarean\u201d.Result:The study shows that the most important step of succeeding in giving vaginal birth after cesarean is the decision stage.Thus, the time of previous birth is important in this process. It has been seen that searching for doctors for giving vaginal birth, getting examined, and the support of the ones who have given vaginal birth after caesarean are important for the continuum of the decision stage. It has been seen that during the delivery, supportive approach of the obstetrician, moving, waiting for the baby to born, pushing and affirmations are the most important ones among the facilitating factors.",
  "date": "2015-05-01",
  "language": "de",
  "licence": "restricted",
  "generatingQuery": "giving AND birth"
}

]
}

[chseifert]

The rationale behind the result group is to group similar items, e.g. multiple, very similar, but slightly different views of the same ancient coin. And we need an representative for the result group as well.
With this context in mind, the above format is also not completely clear to me. As far as I know now other client currently uses this information, which might explain why nobody else has stumbled across this yet.

For the format discussion, I will assign Thomas from the PP group, who possibly directly assigns this further to the recommender.

[pstoehr]

With this piece of information in mind ...
Shouldn't a resultGroup consists of at least two entries?

[hziak]

The result group holds other results that were considered near duplicates of the result already added in the result list. Therefore there might be 1 to n documents in the group.
It doesn't hold only DocumentBadges it hold a list of complete results. The result groups within the already grouped documents will always be empty. I will have a look if we can remove the group within the grouped documents to avoid further confusion about it.

[chseifert]

So, let me see if I understood this correctly.
For example, I get a list of 4 results res 1, res2, res3, res4
Let's say result 2 has additionally very similar results res2a, res2b . Then the latter would be in the result group added to res2? res1, res3, res4 would not have an result group added (or an empty one)?

[hziak]

yes,
basic idea is just to remove duplicates and near duplicates from the list.
But it might be still useful information for some views (e.g. showing only images) so we didn't want to remove that items and instead stick it to the result which we considered being similar or equal.

[chseifert]

and in the above example, the numberOfResults would be 4 or 6?

[hziak]

numberOfResults should be 4 since the groups are not counted

[pstoehr]

Thanks for the clarification!

But the PP returned the following entry:
{
"resultGroup": [
{
"resultGroup": [

  ],
  "documentBadge": {
    "id": "\/2022343\/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF",
    "uri": "http:\/\/europeana.eu\/resolve\/record\/2022343\/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF",
    "provider": "Europeana"
  },
  "mediaType": "IMAGE",
  "previewImage": "http:\/\/europeanastatic.eu\/api\/image?uri=http%3A%2F%2Fwww.culturegrid.org.uk%2Fdpp%2Fresource%2F3075231%2Fstream%2Fthumbnail_image_jpeg&size=LARGE&type=IMAGE",
  "title": "Netsuke in form of women giving birth",
  "date": "1900-01-01",
  "language": "en",
  "licence": "http:\/\/www.europeana.eu\/rights\/rr-f\/",
  "generatingQuery": "(giving AND birth)"
}

],
"documentBadge": {
"id": "/2022343/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF",
"uri": "http://europeana.eu/resolve/record/2022343/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF",
"provider": "Europeana"
},
"mediaType": "IMAGE",
"previewImage": "http://europeanastatic.eu/api/image?uri=http%3A%2F%2Fwww.culturegrid.org.uk%2Fdpp%2Fresource%2F3075231%2Fstream%2Fthumbnail_image_jpeg&size=LARGE&type=IMAGE",
"title": "Netsuke in form of women giving birth",
"date": "1701-01-01",
"language": "en",
"licence": "http://www.europeana.eu/rights/rr-f/",
"generatingQuery": "(giving AND birth)"
},

Therefor I have two additional questions:

1. Why is there an empty resultGroup as a member of the resultGroup? That is the one that can be ignored?
2. Why is the same document referenced twice?

[hziak]

1.) That was what i meant with "I will have a look if we can remove the group within the grouped documents to avoid further confusion about it.". Both objects use the same representation within the system so they are generated in the same way. Therefore there is a result group within the already grouped objects but it will never be not empty.

2.) It looks like somehow Europeana returned the same document twice. If you have a look at the date attribute of both results you can see that, although the "uri" and "id" is identical, the date varies.
So either that’s a problem in the index of Europeana or it's a problem of the transformation.
We should ask @jr-dig-orgel about that.

[pstoehr]

Thanks for the clarifications!

[jr-dig-orgel]

for me its seems that there is a problem in the index of europeana - the transformation seems to work correctly.

[chseifert]

Interestingly, the date in the original Europeana entry is a range: 1700-1900
http://www.europeana.eu/portal/record/2022343/D0807F3F4D94D1529BDAA3D13DFB462E64B7B6CF.html?start=1&query=Netsuke+in+form+of+women+giving+birth&startPage=1&qt=false&rows=24

Thomas, could it be, that the transformation creates two entries for entries with time range, one with the starting date and one with the end date?

[jr-dig-orgel]

@chseifert thanks for the hint -> I will check this