Versions Compared

Old Version 3

changes.mady.by.user Osma Suominen

Saved on

compared with

New Version 4

changes.mady.by.user Osma Suominen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. The API accepts raw text. If your documents are in another format, such as PDF, HTML or Word, you must first convert it to UTF-8 encoded raw text.
  2. The API offers so-called projects and the API request must be targeted at the correct project according to the language of the document. If the document language is unknown, you must first determine it using another tool (see e.g. the SeCo LAS API and the langdetect library for Python). There are currently three projects: yso-fi, yso-sv and yso-en.
  3. The API has several methods. The most important are the list of projects (/v1/projects/) and suggesting subjects for documents (/v1/projects/<project_id>/suggest). You can control the number of suggestions using the limit and threshold parameters. The limit parameter sets the maximum number of suggestions (default 10) and the threshold sets the minimum score level for suggestions.
  4. There are currently no limitations on the use of the API. To avoid overloading the API, please do not make multiple parallel calls - wait for the previous request to finish before making a new one. The maximum input size is 5 MB.

A detailed, interactive OpenAPI/Swagger documentation for the API is available.

...