search

EEXCESS / eexcess

This is the EEXCESS main repository bringing togehter the different sub-projects and providing the documentation in the Wiki. Its the starting point when you want to know more about the project.
http://eexcess.eu/
5 stars 2 forks source link

Updated Documentation for Query Format and Logging #3

Open molybdaen opened 8 years ago

molybdaen commented 8 years ago

Hi all,

i just documented the new query/response format and the logging format to the status we agreed on during the hackathon. I kindly ask all of you to look through the doc and check if it aligns with your current (in case you already implemented it) or upcoming implementation.

The query/response format can be found here (Jörg, Thomas, Hermann): (https://github.com/EEXCESS/eexcess/wiki/%5B21.09.2015%5D-Request-and-Response-format)

The logging is documented here (Thomas): (https://github.com/EEXCESS/eexcess/wiki/EEXCESS---Logging)

Once these formats are implemented (I do not yet know when we will switch to the new format), the two doc-pages will replace the old ones.

schloett commented 8 years ago

The datatype for birthdate is Integer, is this really correct? Moreover, in the user profile page, we only have age categories {child, young adult, adult}, should we align this? Similar applies to address: only country and city are left in the profile page, so the rest is not necessary in the request format as well? The entityType attribute in the contextKeywords should be type instead of entityType. What happens, if a client sends a queryID to the privacy proxy (PP)? Will the PP use this ID or generate a new one by himself?

ThomasCerq commented 8 years ago

The birthDate attribute is obsolete. It will never be used by the FR to provide recommendations. It should be replaced by the ageRange. The address attribute is not relevant. Only country and city might be used at some point but it's not even sure. If a client sends a queryID, the PP will use it. Otherwise a new one is generated. Actually, the best way to go is NOT to provide a queryID.

ThomasCerq commented 8 years ago

Should we remove "gender"? I don't think it will ever be used...

Also, browsingHistory does not appear. Should we add it?

schloett commented 8 years ago

As far as I remember, both attributes are not used by the recommender, hence there is no need to keep them. Can someone of the recommender team confirm this?

ThomasCerq commented 8 years ago

The browsing history will only be used locally then?

schloett commented 8 years ago

As for now: yes. But I am not totally sure, I think there have been ideas to use the browsing history for the source selection, that's why I asked for the confirmation of the recommender guys. On the other hand, nobody complained about its disappearance until now, so removal should be save ;)

chseifert commented 8 years ago

On closing this issue and when the result format is fixed, and the pages are renamed, could you please notify me or comment in https://github.com/EEXCESS/eexcess/issues/12 that the PURLs get updated.

chseifert commented 8 years ago

Important to solve this in short time. We need to make sure the documentation complies with the API with the implementation. Related issues https://github.com/EEXCESS/eexcess/issues/14 https://github.com/EEXCESS/eexcess/issues/15 https://github.com/EEXCESS/eexcess/issues/8

Herman could you please comment

chseifert commented 8 years ago

For client developers it is not clear, whether a change of attribute values would actually change the results. Concretely, these are the following

What we would need: For each attribute a short explanation on whether and what will change when the attribute is set differently. For instance:

Those attribute that will never have any influence, should be removed.

schloett commented 8 years ago

Some attributes also require a more precise description, both in the request and response format.Two examples: 1) request format -> languages -> languageCompetenceLevel: what is the possible range? [0-1] seems reasonable, but stating it explicitly would avoid confusion 2) response format -> result[i] -> mediaType: The documentation states "Media type like image or video and so on." What are the possible values exactly? (Stumbled across this, as in the SearchResultListVis there was a check for mediaType:audio, while the returned type was "SOUND") @hziak could you please add this information (or delegate it to someone who can)?

chseifert commented 8 years ago

Johannes, could you check, whether this is a type? References the section https://github.com/EEXCESS/eexcess/wiki/%5B21.09.2015%5D-Request-and-Response-format#pp-rf1

mail attachment

molybdaen commented 8 years ago

Typo. Fixed

Am 28.10.2015 um 14:07 schrieb chseifert notifications@github.com:

Johannes, could you check, whether this is a type? References the section https://github.com/EEXCESS/eexcess/wiki/%5B21.09.2015%5D-Request-and-Response-format#pp-rf1 https://github.com/EEXCESS/eexcess/wiki/[21.09.2015]-Request-and-Response-format#pp-rf1 https://cloud.githubusercontent.com/assets/4638470/10789329/11345c9a-7d7d-11e5-8513-8cf186945cae.png — Reply to this email directly or view it on GitHub https://github.com/EEXCESS/eexcess/issues/3#issuecomment-151839378.