pub.chive.review.entityLink

chive.pub

Documentation

Link from a text span in a preprint to a knowledge graph entity

main record

Link from a text span in a preprint to a knowledge graph entity

Record Key tid Timestamp-based ID

Properties

confidence integer Optional

Confidence score for the link (scaled by 1000 for 0.0-1.0 range)

minimum: 0maximum: 1000
createdAt string datetime Required

An RFC 3339 formatted timestamp.

eprintUri string at-uri Required

AT-URI of the eprint containing the linked text

schemaRevision integer Optional

Schema revision this record was created with. Absent means revision 1.

minimum: 1
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "eprintUri",
      "target",
      "linkedEntity",
      "createdAt"
    ],
    "properties": {
      "target": {
        "ref": "#textSpanTarget",
        "type": "ref",
        "description": "Text span being linked to an entity"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "eprintUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the eprint containing the linked text"
      },
      "confidence": {
        "type": "integer",
        "maximum": 1000,
        "minimum": 0,
        "description": "Confidence score for the link (scaled by 1000 for 0.0-1.0 range)"
      },
      "linkedEntity": {
        "refs": [
          "#graphNodeLink",
          "#externalIdLink",
          "#authorLink",
          "#eprintLink"
        ],
        "type": "union",
        "description": "The entity being linked to"
      },
      "schemaRevision": {
        "type": "integer",
        "minimum": 1,
        "description": "Schema revision this record was created with. Absent means revision 1."
      }
    }
  },
  "description": "Link from a text span in a preprint to a knowledge graph entity"
}
authorLink object

Link to an ATProto author

Properties

did string did Required

Author's DID

displayName string Required

Author's display name

handle string handle Optional

Author's handle

orcid string Optional

Author's ORCID (if available)

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "did",
    "displayName"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Author's DID"
    },
    "type": {
      "type": "string",
      "const": "author"
    },
    "orcid": {
      "type": "string",
      "description": "Author's ORCID (if available)"
    },
    "handle": {
      "type": "string",
      "format": "handle",
      "description": "Author's handle"
    },
    "displayName": {
      "type": "string",
      "description": "Author's display name"
    }
  },
  "description": "Link to an ATProto author"
}
eprintLink object

Link to another eprint/preprint

Properties

doi string Optional

DOI if available

title string Required

Eprint title

type string Required

No description available.

uri string at-uri Required

AT-URI of the eprint

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "uri",
    "title"
  ],
  "properties": {
    "doi": {
      "type": "string",
      "description": "DOI if available"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the eprint"
    },
    "type": {
      "type": "string",
      "const": "eprint"
    },
    "title": {
      "type": "string",
      "description": "Eprint title"
    }
  },
  "description": "Link to another eprint/preprint"
}
externalIdLink object

Link to an external identifier (Wikidata, ROR, ORCID, etc.)

Properties

identifier string Required

Identifier value (e.g., Q42 for Wikidata)

label string Required

Display label for the entity

system string Required

External identifier system

Known values: wikidata, ror, orcid, isni, viaf, lcsh, fast, credit, spdx, fundref, mesh, aat, gnd, anzsrc, arxiv, doi, pmid, pmcid
type string Required

No description available.

uri string uri Optional

Full URI for the external entity

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "system",
    "identifier",
    "label"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "Full URI for the external entity"
    },
    "type": {
      "type": "string",
      "const": "externalId"
    },
    "label": {
      "type": "string",
      "description": "Display label for the entity"
    },
    "system": {
      "type": "string",
      "description": "External identifier system",
      "knownValues": [
        "wikidata",
        "ror",
        "orcid",
        "isni",
        "viaf",
        "lcsh",
        "fast",
        "credit",
        "spdx",
        "fundref",
        "mesh",
        "aat",
        "gnd",
        "anzsrc",
        "arxiv",
        "doi",
        "pmid",
        "pmcid"
      ]
    },
    "identifier": {
      "type": "string",
      "description": "Identifier value (e.g., Q42 for Wikidata)"
    }
  },
  "description": "Link to an external identifier (Wikidata, ROR, ORCID, etc.)"
}
graphNodeLink object

Link to a knowledge graph node (type or object, with optional subkind)

Properties

id string Optional

Node UUID identifier

kind string Required

Node kind: 'type' for classifications, 'object' for instances

Known values: type, object
label string Required

Display label for the node

slug string Optional

Human-readable slug (e.g., 'computer-science')

subkind string Optional

Subkind slug (e.g., 'field', 'facet', 'institution', 'contribution-type')

subkindUri string at-uri Optional

AT-URI of the subkind type node

type string Required

No description available.

uri string at-uri Required

AT-URI of the graph node

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "uri",
    "label",
    "kind"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Node UUID identifier"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the graph node"
    },
    "kind": {
      "type": "string",
      "description": "Node kind: 'type' for classifications, 'object' for instances",
      "knownValues": [
        "type",
        "object"
      ]
    },
    "slug": {
      "type": "string",
      "description": "Human-readable slug (e.g., 'computer-science')"
    },
    "type": {
      "type": "string",
      "const": "graphNode"
    },
    "label": {
      "type": "string",
      "description": "Display label for the node"
    },
    "subkind": {
      "type": "string",
      "description": "Subkind slug (e.g., 'field', 'facet', 'institution', 'contribution-type')"
    },
    "subkindUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the subkind type node"
    }
  },
  "description": "Link to a knowledge graph node (type or object, with optional subkind)"
}
textPositionSelector object

W3C TextPositionSelector for character-based targeting

Properties

end integer Required

End character offset

minimum: 0
pageNumber integer Required

Page number in the document

minimum: 1
start integer Required

Start character offset

minimum: 0
type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "start",
    "end",
    "pageNumber"
  ],
  "properties": {
    "end": {
      "type": "integer",
      "minimum": 0,
      "description": "End character offset"
    },
    "type": {
      "type": "string",
      "const": "TextPositionSelector"
    },
    "start": {
      "type": "integer",
      "minimum": 0,
      "description": "Start character offset"
    },
    "pageNumber": {
      "type": "integer",
      "minimum": 1,
      "description": "Page number in the document"
    }
  },
  "description": "W3C TextPositionSelector for character-based targeting"
}
textQuoteSelector object

W3C TextQuoteSelector for resilient text matching

Properties

exact string Required

The exact text to match

prefix string Optional

Text immediately before the match

maxLength: 32 bytes
suffix string Optional

Text immediately after the match

maxLength: 32 bytes
type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "exact"
  ],
  "properties": {
    "type": {
      "type": "string",
      "const": "TextQuoteSelector"
    },
    "exact": {
      "type": "string",
      "description": "The exact text to match"
    },
    "prefix": {
      "type": "string",
      "maxLength": 32,
      "description": "Text immediately before the match"
    },
    "suffix": {
      "type": "string",
      "maxLength": 32,
      "description": "Text immediately after the match"
    }
  },
  "description": "W3C TextQuoteSelector for resilient text matching"
}
textSpanTarget object

W3C Web Annotation target for text spans

Properties

source string at-uri Required

AT-URI of the source document

View raw schema 
{
  "type": "object",
  "required": [
    "source",
    "selector"
  ],
  "properties": {
    "source": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the source document"
    },
    "selector": {
      "ref": "#textQuoteSelector",
      "type": "ref",
      "description": "Primary selector for resilient text matching"
    },
    "refinedBy": {
      "ref": "#textPositionSelector",
      "type": "ref",
      "description": "Optional position selector for precise targeting"
    }
  },
  "description": "W3C Web Annotation target for text spans"
}

Lexicon Garden

@