study_schema/extraction-evidence.yaml at main · neurostuff/study_schema · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
id: https://neurostuff.org/schemas/extraction-evidence
name: extraction-evidence
title: Extraction Evidence Support Schema
description: >-
  Shared evidence and value-provenance types for schemas that record structured
  information extracted from source documents.

license: CC0-1.0
version: 0.2.0

prefixes:
  linkml: https://w3id.org/linkml/
  extraction_evidence: https://neurostuff.org/schemas/extraction-evidence/

imports:
  - linkml:types

default_prefix: extraction_evidence
default_range: string

enums:

  ExtractionStatus:
    description: Outcome of explicitly examining a requested attribute during extraction.
    permissible_values:
      extracted:
        description: A usable value was extracted or generated from source-supported information.
      not_reported:
        description: The attribute was examined but no value was found in the available source.

  ValueSource:
    description: Describes how an extracted value relates to the source material.
    permissible_values:
      reported:
        description: Explicitly stated in the source, allowing minor lexical or formatting adaptation.
      generated:
        description: Created by the extraction system; evidence supports the underlying entity or concept.

  EvidenceStatus:
    description: Indicates whether source-text evidence was identified for an extracted value.
    permissible_values:
      present:
        description: At least one complete evidence set was identified.
      not_found:
        description: A value was extracted or generated but no supporting source-text evidence was identified.
      not_applicable:
        description: No value was extracted because the attribute was not reported.

classes:

  ExtractedValue:
    description: >-
      A schema attribute explicitly examined during extraction, including its
      value, source, and supporting evidence.
    attributes:
      extraction_status:
        range: ExtractionStatus
        required: true
      value:
        range: Any
        description: >-
          Extracted or generated value. Populate when extraction_status is
          extracted; omit when it is not_reported.
      value_source:
        range: ValueSource
      evidence:
        range: Evidence
        required: true
        inlined: true

  ExtractedString:
    is_a: ExtractedValue
    description: An ExtractedValue whose value is text.
    slot_usage:
      value:
        range: string

  ExtractedInteger:
    is_a: ExtractedValue
    description: An ExtractedValue whose value is a whole number.
    slot_usage:
      value:
        range: integer

  ExtractedNumber:
    is_a: ExtractedValue
    description: An ExtractedValue whose value is numeric, including fractional values.
    slot_usage:
      value:
        range: float

  ExtractedBoolean:
    is_a: ExtractedValue
    description: An ExtractedValue whose value is true or false.
    slot_usage:
      value:
        range: boolean

  # A multivalued fact is one wrapper holding a list, not a list of wrappers. The list
  # usually comes from one sentence, so one evidence record covers all of it, and a list
  # of wrappers would ask for evidence per item that the source does not separate.

  ExtractedStringList:
    is_a: ExtractedValue
    description: An ExtractedValue whose value is a list of strings, under one evidence record.
    slot_usage:
      value:
        range: string
        multivalued: true

  ExtractedIntegerList:
    is_a: ExtractedValue
    description: An ExtractedValue whose value is a list of whole numbers, under one evidence record.
    slot_usage:
      value:
        range: integer
        multivalued: true

  ExtractedNumberList:
    is_a: ExtractedValue
    description: An ExtractedValue whose value is a list of numbers, under one evidence record.
    slot_usage:
      value:
        range: float
        multivalued: true

  ExtractedBooleanList:
    is_a: ExtractedValue
    description: An ExtractedValue whose value is a list of booleans, under one evidence record.
    slot_usage:
      value:
        range: boolean
        multivalued: true

  Evidence:
    description: Evidence associated with an extracted value.
    attributes:
      status:
        range: EvidenceStatus
        required: true
      sets:
        range: EvidenceSet
        multivalued: true
        inlined_as_list: true

  EvidenceSet:
    description: One independently sufficient set of source-text spans supporting a value.
    attributes:
      spans:
        range: EvidenceSpan
        multivalued: true
        inlined_as_list: true
        required: true
        minimum_cardinality: 1

  EvidenceSpan:
    description: An exact source-text span used as evidence for an extracted value.
    attributes:
      text:
        required: true
      start_char:
        range: integer
        required: true
        minimum_value: 0
      end_char:
        range: integer
        required: true
        minimum_value: 0