Machine Annotation Service Quick Reference Guide (In Progress)

On this page

Overview (In Progress)

Requirements

The tables below provides a summary of the required classes and terms. Term requirements are subject to the use of the parent class where a term that belongs to an optional class are required if and only if, their parent class is in use.

Required Classes
Class Label Required
ods:MachineAnnotationService Machine Annotation Service True
Required Terms
Term Label Class Required
ods:batchingPermitted Batching Permitted MachineAnnotationService True
ods:ID Id MachineAnnotationService True
ods:type Type MachineAnnotationService True
schema:name Name MachineAnnotationService True
ods:containerImage Container Image MachineAnnotationService True
ods:containerTag Container Tag MachineAnnotationService True
ods:timeToLive Time To Live MachineAnnotationService True

Open Digital Specimen

ContactPoint

schema:description schema:email schema:url schema:telephone
schema:description Property
Qualified Term schema:description
Label Description
Definition Description of the contact point, https://schema.org/description
schema:email Property
Qualified Term schema:email
Label Email
Definition Email of the contact point, https://schema.org/email
schema:url Property
Qualified Term schema:url
Label Url
Definition Email of the contact point, https://schema.org/email
schema:telephone Property
Qualified Term schema:telephone
Label Telephone
Definition Telephone number of the contact point, https://schema.org/telephone

MachineAnnotationService

ods:MachineAnnotationService ods:ID ods:type schema:version schema:name schema:description schema:dateCreated ods:dateTombstoned ods:creator ods:containerImage ods:containerTag ods:TargetDigitalObjectFilter schema:creativeWorkStatus schema:codeRepository schema:programmingLanguage ods:serviceAvailability schema:maintainer schema:license ods:dependency schema:ContactPoint ods:slaDocumentation ods:topicName ods:batchingPermitted ods:timeToLive
ods:MachineAnnotationService Class
Qualified Term ods:MachineAnnotationService
Label Machine Annotation Service
Definition A Machine Annotation Service
ods:ID Property
Qualified Term ods:ID
Label Id
Definition Handle of the Machine Annotation Service
Examples
  • ['https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX']
ods:type Property
Qualified Term ods:type
Label Type
Definition The DOI to the FDO type of the object
Examples
  • ['https://doi.org/10.15468/1a2b3c']
schema:version Property
Qualified Term schema:version
Label Version
Definition Version of the Machine Annotation Service, https://schema.org/version
schema:name Property
Qualified Term schema:name
Label Name
Definition Name of the Machine Annotation Service as provided by the user, https://schema.org/name
Examples
  • ['GBIF Linker Service']
schema:description Property
Qualified Term schema:description
Label Description
Definition Description of the Machine Annotation Service as provided by the user, https://schema.org/description
Examples
  • ['A service that links GBIF records to a DiSSCo Digital Specimen. It creates an EntityRelationship indicating the relationship']
schema:dateCreated Property
Qualified Term schema:dateCreated
Label Date Created
Definition Timestamp of creation. Internally generated, https://schema.org/dateCreated
Examples
  • ['2021-06-01T12:00:000Z']
ods:dateTombstoned Property
Qualified Term ods:dateTombstoned
Label Date Tombstoned
Definition Timestamp Machine Annotation Service was tombstoned and no longer active. Generated on request of the user
Examples
  • ['2021-06-01T12:00:000Z']
ods:creator Property
Qualified Term ods:creator
Label Creator
Definition The internal user ID of the creator of the Machine Annotation Service
Examples
  • ['e2befba6-9324-4bb4-9f41-d7dfae4a44b0']
ods:containerImage Property
Qualified Term ods:containerImage
Label Container Image
Definition URI of the image of the containerized application
ods:containerTag Property
Qualified Term ods:containerTag
Label Container Tag
Definition Tag of the image
ods:TargetDigitalObjectFilter Property
Qualified Term ods:TargetDigitalObjectFilter
Label Target Digital Object Filter
Definition Filters describing the criteria that must be met in order to apply the MAS. No filters implies the MAS may run on *any* digital object. Field names are given in JSON paths, and accepted values for that field are provided as an arrays
schema:creativeWorkStatus Property
Qualified Term schema:creativeWorkStatus
Label Creative Work Status
Definition The current status of the service, https://schema.org/creativeWorkStatus
schema:codeRepository Property
Qualified Term schema:codeRepository
Label Code Repository
Definition Link to code base of MAS, https://schema.org/codeRepository
schema:programmingLanguage Property
Qualified Term schema:programmingLanguage
Label Programming Language
Definition The programming language of the MAS, https://schema.org/programmingLanguage
ods:serviceAvailability Property
Qualified Term ods:serviceAvailability
Label Service Availability
Definition Availability commitment of the service provider as described in the SLA
schema:maintainer Class
Qualified Term schema:maintainer
Label Maintainer
Definition Party maintaining the code
schema:license Property
Qualified Term schema:license
Label License
Definition License of the service, https://schema.org/license
ods:dependency Property
Qualified Term ods:dependency
Label Dependency
Definition Handles from other MAS that this MAS depends on
Examples
  • [['https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX']]
schema:ContactPoint Class
Qualified Term schema:ContactPoint
Label Contact Point
Definition The contact point for support and information for the MAS, https://schema.org/ContactPoint
ods:slaDocumentation Property
Qualified Term ods:slaDocumentation
Label Sla Documentation
Definition Link to SLA documentation
ods:topicName Property
Qualified Term ods:topicName
Label Topic Name
Definition Kafka topic through which the MAS receives messages. Defaults to PID of MAS
ods:batchingPermitted Property
Qualified Term ods:batchingPermitted
Label Batching Permitted
Definition Whether or not this MAS can create Batch Annotations. MAS outputs must then comply with batchMetadata, see https://schemas.dissco.tech/schemas/annotations/0.1.0/annotation-event.json
ods:timeToLive Property
Qualified Term ods:timeToLive
Label Time To Live
Definition Time in milliseconds the MAS message may remain in the Kafka Queue before being marked as timed out. Min 1 hour.

maintainer

schema:identifier schema:name schema:email schema:url
schema:identifier Property
Qualified Term schema:identifier
Label Identifier
Definition Identifier of the maintainer, https://schema.org/identifier. Recommendation to use ROR or ORCID
schema:name Property
Qualified Term schema:name
Label Name
Definition Name of the maintainer, https://schema.org/name
schema:email Property
Qualified Term schema:email
Label Email
Definition Email of the maintainer, https://schema.org/email
schema:url Property
Qualified Term schema:url
Label Url
Definition URL of the maintainer, https://schema.org/url