Feature store objects
Objects and models for feature sets. See supported Feature store APIs.
vianops_client.models.featurestore.features
- pydantic model V1ColumnMetadata
Bases:
BaseModelShow JSON schema
{ "title": "V1ColumnMetadata", "type": "object", "properties": { "name": { "title": "Name", "description": "Column name.", "type": "string" }, "dtype": { "title": "Dtype", "description": "Pandas data type of column as a string instance.", "type": "string" }, "sql_type": { "title": "Sql Type", "description": "SQL data type of column as a string instance.", "type": "string" } }, "required": [ "name", "dtype" ] }
- field dtype: str [Required]
Pandas data type of column as a string instance.
- field name: str [Required]
Column name.
- field sql_type: str | None = None
SQL data type of column as a string instance.
- pydantic model V1CreateRefactoredPipeline
Bases:
BaseModelShow JSON schema
{ "title": "V1CreateRefactoredPipeline", "type": "object", "properties": { "artifact_uri": { "title": "Artifact Uri", "description": "Artifact uri.", "type": "string" }, "name": { "title": "Name", "description": "Name.", "type": "string" }, "new_pipeline_name": { "title": "New Pipeline Name", "description": "New pipeline name.", "type": "string" }, "pipeline_description": { "title": "Pipeline Description", "description": "Pipeline description.", "type": "string" }, "pipeline_id": { "title": "Pipeline Id", "description": "Pipeline id.", "type": "integer" }, "pipeline_name": { "title": "Pipeline Name", "description": "Pipeline name.", "type": "string" }, "preprocess": { "title": "Preprocess", "description": "Dictionary of preprocesses included in pipeline.", "type": "object" }, "run_id": { "title": "Run Id", "description": "Run id.", "type": "string" }, "Sources": { "title": "Sources", "description": "Sources.", "type": "string" }, "targetcolumn": { "title": "Targetcolumn", "description": "Target column.", "type": "string" }, "targetset": { "title": "Targetset", "description": "Target set.", "type": "string" }, "user": { "title": "User", "description": "Name of user.", "type": "string" } }, "required": [ "artifact_uri", "name", "new_pipeline_name", "pipeline_description", "pipeline_id", "pipeline_name", "preprocess", "run_id", "Sources", "targetcolumn", "targetset", "user" ] }
- Fields:
- field Sources: str [Required]
Sources.
- field artifact_uri: str [Required]
Artifact uri.
- field name: str [Required]
Name.
- field new_pipeline_name: str [Required]
New pipeline name.
- field pipeline_description: str [Required]
Pipeline description.
- field pipeline_id: int [Required]
Pipeline id.
- field pipeline_name: str [Required]
Pipeline name.
- field preprocess: dict [Required]
Dictionary of preprocesses included in pipeline.
- field run_id: str [Required]
Run id.
- field targetcolumn: str [Required]
Target column.
- field targetset: str [Required]
Target set.
- field user: str [Required]
Name of user.
- pydantic model V1FeatureMetadata
Bases:
BaseModelShow JSON schema
{ "title": "V1FeatureMetadata", "type": "object", "properties": { "setname": { "title": "Setname", "description": "Feature set name.", "type": "string" }, "count": { "title": "Count", "description": "Featureset record count.", "type": "integer" }, "columns": { "title": "Columns", "description": "List of featureset columns.", "type": "array", "items": { "$ref": "#/definitions/V1ColumnMetadata" } }, "is_customquery": { "title": "Is Customquery", "description": "If `true` custom query must be executed to select subset of the entire feature set; otherwise, `false` (the default value).", "default": false, "type": "boolean" }, "created_date": { "title": "Created Date", "description": "Featureset creation date.", "type": "number" } }, "required": [ "setname", "count", "columns" ], "definitions": { "V1ColumnMetadata": { "title": "V1ColumnMetadata", "type": "object", "properties": { "name": { "title": "Name", "description": "Column name.", "type": "string" }, "dtype": { "title": "Dtype", "description": "Pandas data type of column as a string instance.", "type": "string" }, "sql_type": { "title": "Sql Type", "description": "SQL data type of column as a string instance.", "type": "string" } }, "required": [ "name", "dtype" ] } } }
- Fields:
- field columns: List[V1ColumnMetadata] [Required]
List of featureset columns.
- field count: int [Required]
Featureset record count.
- field created_date: float | None = None
Featureset creation date.
- field is_customquery: bool = False
If true custom query must be executed to select subset of the entire feature set; otherwise, false (the default value).
- field setname: str [Required]
Feature set name.
- pydantic model V1FeatureSourceFilters
Bases:
V1FiltersShow JSON schema
{ "title": "V1FeatureSourceFilters", "type": "object", "properties": { "created_by": { "title": "Created By", "description": "List of 'created by' users to search for.", "type": "array", "items": { "type": "string" } }, "modified_by": { "title": "Modified By", "description": "List of 'modified by' users to search for.", "type": "array", "items": { "type": "string" } }, "created_ts_start": { "title": "Created Ts Start", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "created_ts_end": { "title": "Created Ts End", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "modified_ts_start": { "title": "Modified Ts Start", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "modified_ts_end": { "title": "Modified Ts End", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "uuid": { "title": "Uuid", "description": "List of uuids for this operation.", "type": "array", "items": { "type": "string" } }, "name": { "title": "Name", "description": "List of names for this operation.", "type": "array", "items": { "type": "string" } }, "status": { "title": "Status", "description": "List of statuses for this operation.", "type": "array", "items": { "type": "string" } }, "tablenames": { "title": "Tablenames", "description": "List of tablenames for this operation.", "type": "array", "items": { "type": "string" } }, "setnames": { "title": "Setnames", "description": "List of setnames for this operation.", "type": "array", "items": { "type": "string" } }, "indices": { "title": "Indices", "description": "List of indices for this operation", "type": "array", "items": { "type": "integer" } } } }
- Config:
fields: dict = {‘index’: ‘indices’, ‘setname’: ‘setnames’, ‘tablename’: ‘tablenames’}
- Fields:
- field index: List[int] | None = None (alias 'indices')
List of indices for this operation
- field setname: List[str] | None = None (alias 'setnames')
List of setnames for this operation.
- field tablename: List[str] | None = None (alias 'tablenames')
List of tablenames for this operation.
- pydantic model V1FeatureSourceModelPage
Bases:
V1PageModelShow JSON schema
{ "title": "V1FeatureSourceModelPage", "type": "object", "properties": { "items": { "title": "Items", "description": "Feature sources returned by search in page.", "default": [], "type": "array", "items": { "$ref": "#/definitions/V1SaveFeatureSource" } }, "current_page": { "title": "Current Page", "description": "Current page of items.", "default": 0, "type": "integer" }, "page_size": { "title": "Page Size", "description": "Number of items on a page.", "default": 0, "type": "integer" }, "previous_page": { "title": "Previous Page", "description": "Number of the previous page.", "type": "integer" }, "next_page": { "title": "Next Page", "description": "Number of the next page.", "type": "integer" }, "has_previous": { "title": "Has Previous", "description": "Whether or not there is a previous page.", "default": false, "type": "boolean" }, "previous_items": { "title": "Previous Items", "default": 0, "type": "integer" }, "has_next": { "title": "Has Next", "description": "Whether or not there is a next page.", "default": false, "type": "boolean" }, "total": { "title": "Total", "description": "Total number of items returned by search over all pages.", "default": 0, "type": "integer" }, "pages": { "title": "Pages", "description": "Total number of pages returned by search.", "default": 0, "type": "integer" } }, "definitions": { "V1SaveFeatureSource": { "title": "V1SaveFeatureSource", "type": "object", "properties": { "index": { "title": "Index", "description": "Feature Source Index", "type": "integer" }, "tablename": { "title": "Tablename", "description": "Table name.", "type": "string" }, "setname": { "title": "Setname", "description": "Feature set name.", "type": "string" }, "connection": { "title": "Connection", "description": "Database connection.", "type": "string" }, "setdescription": { "title": "Setdescription", "description": "Feature set description.", "type": "string" }, "createddate": { "title": "Createddate", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "createdby": { "title": "Createdby", "description": "User that created the model.", "type": "string" }, "customquery": { "title": "Customquery", "description": "Custom query.", "type": "string" }, "maintain_archives": { "title": "Maintain Archives", "description": "If `true` creates an archive table of a snapshot of the data before it is overwritten or appended; otherwise, `false` (the default value).", "default": false, "type": "boolean" }, "query_metadata": { "title": "Query Metadata", "description": "JSON that breaks down a query into parts consumable downstream by drifter to use as reference for baseline for different computations.", "default": {}, "type": "object" }, "status": { "title": "Status", "description": "status of featuresource record", "default": "active", "type": "string" }, "modified_by": { "title": "Modified By", "description": "user whi modified last", "type": "string" }, "created_by": { "title": "Created By", "description": "user who created the record", "type": "string" }, "description": { "title": "Description", "description": "description of feature source", "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at modification time.", "type": "string", "format": "date-time" } }, "required": [ "tablename", "setname", "connection" ] } } }
- field items: List[V1SaveFeatureSource] = []
Feature sources returned by search in page.
- pydantic model V1FeatureSourceSearch
Bases:
V1PageSearchShow JSON schema
{ "title": "V1FeatureSourceSearch", "type": "object", "properties": { "page": { "title": "Page", "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`).", "type": "integer" }, "page_size": { "title": "Page Size", "description": "Number of items to return on a page. Default is 25 items per page.", "default": 25, "type": "integer" }, "order": { "title": "Order", "description": "Fields to use for ordering returned pages and the sort direction.", "type": "array", "items": { "$ref": "#/definitions/V1OrderBy" } }, "search": { "title": "Search", "description": "String to search for (case-insensitive) across all fields in previously created items.", "type": "string" }, "filters": { "title": "Filters", "description": "Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.", "default": { "created_by": null, "modified_by": null, "created_ts_start": null, "created_ts_end": null, "modified_ts_start": null, "modified_ts_end": null, "uuid": null, "name": null, "status": null, "tablename": null, "setname": null, "index": null }, "allOf": [ { "$ref": "#/definitions/V1FeatureSourceFilters" } ] } }, "required": [ "page" ], "definitions": { "V1OrderBy": { "title": "V1OrderBy", "type": "object", "properties": { "field": { "title": "Field", "description": "Field to order by.", "type": "string" }, "direction": { "title": "Direction", "description": "Direction to order the field by. Supported values: `ASC` (ascending) and `DESC` (descending) (case-insensitive).", "default": "ASC", "type": "string" } }, "required": [ "field" ] }, "V1FeatureSourceFilters": { "title": "V1FeatureSourceFilters", "type": "object", "properties": { "created_by": { "title": "Created By", "description": "List of 'created by' users to search for.", "type": "array", "items": { "type": "string" } }, "modified_by": { "title": "Modified By", "description": "List of 'modified by' users to search for.", "type": "array", "items": { "type": "string" } }, "created_ts_start": { "title": "Created Ts Start", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "created_ts_end": { "title": "Created Ts End", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "modified_ts_start": { "title": "Modified Ts Start", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "modified_ts_end": { "title": "Modified Ts End", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "uuid": { "title": "Uuid", "description": "List of uuids for this operation.", "type": "array", "items": { "type": "string" } }, "name": { "title": "Name", "description": "List of names for this operation.", "type": "array", "items": { "type": "string" } }, "status": { "title": "Status", "description": "List of statuses for this operation.", "type": "array", "items": { "type": "string" } }, "tablenames": { "title": "Tablenames", "description": "List of tablenames for this operation.", "type": "array", "items": { "type": "string" } }, "setnames": { "title": "Setnames", "description": "List of setnames for this operation.", "type": "array", "items": { "type": "string" } }, "indices": { "title": "Indices", "description": "List of indices for this operation", "type": "array", "items": { "type": "integer" } } } } } }
- field filters: V1FeatureSourceFilters | None = V1FeatureSourceFilters(created_by=None, modified_by=None, created_ts_start=None, created_ts_end=None, modified_ts_start=None, modified_ts_end=None, uuid=None, name=None, status=None, tablename=None, setname=None, index=None)
Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.
- pydantic model V1FeatureSourcesList
Bases:
BaseModelShow JSON schema
{ "title": "V1FeatureSourcesList", "type": "array", "items": { "$ref": "#/definitions/V1SaveFeatureSource" }, "definitions": { "V1SaveFeatureSource": { "title": "V1SaveFeatureSource", "type": "object", "properties": { "index": { "title": "Index", "description": "Feature Source Index", "type": "integer" }, "tablename": { "title": "Tablename", "description": "Table name.", "type": "string" }, "setname": { "title": "Setname", "description": "Feature set name.", "type": "string" }, "connection": { "title": "Connection", "description": "Database connection.", "type": "string" }, "setdescription": { "title": "Setdescription", "description": "Feature set description.", "type": "string" }, "createddate": { "title": "Createddate", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "createdby": { "title": "Createdby", "description": "User that created the model.", "type": "string" }, "customquery": { "title": "Customquery", "description": "Custom query.", "type": "string" }, "maintain_archives": { "title": "Maintain Archives", "description": "If `true` creates an archive table of a snapshot of the data before it is overwritten or appended; otherwise, `false` (the default value).", "default": false, "type": "boolean" }, "query_metadata": { "title": "Query Metadata", "description": "JSON that breaks down a query into parts consumable downstream by drifter to use as reference for baseline for different computations.", "default": {}, "type": "object" }, "status": { "title": "Status", "description": "status of featuresource record", "default": "active", "type": "string" }, "modified_by": { "title": "Modified By", "description": "user whi modified last", "type": "string" }, "created_by": { "title": "Created By", "description": "user who created the record", "type": "string" }, "description": { "title": "Description", "description": "description of feature source", "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at modification time.", "type": "string", "format": "date-time" } }, "required": [ "tablename", "setname", "connection" ] } } }
- Fields:
__root__ (List[vianops_client.models.featurestore.features.V1SaveFeatureSource])
- pydantic model V1FeatureSourcesUpdates
Bases:
V1SaveFeatureSourceShow JSON schema
{ "title": "V1FeatureSourcesUpdates", "type": "object", "properties": { "index": { "title": "Index", "description": "Feature Source Index", "type": "integer" }, "tablename": { "title": "Tablename", "description": "Table name.", "type": "string" }, "setname": { "title": "Setname", "description": "Feature set name.", "type": "string" }, "connection": { "title": "Connection", "description": "Database connection.", "type": "string" }, "setdescription": { "title": "Setdescription", "description": "Feature set description.", "type": "string" }, "createddate": { "title": "Createddate", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "createdby": { "title": "Createdby", "description": "User that created the model.", "type": "string" }, "customquery": { "title": "Customquery", "description": "Custom query.", "type": "string" }, "maintain_archives": { "title": "Maintain Archives", "description": "If `true` creates an archive table of a snapshot of the data before it is overwritten or appended; otherwise, `false` (the default value).", "default": false, "type": "boolean" }, "query_metadata": { "title": "Query Metadata", "description": "JSON that breaks down a query into parts consumable downstream by drifter to use as reference for baseline for different computations.", "default": {}, "type": "object" }, "status": { "title": "Status", "description": "status of featuresource record", "default": "active", "type": "string" }, "modified_by": { "title": "Modified By", "description": "user whi modified last", "type": "string" }, "created_by": { "title": "Created By", "description": "user who created the record", "type": "string" }, "description": { "title": "Description", "description": "description of feature source", "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at modification time.", "type": "string", "format": "date-time" }, "filters": { "title": "Filters", "description": "Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.", "allOf": [ { "$ref": "#/definitions/V1FeatureSourceFilters" } ] } }, "required": [ "tablename", "setname", "connection" ], "definitions": { "V1FeatureSourceFilters": { "title": "V1FeatureSourceFilters", "type": "object", "properties": { "created_by": { "title": "Created By", "description": "List of 'created by' users to search for.", "type": "array", "items": { "type": "string" } }, "modified_by": { "title": "Modified By", "description": "List of 'modified by' users to search for.", "type": "array", "items": { "type": "string" } }, "created_ts_start": { "title": "Created Ts Start", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "created_ts_end": { "title": "Created Ts End", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "modified_ts_start": { "title": "Modified Ts Start", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "modified_ts_end": { "title": "Modified Ts End", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "uuid": { "title": "Uuid", "description": "List of uuids for this operation.", "type": "array", "items": { "type": "string" } }, "name": { "title": "Name", "description": "List of names for this operation.", "type": "array", "items": { "type": "string" } }, "status": { "title": "Status", "description": "List of statuses for this operation.", "type": "array", "items": { "type": "string" } }, "tablenames": { "title": "Tablenames", "description": "List of tablenames for this operation.", "type": "array", "items": { "type": "string" } }, "setnames": { "title": "Setnames", "description": "List of setnames for this operation.", "type": "array", "items": { "type": "string" } }, "indices": { "title": "Indices", "description": "List of indices for this operation", "type": "array", "items": { "type": "integer" } } } } } }
- Config:
allow_population_by_field_name: bool = True
orm_mode: bool = True
- Fields:
- field filters: V1FeatureSourceFilters | None = None
Specifies different condition(s) for filtering the results. If not provided, all relevant results are retrieved.
- pydantic model V1ImportFeatureSet
Bases:
BaseModelShow JSON schema
{ "title": "V1ImportFeatureSet", "type": "object", "properties": { "tablename": { "title": "Tablename", "description": "Table name.", "type": "string" }, "setname": { "title": "Setname", "description": "Feature set name.", "type": "string" }, "separator": { "title": "Separator", "description": "Data separator.", "default": ",", "type": "string" }, "srcurl": { "title": "Srcurl", "description": "Source url fron where data is to be loaded.", "type": "string" }, "data": { "title": "Data", "description": "Featureset data.", "type": "string" }, "description": { "title": "Description", "description": "Feature set description.", "type": "string" }, "overwrite": { "title": "Overwrite", "description": "Determines how to manage data if already exists. Supported values: `replace` (overwrite existing data) and `append` (add new data to existing data).", "default": "replace", "type": "string" }, "dtypes": { "title": "Dtypes", "description": "A list of pandas data types as a string instance.", "type": "string" }, "upload_key": { "title": "Upload Key", "description": "Cache upload key.", "type": "string" }, "connectionname": { "title": "Connectionname", "description": "Connection name must match one of the connections already in data source connection list.", "type": "string" }, "query_metadata": { "title": "Query Metadata", "description": "JSON that breaks down a query into parts consumable downstream by drifter to use as reference for baseline for different computations.", "type": "object" } }, "required": [ "tablename", "setname" ] }
- Fields:
- field connectionname: str | None = None
Connection name must match one of the connections already in data source connection list.
- field data: str | None = None
Featureset data.
- field description: str | None = None
Feature set description.
- field dtypes: str | None = None
A list of pandas data types as a string instance.
- field overwrite: str | None = 'replace'
Determines how to manage data if already exists. Supported values: replace (overwrite existing data) and append (add new data to existing data).
- field query_metadata: dict | None = None
JSON that breaks down a query into parts consumable downstream by drifter to use as reference for baseline for different computations.
- field separator: str | None = ','
Data separator.
- field setname: str [Required]
Feature set name.
- field srcurl: str | None = None
Source url fron where data is to be loaded.
- field tablename: str [Required]
Table name.
- field upload_key: str | None = None
Cache upload key.
- pydantic model V1SaveFeatureSource
Bases:
BaseModelShow JSON schema
{ "title": "V1SaveFeatureSource", "type": "object", "properties": { "index": { "title": "Index", "description": "Feature Source Index", "type": "integer" }, "tablename": { "title": "Tablename", "description": "Table name.", "type": "string" }, "setname": { "title": "Setname", "description": "Feature set name.", "type": "string" }, "connection": { "title": "Connection", "description": "Database connection.", "type": "string" }, "setdescription": { "title": "Setdescription", "description": "Feature set description.", "type": "string" }, "createddate": { "title": "Createddate", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "createdby": { "title": "Createdby", "description": "User that created the model.", "type": "string" }, "customquery": { "title": "Customquery", "description": "Custom query.", "type": "string" }, "maintain_archives": { "title": "Maintain Archives", "description": "If `true` creates an archive table of a snapshot of the data before it is overwritten or appended; otherwise, `false` (the default value).", "default": false, "type": "boolean" }, "query_metadata": { "title": "Query Metadata", "description": "JSON that breaks down a query into parts consumable downstream by drifter to use as reference for baseline for different computations.", "default": {}, "type": "object" }, "status": { "title": "Status", "description": "status of featuresource record", "default": "active", "type": "string" }, "modified_by": { "title": "Modified By", "description": "user whi modified last", "type": "string" }, "created_by": { "title": "Created By", "description": "user who created the record", "type": "string" }, "description": { "title": "Description", "description": "description of feature source", "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at modification time.", "type": "string", "format": "date-time" } }, "required": [ "tablename", "setname", "connection" ] }
- Config:
allow_population_by_field_name: bool = True
orm_mode: bool = True
- Fields:
- field connection: str [Required]
Database connection.
- field created_by: str | None = None
user who created the record
- field created_ts: datetime | None = None
Unix time in milliseconds generated at creation time.
- field createdby: str | None = None
User that created the model.
- field createddate: datetime | None = None
Unix time in milliseconds generated at creation time.
- field customquery: str | None = None
Custom query.
- field description: str | None = None
description of feature source
- field index: int | None = None
Feature Source Index
- field maintain_archives: bool | None = False
If true creates an archive table of a snapshot of the data before it is overwritten or appended; otherwise, false (the default value).
- field modified_by: str | None = None
user whi modified last
- field modified_ts: datetime | None = None
Unix time in milliseconds generated at modification time.
- field query_metadata: dict | None = {}
JSON that breaks down a query into parts consumable downstream by drifter to use as reference for baseline for different computations.
- field setdescription: str | None = None
Feature set description.
- field setname: str [Required]
Feature set name.
- field status: str | None = 'active'
status of featuresource record
- field tablename: str [Required]
Table name.