Machine Annotation Service Terms (In Progress)
Open Digital Specimen List of Terms
Machine Annotation Service List of Terms (In Progress)
Title : Machine Annotation Service List of Terms
Date version issued : 2024-06-17
Date created : 2024-06-17
This version : 0.3.0
Latest version : 0.3.0
Abstract
: The Machine Annotation Service (MAS) object describe the Machine Agent which generated automated annotations for DiSSCo.
The object contains fields for describing the service, the container image and the container version.
The image tag cannot be latests
as it needs to be clear which version of the container was used to generate the annotations.
Updating the image tag will also generate a new version of the MAS, providing provenance and traceability.
The TargetDigitalObjectFilter
can be used to specifics which Digital Object the MAS should be applied to.
It uses json path for the filtering and can be used to filter on any field in the Digital Object.
At the moment MAS can only be run on Digital Specimen and Digital Media objects.
Main contributors : Sam Leeflang, Soulaine Theocharides, Tom Dijkema
Creator : Distributed Infrastructure for Scientific Collections (DiSSCo)
Bibliographic citation : Distributed Infrastructure for Scientific Collections. 2024. Machine Annotation Service List of Terms List of Terms.
1 Introduction
1.1 Status of the content of this document
The openDS data specification is in active development. This document is work in progres and might change until version 1.0.0 is released. Its main function at the moment is to inform the community about the current state of the data model and to gather feedback. We hope to include the feedback from the community and reach a first major version of the data model by the end of 2024.
1.2 RFC 2119 key words
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 RFC 2119 and RFC 8174 when, and only when, they appear in all capitals, as shown here.
2 Borrowed Vocabulary
When terms are borrowed from other vocabularies, openDS uses the IRIs, common abbreviations, and namespace prefixes in use in those vocabularies. The IRIs are normative, but abbreviations and namespace prefixes have no impact except as an aid to reading the documentation.
Table 1. Vocabularies from which terms have been borrowed (non-normative)
Vocabulary | Abbreviation | Namespaces and abbreviations |
---|---|---|
Schema.org | Schema | schema: = https://schema.org/version/latest/schemaorg-current-https.rdf |
3 Namespaces, Prefixes and Term Names
The namespace of terms borrowed from other vocabularies is that of the original. The namespace of de openDS terms is http://rs.dissco.eu/opends/terms/. In the table of terms, each term entry has a row with the term name. This term name is generally an “unqualified name” preceded by a widely accepted prefix designating an abbreviation for the namespace It is RECOMMENDED that implementers who need a namespace prefix for the openDS namespace use ods. In this web document, hovering over a term in the Index By Term Name list below will reveal a complete URL that can be used in other web documents to link to this document’s treatment of that term, even if it is from a borrowed vocabulary.
4 Term index
4.1 Index By Term Name
ContactPoint
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
maintainer
5 Vocabulary
Term Name telephone | |
---|---|
Qualified Term | schema:telephone |
Term IRI | http://schema.org/telephone |
Label | Telephone |
Definition | Telephone number of the contact point, https://schema.org/telephone |
Datatype | string |
Belongs to Class | ContactPoint |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name url | |
---|---|
Qualified Term | schema:url |
Term IRI | http://schema.org/url |
Label | Url |
Definition | Email of the contact point, https://schema.org/email |
Datatype | string |
Belongs to Class | ContactPoint |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name email | |
---|---|
Qualified Term | schema:email |
Term IRI | http://schema.org/email |
Label | |
Definition | Email of the contact point, https://schema.org/email |
Datatype | string |
Belongs to Class | ContactPoint |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name description | |
---|---|
Qualified Term | schema:description |
Term IRI | http://schema.org/description |
Label | Description |
Definition | Description of the contact point, https://schema.org/description |
Datatype | string |
Belongs to Class | ContactPoint |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name MachineAnnotationService | |
---|---|
Qualified Term | ods:MachineAnnotationService |
Term IRI | http://rs.dissco.eu/opends/terms/MachineAnnotationService |
Label | Machine Annotation Service |
Definition | A Machine Annotation Service |
Required | True |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name topicName | |
---|---|
Qualified Term | ods:topicName |
Term IRI | http://rs.dissco.eu/opends/terms/topicName |
Label | Topic Name |
Definition | Kafka topic through which the MAS receives messages. Defaults to PID of MAS |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name slaDocumentation | |
---|---|
Qualified Term | ods:slaDocumentation |
Term IRI | http://rs.dissco.eu/opends/terms/slaDocumentation |
Label | Sla Documentation |
Definition | Link to SLA documentation |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ContactPoint | |
---|---|
Qualified Term | schema:ContactPoint |
Term IRI | http://schema.org/ContactPoint |
Label | Contact Point |
Definition | The contact point for support and information for the MAS, https://schema.org/ContactPoint |
Datatype | object |
Required | False |
Repeatable | False |
RDF Type | rdfs:Class |
Term Name dependency | |
---|---|
Qualified Term | ods:dependency |
Term IRI | http://rs.dissco.eu/opends/terms/dependency |
Label | Dependency |
Definition | Handles from other MAS that this MAS depends on |
Examples |
|
Datatype | array |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name license | |
---|---|
Qualified Term | schema:license |
Term IRI | http://schema.org/license |
Label | License |
Definition | License of the service, https://schema.org/license |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name maintainer | |
---|---|
Qualified Term | schema:maintainer |
Term IRI | http://schema.org/maintainer |
Label | Maintainer |
Definition | Party maintaining the code |
Datatype | object |
Required | False |
Repeatable | False |
RDF Type | rdfs:Class |
Term Name batchingPermitted | |
---|---|
Qualified Term | ods:batchingPermitted |
Term IRI | http://rs.dissco.eu/opends/terms/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 |
Datatype | boolean |
Belongs to Class | MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name programmingLanguage | |
---|---|
Qualified Term | schema:programmingLanguage |
Term IRI | http://schema.org/programmingLanguage |
Label | Programming Language |
Definition | The programming language of the MAS, https://schema.org/programmingLanguage |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name serviceAvailability | |
---|---|
Qualified Term | ods:serviceAvailability |
Term IRI | http://rs.dissco.eu/opends/terms/serviceAvailability |
Label | Service Availability |
Definition | Availability commitment of the service provider as described in the SLA |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name creativeWorkStatus | |
---|---|
Qualified Term | schema:creativeWorkStatus |
Term IRI | http://schema.org/creativeWorkStatus |
Label | Creative Work Status |
Definition | The current status of the service, https://schema.org/creativeWorkStatus |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ID | |
---|---|
Qualified Term | ods:ID |
Term IRI | http://rs.dissco.eu/opends/terms/ID |
Label | Id |
Definition | Handle of the Machine Annotation Service |
Examples |
|
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name type | |
---|---|
Qualified Term | ods:type |
Term IRI | http://rs.dissco.eu/opends/terms/type |
Label | Type |
Definition | The DOI to the FDO type of the object |
Examples |
|
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name version | |
---|---|
Qualified Term | schema:version |
Term IRI | http://schema.org/version |
Label | Version |
Definition | Version of the Machine Annotation Service, https://schema.org/version |
Datatype | integer |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name name | |
---|---|
Qualified Term | schema:name |
Term IRI | http://schema.org/name |
Label | Name |
Definition | Name of the Machine Annotation Service as provided by the user, https://schema.org/name |
Examples |
|
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name description | |
---|---|
Qualified Term | schema:description |
Term IRI | http://schema.org/description |
Label | Description |
Definition | Description of the Machine Annotation Service as provided by the user, https://schema.org/description |
Examples |
|
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name dateCreated | |
---|---|
Qualified Term | schema:dateCreated |
Term IRI | http://schema.org/dateCreated |
Label | Date Created |
Definition | Timestamp of creation. Internally generated, https://schema.org/dateCreated |
Examples |
|
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name dateTombstoned | |
---|---|
Qualified Term | ods:dateTombstoned |
Term IRI | http://rs.dissco.eu/opends/terms/dateTombstoned |
Label | Date Tombstoned |
Definition | Timestamp Machine Annotation Service was tombstoned and no longer active. Generated on request of the user |
Examples |
|
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name creator | |
---|---|
Qualified Term | ods:creator |
Term IRI | http://rs.dissco.eu/opends/terms/creator |
Label | Creator |
Definition | The internal user ID of the creator of the Machine Annotation Service |
Examples |
|
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name containerImage | |
---|---|
Qualified Term | ods:containerImage |
Term IRI | http://rs.dissco.eu/opends/terms/containerImage |
Label | Container Image |
Definition | URI of the image of the containerized application |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name containerTag | |
---|---|
Qualified Term | ods:containerTag |
Term IRI | http://rs.dissco.eu/opends/terms/containerTag |
Label | Container Tag |
Definition | Tag of the image |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name TargetDigitalObjectFilter | |
---|---|
Qualified Term | ods:TargetDigitalObjectFilter |
Term IRI | http://rs.dissco.eu/opends/terms/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 |
Datatype | object |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name codeRepository | |
---|---|
Qualified Term | schema:codeRepository |
Term IRI | http://schema.org/codeRepository |
Label | Code Repository |
Definition | Link to code base of MAS, https://schema.org/codeRepository |
Datatype | string |
Belongs to Class | MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name timeToLive | |
---|---|
Qualified Term | ods:timeToLive |
Term IRI | http://rs.dissco.eu/opends/terms/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. |
Datatype | integer |
Belongs to Class | MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name url | |
---|---|
Qualified Term | schema:url |
Term IRI | http://schema.org/url |
Label | Url |
Definition | URL of the maintainer, https://schema.org/url |
Datatype | string |
Belongs to Class | maintainer |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name email | |
---|---|
Qualified Term | schema:email |
Term IRI | http://schema.org/email |
Label | |
Definition | Email of the maintainer, https://schema.org/email |
Datatype | string |
Belongs to Class | maintainer |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name name | |
---|---|
Qualified Term | schema:name |
Term IRI | http://schema.org/name |
Label | Name |
Definition | Name of the maintainer, https://schema.org/name |
Datatype | string |
Belongs to Class | maintainer |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name identifier | |
---|---|
Qualified Term | schema:identifier |
Term IRI | http://schema.org/identifier |
Label | Identifier |
Definition | Identifier of the maintainer, https://schema.org/identifier. Recommendation to use ROR or ORCID |
Datatype | string |
Belongs to Class | maintainer |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |