Risk store objects
Objects and models for drift, explainability, and uncertainty. This data is maintained in the hila Enterprise risk store database. See supported Risk store APIs.
vianops_client.models.riskstore.data_profiling
- pydantic model V1DataProfilingJobModel
Bases:
BaseModelShow JSON schema
{ "title": "V1DataProfilingJobModel", "type": "object", "properties": { "inference_mapping": { "anyOf": [ { "$ref": "#/$defs/V1InferenceMappingModel" }, { "type": "null" } ], "description": "Inference mapping object. Inference mapping object is optional if `deployment` , `model_name`, `model_version` and `model_stage` are provided; otherwise, required." }, "deployment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the deployment. Deployment is optional if inference_mapping is provided; otherwise, required (along with model_name, 'model_version, and model_stage`).", "title": "Deployment" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the model. Model name is optional if inference_mapping is provided; otherwise, required (along with 'deployment`, `model_version`, and `model_stage`).", "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Version of the model. Model version is optional if inference_mapping is provided; otherwise, required (along with 'deployment`, 'model_name`, and `model_stage`).", "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stage of the model. Model stage is optional if inference_mapping is provided; otherwise, required (along with 'deployment`, 'model_name`, and `model_version`).", "title": "Model Stage" }, "policy": { "$ref": "#/$defs/V1DataProfilingPolicy", "description": "Policy parameters for a data profiling job." }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Job status.", "title": "Status" }, "segments": { "anyOf": [ { "items": { "$ref": "#/$defs/V1SegmentModel" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of segments used by the drift policy to be included in the data profiling analysis.", "title": "Segments" } }, "$defs": { "V1Baseline": { "properties": { "window_method": { "description": "The window method. Supported values: `prior`, `last`, `same_prior_year`, `training` .", "title": "Window Method", "type": "string" }, "window_type": { "description": "The baseline window type. Supported values: `day`, `week`, `month`, `quarter`, `year`, `training`.", "title": "Window Type", "type": "string" }, "last_amount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The last amount of `prior` or `last` for the given window type.", "title": "Last Amount" }, "process_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The process date.", "title": "Process Date" }, "offset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The policy`s offset type. Supported values: `week`, `month`, and `quarter`.", "title": "Offset Type" }, "offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The offset amount.", "title": "Offset" }, "start_of_week": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The start day of week. Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.", "title": "Start Of Week" }, "quarter_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The date to start the quarter.", "title": "Quarter Start" }, "year_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The date to start the year.", "title": "Year Start" } }, "required": [ "window_method", "window_type" ], "title": "V1Baseline", "type": "object" }, "V1BetweenOperatorModel": { "properties": { "min": { "default": null, "description": "Minimum value of BETWEEN.", "title": "Min", "type": "number" }, "max": { "default": null, "description": "Maximum value of BETWEEN.", "title": "Max", "type": "number" } }, "title": "V1BetweenOperatorModel", "type": "object" }, "V1DataProfilingPolicy": { "properties": { "window_parameters": { "$ref": "#/$defs/V1WindowParameters", "description": "Window parameters for a policy." } }, "required": [ "window_parameters" ], "title": "V1DataProfilingPolicy", "type": "object" }, "V1InferenceMappingColumnSchema": { "properties": { "feature_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Id of the feature, generated by the platform for optimization.", "title": "Feature Id" }, "name": { "description": "Name of column.", "title": "Name", "type": "string" }, "dtype": { "description": "Data type of column. For example, `float64`.", "title": "Dtype", "type": "string" }, "sql_type": { "description": "SQL data type of column. For example, `Float32`.", "title": "Sql Type", "type": "string" }, "feature_type": { "description": "Feature type of column. Acceptable values include `categorical` and `continuous`.", "title": "Feature Type", "type": "string" }, "segmentation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "If true (the default), the column is enabled for segmentation calculations.", "title": "Segmentation" }, "drift": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "If true (the default), the column is enabled for drift calculations.", "title": "Drift" }, "hotspot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If true (the default), the column is enabled for hotspot analysis.", "title": "Hotspot" }, "rca": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "List of column names included for root cause analysis (rca). Set by the platform based on feature configuration to identify features available for hotspot analysis.", "title": "Rca" }, "round": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The number of decimals to round to on a continuous float column.", "title": "Round" } }, "required": [ "name", "dtype", "sql_type", "feature_type" ], "title": "V1InferenceMappingColumnSchema", "type": "object" }, "V1InferenceMappingModel": { "example": { "connection": "Internal clickhouse DB", "create_ddl": null, "deployment": "vianai.jt_placeholder_deployment", "df_schema": { "columns": [ { "drift": true, "dtype": "float64", "feature_id": 1, "feature_type": "categorical", "name": "PULocationID", "segmentation": true, "sql_type": "Float32" }, { "drift": true, "dtype": "float64", "feature_id": 2, "feature_type": "categorical", "name": "DOLocationID", "segmentation": true, "sql_type": "Float32" }, { "drift": true, "dtype": "float64", "feature_id": 3, "feature_type": "continuous", "name": "trip_distance", "segmentation": true, "sql_type": "Float32" }, { "drift": true, "dtype": "float64", "feature_id": 4, "feature_type": "continuous", "name": "travel_time", "segmentation": true, "sql_type": "Float32" }, { "drift": false, "dtype": "datetime64[ns]", "feature_id": 5, "feature_type": "unknown", "name": "PUdatetime", "sql_type": "" } ], "datetime_col": "PUdatetime", "identifier_cols": [ "pk" ], "target_col": "total_amount" }, "ground_truth_table": "16794179557100_gt", "identifier_cols_schema": null, "index": 7, "inference_table": "16794179557100_dit", "joined_table": "16794179557100_joined", "key_table": "16794179557100_key", "model_name": "vianai.jt_placeholder_deployment", "model_stage": "primary", "model_version": "1", "postprocessors": [ { "classname": "vianai.postprocessing.classification.PickInferenceMapper", "initparams": { "mapper": "{1:'a',2:'b',3:'c'}" }, "method": "fit_transform" } ] }, "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Index identifier.", "title": "Index" }, "deployment": { "description": "Deployment name for the related model.", "title": "Deployment", "type": "string" }, "model_name": { "description": "Model name for the related model.", "title": "Model Name", "type": "string" }, "model_version": { "description": "Model version for the related model, e.g., 1.", "title": "Model Version", "type": "string" }, "model_stage": { "description": "Model stage for the related model, e.g., primary.", "title": "Model Stage", "type": "string" }, "connection": { "description": "Database connection for the inference mapping.", "title": "Connection", "type": "string" }, "df_schema": { "$ref": "#/$defs/V1InferenceMappingSchema", "description": "Dictionary containing dataframe schema for model, i.e., target column, identifier column(s), all columns, datetime column, and predict probability column (classification models only)." }, "identifier_cols_schema": { "anyOf": [ {}, { "type": "null" } ], "default": null, "description": "List containing identifier columns schema for model.", "title": "Identifier Cols Schema" }, "inference_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of inference table for mapping.", "title": "Inference Table" }, "ground_truth_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of ground truth table for mapping.", "title": "Ground Truth Table" }, "joined_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of joined table for mapping.", "title": "Joined Table" }, "key_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of key table for mapping.", "title": "Key Table" }, "create_ddl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The query to create the ddl tables.", "title": "Create Ddl" }, "postprocessors": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "One or more postprocessor (and related params) to include in inference mapping, to transform output data before sending to backend database. The available postprocessors include `PickHighestProbability`, `PickInferenceMapper`, and `PickProbablityThreshold`. For each postprocessor, specify the classname, method, and initparams.", "title": "Postprocessors" }, "training_set_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Training set id that needs to be specified for training data preprocessing.", "title": "Training Set Id" }, "training_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Training table name that needs to be specified for training data preprocessing.", "title": "Training Table" } }, "required": [ "deployment", "model_name", "model_version", "model_stage", "connection", "df_schema" ], "title": "V1InferenceMappingModel", "type": "object" }, "V1InferenceMappingSchema": { "properties": { "target_col": { "description": "Name of target column.", "title": "Target Col", "type": "string" }, "identifier_cols": { "default": [], "description": "List of identifier columns.", "items": { "type": "string" }, "title": "Identifier Cols", "type": "array" }, "columns": { "description": "List of all columns.", "items": { "$ref": "#/$defs/V1InferenceMappingColumnSchema" }, "title": "Columns", "type": "array" }, "datetime_col": { "default": "", "description": "Name of datetime column", "title": "Datetime Col", "type": "string" }, "predict_proba_col": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "(Classification models only) Name of column that provides the predict probability.", "title": "Predict Proba Col" } }, "required": [ "target_col", "columns" ], "title": "V1InferenceMappingSchema", "type": "object" }, "V1SegmentFilterModel": { "additionalProperties": false, "example": { "conjunction": "AND", "feature_name": "FEATURE NAME", "grouped_filters": [ { "conjunction": "AND", "feature_name": "FEATURE NAME", "operator": "=", "value": [ "VALUE 1", "VALUE 2" ] } ], "operator": "=", "value": [ "VALUE 1", "VALUE 2" ] }, "properties": { "feature_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of feature field to do the operation on.", "title": "Feature Name" }, "value": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "type": "number" } ] }, "type": "array" }, { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "type": "number" }, { "$ref": "#/$defs/V1BetweenOperatorModel" }, { "$ref": "#/$defs/V1TopBottomOperatorModel" }, { "type": "null" } ], "default": null, "description": "Values of operator doing the filter. Value types supported are based on operator.", "title": "Value" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Operation to perform on the feature field. This field is case-insensitive. Supported operators: `=`, `>`, `<`, `<=`, `>=`, `BETWEEN`, `TOP`, `BOTTOM`, `DISTINCT`", "title": "Operator" }, "conjunction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Relationship to next filter. If there is no next filter, set to null. This field is case-insensitive. Supported values: `AND`, `OR`, `null`. Default value is `null`.", "title": "Conjunction" }, "grouped_filters": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of grouped filters. Use for creating a nested filter within a filter.", "title": "Grouped Filters" } }, "title": "V1SegmentFilterModel", "type": "object" }, "V1SegmentModel": { "example": { "created_by": "user1", "created_ts": 1672531200000, "description": "DESCRIPTION", "filters": [ { "conjunction": null, "feature_name": "FEATURE NAME", "grouped_filters": null, "operator": "=", "value": [ "VALUE 1", "VALUE 2" ] } ], "id": 1, "model_uuid": "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "modified_by": "user2", "modified_ts": 1672531200000, "name": "NAME", "status": "inactive" }, "properties": { "model_uuid": { "description": "Unique identifier for model.", "title": "Model Uuid", "type": "string" }, "name": { "description": "Name of the segment.", "title": "Name", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the segment.", "title": "Description" }, "filters": { "description": "List of segment filters, their conditions, and relationships.", "items": { "$ref": "#/$defs/V1SegmentFilterModel" }, "title": "Filters", "type": "array" }, "id": { "description": "Unique identifier generated by the platform for the segment.", "title": "Id", "type": "integer" }, "status": { "description": "Current status of the segment. This field is case-insensitive. Possible values: `active`, `inactive` (default), `archived`, `delete`.", "title": "Status", "type": "string" }, "created_ts": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ], "description": "Timestamp (Unix time in milliseconds) generated when the segment is created. You can specify the timestamp as a float or date time string value.", "title": "Created Ts" }, "modified_ts": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ], "description": "Timestamp (Unix time in milliseconds) generated when the segment is modified. You can specify the timestamp as a float or date time string value.", "title": "Modified Ts" }, "created_by": { "description": "User who created the segment.", "title": "Created By", "type": "string" }, "modified_by": { "description": "User who last modified the segment.", "title": "Modified By", "type": "string" } }, "required": [ "model_uuid", "name", "filters", "id", "status", "created_ts", "modified_ts", "created_by", "modified_by" ], "title": "V1SegmentModel", "type": "object" }, "V1Target": { "properties": { "window_type": { "description": "The target window type. Accepted values include: `day`, `week`, `month`, `quarter`, and `year`.", "title": "Window Type", "type": "string" }, "process_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The process date.", "title": "Process Date" }, "offset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The policy`s offset type. Accepted values include: `week`, `month`, and `quarter`.", "title": "Offset Type" }, "offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The offset amount.", "title": "Offset" }, "start_of_week": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The start day of week. Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.", "title": "Start Of Week" }, "quarter_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The date to start the quarter.", "title": "Quarter Start" }, "year_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The date to start the year.", "title": "Year Start" } }, "required": [ "window_type" ], "title": "V1Target", "type": "object" }, "V1TopBottomOperatorModel": { "properties": { "direction": { "default": "DESC", "description": "Direction of field values. This field is case-insensitive. Supported directions: `ASC` (ascending), `DESC` (descending). Default is `DESC`.", "title": "Direction", "type": "string" }, "method": { "default": "flat", "description": "Whether it should be the top/bottom percent or flat amount. This field is case-insensitive. Supported methods: `percent`, `flat`. Default is `flat`.", "title": "Method", "type": "string" }, "value": { "default": null, "description": "Percent or flat number of rows to take.", "title": "Value", "type": "number" } }, "title": "V1TopBottomOperatorModel", "type": "object" }, "V1WindowParameters": { "properties": { "target": { "$ref": "#/$defs/V1Target", "description": "The target parameters." }, "baseline": { "$ref": "#/$defs/V1Baseline", "description": "The baseline parameters." } }, "required": [ "target", "baseline" ], "title": "V1WindowParameters", "type": "object" } }, "example": { "deployment": "Taxi fare model 2 vianai", "model_name": "Taxi fare model 2 vianai", "model_stage": "primary", "model_version": "1", "policy": { "window_parameters": { "baseline": { "process_date": "2023-04-19", "window_method": "prior", "window_type": "day" }, "target": { "process_date": "2023-04-19", "window_type": "day" } } }, "segments": [ { "created_by": "user1", "created_ts": "1683132722980.102", "description": "Segment to filter data for particular pickup and dropoff locations in Williamsburg and Manhattan", "filters": [ { "conjunction": "None", "feature_name": "DOLocation", "grouped_filters": "None", "operator": "=", "value": [ "Little Italy/NoLiTa", "Lower East Side" ] } ], "id": 2, "model_uuid": "fe126008-0581-4d10-bc5e-93c0c0cfa157", "modified_by": "user2", "modified_ts": "1683132722980.102", "name": "Williamsburg-Manhattan segment 1 vianai", "status": "active" } ], "status": "inactive" }, "required": [ "policy" ] }
- Config:
protected_namespaces: tuple = ()
from_attributes: bool = True
json_schema_extra: dict = {‘example’: {‘deployment’: ‘Taxi fare model 2 vianai’, ‘model_name’: ‘Taxi fare model 2 vianai’, ‘model_version’: ‘1’, ‘model_stage’: ‘primary’, ‘policy’: {‘window_parameters’: {‘target’: {‘window_type’: ‘day’, ‘process_date’: ‘2023-04-19’}, ‘baseline’: {‘window_method’: ‘prior’, ‘window_type’: ‘day’, ‘process_date’: ‘2023-04-19’}}}, ‘status’: ‘inactive’, ‘segments’: [{‘model_uuid’: ‘fe126008-0581-4d10-bc5e-93c0c0cfa157’, ‘name’: ‘Williamsburg-Manhattan segment 1 vianai’, ‘description’: ‘Segment to filter data for particular pickup and dropoff locations in Williamsburg and Manhattan’, ‘filters’: [{‘feature_name’: ‘DOLocation’, ‘value’: [‘Little Italy/NoLiTa’, ‘Lower East Side’], ‘operator’: ‘=’, ‘conjunction’: ‘None’, ‘grouped_filters’: ‘None’}], ‘id’: 2, ‘status’: ‘active’, ‘created_ts’: ‘1683132722980.102’, ‘modified_ts’: ‘1683132722980.102’, ‘created_by’: ‘user1’, ‘modified_by’: ‘user2’}]}}
- Fields:
- field deployment: str | None = None
Name of the deployment. Deployment is optional if inference_mapping is provided; otherwise, required (along with model_name, ‘model_version, and model_stage`).
- field inference_mapping: V1InferenceMappingModel | None = <class 'vianops_client.models.inferencestore.inference_mapping.V1InferenceMappingModel'>
Inference mapping object. Inference mapping object is optional if deployment , model_name, model_version and model_stage are provided; otherwise, required.
- field model_name: str | None = None
Name of the model. Model name is optional if inference_mapping is provided; otherwise, required (along with ‘deployment`, model_version, and model_stage).
- field model_stage: str | None = None
Stage of the model. Model stage is optional if inference_mapping is provided; otherwise, required (along with ‘deployment`, ‘model_name`, and model_version).
- field model_version: str | None = None
Version of the model. Model version is optional if inference_mapping is provided; otherwise, required (along with ‘deployment`, ‘model_name`, and model_stage).
- field policy: V1DataProfilingPolicy [Required]
Policy parameters for a data profiling job.
- field segments: List[V1SegmentModel] | None = None
List of segments used by the drift policy to be included in the data profiling analysis.
- field status: str | None = None
Job status.
- pydantic model V1DataProfilingPolicy
Bases:
BaseModelShow JSON schema
{ "title": "V1DataProfilingPolicy", "type": "object", "properties": { "window_parameters": { "$ref": "#/$defs/V1WindowParameters", "description": "Window parameters for a policy." } }, "$defs": { "V1Baseline": { "properties": { "window_method": { "description": "The window method. Supported values: `prior`, `last`, `same_prior_year`, `training` .", "title": "Window Method", "type": "string" }, "window_type": { "description": "The baseline window type. Supported values: `day`, `week`, `month`, `quarter`, `year`, `training`.", "title": "Window Type", "type": "string" }, "last_amount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The last amount of `prior` or `last` for the given window type.", "title": "Last Amount" }, "process_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The process date.", "title": "Process Date" }, "offset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The policy`s offset type. Supported values: `week`, `month`, and `quarter`.", "title": "Offset Type" }, "offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The offset amount.", "title": "Offset" }, "start_of_week": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The start day of week. Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.", "title": "Start Of Week" }, "quarter_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The date to start the quarter.", "title": "Quarter Start" }, "year_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The date to start the year.", "title": "Year Start" } }, "required": [ "window_method", "window_type" ], "title": "V1Baseline", "type": "object" }, "V1Target": { "properties": { "window_type": { "description": "The target window type. Accepted values include: `day`, `week`, `month`, `quarter`, and `year`.", "title": "Window Type", "type": "string" }, "process_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The process date.", "title": "Process Date" }, "offset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The policy`s offset type. Accepted values include: `week`, `month`, and `quarter`.", "title": "Offset Type" }, "offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The offset amount.", "title": "Offset" }, "start_of_week": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The start day of week. Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.", "title": "Start Of Week" }, "quarter_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The date to start the quarter.", "title": "Quarter Start" }, "year_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The date to start the year.", "title": "Year Start" } }, "required": [ "window_type" ], "title": "V1Target", "type": "object" }, "V1WindowParameters": { "properties": { "target": { "$ref": "#/$defs/V1Target", "description": "The target parameters." }, "baseline": { "$ref": "#/$defs/V1Baseline", "description": "The baseline parameters." } }, "required": [ "target", "baseline" ], "title": "V1WindowParameters", "type": "object" } }, "required": [ "window_parameters" ] }
- field window_parameters: V1WindowParameters [Required]
Window parameters for a policy.
vianops_client.models.riskstore.drift
- pydantic model V1DriftColumnReport
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftColumnReport", "type": "object", "properties": { "column_name": { "title": "Column Name", "type": "string" }, "drift_percentage": { "title": "Drift Percentage", "type": "number" }, "drift_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Drift Count" } }, "required": [ "column_name", "drift_percentage" ] }
- field column_name: str [Required]
- field drift_count: int | None = None
- field drift_percentage: float [Required]
- pydantic model V1DriftDetectionConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionConfig", "type": "object", "properties": { "deployment_name": { "title": "Deployment Name", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "cron": { "title": "Cron", "type": "string" }, "drift_detections": { "title": "Drift Detections" } }, "required": [ "deployment_name", "model_name", "model_version", "cron", "drift_detections" ] }
- Config:
protected_namespaces: tuple = ()
- Fields:
- field cron: str [Required]
- field deployment_name: str [Required]
- field drift_detections: Any [Required]
- field model_name: str [Required]
- field model_version: str [Required]
- pydantic model V1DriftDetectionModel
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionModel", "type": "object", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Index.", "title": "Index" }, "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Job ID that ran the drift detection.", "title": "Job Id" }, "deployment": { "description": "Name of the deployment.", "title": "Deployment", "type": "string" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the model.", "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Version of the model.", "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stage of the model.", "title": "Model Stage" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Hostname that ran the drift detection.", "title": "Hostname" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the deployment.", "title": "Feature Set Name" }, "featureset_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Count of feature sets.", "title": "Featureset Count" }, "batch_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Count of batches.", "title": "Batch Count" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Runtime duration.", "title": "Runtime" }, "processed_ts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Timestamp of processing.", "title": "Processed Ts" }, "column_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the column.", "title": "Column Name" }, "column_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of the column.", "title": "Column Type" }, "drift_array": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "Array containing drift information.", "title": "Drift Array" }, "drift_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Count of drifts detected.", "title": "Drift Count" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of the record.", "title": "Type" }, "training_drift_array": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "Array containing training drift information.", "title": "Training Drift Array" }, "warning_array": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "Array containing warnings.", "title": "Warning Array" }, "training_warning_array": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "Array containing training warnings.", "title": "Training Warning Array" }, "createddate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Creation timestamp.", "title": "Createddate" }, "batch_starttime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Batch start timestamp.", "title": "Batch Starttime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Key identifier.", "title": "Key" }, "results": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Dictionary containing results.", "title": "Results" }, "data_profile": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Dictionary containing data profile.", "title": "Data Profile" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Status of the record.", "title": "Status" }, "verbose": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Verbose mode flag.", "title": "Verbose" }, "drift_policy_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the drift policy.", "title": "Drift Policy Name" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Limit value.", "title": "Limit" }, "drift_config": { "description": "Configuration for drift detection.", "title": "Drift Config" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "ID of the segment.", "title": "Segment Id" }, "policy_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the policy.", "title": "Policy Uuid" } }, "example": { "batch_count": 100, "batch_starttime": 0, "column_name": "feature_a", "column_type": "int", "createddate": 0, "data_profile": {}, "deployment": "vianai.deployment", "drift_array": [ { "bin": "value_a", "count": 10 }, { "bin": "value_b", "count": 10 } ], "drift_config": "string", "drift_count": 10, "drift_policy_name": "vianai.policy_a", "feature_set_name": "vianai.feature_set", "featureset_count": 1000, "hostname": "127.0.0.1", "index": 0, "job_id": "driftdetection-queue-123", "key": "driftdetection-queue-123:vianai.deployment:vianai.model_name", "limit": 0, "model_name": "vianai.model_name", "model_stage": "primary", "model_version": "vianai.model_version", "policy_uuid": "abc-123-456", "processed_ts": 0.0, "results": {}, "runtime": 0.0, "segment_id": 1, "training_drift_array": [ "string" ], "training_warning_array": [ "string" ], "type": "string", "warning_array": [ "string" ] }, "required": [ "deployment", "drift_config" ] }
- Config:
protected_namespaces: tuple = ()
from_attributes: bool = True
json_schema_extra: dict = {‘example’: {‘index’: 0, ‘job_id’: ‘driftdetection-queue-123’, ‘deployment’: ‘vianai.deployment’, ‘model_name’: ‘vianai.model_name’, ‘model_version’: ‘vianai.model_version’, ‘model_stage’: ‘primary’, ‘hostname’: ‘127.0.0.1’, ‘feature_set_name’: ‘vianai.feature_set’, ‘featureset_count’: 1000, ‘batch_count’: 100, ‘runtime’: 0.0, ‘processed_ts’: 0.0, ‘column_name’: ‘feature_a’, ‘column_type’: ‘int’, ‘drift_array’: [{‘bin’: ‘value_a’, ‘count’: 10}, {‘bin’: ‘value_b’, ‘count’: 10}], ‘drift_count’: 10, ‘type’: ‘string’, ‘training_drift_array’: [‘string’], ‘warning_array’: [‘string’], ‘training_warning_array’: [‘string’], ‘createddate’: 0, ‘batch_starttime’: 0, ‘key’: ‘driftdetection-queue-123:vianai.deployment:vianai.model_name’, ‘results’: {}, ‘data_profile’: {}, ‘drift_policy_name’: ‘vianai.policy_a’, ‘limit’: 0, ‘drift_config’: ‘string’, ‘segment_id’: 1, ‘policy_uuid’: ‘abc-123-456’}}
- Fields:
- field batch_count: int | None = None
Count of batches.
- field batch_starttime: float | None = None
Batch start timestamp.
- field column_name: str | None = None
Name of the column.
- field column_type: str | None = None
Type of the column.
- field createddate: float | None = None
Creation timestamp.
- field data_profile: dict | None = None
Dictionary containing data profile.
- field deployment: str [Required]
Name of the deployment.
- field drift_array: list | None = None
Array containing drift information.
- field drift_config: Any [Required]
Configuration for drift detection.
- field drift_count: int | None = None
Count of drifts detected.
- field drift_policy_name: str | None = None
Name of the drift policy.
- field feature_set_name: str | None = None
Name of the deployment.
- field featureset_count: int | None = None
Count of feature sets.
- field hostname: str | None = None
Hostname that ran the drift detection.
- field index: int | None = None
Index.
- field job_id: str | None = None
Job ID that ran the drift detection.
- field key: str | None = None
Key identifier.
- field limit: int | None = None
Limit value.
- field model_name: str | None = None
Name of the model.
- field model_stage: str | None = None
Stage of the model.
- field model_version: str | None = None
Version of the model.
- field policy_uuid: str | None = None
UUID of the policy.
- field processed_ts: float | None = None
Timestamp of processing.
- field results: dict | None = None
Dictionary containing results.
- field runtime: float | None = None
Runtime duration.
- field segment_id: int | None = None
ID of the segment.
- field status: str | None = None
Status of the record.
- field training_drift_array: list | None = None
Array containing training drift information.
- field training_warning_array: list | None = None
Array containing training warnings.
- field type: str | None = None
Type of the record.
- field verbose: bool | None = None
Verbose mode flag.
- field warning_array: list | None = None
Array containing warnings.
- pydantic model V1DriftDetectionModelList
Bases:
RootModelShow JSON schema
{ "title": "V1DriftDetectionModelList", "type": "array", "$defs": { "V1DriftDetectionModel": { "example": { "batch_count": 100, "batch_starttime": 0, "column_name": "feature_a", "column_type": "int", "createddate": 0, "data_profile": {}, "deployment": "vianai.deployment", "drift_array": [ { "bin": "value_a", "count": 10 }, { "bin": "value_b", "count": 10 } ], "drift_config": "string", "drift_count": 10, "drift_policy_name": "vianai.policy_a", "feature_set_name": "vianai.feature_set", "featureset_count": 1000, "hostname": "127.0.0.1", "index": 0, "job_id": "driftdetection-queue-123", "key": "driftdetection-queue-123:vianai.deployment:vianai.model_name", "limit": 0, "model_name": "vianai.model_name", "model_stage": "primary", "model_version": "vianai.model_version", "policy_uuid": "abc-123-456", "processed_ts": 0.0, "results": {}, "runtime": 0.0, "segment_id": 1, "training_drift_array": [ "string" ], "training_warning_array": [ "string" ], "type": "string", "warning_array": [ "string" ] }, "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Index.", "title": "Index" }, "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Job ID that ran the drift detection.", "title": "Job Id" }, "deployment": { "description": "Name of the deployment.", "title": "Deployment", "type": "string" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the model.", "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Version of the model.", "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stage of the model.", "title": "Model Stage" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Hostname that ran the drift detection.", "title": "Hostname" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the deployment.", "title": "Feature Set Name" }, "featureset_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Count of feature sets.", "title": "Featureset Count" }, "batch_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Count of batches.", "title": "Batch Count" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Runtime duration.", "title": "Runtime" }, "processed_ts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Timestamp of processing.", "title": "Processed Ts" }, "column_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the column.", "title": "Column Name" }, "column_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of the column.", "title": "Column Type" }, "drift_array": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "Array containing drift information.", "title": "Drift Array" }, "drift_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Count of drifts detected.", "title": "Drift Count" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of the record.", "title": "Type" }, "training_drift_array": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "Array containing training drift information.", "title": "Training Drift Array" }, "warning_array": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "Array containing warnings.", "title": "Warning Array" }, "training_warning_array": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "Array containing training warnings.", "title": "Training Warning Array" }, "createddate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Creation timestamp.", "title": "Createddate" }, "batch_starttime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Batch start timestamp.", "title": "Batch Starttime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Key identifier.", "title": "Key" }, "results": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Dictionary containing results.", "title": "Results" }, "data_profile": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Dictionary containing data profile.", "title": "Data Profile" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Status of the record.", "title": "Status" }, "verbose": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Verbose mode flag.", "title": "Verbose" }, "drift_policy_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the drift policy.", "title": "Drift Policy Name" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Limit value.", "title": "Limit" }, "drift_config": { "description": "Configuration for drift detection.", "title": "Drift Config" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "ID of the segment.", "title": "Segment Id" }, "policy_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the policy.", "title": "Policy Uuid" } }, "required": [ "deployment", "drift_config" ], "title": "V1DriftDetectionModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1DriftDetectionModel" } }
- field root: List[V1DriftDetectionModel] [Required]
- pydantic model V1DriftDetectionReport
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionReport", "type": "object", "properties": { "deployment": { "title": "Deployment", "type": "string" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Stage" }, "runtime": { "title": "Runtime", "type": "number" }, "num_predicts": { "title": "Num Predicts", "type": "integer" }, "columns": { "items": { "$ref": "#/$defs/V1DriftColumnReport" }, "title": "Columns", "type": "array" }, "batch_starttime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Batch Starttime" } }, "$defs": { "V1DriftColumnReport": { "properties": { "column_name": { "title": "Column Name", "type": "string" }, "drift_percentage": { "title": "Drift Percentage", "type": "number" }, "drift_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Drift Count" } }, "required": [ "column_name", "drift_percentage" ], "title": "V1DriftColumnReport", "type": "object" } }, "required": [ "deployment", "runtime", "num_predicts", "columns" ] }
- Config:
protected_namespaces: tuple = ()
- Fields:
- field batch_starttime: float | None = None
- field columns: List[V1DriftColumnReport] [Required]
- field deployment: str [Required]
- field model_name: str | None = None
- field model_stage: str | None = None
- field model_version: str | None = None
- field num_predicts: int [Required]
- field runtime: float [Required]
- pydantic model V1DriftDetectionReportList
Bases:
RootModelShow JSON schema
{ "title": "V1DriftDetectionReportList", "type": "array", "$defs": { "V1DriftColumnReport": { "properties": { "column_name": { "title": "Column Name", "type": "string" }, "drift_percentage": { "title": "Drift Percentage", "type": "number" }, "drift_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Drift Count" } }, "required": [ "column_name", "drift_percentage" ], "title": "V1DriftColumnReport", "type": "object" }, "V1DriftDetectionReport": { "properties": { "deployment": { "title": "Deployment", "type": "string" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Stage" }, "runtime": { "title": "Runtime", "type": "number" }, "num_predicts": { "title": "Num Predicts", "type": "integer" }, "columns": { "items": { "$ref": "#/$defs/V1DriftColumnReport" }, "title": "Columns", "type": "array" }, "batch_starttime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Batch Starttime" } }, "required": [ "deployment", "runtime", "num_predicts", "columns" ], "title": "V1DriftDetectionReport", "type": "object" } }, "items": { "$ref": "#/$defs/V1DriftDetectionReport" } }
- field root: List[V1DriftDetectionReport] [Required]
- pydantic model V1DriftDetectionSummary
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionSummary", "type": "object", "properties": { "deployment": { "title": "Deployment", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "num_drifts": { "title": "Num Drifts", "type": "integer" }, "num_warns": { "title": "Num Warns", "type": "integer" }, "num_criticals": { "title": "Num Criticals", "type": "integer" }, "warn_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Warn Level" }, "num_input_columns": { "title": "Num Input Columns", "type": "integer" } }, "required": [ "deployment", "runtime", "num_drifts", "num_warns", "num_criticals", "num_input_columns" ] }
- Fields:
- field deployment: str [Required]
- field num_criticals: int [Required]
- field num_drifts: int [Required]
- field num_input_columns: int [Required]
- field num_warns: int [Required]
- field runtime: float [Required]
- field warn_level: str | None = None
- pydantic model V1DriftDetectionSummaryList
Bases:
RootModelShow JSON schema
{ "title": "V1DriftDetectionSummaryList", "type": "array", "$defs": { "V1DriftDetectionSummary": { "properties": { "deployment": { "title": "Deployment", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "num_drifts": { "title": "Num Drifts", "type": "integer" }, "num_warns": { "title": "Num Warns", "type": "integer" }, "num_criticals": { "title": "Num Criticals", "type": "integer" }, "warn_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Warn Level" }, "num_input_columns": { "title": "Num Input Columns", "type": "integer" } }, "required": [ "deployment", "runtime", "num_drifts", "num_warns", "num_criticals", "num_input_columns" ], "title": "V1DriftDetectionSummary", "type": "object" } }, "items": { "$ref": "#/$defs/V1DriftDetectionSummary" } }
- field root: List[V1DriftDetectionSummary] [Required]
- pydantic model V1DriftPolicyConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftPolicyConfig", "type": "object", "properties": { "deployment_name": { "title": "Deployment Name", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "model_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Type" }, "cron": { "title": "Cron", "type": "string" }, "drift_policies": { "items": { "type": "string" }, "title": "Drift Policies", "type": "array" } }, "additionalProperties": true, "required": [ "deployment_name", "model_name", "model_version", "cron", "drift_policies" ] }
- Config:
protected_namespaces: tuple = ()
populate_by_name: bool = True
extra: str = allow
- Fields:
- field cron: str [Required]
- field deployment_name: str [Required]
- field drift_policies: List[str] [Required]
- field model_name: str [Required]
- field model_type: str | None = None
- field model_version: str [Required]
- pydantic model V1UncertaintyPolicyConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1UncertaintyPolicyConfig", "type": "object", "properties": { "deployment_name": { "title": "Deployment Name", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "cron": { "title": "Cron", "type": "string" }, "uncertainty_policies": { "title": "Uncertainty Policies" } }, "required": [ "deployment_name", "model_name", "model_version", "cron", "uncertainty_policies" ] }
- Config:
protected_namespaces: tuple = ()
- Fields:
- field cron: str [Required]
- field deployment_name: str [Required]
- field model_name: str [Required]
- field model_version: str [Required]
- field uncertainty_policies: Any [Required]
vianops_client.models.riskstore.explainability
- pydantic model V1ExplainabilityModel
Bases:
V1ExplainabilityModelCommonShow JSON schema
{ "title": "V1ExplainabilityModel", "type": "object", "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Explainability job id.", "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Feature Set Name" }, "deployment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deployment name.", "title": "Deployment" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model name.", "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model version.", "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model stage.", "title": "Model Stage" }, "explainability_config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Explainability configurations.", "title": "Explainability Config" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key based on the concatenation of multiple fields.", "title": "Key" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Index.", "title": "Index" }, "experiment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Experiment type, regression or classification.", "title": "Experiment Type" }, "experiment_metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Experiment metric.", "title": "Experiment Metric" }, "target_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of target column.", "title": "Target Column" }, "categorical_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of columns.", "title": "Categorical Columns" }, "results": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Explainability job results.", "title": "Results" } } }
- Config:
protected_namespaces: tuple = ()
from_attributes: bool = True
- Fields:
- field categorical_columns: List[str] | None = None
List of columns.
- field experiment_metric: str | None = None
Experiment metric.
- field experiment_type: str | None = None
Experiment type, regression or classification.
- field index: int | None = None
Index.
- field results: dict | None = None
Explainability job results.
- field target_column: str | None = None
Name of target column.
- pydantic model V1ExplainabilityModelCommon
Bases:
BaseModelShow JSON schema
{ "title": "V1ExplainabilityModelCommon", "type": "object", "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Explainability job id.", "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Feature Set Name" }, "deployment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deployment name.", "title": "Deployment" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model name.", "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model version.", "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model stage.", "title": "Model Stage" }, "explainability_config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Explainability configurations.", "title": "Explainability Config" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key based on the concatenation of multiple fields.", "title": "Key" } } }
- Config:
protected_namespaces: tuple = ()
from_attributes: bool = True
- Fields:
- field deployment: str | None = None
Deployment name.
- field explainability_config: dict | None = None
Explainability configurations.
- field feature_set_name: str | None = None
Name of featureset.
- field job_id: str | None = None
Explainability job id.
- field key: str | None = None
A key based on the concatenation of multiple fields.
- field model_name: str | None = None
Model name.
- field model_stage: str | None = None
Model stage.
- field model_version: str | None = None
Model version.
- field runtime: float | None = None
Name of featureset.
- pydantic model V1ExplainabilityModelList
Bases:
RootModelShow JSON schema
{ "title": "V1ExplainabilityModelList", "type": "array", "$defs": { "V1ExplainabilityModel": { "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Explainability job id.", "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Feature Set Name" }, "deployment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deployment name.", "title": "Deployment" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model name.", "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model version.", "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model stage.", "title": "Model Stage" }, "explainability_config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Explainability configurations.", "title": "Explainability Config" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key based on the concatenation of multiple fields.", "title": "Key" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Index.", "title": "Index" }, "experiment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Experiment type, regression or classification.", "title": "Experiment Type" }, "experiment_metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Experiment metric.", "title": "Experiment Metric" }, "target_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of target column.", "title": "Target Column" }, "categorical_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of columns.", "title": "Categorical Columns" }, "results": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Explainability job results.", "title": "Results" } }, "title": "V1ExplainabilityModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1ExplainabilityModel" } }
- field root: List[V1ExplainabilityModel] [Required]
- pydantic model V1ExplainabilityModelPage
Bases:
PageModelShow JSON schema
{ "title": "V1ExplainabilityModelPage", "type": "object", "properties": { "items": { "default": [], "items": { "$ref": "#/$defs/V1ExplainabilityModel" }, "title": "Items", "type": "array" }, "current_page": { "default": 0, "title": "Current Page", "type": "integer" }, "page_size": { "default": 0, "title": "Page Size", "type": "integer" }, "previous_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Previous Page" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Next Page" }, "has_previous": { "default": false, "title": "Has Previous", "type": "boolean" }, "previous_items": { "default": 0, "title": "Previous Items", "type": "integer" }, "has_next": { "default": false, "title": "Has Next", "type": "boolean" }, "total": { "default": 0, "title": "Total", "type": "integer" }, "pages": { "default": 0, "title": "Pages", "type": "integer" } }, "$defs": { "V1ExplainabilityModel": { "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Explainability job id.", "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Feature Set Name" }, "deployment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deployment name.", "title": "Deployment" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model name.", "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model version.", "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model stage.", "title": "Model Stage" }, "explainability_config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Explainability configurations.", "title": "Explainability Config" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key based on the concatenation of multiple fields.", "title": "Key" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Index.", "title": "Index" }, "experiment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Experiment type, regression or classification.", "title": "Experiment Type" }, "experiment_metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Experiment metric.", "title": "Experiment Metric" }, "target_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of target column.", "title": "Target Column" }, "categorical_columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of columns.", "title": "Categorical Columns" }, "results": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Explainability job results.", "title": "Results" } }, "title": "V1ExplainabilityModel", "type": "object" } } }
- field items: List[V1ExplainabilityModel] = []
- pydantic model V1ExplainaibilitySearch
Bases:
V1ExplainabilityModelCommonShow JSON schema
{ "title": "V1ExplainaibilitySearch", "type": "object", "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Explainability job id.", "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Feature Set Name" }, "deployment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deployment name.", "title": "Deployment" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model name.", "title": "Model Name" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model version.", "title": "Model Version" }, "model_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Model stage.", "title": "Model Stage" }, "explainability_config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "Explainability configurations.", "title": "Explainability Config" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Name of featureset.", "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key based on the concatenation of multiple fields.", "title": "Key" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The host name.", "title": "Hostname" } } }
- Config:
protected_namespaces: tuple = ()
from_attributes: bool = True
- Fields:
- field hostname: str | None = None
The host name.
vianops_client.models.riskstore.performance
- pydantic model V1ModelMetricsBase
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsBase", "type": "object", "properties": { "model_uuid": { "description": "The model unique identifier. Returned from /v1/models as part of V1ModelsModel.", "title": "Model Uuid", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment unique identifier. Returned from v1/segment as part of V1SegmentModel. To aggregate the data for a specific segment, specify that ID. To aggregate the data for all possible segments for the model, set to 0 or null.", "title": "Segment Id" }, "start_date": { "description": "The start date (Unix timestamp in milliseconds) for the window.", "format": "date", "title": "Start Date", "type": "string" }, "end_date": { "description": "The end date (Unix timestamp in milliseconds) for the window.", "format": "date", "title": "End Date", "type": "string" }, "include_details": { "default": false, "description": "Optional Flag: Set true to include intermediate dataframe in results.", "title": "Include Details", "type": "boolean" } }, "required": [ "model_uuid", "start_date", "end_date" ] }
- Config:
protected_namespaces: tuple = ()
- Fields:
- field end_date: date [Required]
The end date (Unix timestamp in milliseconds) for the window.
- field include_details: bool = False
Optional Flag: Set true to include intermediate dataframe in results.
- field model_uuid: str [Required]
The model unique identifier. Returned from /v1/models as part of V1ModelsModel.
- field segment_id: int | None = None
The segment unique identifier. Returned from v1/segment as part of V1SegmentModel. To aggregate the data for a specific segment, specify that ID. To aggregate the data for all possible segments for the model, set to 0 or null.
- field start_date: date [Required]
The start date (Unix timestamp in milliseconds) for the window.
- pydantic model V1ModelMetricsList
Bases:
RootModelShow JSON schema
{ "title": "V1ModelMetricsList", "type": "array", "$defs": { "V1ModelMetricsBase": { "properties": { "model_uuid": { "description": "The model unique identifier. Returned from /v1/models as part of V1ModelsModel.", "title": "Model Uuid", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment unique identifier. Returned from v1/segment as part of V1SegmentModel. To aggregate the data for a specific segment, specify that ID. To aggregate the data for all possible segments for the model, set to 0 or null.", "title": "Segment Id" }, "start_date": { "description": "The start date (Unix timestamp in milliseconds) for the window.", "format": "date", "title": "Start Date", "type": "string" }, "end_date": { "description": "The end date (Unix timestamp in milliseconds) for the window.", "format": "date", "title": "End Date", "type": "string" }, "include_details": { "default": false, "description": "Optional Flag: Set true to include intermediate dataframe in results.", "title": "Include Details", "type": "boolean" } }, "required": [ "model_uuid", "start_date", "end_date" ], "title": "V1ModelMetricsBase", "type": "object" } }, "items": { "$ref": "#/$defs/V1ModelMetricsBase" } }
- field root: List[V1ModelMetricsBase] [Required]
- pydantic model V1ModelMetricsModel
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsModel", "type": "object", "properties": { "experiment_type": { "description": "The experiment type.", "title": "Experiment Type", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment unique identifier.", "title": "Segment Id" }, "metrics": { "description": "The metrics.", "title": "Metrics", "type": "object" }, "window": { "description": "The window.", "title": "Window", "type": "object" }, "intermediate_details": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The intermediate details.", "title": "Intermediate Details" } }, "required": [ "experiment_type", "metrics", "window" ] }
- Fields:
- field experiment_type: str [Required]
The experiment type.
- field intermediate_details: List[dict] | None = None
The intermediate details.
- field metrics: dict [Required]
The metrics.
- field segment_id: int | None = None
The segment unique identifier.
- field window: dict [Required]
The window.
- dict(*args, **kwargs)
- pydantic model V1ModelMetricsReturn
Bases:
RootModelShow JSON schema
{ "title": "V1ModelMetricsReturn", "type": "object", "$defs": { "V1ModelMetricsModel": { "properties": { "experiment_type": { "description": "The experiment type.", "title": "Experiment Type", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment unique identifier.", "title": "Segment Id" }, "metrics": { "description": "The metrics.", "title": "Metrics", "type": "object" }, "window": { "description": "The window.", "title": "Window", "type": "object" }, "intermediate_details": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The intermediate details.", "title": "Intermediate Details" } }, "required": [ "experiment_type", "metrics", "window" ], "title": "V1ModelMetricsModel", "type": "object" } }, "additionalProperties": { "items": { "$ref": "#/$defs/V1ModelMetricsModel" }, "type": "array" } }
- field root: Dict[str, List[V1ModelMetricsModel]] [Required]
- pydantic model V1PerformanceBaseModel
Bases:
V1PerformanceModelShow JSON schema
{ "title": "V1PerformanceBaseModel", "type": "object", "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The performance job status.", "title": "Status" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A concatenation of multiple fields.", "title": "Key" }, "job_id": { "description": "The performance job id.", "title": "Job Id", "type": "string" }, "deployment": { "description": "The deployment name.", "title": "Deployment", "type": "string" }, "model_name": { "description": "The name of the model.", "title": "Model Name", "type": "string" }, "model_version": { "description": "The model version.", "title": "Model Version", "type": "string" }, "model_stage": { "description": "The model stage.", "title": "Model Stage", "type": "string" }, "hostname": { "description": "The host name.", "title": "Hostname", "type": "string" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the featureset.", "title": "Feature Set Name" }, "experiment_type": { "description": "The experiment type, either classification or regression.", "title": "Experiment Type", "type": "string" }, "policy_name": { "description": "The name of the performance policy.", "title": "Policy Name", "type": "string" }, "policy_uuid": { "description": "The policy's unique identifier", "title": "Policy Uuid", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment's unique identifier.", "title": "Segment Id" }, "model_uuid": { "description": "The model's unique identifier.", "title": "Model Uuid", "type": "string" }, "results": { "description": "The performance job results.", "title": "Results" }, "runtime": { "description": "The performance job runtime.", "title": "Runtime", "type": "number" }, "processed_ts": { "description": "The processed timestamp.", "title": "Processed Ts", "type": "number" }, "predict_date": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ], "description": "The prediction date.", "title": "Predict Date" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The performance result index.", "title": "Index" } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "results", "runtime", "processed_ts", "predict_date" ] }
- Config:
protected_namespaces: tuple = ()
- Fields:
- field index: int | None = None
The performance result index.
- pydantic model V1PerformanceBaseModelList
Bases:
RootModelShow JSON schema
{ "title": "V1PerformanceBaseModelList", "type": "array", "$defs": { "V1PerformanceModel": { "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The performance job status.", "title": "Status" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A concatenation of multiple fields.", "title": "Key" }, "job_id": { "description": "The performance job id.", "title": "Job Id", "type": "string" }, "deployment": { "description": "The deployment name.", "title": "Deployment", "type": "string" }, "model_name": { "description": "The name of the model.", "title": "Model Name", "type": "string" }, "model_version": { "description": "The model version.", "title": "Model Version", "type": "string" }, "model_stage": { "description": "The model stage.", "title": "Model Stage", "type": "string" }, "hostname": { "description": "The host name.", "title": "Hostname", "type": "string" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the featureset.", "title": "Feature Set Name" }, "experiment_type": { "description": "The experiment type, either classification or regression.", "title": "Experiment Type", "type": "string" }, "policy_name": { "description": "The name of the performance policy.", "title": "Policy Name", "type": "string" }, "policy_uuid": { "description": "The policy's unique identifier", "title": "Policy Uuid", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment's unique identifier.", "title": "Segment Id" }, "model_uuid": { "description": "The model's unique identifier.", "title": "Model Uuid", "type": "string" }, "results": { "description": "The performance job results.", "title": "Results" }, "runtime": { "description": "The performance job runtime.", "title": "Runtime", "type": "number" }, "processed_ts": { "description": "The processed timestamp.", "title": "Processed Ts", "type": "number" }, "predict_date": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ], "description": "The prediction date.", "title": "Predict Date" } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "results", "runtime", "processed_ts", "predict_date" ], "title": "V1PerformanceModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1PerformanceModel" } }
- field root: List[V1PerformanceModel] [Required]
- pydantic model V1PerformanceModel
Bases:
V1PerformanceUpdatableModelShow JSON schema
{ "title": "V1PerformanceModel", "type": "object", "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The performance job status.", "title": "Status" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A concatenation of multiple fields.", "title": "Key" }, "job_id": { "description": "The performance job id.", "title": "Job Id", "type": "string" }, "deployment": { "description": "The deployment name.", "title": "Deployment", "type": "string" }, "model_name": { "description": "The name of the model.", "title": "Model Name", "type": "string" }, "model_version": { "description": "The model version.", "title": "Model Version", "type": "string" }, "model_stage": { "description": "The model stage.", "title": "Model Stage", "type": "string" }, "hostname": { "description": "The host name.", "title": "Hostname", "type": "string" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the featureset.", "title": "Feature Set Name" }, "experiment_type": { "description": "The experiment type, either classification or regression.", "title": "Experiment Type", "type": "string" }, "policy_name": { "description": "The name of the performance policy.", "title": "Policy Name", "type": "string" }, "policy_uuid": { "description": "The policy's unique identifier", "title": "Policy Uuid", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment's unique identifier.", "title": "Segment Id" }, "model_uuid": { "description": "The model's unique identifier.", "title": "Model Uuid", "type": "string" }, "results": { "description": "The performance job results.", "title": "Results" }, "runtime": { "description": "The performance job runtime.", "title": "Runtime", "type": "number" }, "processed_ts": { "description": "The processed timestamp.", "title": "Processed Ts", "type": "number" }, "predict_date": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ], "description": "The prediction date.", "title": "Predict Date" } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "results", "runtime", "processed_ts", "predict_date" ] }
- Config:
protected_namespaces: tuple = ()
- Fields:
- field deployment: str [Required]
The deployment name.
- field experiment_type: str [Required]
The experiment type, either classification or regression.
- field feature_set_name: str | None = None
The name of the featureset.
- field hostname: str [Required]
The host name.
- field job_id: str [Required]
The performance job id.
- field model_name: str [Required]
The name of the model.
- field model_stage: str [Required]
The model stage.
- field model_uuid: str [Required]
The model’s unique identifier.
- field model_version: str [Required]
The model version.
- field policy_name: str [Required]
The name of the performance policy.
- field policy_uuid: str [Required]
The policy’s unique identifier
- field predict_date: float | datetime [Required]
The prediction date.
- field processed_ts: float [Required]
The processed timestamp.
- field results: Any [Required]
The performance job results.
- field runtime: float [Required]
The performance job runtime.
- field segment_id: int | None = None
The segment’s unique identifier.
- pydantic model V1PerformanceModelList
Bases:
RootModelShow JSON schema
{ "title": "V1PerformanceModelList", "type": "array", "$defs": { "V1PerformanceBaseModel": { "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The performance job status.", "title": "Status" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A concatenation of multiple fields.", "title": "Key" }, "job_id": { "description": "The performance job id.", "title": "Job Id", "type": "string" }, "deployment": { "description": "The deployment name.", "title": "Deployment", "type": "string" }, "model_name": { "description": "The name of the model.", "title": "Model Name", "type": "string" }, "model_version": { "description": "The model version.", "title": "Model Version", "type": "string" }, "model_stage": { "description": "The model stage.", "title": "Model Stage", "type": "string" }, "hostname": { "description": "The host name.", "title": "Hostname", "type": "string" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the featureset.", "title": "Feature Set Name" }, "experiment_type": { "description": "The experiment type, either classification or regression.", "title": "Experiment Type", "type": "string" }, "policy_name": { "description": "The name of the performance policy.", "title": "Policy Name", "type": "string" }, "policy_uuid": { "description": "The policy's unique identifier", "title": "Policy Uuid", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment's unique identifier.", "title": "Segment Id" }, "model_uuid": { "description": "The model's unique identifier.", "title": "Model Uuid", "type": "string" }, "results": { "description": "The performance job results.", "title": "Results" }, "runtime": { "description": "The performance job runtime.", "title": "Runtime", "type": "number" }, "processed_ts": { "description": "The processed timestamp.", "title": "Processed Ts", "type": "number" }, "predict_date": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ], "description": "The prediction date.", "title": "Predict Date" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The performance result index.", "title": "Index" } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "results", "runtime", "processed_ts", "predict_date" ], "title": "V1PerformanceBaseModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1PerformanceBaseModel" } }
- field root: List[V1PerformanceBaseModel] [Required]
- pydantic model V1PerformanceModelPage
Bases:
V1PageModelShow JSON schema
{ "title": "V1PerformanceModelPage", "type": "object", "properties": { "items": { "items": { "$ref": "#/$defs/V1PerformanceBaseModel" }, "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": { "V1PerformanceBaseModel": { "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The performance job status.", "title": "Status" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A concatenation of multiple fields.", "title": "Key" }, "job_id": { "description": "The performance job id.", "title": "Job Id", "type": "string" }, "deployment": { "description": "The deployment name.", "title": "Deployment", "type": "string" }, "model_name": { "description": "The name of the model.", "title": "Model Name", "type": "string" }, "model_version": { "description": "The model version.", "title": "Model Version", "type": "string" }, "model_stage": { "description": "The model stage.", "title": "Model Stage", "type": "string" }, "hostname": { "description": "The host name.", "title": "Hostname", "type": "string" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the featureset.", "title": "Feature Set Name" }, "experiment_type": { "description": "The experiment type, either classification or regression.", "title": "Experiment Type", "type": "string" }, "policy_name": { "description": "The name of the performance policy.", "title": "Policy Name", "type": "string" }, "policy_uuid": { "description": "The policy's unique identifier", "title": "Policy Uuid", "type": "string" }, "segment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The segment's unique identifier.", "title": "Segment Id" }, "model_uuid": { "description": "The model's unique identifier.", "title": "Model Uuid", "type": "string" }, "results": { "description": "The performance job results.", "title": "Results" }, "runtime": { "description": "The performance job runtime.", "title": "Runtime", "type": "number" }, "processed_ts": { "description": "The processed timestamp.", "title": "Processed Ts", "type": "number" }, "predict_date": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ], "description": "The prediction date.", "title": "Predict Date" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The performance result index.", "title": "Index" } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "results", "runtime", "processed_ts", "predict_date" ], "title": "V1PerformanceBaseModel", "type": "object" } }, "required": [ "items" ] }
- field items: List[V1PerformanceBaseModel] [Required]
- pydantic model V1PerformancePageSearch
Bases:
V1PageSearch,V1PerformanceSearchShow JSON schema
{ "title": "V1PerformancePageSearch", "type": "object", "properties": { "indices": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of indices to search for.", "title": "Indices" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of job_ids to search for.", "title": "Job Ids" }, "feature_set_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of feature set names to search for.", "title": "Feature Set Names" }, "deployments": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of deployment names to search for.", "title": "Deployments" }, "model_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of model names to search for.", "title": "Model Names" }, "model_versions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of model versions to search for.", "title": "Model Versions" }, "model_stages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of model stages to search for.", "title": "Model Stages" }, "experiment_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of experiment types to search for.", "title": "Experiment Types" }, "hostnames": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of hostnames to search for.", "title": "Hostnames" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of statuses to search for.", "title": "Statuses" }, "policy_uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of policy unique identifiers to search for.", "title": "Policy Uuids" }, "policy_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of policy names to search for.", "title": "Policy Names" }, "segment_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of segment unique identifiers to search for.", "title": "Segment Ids" }, "model_uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of model unique identifiers to search for.", "title": "Model Uuids" }, "runtimes": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of runtimes to search for.", "title": "Runtimes" }, "results": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of results to search for.", "title": "Results" }, "processed_tss": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of processed timestamps to search for.", "title": "Processed Tss" }, "predict_dates": { "anyOf": [ { "items": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of predict dates to search for.", "title": "Predict Dates" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of keys to search for.", "title": "Keys" }, "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" } }, "$defs": { "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": { "indices": [ 1, 2 ], "page": 1, "page_size": 100, "policy_uuids": [ "07f69488-f8a6-4e40-a294-5c2d2bfda64b" ] } }
- Config:
protected_namespaces: tuple = ()
json_schema_extra: dict = {‘example’: {‘page’: 1, ‘page_size’: 100, ‘indices’: [1, 2], ‘policy_uuids’: [‘07f69488-f8a6-4e40-a294-5c2d2bfda64b’]}}
- Fields:
- pydantic model V1PerformanceSearch
Bases:
BaseModelShow JSON schema
{ "title": "V1PerformanceSearch", "type": "object", "properties": { "indices": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of indices to search for.", "title": "Indices" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of job_ids to search for.", "title": "Job Ids" }, "feature_set_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of feature set names to search for.", "title": "Feature Set Names" }, "deployments": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of deployment names to search for.", "title": "Deployments" }, "model_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of model names to search for.", "title": "Model Names" }, "model_versions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of model versions to search for.", "title": "Model Versions" }, "model_stages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of model stages to search for.", "title": "Model Stages" }, "experiment_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of experiment types to search for.", "title": "Experiment Types" }, "hostnames": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of hostnames to search for.", "title": "Hostnames" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of statuses to search for.", "title": "Statuses" }, "policy_uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of policy unique identifiers to search for.", "title": "Policy Uuids" }, "policy_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of policy names to search for.", "title": "Policy Names" }, "segment_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of segment unique identifiers to search for.", "title": "Segment Ids" }, "model_uuids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of model unique identifiers to search for.", "title": "Model Uuids" }, "runtimes": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of runtimes to search for.", "title": "Runtimes" }, "results": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of results to search for.", "title": "Results" }, "processed_tss": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of processed timestamps to search for.", "title": "Processed Tss" }, "predict_dates": { "anyOf": [ { "items": { "anyOf": [ { "type": "number" }, { "format": "date-time", "type": "string" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of predict dates to search for.", "title": "Predict Dates" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of keys to search for.", "title": "Keys" } } }
- Config:
protected_namespaces: tuple = ()
- Fields:
- field deployments: List[str] | None = None
The list of deployment names to search for.
- field experiment_types: List[str] | None = None
The list of experiment types to search for.
- field feature_set_names: List[str] | None = None
The list of feature set names to search for.
- field hostnames: List[str] | None = None
The list of hostnames to search for.
- field indices: List[int] | None = None
List of indices to search for.
- field job_ids: List[str] | None = None
The list of job_ids to search for.
- field keys: List[str] | None = None
The list of keys to search for.
- field model_names: List[str] | None = None
The list of model names to search for.
- field model_stages: List[str] | None = None
The list of model stages to search for.
- field model_uuids: List[str] | None = None
The list of model unique identifiers to search for.
- field model_versions: List[str] | None = None
The list of model versions to search for.
- field policy_names: List[str] | None = None
The list of policy names to search for.
- field policy_uuids: List[str] | None = None
The list of policy unique identifiers to search for.
- field predict_dates: List[float | datetime] | None = None
The list of predict dates to search for.
- field processed_tss: List[float] | None = None
The list of processed timestamps to search for.
- field results: List[Any] | None = None
The list of results to search for.
- field runtimes: List[float] | None = None
The list of runtimes to search for.
- field segment_ids: List[int] | None = None
The list of segment unique identifiers to search for.
- field statuses: List[str] | None = None
The list of statuses to search for.
- pydantic model V1PerformanceUpdatableModel
Bases:
BaseModelShow JSON schema
{ "title": "V1PerformanceUpdatableModel", "type": "object", "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The performance job status.", "title": "Status" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A concatenation of multiple fields.", "title": "Key" } } }
- Fields:
- field key: str | None = None
A concatenation of multiple fields.
- field status: str | None = None
The performance job status.
- pydantic model V1PerformanceUpdateModel
Bases:
V1PerformanceUpdatableModelShow JSON schema
{ "title": "V1PerformanceUpdateModel", "type": "object", "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The performance job status.", "title": "Status" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A concatenation of multiple fields.", "title": "Key" }, "index": { "description": "", "title": "Index", "type": "integer" } }, "required": [ "index" ] }
- Fields:
- field index: int [Required]
- pydantic model V1PerformanceUpdateModelList
Bases:
RootModelShow JSON schema
{ "title": "V1PerformanceUpdateModelList", "type": "array", "$defs": { "V1PerformanceUpdateModel": { "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The performance job status.", "title": "Status" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A concatenation of multiple fields.", "title": "Key" }, "index": { "description": "", "title": "Index", "type": "integer" } }, "required": [ "index" ], "title": "V1PerformanceUpdateModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1PerformanceUpdateModel" } }
- field root: List[V1PerformanceUpdateModel] [Required]
vianops_client.models.riskstore.uncertainty
- pydantic model V1UncertaintyModel
Bases:
V1UncertaintyModelSearchShow JSON schema
{ "title": "V1UncertaintyModel", "type": "object", "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Feature Set Name" }, "experiment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Experiment Type" }, "experiment_metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Experiment Metric" }, "target_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Column" }, "categorical_columns": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Categorical Columns" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "results": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "title": "Results" } } }
- Config:
from_attributes: bool = True
- Fields:
- field index: int | None = None
- field results: dict | None = None
- pydantic model V1UncertaintyModelList
Bases:
RootModelShow JSON schema
{ "title": "V1UncertaintyModelList", "type": "array", "$defs": { "V1UncertaintyModel": { "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Feature Set Name" }, "experiment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Experiment Type" }, "experiment_metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Experiment Metric" }, "target_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Column" }, "categorical_columns": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Categorical Columns" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "results": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "title": "Results" } }, "title": "V1UncertaintyModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1UncertaintyModel" } }
- field root: List[V1UncertaintyModel] [Required]
- pydantic model V1UncertaintyModelPage
Bases:
PageModelShow JSON schema
{ "title": "V1UncertaintyModelPage", "type": "object", "properties": { "items": { "default": [], "items": { "$ref": "#/$defs/V1UncertaintyModel" }, "title": "Items", "type": "array" }, "current_page": { "default": 0, "title": "Current Page", "type": "integer" }, "page_size": { "default": 0, "title": "Page Size", "type": "integer" }, "previous_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Previous Page" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Next Page" }, "has_previous": { "default": false, "title": "Has Previous", "type": "boolean" }, "previous_items": { "default": 0, "title": "Previous Items", "type": "integer" }, "has_next": { "default": false, "title": "Has Next", "type": "boolean" }, "total": { "default": 0, "title": "Total", "type": "integer" }, "pages": { "default": 0, "title": "Pages", "type": "integer" } }, "$defs": { "V1UncertaintyModel": { "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Feature Set Name" }, "experiment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Experiment Type" }, "experiment_metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Experiment Metric" }, "target_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Column" }, "categorical_columns": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Categorical Columns" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "results": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "title": "Results" } }, "title": "V1UncertaintyModel", "type": "object" } } }
- field items: List[V1UncertaintyModel] = []
- pydantic model V1UncertaintyModelSearch
Bases:
BaseModelShow JSON schema
{ "title": "V1UncertaintyModelSearch", "type": "object", "properties": { "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Job Id" }, "feature_set_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Feature Set Name" }, "experiment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Experiment Type" }, "experiment_metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Experiment Metric" }, "target_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Column" }, "categorical_columns": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Categorical Columns" }, "runtime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Runtime" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" } } }
- Fields:
- field categorical_columns: str | None = None
- field experiment_metric: str | None = None
- field experiment_type: str | None = None
- field feature_set_name: str | None = None
- field job_id: str | None = None
- field key: str | None = None
- field runtime: float | None = None
- field target_column: str | None = None
- pydantic model V1UncertaintyPolicyConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1UncertaintyPolicyConfig", "type": "object", "properties": { "deployment_name": { "title": "Deployment Name", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "cron": { "title": "Cron", "type": "string" }, "uncertainty_policies": { "title": "Uncertainty Policies" } }, "required": [ "deployment_name", "model_name", "model_version", "cron", "uncertainty_policies" ] }
- Config:
protected_namespaces: tuple = ()
- Fields:
- field cron: str [Required]
- field deployment_name: str [Required]
- field model_name: str [Required]
- field model_version: str [Required]
- field uncertainty_policies: Any [Required]
vianops_client.api.riskstore.model_metrics
- class V1ModelMetricCategory(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
str,Enum- CUSTOM = 'custom'
- LOWER_LEVEL = 'lower_level'
- STANDARD = 'standard'
- class V1ModelMetricLanguage(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
str,Enum- PYTHON = 'python'
- PY_STATEMENT = 'py_statement'
- SQL = 'SQL'
- pydantic model V1ModelMetricPythonConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricPythonConfig", "type": "object", "properties": { "classname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Classname with full package location e.g rootpackage.chhildpackage.ClassName", "title": "Classname" }, "module": { "description": "module from class to be imported", "title": "Module", "type": "string" }, "method": { "description": "Method to be executed", "title": "Method", "type": "string" }, "init_params": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "params required by method", "title": "Init Params" } }, "required": [ "module", "method" ] }
- field classname: str | None = None
Classname with full package location e.g rootpackage.chhildpackage.ClassName
- field init_params: dict | None = None
params required by method
- field method: str [Required]
Method to be executed
- field module: str [Required]
module from class to be imported
- pydantic model V1ModelMetricSearch
Bases:
V1PageSearchShow JSON schema
{ "title": "V1ModelMetricSearch", "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/V1ModelMetricsFilters", "description": "Specifies different condition(s) for filtering the results." } }, "$defs": { "V1ModelMetricTags": { "properties": { "for_display": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Display" }, "is_metric_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "title": "Is Metric Of Interest" }, "for_custom_definition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Custom Definition" }, "is_percent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "title": "Is Percent" }, "lower_is_better": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "title": "Lower Is Better" }, "needs_predict_proba": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "title": "Needs Predict Proba" }, "needs_class_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "title": "Needs Class Of Interest" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Task type. Supported values: `benchmarking_structured`, `monitoring`", "title": "Task Type" } }, "title": "V1ModelMetricTags", "type": "object" }, "V1ModelMetricsFilters": { "examples": [ { "names": [ "Example Metric" ], "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 metric uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric names for this operation.", "title": "Names" }, "languages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of languages for this operation.", "title": "Languages" }, "metric_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric types for this operation.", "title": "Metric Types" }, "experiment_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of experiment types for this operation.", "title": "Experiment Types" }, "abbreviations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of abbreviations for this operation.", "title": "Abbreviations" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of alternative names for this operation.", "title": "Alt Names" }, "full_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of full names for this operation.", "title": "Full Names" }, "metric_categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric categories for this operation.", "title": "Metric Categories" }, "metric_tags": { "anyOf": [ { "items": { "$ref": "#/$defs/V1ModelMetricTags" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric tags for this operation.", "title": "Metric Tags" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of statuses for this operation.", "title": "Statuses" } }, "title": "V1ModelMetricsFilters", "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 model metrics" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] }, "order": [ { "direction": "DESC", "field": "metric_name" } ], "page": 1, "page_size": 100, "search": "vianai" }, "required": [ "filters" ] }
- Config:
json_schema_extra: dict = {‘example’: {‘page’: 1, ‘page_size’: 100, ‘order’: [{‘field’: ‘metric_name’, ‘direction’: ‘DESC’}], ‘search’: ‘vianai’, ‘filters’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example model metrics’]}}}
- Fields:
- field filters: V1ModelMetricsFilters [Required]
Specifies different condition(s) for filtering the results.
- pydantic model V1ModelMetricTags
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricTags", "type": "object", "properties": { "for_display": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Display" }, "is_metric_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "title": "Is Metric Of Interest" }, "for_custom_definition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Custom Definition" }, "is_percent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "title": "Is Percent" }, "lower_is_better": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "title": "Lower Is Better" }, "needs_predict_proba": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "title": "Needs Predict Proba" }, "needs_class_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "title": "Needs Class Of Interest" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Task type. Supported values: `benchmarking_structured`, `monitoring`", "title": "Task Type" } } }
- Fields:
- field for_custom_definition: bool | None = True
for user created custom metric
- field for_display: bool | None = True
for user created custom metric
- field is_metric_of_interest: bool | None = False
If true, this is the metric of interest; otherwise, false (the default, not the metric of interest).
- field is_percent: bool | None = False
If true, this is a percentage value; otherwise, false (the default, this is a numeric value).
- field lower_is_better: bool | None = False
If true, when this metric is evaluated, lower values are better; otherwise, false (the default value, higher values are better).
- field needs_class_of_interest: bool | None = False
If true, the metric needs class of interest; otherwise, false (the default, no need for class of interest).
- field needs_predict_proba: bool | None = False
If true, the metric needs predict probability calculated; otherwise, false (the default, no predict probability needed).
- field task_type: str | None = None
Task type. Supported values: benchmarking_structured, monitoring
- pydantic model V1ModelMetricsBaseModel
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsBaseModel", "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the metric.", "title": "Description" }, "abbreviation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Abbreviation for the metric name.", "title": "Abbreviation" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Alternate names for the metric.", "title": "Alt Names" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full name of metric", "title": "Full Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": false, "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "title": "Status" }, "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 metric", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metric", "title": "Modified By" } }, "example": { "abbreviation": "Abbreviation of metric", "alt_names": [ "Alternative names for metric" ], "definition": "Metric definition", "description": "Metric description", "experiment_type": "regression", "full_name": "Metric full name", "language": "python", "metric_name": "Metric name", "metric_type": "drift-prediction", "status": "active" } }
- Config:
from_attributes: bool = True
json_schema_extra: dict = {‘example’: {‘metric_name’: ‘Metric name’, ‘description’: ‘Metric description’, ‘language’: ‘python’, ‘metric_type’: ‘drift-prediction’, ‘experiment_type’: ‘regression’, ‘definition’: ‘Metric definition’, ‘abbreviation’: ‘Abbreviation of metric’, ‘alt_names’: [‘Alternative names for metric’], ‘full_name’: ‘Metric full name’, ‘status’: ‘active’}}
- Fields:
- field abbreviation: str | None = None
Abbreviation for the metric name.
- field alt_names: List[str] | None = None
Alternate names for the metric.
- field created_by: str | None = None
User who created the metric
- field created_ts: datetime | None = None
Unix time in milliseconds generated at creation time.
- field description: str | None = None
Description of the metric.
- field full_name: str | None = None
Full name of metric
- field modified_by: str | None = None
User who modified the metric
- field modified_ts: datetime | None = None
Unix time in milliseconds generated at last modification time.
- field status: str | None = False
Current status of the metric. This field is case-insensitive. Possible values: active`(default), `inactive , archived, deleted.
- pydantic model V1ModelMetricsBaseModelList
Bases:
RootModelShow JSON schema
{ "title": "V1ModelMetricsBaseModelList", "type": "array", "$defs": { "V1ModelMetricsBaseModel": { "example": { "abbreviation": "Abbreviation of metric", "alt_names": [ "Alternative names for metric" ], "definition": "Metric definition", "description": "Metric description", "experiment_type": "regression", "full_name": "Metric full name", "language": "python", "metric_name": "Metric name", "metric_type": "drift-prediction", "status": "active" }, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the metric.", "title": "Description" }, "abbreviation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Abbreviation for the metric name.", "title": "Abbreviation" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Alternate names for the metric.", "title": "Alt Names" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full name of metric", "title": "Full Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": false, "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "title": "Status" }, "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 metric", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metric", "title": "Modified By" } }, "title": "V1ModelMetricsBaseModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1ModelMetricsBaseModel" } }
- field root: List[V1ModelMetricsBaseModel] [Required]
- pydantic model V1ModelMetricsFilters
Bases:
V1FiltersCommonShow JSON schema
{ "title": "V1ModelMetricsFilters", "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 metric uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric names for this operation.", "title": "Names" }, "languages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of languages for this operation.", "title": "Languages" }, "metric_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric types for this operation.", "title": "Metric Types" }, "experiment_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of experiment types for this operation.", "title": "Experiment Types" }, "abbreviations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of abbreviations for this operation.", "title": "Abbreviations" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of alternative names for this operation.", "title": "Alt Names" }, "full_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of full names for this operation.", "title": "Full Names" }, "metric_categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric categories for this operation.", "title": "Metric Categories" }, "metric_tags": { "anyOf": [ { "items": { "$ref": "#/$defs/V1ModelMetricTags" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric tags for this operation.", "title": "Metric Tags" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of statuses for this operation.", "title": "Statuses" } }, "$defs": { "V1ModelMetricTags": { "properties": { "for_display": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Display" }, "is_metric_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "title": "Is Metric Of Interest" }, "for_custom_definition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Custom Definition" }, "is_percent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "title": "Is Percent" }, "lower_is_better": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "title": "Lower Is Better" }, "needs_predict_proba": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "title": "Needs Predict Proba" }, "needs_class_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "title": "Needs Class Of Interest" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Task type. Supported values: `benchmarking_structured`, `monitoring`", "title": "Task Type" } }, "title": "V1ModelMetricTags", "type": "object" } }, "examples": [ { "names": [ "Example Metric" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] } ] }
- Config:
populate_by_name: bool = True
alias_generator: function = <function V1ModelMetricsFilters.<lambda> at 0x7f98c4e8f9c0>
json_schema_extra: dict = {‘examples’: [{‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example Metric’]}]}
- Fields:
- field abbreviation: List[str] | None = None (alias 'abbreviations')
List of abbreviations for this operation.
- field alt_names: List[str] | None = None
List of alternative names for this operation.
- field experiment_type: List[str] | None = None (alias 'experiment_types')
List of experiment types for this operation.
- field full_name: List[str] | None = None (alias 'full_names')
List of full names for this operation.
- field language: List[str] | None = None (alias 'languages')
List of languages for this operation.
- field metric_category: List[str] | None = None (alias 'metric_categories')
List of metric categories for this operation.
- field metric_name: List[str] | None = None (alias 'names')
List of metric names for this operation.
- field metric_tags: List[V1ModelMetricTags] | None = None
List of metric tags for this operation.
- field metric_type: List[str] | None = None (alias 'metric_types')
List of metric types for this operation.
- field status: List[str] | None = None (alias 'statuses')
List of statuses for this operation.
- field uuid: List[str] | None = None (alias 'uuids')
List of metric uuids for this operation.
- pydantic model V1ModelMetricsModel
Bases:
V1ModelMetricsBaseModelAdds one or more model metrics.
Show JSON schema
{ "title": "V1ModelMetricsModel", "description": "Adds one or more model metrics.", "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the metric.", "title": "Description" }, "abbreviation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Abbreviation for the metric name.", "title": "Abbreviation" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Alternate names for the metric.", "title": "Alt Names" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full name of metric", "title": "Full Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": false, "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "title": "Status" }, "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 metric", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metric", "title": "Modified By" }, "metric_name": { "description": "Metric name", "title": "Metric Name", "type": "string" }, "language": { "$ref": "#/$defs/V1ModelMetricLanguage", "description": "Language of metric definition" }, "metric_type": { "$ref": "#/$defs/V1ModelMetricType", "description": "Metric type" }, "experiment_type": { "$ref": "#/$defs/V1ModelMetricExperimentType", "description": "Metric experiment type" }, "definition": { "anyOf": [ { "$ref": "#/$defs/V1ModelMetricPythonConfig" }, { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metric definition", "title": "Definition" }, "uuid": { "anyOf": [ { "type": "string" }, { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the Metric.", "title": "Uuid" }, "metric_category": { "$ref": "#/$defs/V1ModelMetricCategory", "description": "Metric category" }, "metric_tags": { "$ref": "#/$defs/V1ModelMetricTags", "description": "Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest" } }, "$defs": { "V1ModelMetricCategory": { "enum": [ "standard", "custom", "lower_level" ], "title": "V1ModelMetricCategory", "type": "string" }, "V1ModelMetricExperimentType": { "enum": [ "regression", "binary_classification", "multiclass_classification", "multilabel_classification", "ranking", "clustering", "LLM" ], "title": "V1ModelMetricExperimentType", "type": "string" }, "V1ModelMetricLanguage": { "enum": [ "python", "SQL", "py_statement" ], "title": "V1ModelMetricLanguage", "type": "string" }, "V1ModelMetricPythonConfig": { "properties": { "classname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Classname with full package location e.g rootpackage.chhildpackage.ClassName", "title": "Classname" }, "module": { "description": "module from class to be imported", "title": "Module", "type": "string" }, "method": { "description": "Method to be executed", "title": "Method", "type": "string" }, "init_params": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "params required by method", "title": "Init Params" } }, "required": [ "module", "method" ], "title": "V1ModelMetricPythonConfig", "type": "object" }, "V1ModelMetricTags": { "properties": { "for_display": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Display" }, "is_metric_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "title": "Is Metric Of Interest" }, "for_custom_definition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Custom Definition" }, "is_percent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "title": "Is Percent" }, "lower_is_better": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "title": "Lower Is Better" }, "needs_predict_proba": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "title": "Needs Predict Proba" }, "needs_class_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "title": "Needs Class Of Interest" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Task type. Supported values: `benchmarking_structured`, `monitoring`", "title": "Task Type" } }, "title": "V1ModelMetricTags", "type": "object" }, "V1ModelMetricType": { "enum": [ "model_performance", "drift-feature", "drift-prediction", "data-profiling", "fairness-bias", "explainability", "outliers", "uncertainty" ], "title": "V1ModelMetricType", "type": "string" } }, "example": { "abbreviation": "MAPE", "alt_names": [], "definition": "np.mean(np.abs(y_true - y_pred) / y_true) * 100", "description": "Calculates the Mean Absolute Percentage Error (MAPE) between the true and predicted values.", "experiment_type": "regression", "full_name": "Mean Absolute Percentage Error", "language": "py_statement", "metric_category": "custom", "metric_name": "MAPE", "metric_tags": { "is_metric_of_interest": false, "is_percent": false, "lower_is_better": true, "needs_predict_proba": false }, "metric_type": "model_performance", "status": "active" }, "required": [ "metric_name", "language", "metric_type", "experiment_type", "metric_category", "metric_tags" ] }
- Config:
from_attributes: bool = True
json_schema_extra: dict = {‘example’: {‘metric_name’: ‘MAPE’, ‘description’: ‘Calculates the Mean Absolute Percentage Error (MAPE) between the true and predicted values.’, ‘language’: ‘py_statement’, ‘metric_type’: ‘model_performance’, ‘experiment_type’: ‘regression’, ‘definition’: ‘np.mean(np.abs(y_true - y_pred) / y_true) * 100’, ‘abbreviation’: ‘MAPE’, ‘status’: ‘active’, ‘alt_names’: [], ‘metric_category’: ‘custom’, ‘full_name’: ‘Mean Absolute Percentage Error’, ‘metric_tags’: {‘lower_is_better’: True, ‘needs_predict_proba’: False, ‘is_metric_of_interest’: False, ‘is_percent’: False}}}
- Fields:
definition (vianops_client.models.riskstore.model_metrics.V1ModelMetricPythonConfig | str | None)experiment_type (vianops_client.models.riskstore.model_metrics.V1ModelMetricExperimentType)language (vianops_client.models.riskstore.model_metrics.V1ModelMetricLanguage)metric_category (vianops_client.models.riskstore.model_metrics.V1ModelMetricCategory)metric_tags (vianops_client.models.riskstore.model_metrics.V1ModelMetricTags)metric_type (vianops_client.models.riskstore.model_metrics.V1ModelMetricType)
- field definition: V1ModelMetricPythonConfig | str | None = None
Metric definition
- field experiment_type: V1ModelMetricExperimentType [Required]
Metric experiment type
- field language: V1ModelMetricLanguage [Required]
Language of metric definition
- field metric_category: V1ModelMetricCategory [Required]
Metric category
- field metric_name: str [Required]
Metric name
- field metric_tags: V1ModelMetricTags [Required]
Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest
- field metric_type: V1ModelMetricType [Required]
Metric type
- field uuid: str | UUID | None = None
UUID of the Metric.
- pydantic model V1ModelMetricsModelList
Bases:
RootModelShow JSON schema
{ "title": "V1ModelMetricsModelList", "type": "array", "$defs": { "V1ModelMetricCategory": { "enum": [ "standard", "custom", "lower_level" ], "title": "V1ModelMetricCategory", "type": "string" }, "V1ModelMetricExperimentType": { "enum": [ "regression", "binary_classification", "multiclass_classification", "multilabel_classification", "ranking", "clustering", "LLM" ], "title": "V1ModelMetricExperimentType", "type": "string" }, "V1ModelMetricLanguage": { "enum": [ "python", "SQL", "py_statement" ], "title": "V1ModelMetricLanguage", "type": "string" }, "V1ModelMetricPythonConfig": { "properties": { "classname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Classname with full package location e.g rootpackage.chhildpackage.ClassName", "title": "Classname" }, "module": { "description": "module from class to be imported", "title": "Module", "type": "string" }, "method": { "description": "Method to be executed", "title": "Method", "type": "string" }, "init_params": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "params required by method", "title": "Init Params" } }, "required": [ "module", "method" ], "title": "V1ModelMetricPythonConfig", "type": "object" }, "V1ModelMetricTags": { "properties": { "for_display": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Display" }, "is_metric_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "title": "Is Metric Of Interest" }, "for_custom_definition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Custom Definition" }, "is_percent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "title": "Is Percent" }, "lower_is_better": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "title": "Lower Is Better" }, "needs_predict_proba": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "title": "Needs Predict Proba" }, "needs_class_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "title": "Needs Class Of Interest" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Task type. Supported values: `benchmarking_structured`, `monitoring`", "title": "Task Type" } }, "title": "V1ModelMetricTags", "type": "object" }, "V1ModelMetricType": { "enum": [ "model_performance", "drift-feature", "drift-prediction", "data-profiling", "fairness-bias", "explainability", "outliers", "uncertainty" ], "title": "V1ModelMetricType", "type": "string" }, "V1ModelMetricsModel": { "description": "Adds one or more model metrics.", "example": { "abbreviation": "MAPE", "alt_names": [], "definition": "np.mean(np.abs(y_true - y_pred) / y_true) * 100", "description": "Calculates the Mean Absolute Percentage Error (MAPE) between the true and predicted values.", "experiment_type": "regression", "full_name": "Mean Absolute Percentage Error", "language": "py_statement", "metric_category": "custom", "metric_name": "MAPE", "metric_tags": { "is_metric_of_interest": false, "is_percent": false, "lower_is_better": true, "needs_predict_proba": false }, "metric_type": "model_performance", "status": "active" }, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the metric.", "title": "Description" }, "abbreviation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Abbreviation for the metric name.", "title": "Abbreviation" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Alternate names for the metric.", "title": "Alt Names" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full name of metric", "title": "Full Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": false, "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "title": "Status" }, "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 metric", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metric", "title": "Modified By" }, "metric_name": { "description": "Metric name", "title": "Metric Name", "type": "string" }, "language": { "$ref": "#/$defs/V1ModelMetricLanguage", "description": "Language of metric definition" }, "metric_type": { "$ref": "#/$defs/V1ModelMetricType", "description": "Metric type" }, "experiment_type": { "$ref": "#/$defs/V1ModelMetricExperimentType", "description": "Metric experiment type" }, "definition": { "anyOf": [ { "$ref": "#/$defs/V1ModelMetricPythonConfig" }, { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metric definition", "title": "Definition" }, "uuid": { "anyOf": [ { "type": "string" }, { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the Metric.", "title": "Uuid" }, "metric_category": { "$ref": "#/$defs/V1ModelMetricCategory", "description": "Metric category" }, "metric_tags": { "$ref": "#/$defs/V1ModelMetricTags", "description": "Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest" } }, "required": [ "metric_name", "language", "metric_type", "experiment_type", "metric_category", "metric_tags" ], "title": "V1ModelMetricsModel", "type": "object" } }, "items": { "$ref": "#/$defs/V1ModelMetricsModel" } }
- field root: List[V1ModelMetricsModel] [Required]
- pydantic model V1ModelMetricsModelPage
Bases:
V1PageModelShow JSON schema
{ "title": "V1ModelMetricsModelPage", "type": "object", "properties": { "items": { "default": [], "description": "Model metrics returned by search in page.", "items": { "$ref": "#/$defs/V1ModelMetricsModel" }, "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": { "V1ModelMetricCategory": { "enum": [ "standard", "custom", "lower_level" ], "title": "V1ModelMetricCategory", "type": "string" }, "V1ModelMetricExperimentType": { "enum": [ "regression", "binary_classification", "multiclass_classification", "multilabel_classification", "ranking", "clustering", "LLM" ], "title": "V1ModelMetricExperimentType", "type": "string" }, "V1ModelMetricLanguage": { "enum": [ "python", "SQL", "py_statement" ], "title": "V1ModelMetricLanguage", "type": "string" }, "V1ModelMetricPythonConfig": { "properties": { "classname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Classname with full package location e.g rootpackage.chhildpackage.ClassName", "title": "Classname" }, "module": { "description": "module from class to be imported", "title": "Module", "type": "string" }, "method": { "description": "Method to be executed", "title": "Method", "type": "string" }, "init_params": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "description": "params required by method", "title": "Init Params" } }, "required": [ "module", "method" ], "title": "V1ModelMetricPythonConfig", "type": "object" }, "V1ModelMetricTags": { "properties": { "for_display": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Display" }, "is_metric_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "title": "Is Metric Of Interest" }, "for_custom_definition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Custom Definition" }, "is_percent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "title": "Is Percent" }, "lower_is_better": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "title": "Lower Is Better" }, "needs_predict_proba": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "title": "Needs Predict Proba" }, "needs_class_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "title": "Needs Class Of Interest" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Task type. Supported values: `benchmarking_structured`, `monitoring`", "title": "Task Type" } }, "title": "V1ModelMetricTags", "type": "object" }, "V1ModelMetricType": { "enum": [ "model_performance", "drift-feature", "drift-prediction", "data-profiling", "fairness-bias", "explainability", "outliers", "uncertainty" ], "title": "V1ModelMetricType", "type": "string" }, "V1ModelMetricsModel": { "description": "Adds one or more model metrics.", "example": { "abbreviation": "MAPE", "alt_names": [], "definition": "np.mean(np.abs(y_true - y_pred) / y_true) * 100", "description": "Calculates the Mean Absolute Percentage Error (MAPE) between the true and predicted values.", "experiment_type": "regression", "full_name": "Mean Absolute Percentage Error", "language": "py_statement", "metric_category": "custom", "metric_name": "MAPE", "metric_tags": { "is_metric_of_interest": false, "is_percent": false, "lower_is_better": true, "needs_predict_proba": false }, "metric_type": "model_performance", "status": "active" }, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the metric.", "title": "Description" }, "abbreviation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Abbreviation for the metric name.", "title": "Abbreviation" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Alternate names for the metric.", "title": "Alt Names" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full name of metric", "title": "Full Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": false, "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "title": "Status" }, "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 metric", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metric", "title": "Modified By" }, "metric_name": { "description": "Metric name", "title": "Metric Name", "type": "string" }, "language": { "$ref": "#/$defs/V1ModelMetricLanguage", "description": "Language of metric definition" }, "metric_type": { "$ref": "#/$defs/V1ModelMetricType", "description": "Metric type" }, "experiment_type": { "$ref": "#/$defs/V1ModelMetricExperimentType", "description": "Metric experiment type" }, "definition": { "anyOf": [ { "$ref": "#/$defs/V1ModelMetricPythonConfig" }, { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metric definition", "title": "Definition" }, "uuid": { "anyOf": [ { "type": "string" }, { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the Metric.", "title": "Uuid" }, "metric_category": { "$ref": "#/$defs/V1ModelMetricCategory", "description": "Metric category" }, "metric_tags": { "$ref": "#/$defs/V1ModelMetricTags", "description": "Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest" } }, "required": [ "metric_name", "language", "metric_type", "experiment_type", "metric_category", "metric_tags" ], "title": "V1ModelMetricsModel", "type": "object" } }, "example": { "current_page": 1, "has_next": false, "has_previous": false, "items": [ { "abbreviation": "Abbreviation of metric", "alt_names": [ "Alternative names for metric" ], "created_by": "user1", "created_ts": 1675292368, "definition": "Metric definition", "description": "Metric description", "experiment_type": "regression", "full_name": "Metric name", "language": "Python", "metric_name": "Metric name 2", "metric_tags": { "is_metric_of_interest": false, "is_percent": false, "is_standard": false, "needs_predict_proba": false }, "metric_type": "drift-feature", "modified_by": "user1", "modified_ts": 1675292368, "status": "active", "uuid": "a09fad35-a841-4869-b812-8acac735c668" } ], "next_page": null, "page_size": 100, "pages": 1, "previous_items": 0, "previous_page": null, "total": 1 } }
- Config:
json_schema_extra: dict = {‘example’: {‘items’: [{‘metric_name’: ‘Metric name 2’, ‘description’: ‘Metric description’, ‘language’: ‘Python’, ‘metric_type’: ‘drift-feature’, ‘experiment_type’: ‘regression’, ‘definition’: ‘Metric definition’, ‘abbreviation’: ‘Abbreviation of metric’, ‘alt_names’: [‘Alternative names for metric’], ‘full_name’: ‘Metric name’, ‘metric_tags’: {‘needs_predict_proba’: False, ‘is_standard’: False, ‘is_metric_of_interest’: False, ‘is_percent’: False}, ‘status’: ‘active’, ‘created_ts’: 1675292368, ‘modified_ts’: 1675292368, ‘created_by’: ‘user1’, ‘modified_by’: ‘user1’, ‘uuid’: ‘a09fad35-a841-4869-b812-8acac735c668’}], ‘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[V1ModelMetricsModel] = []
Model metrics returned by search in page.
- pydantic model V1ModelMetricsUpdates
Bases:
V1ModelMetricsBaseModelShow JSON schema
{ "title": "V1ModelMetricsUpdates", "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metric description", "title": "Description" }, "abbreviation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Abbreviation for the metric name.", "title": "Abbreviation" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Alternate names for the metric.", "title": "Alt Names" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full name of metric", "title": "Full Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": false, "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "title": "Status" }, "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 metric", "title": "Created By" }, "modified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User who modified the metric", "title": "Modified By" }, "metric_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metric name", "title": "Metric Name" }, "language": { "anyOf": [ { "$ref": "#/$defs/V1ModelMetricLanguage" }, { "type": "null" } ], "default": null, "description": "Language of metric definition" }, "metric_type": { "anyOf": [ { "$ref": "#/$defs/V1ModelMetricType" }, { "type": "null" } ], "default": null, "description": "Metric type" }, "experiment_type": { "anyOf": [ { "$ref": "#/$defs/V1ModelMetricExperimentType" }, { "type": "null" } ], "default": null, "description": "Metric experiment type" }, "metric_category": { "anyOf": [ { "$ref": "#/$defs/V1ModelMetricCategory" }, { "type": "null" } ], "default": null, "description": "Metric category" }, "metric_tags": { "anyOf": [ { "$ref": "#/$defs/V1ModelMetricTags" }, { "type": "null" } ], "default": null, "description": "Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest" }, "definition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metric definition", "title": "Definition" }, "filters": { "$ref": "#/$defs/V1ModelMetricsFilters", "description": "Specifies different condition(s) for filtering the results." } }, "$defs": { "V1ModelMetricCategory": { "enum": [ "standard", "custom", "lower_level" ], "title": "V1ModelMetricCategory", "type": "string" }, "V1ModelMetricExperimentType": { "enum": [ "regression", "binary_classification", "multiclass_classification", "multilabel_classification", "ranking", "clustering", "LLM" ], "title": "V1ModelMetricExperimentType", "type": "string" }, "V1ModelMetricLanguage": { "enum": [ "python", "SQL", "py_statement" ], "title": "V1ModelMetricLanguage", "type": "string" }, "V1ModelMetricTags": { "properties": { "for_display": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Display" }, "is_metric_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "title": "Is Metric Of Interest" }, "for_custom_definition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "for user created custom metric", "title": "For Custom Definition" }, "is_percent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "title": "Is Percent" }, "lower_is_better": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "title": "Lower Is Better" }, "needs_predict_proba": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "title": "Needs Predict Proba" }, "needs_class_of_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "title": "Needs Class Of Interest" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Task type. Supported values: `benchmarking_structured`, `monitoring`", "title": "Task Type" } }, "title": "V1ModelMetricTags", "type": "object" }, "V1ModelMetricType": { "enum": [ "model_performance", "drift-feature", "drift-prediction", "data-profiling", "fairness-bias", "explainability", "outliers", "uncertainty" ], "title": "V1ModelMetricType", "type": "string" }, "V1ModelMetricsFilters": { "examples": [ { "names": [ "Example Metric" ], "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 metric uuids for this operation.", "title": "Uuids" }, "names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric names for this operation.", "title": "Names" }, "languages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of languages for this operation.", "title": "Languages" }, "metric_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric types for this operation.", "title": "Metric Types" }, "experiment_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of experiment types for this operation.", "title": "Experiment Types" }, "abbreviations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of abbreviations for this operation.", "title": "Abbreviations" }, "alt_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of alternative names for this operation.", "title": "Alt Names" }, "full_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of full names for this operation.", "title": "Full Names" }, "metric_categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric categories for this operation.", "title": "Metric Categories" }, "metric_tags": { "anyOf": [ { "items": { "$ref": "#/$defs/V1ModelMetricTags" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of metric tags for this operation.", "title": "Metric Tags" }, "statuses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of statuses for this operation.", "title": "Statuses" } }, "title": "V1ModelMetricsFilters", "type": "object" } }, "example": { "description": "Updated metric description", "filters": { "names": [ "Example Metric" ], "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ] }, "metric_name": "Updated metric name" }, "required": [ "filters" ] }
- Config:
from_attributes: bool = True
json_schema_extra: dict = {‘example’: {‘metric_name’: ‘Updated metric name’, ‘description’: ‘Updated metric description’, ‘filters’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example Metric’]}}}
- Fields:
experiment_type (vianops_client.models.riskstore.model_metrics.V1ModelMetricExperimentType | None)filters (vianops_client.models.riskstore.model_metrics.V1ModelMetricsFilters)language (vianops_client.models.riskstore.model_metrics.V1ModelMetricLanguage | None)metric_category (vianops_client.models.riskstore.model_metrics.V1ModelMetricCategory | None)metric_tags (vianops_client.models.riskstore.model_metrics.V1ModelMetricTags | None)metric_type (vianops_client.models.riskstore.model_metrics.V1ModelMetricType | None)
- field definition: str | None = None
Metric definition
- field description: str | None = None
Metric description
- field experiment_type: V1ModelMetricExperimentType | None = None
Metric experiment type
- field filters: V1ModelMetricsFilters [Required]
Specifies different condition(s) for filtering the results.
- field language: V1ModelMetricLanguage | None = None
Language of metric definition
- field metric_category: V1ModelMetricCategory | None = None
Metric category
- field metric_name: str | None = None
Metric name
- field metric_tags: V1ModelMetricTags | None = None
Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest
- field metric_type: V1ModelMetricType | None = None
Metric type