osdu-python-models 0.5.0__py3-none-any.whl

osdu_models/workproductcomponent/data_quality/v1_2_0.py

@@ -0,0 +1,41 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/data_quality/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_business_rule import v1_0_0
+from ...abstract.abstract_quality_metric import v1_1_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_1_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for DataQuality 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EvaluatedRecordID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-[\w\-\.]+|reference-data\-\-[\w\-\.]+|work-product-component\-\-[\w\-\.]+|work-product\-\-[\w\-\.]+|dataset\-\-[\w\-\.]+):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The reference to the evaluated data record. The record version number is required.
+    """
+    BusinessRules: v1_0_0.AbstractBusinessRule | None = None
+    """
+    The BusinessRules on which this quality evaluation is based on combined with the run status results.
+    """
+    QualityMetric: v1_1_0.AbstractQualityMetric | None = None
+    """
+    The list of evaluated quality metrics for the evaluated data record.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/data_quality/v1_3_0.py

@@ -0,0 +1,41 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/data_quality/v1_3_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_business_rule import v1_0_0
+from ...abstract.abstract_quality_metric import v1_1_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for DataQuality 1.3.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EvaluatedRecordID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-[\w\-\.]+|reference-data\-\-[\w\-\.]+|work-product-component\-\-[\w\-\.]+|work-product\-\-[\w\-\.]+|dataset\-\-[\w\-\.]+):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The reference to the evaluated data record. The record version number is required.
+    """
+    BusinessRules: v1_0_0.AbstractBusinessRule | None = None
+    """
+    The BusinessRules on which this quality evaluation is based on combined with the run status results.
+    """
+    QualityMetric: v1_1_0.AbstractQualityMetric | None = None
+    """
+    The list of evaluated quality metrics for the evaluated data record.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/data_quality/v2_0_0.py

