FAQ

General

Can you explain what the Climate Tagger API is and how it works?

The Climate Tagger API is a free service that automatically turns data into knowledge – knowledge that helps you and the users of your information services make better decisions. It is independent from specific content management systems and offers additional functionality compared to the Climate Tagger Drupal and CKAN modules provided by the Climate Tagger Suite.

Who is responsible for this service?

Climate Tagger is a joint tool of the Climate Knowledge Brokers Group (CKB Group), developed by REEEP with support from key donors, partners and expert contributors (see http://www.climatetagger.net/contributors-and-supporters/ for more details)

How can I use the Climate Tagger API?

To upload and tag documents or fully implant the Climate Tagger API into your publishing environment you have to register. Once you've registered you will receive an automated email. Activate your account by following the link in this email and you will be able to log in to the API dashboard. In the dashboard, you can create new API projects and get an authentication token to use the Climate Tagger API. As a test project the user can create a new project which is set on "private" and which can be deleted once it is not needed anymore.

What languages can the API be used for?

The API is currently available in English, German, French, Portuguese and Spanish.

Can I limited the subject area of tags for my resources?

If you want to use Climate Tagger for a very specific set of documents, it is now possible to select only certain parts of the thesaurus for even more precise tagging. Currently available are the topics: select All (Climate Tagger Thesaurus), climate change adaptation, climate change mitigation, renewable energy, energy efficiency. This feature is available for the API, including the demo and "upload and tag". Default setting is select All (Climate Tagger Thesaurus).

API tag extraction service

What kind of documents can I use the tag extraction service for?

The Climate Tagger API for automated tagging is specifically developed for documents dealing with climate change related topics and is regularly updated and extended to cover more topics within this area.

How does the API extract tags?

The API extracted concepts based on the Climate Thesaurus plus free tags based on frequency.

Do I need a deep integration of the Climate Tagger API to benefit from automated tagging?

No, if you only want to tag a limited amount of documents you can just upload and tag documents directly after registration. No technical implementation is required; export and download results are returned for further use as CSV files. Bulk upload is possible!

Is there a limit how many request I can send to the API?

For the fully implemented Climate Tagger API, currently there is no limit. There is, however a limit (500 documents) to upload and tag documents without the API implementation.

Content pool and suggested readings

What kind of documents does the content pool consist of?

The content pool consists of 3rd party documents that have been indexed by the Climate Tagger API and added to the content pool by the uploader as well as REEEP's own original sources.

Will all documents that I tag with the Climate Tagger become part of the content pool?

Not at all. It is up to you if you want to share your resources! When you do want to share, we never store the actual document, just the indexed tags and the URL of your resource.

How are recommended documents suggested?

Based on your selection of keywords (tags), documents that have been previously indexed are suggested to you.

How are similar documents suggested?

Documents that have a already been indexed are tested for their similarity to your uploaded documents based on the tags extracted from the Climate Tagger API.

How can I test this feature/is there a sandbox?

To create a test project the user open a new project with the setting on private (tick appropriate box). After you have revised this feature you can delete this project.