TextDocument (v1)¶

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

Description¶

A text document.

Properties¶

Synopsis¶

Properties marked with * are required.

Property	Type	Origin
text	object	native
location	string	Document (v1)
mime	string	Document (v1)
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 (v1)¶

`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.

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 *location* property is used."
    },
    "text": {
      "additionalProperties": true,
      "type": "object",
      "description": "A JSON-LD value object which has a *@value* and a *@language* property."
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}