Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API usage and output #193

Open
anastasiabright opened this issue May 10, 2024 · 5 comments
Open

API usage and output #193

anastasiabright opened this issue May 10, 2024 · 5 comments

Comments

@anastasiabright
Copy link

Dear FAIR EVA team,

I attempted to assess my data using your service, following your API setup instructions. I have a couple of questions:

  1. On GitHub, the documentation suggests using "repo":"oai-pmh" in our request, whereas on the API page, it suggests "repo": "digital_csic". Could you please clarify, which one is correct?

Using the digital_csic repo, I encountered a server error:
fair_eva2

  1. On the other hand, when using "repo":"oai-pmh", the results I received were quite confusing. Most of my data sets returned with "0", regardless of whether they were published under DOI or any other URL. See the screenshot with a prefilled example from the API page, with also "0"s in the output:
    fair_eva1

Do you have any insignts into why I could have gotten such results? Is the service working as intended?

I appreciate your response and hope to here from you very soon!

Best regards,
Anastasiia Iarkaeva
(Research fellow at BIH QUEST Center for Responsible Research at Charité)

@PalomoIFCA
Copy link
Contributor

Hello, thanks for your questions:

First of all ¿where is the asset, you want to evaluate?, that is what dictates the repo argument, also you will need the identifier in that repo

Best regards

Iván Palomo

@anastasiabright
Copy link
Author

Dear Iván Palomo,

Thank you for quick response!
I'm not sure I can follow your question, but let's clarify a bit if it helps to understand my issue:

I cloned your GitHub repository and run the local instance, where I tested both "repo" arguments (oai-pmh and digital-csic) on identifier 10.1010/test87 from the API test. When I try on my own identifier (actually, there is a whole list of IDs I want to check through API), I get the same result.

In addition, I tried out the beta version under https://fair.csic.es/en, and got an error too, see:
fair_eva3

When you say asset, do you mean the DOI that I validate?

Best regards,
Anastasiia Iarkaeva

@PalomoIFCA
Copy link
Contributor

OK, the web version at the moment , does not work properly.

Try with the command

curl -X POST "http://localhost:9090/v1.0/rda/rda_all" -H  "accept: application/json" -H  "Content-Type: application/json" -d '{"id":"http://hdl.handle.net/10261/157765","lang":"es","oai_base": "http://digital.csic.es/dspace-oai/request","repo":"oai-pmh"}'

This should work and make a good evaluation .

repo depends on where the item is stored, and for now you should only use oai-pmh or epos.

When I reffer to the asset I mean the digital object that the DOI represents. , the DOI or Handle is used ussually with oai-pmh repositories but epos for example uses their own UUIDs

Best regards,
Iván Palomo

@anastasiabright
Copy link
Author

Thank you again for explaination.

I tried this request, and refered to it in my first comment under sub-item 2.
I am wondering why I could get "test_status":"fail", i.e. score=0 in all tests... I apply it on DOIs with real data sets, e.g. 10.6084/m9.figshare.14524716.v1.

So far, I understood that I did everything right, and these are the most results I can get with FAIR EVA.
Please, if you have any further suggestions or hints for improving the scores with currently available service's version(s), I will be happy to apply it!

Best regards,
Anastasiia Iarkaeva

@PalomoIFCA
Copy link
Contributor

PalomoIFCA commented May 17, 2024

Hello, in item 2 you used the identifier not for a real item just a testing one predefined in the API id (10.10'/test87) that is the reason that item gives you 0 points.

In the case of the particular identifier you show to me, it is not present in digital csic so if you are using that endpoint (the endpoint you use in both your screenshots) it will return 0 points. The other option is that the endpoint you are using is different, if that is the case maybe the endpoint doesn´t support oai-pmh protocols and would require the creation of its own plugin.

In any case the comand I sent you should work, i have tried it and it returns a succesfull evaluation

curl -X POST "http://localhost:9090/v1.0/rda/rda_all" -H  "accept: application/json" -H  "Content-Type: application/json" -d '{"id":"http://hdl.handle.net/10261/157765","lang":"es","oai_base": "http://digital.csic.es/dspace-oai/request","repo":"oai-pmh"}'

In any case I hope I have helped you.

Best regards, Ivan

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants