Skip to content

Class: Documentation

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

URI: airo:Documentation

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

      Documentation : author

      Documentation : broad_mappings





        Documentation --> "*" Any : broad_mappings
        click Any href "../Any/"



      Documentation : close_mappings





        Documentation --> "*" Any : close_mappings
        click Any href "../Any/"



      Documentation : dateCreated

      Documentation : dateModified

      Documentation : description

      Documentation : exact_mappings





        Documentation --> "*" Any : exact_mappings
        click Any href "../Any/"



      Documentation : hasLicense





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



      Documentation : id

      Documentation : name

      Documentation : narrow_mappings





        Documentation --> "*" Any : narrow_mappings
        click Any href "../Any/"



      Documentation : related_mappings





        Documentation --> "*" Any : related_mappings
        click Any href "../Any/"



      Documentation : url

Inheritance

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
exact_mappings *
Any
The property is used to link two concepts, indicating a high degree of confid... Entity
close_mappings *
Any
The property is used to link two concepts that are sufficiently similar that ... Entity
related_mappings *
Any
The property skos:relatedMatch is used to state an associative mapping link b... Entity
narrow_mappings *
Any
The property is used to state a hierarchical mapping link between two concept... Entity
broad_mappings *
Any
The property is used to state a hierarchical mapping link between two concept... Entity

Usages

used by used in type used
Container documents range Documentation
Dataset hasDocumentation range Documentation
Vocabulary hasDocumentation range Documentation
Taxonomy hasDocumentation range Documentation
Concept hasDocumentation range Documentation
Group hasDocumentation range Documentation
Entry hasDocumentation range Documentation
Term hasDocumentation range Documentation
Principle hasDocumentation range Documentation
RiskTaxonomy hasDocumentation range Documentation
RiskGroup hasDocumentation range Documentation
Risk hasDocumentation range Documentation
RiskConcept hasDocumentation range Documentation
RiskControl hasDocumentation range Documentation
Action hasDocumentation range Documentation
RiskIncident hasDocumentation range Documentation
Impact 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
AiTask hasDocumentation range Documentation
CapabilityTaxonomy hasDocumentation range Documentation
CapabilityConcept hasDocumentation range Documentation
CapabilityDomain hasDocumentation range Documentation
CapabilityGroup hasDocumentation range Documentation
Capability 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
StakeholderGroup hasDocumentation range Documentation

Identifier and Mapping Information

Schema Source

  • from schema: https://ibm.github.io/ai-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/ai-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/ai-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/ai-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/ai-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/ai-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: airo:hasLicense
    alias: hasLicense
    owner: Documentation
    domain_of:
    - Dataset
    - Documentation
    - Vocabulary
    - Taxonomy
    - 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/ai-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/ai-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/ai-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/ai-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/ai-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/ai-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: schema:dateModified
    alias: dateModified
    owner: Documentation
    domain_of:
    - Entity
    range: date
    required: false
  exact_mappings:
    name: exact_mappings
    description: The property is used to link two concepts, indicating a high degree
      of confidence that the concepts can be used interchangeably across a wide range
      of information retrieval applications
    from_schema: https://ibm.github.io/ai-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: skos:exactMatch
    alias: exact_mappings
    owner: Documentation
    domain_of:
    - Entity
    range: Any
    multivalued: true
    inlined: false
  close_mappings:
    name: close_mappings
    description: The property is used to link two concepts that are sufficiently similar
      that they can be used interchangeably in some information retrieval applications.
    from_schema: https://ibm.github.io/ai-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: skos:closeMatch
    alias: close_mappings
    owner: Documentation
    domain_of:
    - Entity
    range: Any
    multivalued: true
    inlined: false
  related_mappings:
    name: related_mappings
    description: The property skos:relatedMatch is used to state an associative mapping
      link between two concepts.
    from_schema: https://ibm.github.io/ai-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: skos:relatedMatch
    alias: related_mappings
    owner: Documentation
    domain_of:
    - Entity
    range: Any
    multivalued: true
    inlined: false
  narrow_mappings:
    name: narrow_mappings
    description: The property is used to state a hierarchical mapping link between
      two concepts, indicating that the concept linked to, is a narrower concept than
      the originating concept.
    from_schema: https://ibm.github.io/ai-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: skos:narrowMatch
    alias: narrow_mappings
    owner: Documentation
    domain_of:
    - Entity
    range: Any
    multivalued: true
    inlined: false
  broad_mappings:
    name: broad_mappings
    description: The property is used to state a hierarchical mapping link between
      two concepts, indicating that the concept linked to, is a broader concept than
      the originating concept.
    from_schema: https://ibm.github.io/ai-atlas-nexus/ontology/ai-risk-ontology
    rank: 1000
    slot_uri: skos:broadMatch
    alias: broad_mappings
    owner: Documentation
    domain_of:
    - Entity
    range: Any
    multivalued: true
    inlined: false
class_uri: airo:Documentation