Alignment (v1)¶

Previous Version: none (this is the oldest version)
URI: http://clams.ai/vocabulary/type/Alignment/v1
Shortname: Alignment
Inherits from: Thing (v1)
Included in: 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.2.0
Also Known As: This type is also accessible at the following legacy URLs for backward compatibility:

Description¶

An alignment between two regions, two documents or a region and a document. Typically one of the regions or documents is a text span or text document and the other an image or audio segment or document. While there is no enforced directionality we tend to consider the text region or document as the target of the alignment.

Properties¶

Synopsis¶

Properties marked with * are required.

Property	Type	Origin
source *	string	native
target *	string	native
sourceType	string	native
targetType	string	native
id *	string	Thing (v1)

Native¶

`source`¶

type: string
required: yes

The first of the aligned regions or documents.

`target`¶

type: string
required: yes

The second of the aligned regions or documents.

`sourceType`¶

type: string
required: no

The type of the source of the alignment.

`targetType`¶

type: string
required: no

The type of the target of the alignment.

Inherited from Thing (v1)¶

`id`¶

type: string
required: yes

A unique identifier for the annotation or document. Uniqueness is relative to the view the annotation is in or the list of documents at the top level of a MMIF file.

JSON Schema¶

{
  "additionalProperties": true,
  "properties": {
    "id": {
      "description": "A unique identifier for the annotation or document. Uniqueness is relative to the view the annotation is in or the list of documents at the top level of a MMIF file.",
      "type": "string"
    },
    "sourceType": {
      "type": "string",
      "description": "The type of the source of the alignment."
    },
    "targetType": {
      "type": "string",
      "description": "The type of the target of the alignment."
    },
    "source": {
      "description": "The first of the aligned regions or documents.",
      "type": "string"
    },
    "target": {
      "description": "The second of the aligned regions or documents.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "source",
    "target"
  ],
  "type": "object"
}