@@ -0,0 +1,209 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/data_quality/v2_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class AssessmentResult(BaseModel):
+    """
+    The assessment of an executed QualityDataRule.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    QualityAssessmentStateID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-QualityAssessmentState:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Quality Assessment State ID')
+    """
+    The assessment state for this rule.
+    """
+    AssessedPartID: str | None = Field(None, title='Assessed Part ID')
+    """
+    The unique identifier of an assessment result in the AssessmentResults[] array. This identifier becomes relevant if the assessments run over arrays of objects. Typically the 'local object identifier' of the assessed object will be used. Example: WellLog has Curves[], then Curves[].CurveID would be used as AssessedPartID.
+    """
+    ExtensionProperties: dict[str, Any] | None = Field(
+        None, title='Extension Properties'
+    )
+    """
+    An extension point to add properties, which are not searchable.
+    """
+
+
+class DataRule(BaseModel):
+    """
+    The DataQualityRule and the DataQualityRule properties captured at the time of assessment.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DataQualityRuleID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-DataQualityRule:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Data Quality Rule ID')
+    """
+    The reference to the individual DataQualityRule record ID. This is a mandatory property value.
+    """
+    DataRulePurposeTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DataRulePurposeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Data Rule Purpose Type ID')
+    """
+    The rule's purpose in the context of this DataQualityRule as captured during the assessment.
+    """
+    DataRuleStatement: str | None = Field(None, title='Data Rule Statement')
+    """
+    The rule's statement in natural language as captured during the assessment.
+    """
+    Weight: float | None = Field(None, title='Weight')
+    """
+    The rule's weight in the context of the DataQualityRuleSet as captured during the assessment.
+    """
+    DataRuleDimensionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DataRuleDimensionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Data Rule Dimension Type ID')
+    """
+    The rule's dimension type reference as captured during the assessment.
+    """
+    DataQualityRuleStatusID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DataQualityRuleStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Data Quality Rule Status ID')
+    """
+    The rule's evaluation status, e.g., Active, Inactive, Development.
+    """
+    ExecutionTime: float | None = Field(
+        None, examples=['23 ms'], title='Execution Time'
+    )
+    """
+    The time it took to perform the assessment of this rule.
+    """
+    AssessmentResults: list[AssessmentResult] | None = Field(
+        None, title='Assessment Results'
+    )
+    """
+    The assessment results for this this rule.
+    """
+
+
+class DimensionMetric(BaseModel):
+    """
+    The assessment score per data rule dimension type and its weight.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DataRuleDimensionTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-DataRuleDimensionType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Data Rule Dimension Type ID')
+    """
+    The reference to the DataRuleDimensionType, to which score and weight are associated.
+    """
+    Score: float | None = Field(None, title='Score')
+    """
+    The assessment score in % aggregated for this dimension type.
+    """
+    Weight: float | None = Field(None, title='Weight')
+    """
+    The weight factor for this score for the overall score.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for DataQuality 2.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EvaluatedRecordID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-[\w\-\.]+|reference-data\-\-[\w\-\.]+|work-product-component\-\-[\w\-\.]+|work-product\-\-[\w\-\.]+|dataset\-\-[\w\-\.]+):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Evaluated Record ID')
+    """
+    The reference to the evaluated data record. The record version number is required.
+    """
+    EvaluatedDDMSDatasets: (
+        list[
+            constr(
+                pattern=r'^(([^:/?#]+):)(\/\/([^/?#]+))(\/[^?#]+)(\?([^#]*))?(#(.*))?'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[['urn://wddms-3/uuid:20840361-adc0-4842-999b-5639bd07bb38']],
+        title='Evaluated DDMS Datasets',
+    )
+    """
+    If the quality assessment dealt with dataset content, then this array of URIs will contain the references to the optimized DDMS content used in the assessment. The reference is expected to be a member of the EvaluatedRecordID's data.DDMSDatasets[] list of URIs.
+    """
+    EvaluatedKind: (
+        constr(
+            pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:([0-9]+)?(\.)?([0-9]+)?(\.)?([0-9]+)?$'
+        )
+        | None
+    ) = Field(
+        None, examples=['osdu:wks:group-type--EntityType:2'], title='Evaluated Kind'
+    )
+    """
+    The EvaluatedRecordID's kind.
+    """
+    DataQualityRuleSetID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DataQualityRuleSet:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Data Quality Rule Set ID')
+    """
+    The DataQualityRuleSet aggregating other rule sets and/or individual DataQualityRule instances, individually weighted in the context of the DataQualityRuleSet.
+    """
+    StartDateTime: str | None = Field(None, title='Start Date Time')
+    """
+    The date-time at which the quality assessment started.
+    """
+    DataRules: list[DataRule] = Field(..., title='Data Rules')
+    """
+    The data rules part of this assessment.
+    """
+    MethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-QualityAssessmentMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Method ID')
+    """
+    The reference to the assessment calculation method.
+    """
+    TotalScore: float | None = Field(None, title='Total Score')
+    """
+    The assessment score in % aggregated for all dimension types.
+    """
+    DimensionMetrics: list[DimensionMetric] | None = Field(
+        None, title='Dimension Metrics'
+    )
+    """
+    The individual scores per dimension.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/data_quality_summary/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/workproductcomponent/data_quality_summary/v1_0_0.py

@@ -0,0 +1,151 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/data_quality_summary/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class DimensionMetric(BaseModel):
+    """
+    The assessment score per data rule dimension type and its weight.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DataRuleDimensionTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-DataRuleDimensionType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Data Rule Dimension Type ID')
+    """
+    The reference to the DataRuleDimensionType, to which score and weight are associated.
+    """
+    Score: float | None = Field(None, title='Score')
+    """
+    The assessment score in % aggregated for this dimension type.
+    """
+    Weight: float | None = Field(None, title='Weight')
+    """
+    The weight factor for this score for the overall score.
+    """
+
+
+class DataQualitySummarySetItem(BaseModel):
+    """
+    This is used to store the latest summary of data quality evaluation results for each RuleSet and is associated by reference to a work product component or master data object. Only one DataQualityReview per DataQualityRuleSet
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DataQualityRuleSetID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-DataQualityRuleSet:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:reference-data--DataQualityRuleSet:34jh45jk3hjsdfh8:'],
+        title='Data Quality Rule Set ID',
+    )
+    """
+    The reference to the data quality rule set run for the data quality summary. Unique Key for the item in the DataQualitySummarySet array.
+    """
+    DataQualityRuleSetName: str | None = Field(
+        None, examples=['Base line rule set'], title='Data Quality Rule Set Name'
+    )
+    """
+    The name of the data quality rule set run for the data quality summary which should stay consistent with the DataQualityRuleSet. Denormalized for easier discoverability of the summaries, but needs to be kept up to date.
+    """
+    DataQualityID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-DataQuality:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=[
+            'namespace:work-product-component--DataQuality:a8116688-1313-421c-9fdc-de9f75c3093c:'
+        ],
+        title='Data Quality ID',
+    )
+    """
+    This ID points to a Data Quality object used to store the result from a run of a Data Quality Metric Evaluation engine. Captures summary information, such as which rule-set(s) and rule(s) have been used, when this was run and by whom. Detailed results may be associated with a dataset.
+    """
+    StartDateTime: str | None = Field(
+        None, examples=['2023-10-26T07:15:51.518Z'], title='Start Date Time'
+    )
+    """
+    The date-time at which the quality assessment started.
+    """
+    MethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-QualityAssessmentMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--QualityAssessmentMethod:AverageAssessment:'
+        ],
+        title='Method ID',
+    )
+    """
+    The reference to the assessment calculation method.
+    """
+    TotalScore: float | None = Field(None, examples=[100], title='Total Score')
+    """
+    The assessment score in % aggregated for all dimension types.
+    """
+    DimensionMetrics: list[DimensionMetric] | None = Field(
+        None,
+        examples=[
+            [
+                {
+                    'DataRuleDimensionTypeID': 'namespace:reference-data--DataRuleDimensionType:Accuracy:',
+                    'Score': 100.0,
+                },
+                {
+                    'DataRuleDimensionTypeID': 'namespace:reference-data--DataRuleDimensionType:Completeness:',
+                    'Score': 100.0,
+                },
+            ]
+        ],
+        title='Dimension Metrics',
+    )
+    """
+    The individual scores per dimension.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for DataQualitySummary 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EvaluatedRecordID: constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$') = (
+        Field(..., title='Evaluated Record ID')
+    )
+    """
+    The reference to the evaluated data record. The record version number is required.
+    """
+    DataQualitySummarySet: list[DataQualitySummarySetItem] = Field(
+        ..., title='Data Quality Summary Set'
+    )
+    """
+    The set of Data Quality Review objects associated with the data quality summary
+    """
+    EvaluatedKind: (
+        constr(
+            pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:([0-9]+)?(\.)?([0-9]+)?(\.)?([0-9]+)?$'
+        )
+        | None
+    ) = Field(
+        None, examples=['osdu:wks:group-type--EntityType:2'], title='Evaluated Kind'
+    )
+    """
+    The EvaluatedRecordID's kind.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/document/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/workproductcomponent/document/v1_0_0.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/document/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_0_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_0_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for Document 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DocumentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DocumentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The kind of document--from a business standpoint, e.g., seismic processing report, etc.
+    """
+    NumberOfPages: int | None = None
+    """
+    Number of pages in the document, useful in cases where if it was described in the acquired manifest as opposed to a derived/calculated value
+    """
+    SubTitle: str | None = None
+    """
+    The sub-title of the document.
+    """
+    DocumentSubject: str | None = None
+    """
+    A description text or an array of subjects covered by the document. If present this information must compliment the Tag and SubTitle
+    """
+    DatePublished: str | None = None
+    """
+    The UTC date time and date of the document publication
+    """
+    DateModified: str | None = None
+    """
+    The UTC date time and date of the document when it was last modified
+    """
+    DocumentLanguage: str | None = None
+    """
+    Document language as listed in the ISO 639-3 https://en.wikipedia.org/wiki/ISO_639, https://en.wikipedia.org/wiki/List_of_ISO_639-3_codes
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/document/v1_1_0.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/document/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_1_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for Document 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DocumentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DocumentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The kind of document--from a business standpoint, e.g., seismic processing report, etc.
+    """
+    NumberOfPages: int | None = None
+    """
+    Number of pages in the document, useful in cases where if it was described in the acquired manifest as opposed to a derived/calculated value
+    """
+    SubTitle: str | None = None
+    """
+    The sub-title of the document.
+    """
+    DocumentSubject: str | None = None
+    """
+    A description text or an array of subjects covered by the document. If present this information must compliment the Tag and SubTitle
+    """
+    DatePublished: str | None = None
+    """
+    The UTC date time and date of the document publication
+    """
+    DateModified: str | None = None
+    """
+    The UTC date time and date of the document when it was last modified
+    """
+    DocumentLanguage: str | None = None
+    """
+    Document language as listed in the ISO 639-3 https://en.wikipedia.org/wiki/ISO_639, https://en.wikipedia.org/wiki/List_of_ISO_639-3_codes
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/document/v1_2_0.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/document/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for Document 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DocumentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DocumentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The kind of document--from a business standpoint, e.g., seismic processing report, etc.
+    """
+    NumberOfPages: int | None = None
+    """
+    Number of pages in the document, useful in cases where if it was described in the acquired manifest as opposed to a derived/calculated value
+    """
+    SubTitle: str | None = None
+    """
+    The sub-title of the document.
+    """
+    DocumentSubject: str | None = None
+    """
+    A description text or an array of subjects covered by the document. If present this information must compliment the Tag and SubTitle
+    """
+    DatePublished: str | None = None
+    """
+    The UTC date time and date of the document publication
+    """
+    DateModified: str | None = None
+    """
+    The UTC date time and date of the document when it was last modified
+    """
+    DocumentLanguage: str | None = None
+    """
+    Document language as listed in the ISO 639-3 https://en.wikipedia.org/wiki/ISO_639, https://en.wikipedia.org/wiki/List_of_ISO_639-3_codes
+    """
+    ExtensionProperties: dict[str, Any] | None = None