Class: Documentation

Documented information about a concept or other topic(s) of interest.

 classDiagram
    class Documentation
    click Documentation href "../Documentation"
      Entity <|-- Documentation
        click Entity href "../Entity"

      Documentation : author

      Documentation : dateCreated

      Documentation : dateModified

      Documentation : description

      Documentation : hasLicense





        Documentation --> "0..1" License : hasLicense
        click License href "../License"



      Documentation : id

      Documentation : name

      Documentation : url

Inheritance

Entity
- Documentation

Slots

Name	Cardinality and Range	Description	Inheritance
hasLicense	0..1 License	Indicates licenses associated with a resource	direct
author	0..1 String	The author or authors of the documentation	direct
id	1 String	A unique identifier to this instance of the model element	Entity
name	0..1 String	A text name of this instance	Entity
description	0..1 String	The description of an entity	Entity
url	0..1 Uri	An optional URL associated with this instance	Entity
dateCreated	0..1 Date	The date on which the entity was created	Entity
dateModified	0..1 Date	The date on which the entity was most recently modified	Entity

Usages

used by	used in	type	used
Container	documents	range	Documentation
Dataset	hasDocumentation	range	Documentation
Vocabulary	hasDocumentation	range	Documentation
Term	hasDocumentation	range	Documentation
RiskTaxonomy	hasDocumentation	range	Documentation
Action	hasDocumentation	range	Documentation
BaseAi	hasDocumentation	range	Documentation
AiSystem	hasDocumentation	range	Documentation
AiAgent	hasDocumentation	range	Documentation
AiModel	hasDocumentation	range	Documentation
LargeLanguageModel	hasDocumentation	range	Documentation
LargeLanguageModelFamily	hasDocumentation	range	Documentation
AiEval	hasDocumentation	range	Documentation
BenchmarkMetadataCard	hasDocumentation	range	Documentation
Question	hasDocumentation	range	Documentation
Questionnaire	hasDocumentation	range	Documentation
Adapter	hasDocumentation	range	Documentation
LLMIntrinsic	hasDocumentation	range	Documentation

Identifier and Mapping Information

Schema Source

from schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology

Mappings

Mapping Type	Mapped Value
self	airo:Documentation
native	nexus:Documentation

LinkML Source

Direct

name: Documentation
description: Documented information about a concept or other topic(s) of interest.
from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
is_a: Entity
slots:
- hasLicense
attributes:
  author:
    name: author
    description: The author or authors of the documentation
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/common
    rank: 1000
    domain_of:
    - Documentation
    - RiskIncident
class_uri: airo:Documentation

Induced

name: Documentation
description: Documented information about a concept or other topic(s) of interest.
from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
is_a: Entity
attributes:
  author:
    name: author
    description: The author or authors of the documentation
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/common
    rank: 1000
    alias: author
    owner: Documentation
    domain_of:
    - Documentation
    - RiskIncident
    range: string
  hasLicense:
    name: hasLicense
    description: Indicates licenses associated with a resource
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: airo:hasLicense
    alias: hasLicense
    owner: Documentation
    domain_of:
    - Dataset
    - Documentation
    - Vocabulary
    - RiskTaxonomy
    - BaseAi
    - AiEval
    - BenchmarkMetadataCard
    - Adapter
    range: License
  id:
    name: id
    description: A unique identifier to this instance of the model element. Example
      identifiers include UUID, URI, URN, etc.
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: schema:identifier
    identifier: true
    alias: id
    owner: Documentation
    domain_of:
    - Entity
    range: string
    required: true
  name:
    name: name
    description: A text name of this instance.
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: Documentation
    domain_of:
    - Entity
    - BenchmarkMetadataCard
    range: string
  description:
    name: description
    description: The description of an entity
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: schema:description
    alias: description
    owner: Documentation
    domain_of:
    - Entity
    range: string
  url:
    name: url
    description: An optional URL associated with this instance.
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: schema:url
    alias: url
    owner: Documentation
    domain_of:
    - Entity
    range: uri
  dateCreated:
    name: dateCreated
    description: The date on which the entity was created.
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: schema:dateCreated
    alias: dateCreated
    owner: Documentation
    domain_of:
    - Entity
    range: date
    required: false
  dateModified:
    name: dateModified
    description: The date on which the entity was most recently modified.
    from_schema: https://ibm.github.io/risk-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: schema:dateModified
    alias: dateModified
    owner: Documentation
    domain_of:
    - Entity
    range: date
    required: false
class_uri: airo:Documentation