Documentation

Updated: 28-6-2023

Description

Provides structured documentation for model

Endpoint

/v2/observation/documentation

Method

GET

Parameters

None

Response (successful)

HTTP Code: 200

JSON-structure, containing the following elements:

  • description
  • model_implementation
    • class_count
    • version
  • release_notes
  • tag
  • use_policy
    • authorized
      • authentication
      • max per day
      • url
    • unauthorized
      • max_per_day
JSON field data-type values description
description string key: language code, value: JSON escaped HTML The description is a natural language description of what the algorithm can do (and can’t)
model_implementation.class_count int [2, 2^32 - 1] Number of classes (taxa) in implementation
model_implementation.version string unique implementation identifier see values
release_notes string key: language code, value: JSON escaped HTML Release notes indicate changes a.o. changes w.r.t. to previous models
tag string “algorithm=<algorithm_tag>,api=api-v2:<api_tag> Human-readable tag for specific algorithm and api version
use_policy.authorized.authentication string [0, 2^32 - 1] describes the type of authentication used
use_policy.authorized.max_per_day string “fair use” Indicates the conditions of use of the API when authorized
use_policy.authorized.url string [0, 2^32 - 1] URL to the authorized version of the service
use_policy.unauthorized.max_per_day int [0, 2^32 - 1] Maximum number of identifications per day without authentication

Example request

​
curl \
    "https://multi-source.identify.biodiversityanalysis.eu/v2/observation/documentation" | \
jq

Requires curl and jq to be installed.

import json

import requests


def example_request():
    url = (
        "https://multi-source.identify."
        "biodiversityanalysis.eu/v2/"
        "observation/documentation"
    )

    response = requests.get(url=url)
    return response.json()


if __name__ == "__main__":
    json_response = example_request()
    print(json.dumps(json_response, indent=2))

Requires the Python requests library. Available with pip install requests.

Example response

{
  "description": {
    "en": "The webservice identifies species of plants, animals and fungi that naturally occur in Europe, based on photos of observations. The underlying recognition model has been trained using photos from Observation International, Artsdatabanken (Norway), Artdatabanken (Sweden), United Kingdom Species Inventory (United Kingdom), Arter.dk (Denmark) and FINBIF (Finland). The model contains     39477 taxa: 31419 species, 3391 higher taxa, 949 species-groups, 3059 infraspecies and 659 hybrid species. Identifications can benefit from multiple photos from the same observation. Provide up to four photos in a single request to improve identification results."
  },
  "model_implementation": {
    "class_count": 794,
    "version": "df722733dc3eb9647870d237c918cecd0d8aabeb"
  },
  "release_notes": {
    "en": "release candidate for public release"
  },
  "tag": "algorithm=msm-eur:1.1-20230619,api=api-v2:2.1.0-20230616",
  "use_policy": {
    "authorized": {
      "authentication": "https://tools.ietf.org/html/rfc7617",
      "max_per_day": "fair use",
      "url": "https://identify.biodiversityanalysis.nl/v2/observation/identify/auth"
    },
    "unauthorized": {
      "max_per_day": 10
    }
  }
}