Datapipeline objects
Submodules
vianops_client.models.datapipeline.extraction_metadata module
- pydantic model V1BaseExtractionMetadataModel
Bases:
BaseModelShow JSON schema
{ "title": "V1BaseExtractionMetadataModel", "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "metadata description", "title": "Description" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who created the metadata", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metadata", "title": "Modified By" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "active", "description": "Status of the metadata", "title": "Status" } } }
- Fields:
- field created_by: str | None = None
User who created the metadata
- field created_ts: datetime | None = None
Unix time in milliseconds generated at creation time.
- field description: str | None = None
metadata description
- field modified_by: str | None = None
User who modified the metadata
- field modified_ts: datetime | None = None
Unix time in milliseconds generated at last modification time.
- field status: str | None = 'active'
Status of the metadata
- pydantic model V1ExtractionMetadataFilters
Bases:
V1FiltersCommonShow JSON schema
{ "title": "V1ExtractionMetadataFilters", "type": "object", "properties": { "created_bys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'created by' users to search for.", "title": "Created Bys" }, "modified_bys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'modified by' users to search for.", "title": "Modified Bys" }, "created_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts Start" }, "created_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts End" }, "modified_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts Start" }, "modified_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts End" }, "uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metadata uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metadata names for this operation.", "title": "Names" }, "descriptions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of descriptions for this operation.", "title": "Descriptions" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of status for this operation.", "title": "Statuses" } }, "example": { "names": [ "Example metdata" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] } }
- Config:
from_attributes: bool = True
populate_by_name: bool = True
alias_generator: function = <function V1ExtractionMetadataFilters.<lambda> at 0x7f98c4e05800>
json_schema_extra: dict = {‘example’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example metdata’]}}
- Fields:
- field description: List[str] | None = None (alias 'descriptions')
List of descriptions for this operation.
- field name: List[str] | None = None (alias 'names')
List of metadata names for this operation.
- field status: List[str] | None = None (alias 'statuses')
List of status for this operation.
- field uuid: List[str] | None = None (alias 'uuids')
List of metadata uuids for this operation.
- pydantic model V1ExtractionMetadataModel
Bases:
V1BaseExtractionMetadataModelShow JSON schema
{ "title": "V1ExtractionMetadataModel", "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "metadata description", "title": "Description" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who created the metadata", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metadata", "title": "Modified By" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "active", "description": "Status of the metadata", "title": "Status" }, "uuid": { "anyOf": [ { "type": "string" }, { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the metadata.", "title": "Uuid" }, "name": { "description": "Name of the metadata", "title": "Name", "type": "string" }, "layout_dection_model_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Layout Detection model metadata", "title": "Layout Dection Model Metadata" }, "ocr_dection_model_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "OCR Detection model metadata", "title": "Ocr Dection Model Metadata" } }, "example": { "description": "Sample for metadata", "layout_dection_model_metadata": {}, "name": "sample_metadata", "ocr_dection_model_metadata": {} }, "required": [ "name" ] }
- Config:
from_attributes: bool = True
json_schema_extra: dict = {‘example’: {‘description’: ‘Sample for metadata’, ‘name’: ‘sample_metadata’, ‘layout_dection_model_metadata’: {}, ‘ocr_dection_model_metadata’: {}}}
- Fields:
- field layout_dection_model_metadata: Dict | None = None
Layout Detection model metadata
- field name: str [Required]
Name of the metadata
- field ocr_dection_model_metadata: Dict | None = None
OCR Detection model metadata
- field uuid: str | UUID | None = None
UUID of the metadata.
- pydantic model V1ExtractionMetadataModelList
Bases:
RootModelShow JSON schema
{ "title": "V1ExtractionMetadataModelList", "type": "array", "$defs": { "V1ExtractionMetadataModel": { "example": { "description": "Sample for metadata", "layout_dection_model_metadata": {}, "name": "sample_metadata", "ocr_dection_model_metadata": {} }, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "metadata description", "title": "Description" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who created the metadata", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metadata", "title": "Modified By" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "active", "description": "Status of the metadata", "title": "Status" }, "uuid": { "anyOf": [ { "type": "string" }, { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the metadata.", "title": "Uuid" }, "name": { "description": "Name of the metadata", "title": "Name", "type": "string" }, "layout_dection_model_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Layout Detection model metadata", "title": "Layout Dection Model Metadata" }, "ocr_dection_model_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "OCR Detection model metadata", "title": "Ocr Dection Model Metadata" } }, "required": [ "name" ], "title": "V1ExtractionMetadataModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1ExtractionMetadataModel" } }
- Fields:
- field root: List[V1ExtractionMetadataModel] [Required]
- pydantic model V1ExtractionMetadataPage
Bases:
V1PageModelShow JSON schema
{ "title": "V1ExtractionMetadataPage", "type": "object", "properties": { "items": { "default": [], "description": "Extraction metadata returned by search in page.", "items": { "$ref": "#/$defs/V1ExtractionMetadataModel" }, "title": "Items", "type": "array" }, "current_page": { "default": 0, "description": "Current page of items.", "title": "Current Page", "type": "integer" }, "page_size": { "default": 0, "description": "Number of items on a page.", "title": "Page Size", "type": "integer" }, "previous_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of the previous page.", "title": "Previous Page" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of the next page.", "title": "Next Page" }, "has_previous": { "default": false, "description": "Whether or not there is a previous page.", "title": "Has Previous", "type": "boolean" }, "previous_items": { "default": 0, "title": "Previous Items", "type": "integer" }, "has_next": { "default": false, "description": "Whether or not there is a next page.", "title": "Has Next", "type": "boolean" }, "total": { "default": 0, "description": "Total number of items returned by search over all pages.", "title": "Total", "type": "integer" }, "pages": { "default": 0, "description": "Total number of pages returned by search.", "title": "Pages", "type": "integer" } }, "$defs": { "V1ExtractionMetadataModel": { "example": { "description": "Sample for metadata", "layout_dection_model_metadata": {}, "name": "sample_metadata", "ocr_dection_model_metadata": {} }, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "metadata description", "title": "Description" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who created the metadata", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metadata", "title": "Modified By" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "active", "description": "Status of the metadata", "title": "Status" }, "uuid": { "anyOf": [ { "type": "string" }, { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the metadata.", "title": "Uuid" }, "name": { "description": "Name of the metadata", "title": "Name", "type": "string" }, "layout_dection_model_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Layout Detection model metadata", "title": "Layout Dection Model Metadata" }, "ocr_dection_model_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "OCR Detection model metadata", "title": "Ocr Dection Model Metadata" } }, "required": [ "name" ], "title": "V1ExtractionMetadataModel", "type": "object" } }, "example": { "current_page": 1, "has_next": false, "has_previous": false, "items": [ { "created_by": "user1", "created_ts": 1675292368, "description": "Example description 1", "layout_dection_model_metadata": {}, "modified_by": "user1", "modified_ts": 1675292368, "name": "Example metadata 1", "ocr_dection_model_metadata": {}, "status": "run", "uuid": "5efc9544-e84a-4a94-9e6d-5774e1c609ab" } ], "next_page": null, "page_size": 100, "pages": 1, "previous_items": 0, "previous_page": null, "total": 1 } }
- Config:
json_schema_extra: dict = {‘example’: {‘items’: [{‘uuid’: ‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘name’: ‘Example metadata 1’, ‘description’: ‘Example description 1’, ‘layout_dection_model_metadata’: {}, ‘ocr_dection_model_metadata’: {}, ‘created_ts’: 1675292368, ‘modified_ts’: 1675292368, ‘created_by’: ‘user1’, ‘modified_by’: ‘user1’, ‘status’: ‘run’}], ‘current_page’: 1, ‘page_size’: 100, ‘previous_page’: None, ‘next_page’: None, ‘has_previous’: False, ‘previous_items’: 0, ‘has_next’: False, ‘total’: 1, ‘pages’: 1}}
- Fields:
- field items: List[V1ExtractionMetadataModel] = []
Extraction metadata returned by search in page.
- pydantic model V1ExtractionMetadataSearch
Bases:
V1PageSearchShow JSON schema
{ "title": "V1ExtractionMetadataSearch", "type": "object", "properties": { "page": { "default": 1, "description": "Page number to return. Zero-index based. Cannot be less than zero or greater than number of pages. To make sure you don't exceed the number of pages, set `page` to 1 and run this search operation to return the total number items (`total`). Then run it again to return the exact page (`page`) for the specified number of items per page (`page-size`).", "title": "Page", "type": "integer" }, "page_size": { "default": 25, "description": "Number of items to return on a page. Default is 25 items per page.", "title": "Page Size", "type": "integer" }, "order": { "anyOf": [ { "items": { "$ref": "#/$defs/V1OrderBy" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Fields to use for ordering returned pages and the sort direction.", "title": "Order" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "String to search for (case-insensitive) across all fields in previously created items.", "title": "Search" }, "filters": { "$ref": "#/$defs/V1ExtractionMetadataFilters", "description": "Specifies different condition(s) for filtering the results." } }, "$defs": { "V1ExtractionMetadataFilters": { "example": { "names": [ "Example metdata" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] }, "properties": { "created_bys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'created by' users to search for.", "title": "Created Bys" }, "modified_bys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'modified by' users to search for.", "title": "Modified Bys" }, "created_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts Start" }, "created_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts End" }, "modified_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts Start" }, "modified_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts End" }, "uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metadata uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metadata names for this operation.", "title": "Names" }, "descriptions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of descriptions for this operation.", "title": "Descriptions" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of status for this operation.", "title": "Statuses" } }, "title": "V1ExtractionMetadataFilters", "type": "object" }, "V1OrderBy": { "properties": { "field": { "description": "Field to order by.", "title": "Field", "type": "string" }, "direction": { "default": "ASC", "description": "Direction to order the field by. Supported values: `ASC` (ascending) and `DESC` (descending) (case-insensitive).", "enum": [ "ASC", "DESC" ], "title": "Direction", "type": "string" } }, "required": [ "field" ], "title": "V1OrderBy", "type": "object" } }, "example": { "filters": { "names": [ "Example metadata metrics" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] }, "order": [ { "direction": "DESC", "field": "name" } ], "page": 1, "page_size": 100, "search": "vianai" }, "required": [ "filters" ] }
- Config:
json_schema_extra: dict = {‘example’: {‘page’: 1, ‘page_size’: 100, ‘order’: [{‘field’: ‘name’, ‘direction’: ‘DESC’}], ‘search’: ‘vianai’, ‘filters’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example metadata metrics’]}}}
- Fields:
- field filters: V1ExtractionMetadataFilters [Required]
Specifies different condition(s) for filtering the results.
- pydantic model V1ExtractionMetadataUpdates
Bases:
V1BaseExtractionMetadataModelShow JSON schema
{ "title": "V1ExtractionMetadataUpdates", "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "metadata description", "title": "Description" }, "created_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at creation time.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds generated at last modification time.", "title": "Modified Ts" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who created the metadata", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metadata", "title": "Modified By" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "active", "description": "Status of the metadata", "title": "Status" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "metadata name", "title": "Name" }, "layout_dection_model_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Layout Detection model metadata", "title": "Layout Dection Model Metadata" }, "ocr_dection_model_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "OCR Detection model metadata", "title": "Ocr Dection Model Metadata" }, "filters": { "$ref": "#/$defs/V1ExtractionMetadataFilters", "description": "Specifies different condition(s) for filtering the results." } }, "$defs": { "V1ExtractionMetadataFilters": { "example": { "names": [ "Example metdata" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] }, "properties": { "created_bys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'created by' users to search for.", "title": "Created Bys" }, "modified_bys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of 'modified by' users to search for.", "title": "Modified Bys" }, "created_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts Start" }, "created_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "title": "Created Ts End" }, "modified_ts_start": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts Start" }, "modified_ts_end": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "title": "Modified Ts End" }, "uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metadata uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metadata names for this operation.", "title": "Names" }, "descriptions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of descriptions for this operation.", "title": "Descriptions" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of status for this operation.", "title": "Statuses" } }, "title": "V1ExtractionMetadataFilters", "type": "object" } }, "example": { "description": "Updated metadata description", "filters": { "names": [ "Example metadata" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] }, "name": "Updated metadata name" }, "required": [ "filters" ] }
- Config:
json_schema_extra: dict = {‘example’: {‘name’: ‘Updated metadata name’, ‘description’: ‘Updated metadata description’, ‘filters’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example metadata’]}}}
- Fields:
- field description: str | None = None
metadata description
- field filters: V1ExtractionMetadataFilters [Required]
Specifies different condition(s) for filtering the results.
- field layout_dection_model_metadata: Dict | None = None
Layout Detection model metadata
- field name: str | None = None
metadata name
- field ocr_dection_model_metadata: Dict | None = None
OCR Detection model metadata