TextDocument (v2)

Description

A text document.

Properties

Synopsis

Properties marked with * are required.

Property

Type

Origin

text

object

native

location

string

Document (v2)

mime

string

Document (v2)

origination

string

Document (v2)

origins

array of string

Document (v2)

id *

string

Thing (v1)

Native

text

  • type: object

  • required: no

A JSON-LD value object which has a @value and a @language property.

Inherited from Document (v2)

location

  • type: string

  • required: no

The location of an external file.

mime

  • type: string

  • required: no

The MIME type of the document, only used when the location property is used.

origination

  • type: string

  • required: no

Describes the nature of the derivation relationship between this document and its origins. Example values include derived, transcription, topologically-identical.

origins

  • type: array of string

  • required: no

IDs of annotations or documents that this document was derived or inferred from. For example, a TextDocument produced by a transcription app points back to its source AudioDocument via this property. Supports multi-source derivation (e.g., OCR over consecutive video frames producing a single consensus document). When this property is set, an accompanying origination should also be provided to describe the nature of the derivation.

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"
    },
    "location": {
      "type": "string",
      "description": "The location of an external file."
    },
    "mime": {
      "type": "string",
      "description": "The MIME type of the document, only used when the <code>location</code> property is used."
    },
    "origins": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "description": "IDs of annotations or documents that this document was derived or inferred from. For example, a <code>TextDocument</code> produced by a transcription app points back to its source <code>AudioDocument</code> via this property. Supports multi-source derivation (e.g., OCR over consecutive video frames producing a single consensus document). When this property is set, an accompanying <code>origination</code> should also be provided to describe the nature of the derivation."
    },
    "origination": {
      "type": "string",
      "description": "Describes the nature of the derivation relationship between this document and its <code>origins</code>. Example values include <code>derived</code>, <code>transcription</code>, <code>topologically-identical</code>."
    },
    "text": {
      "additionalProperties": true,
      "type": "object",
      "description": "A JSON-LD value object which has a *@value* and a *@language* property."
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}