1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.projects.html">projects</a> . <a href="aiplatform_v1beta1.projects.locations.html">locations</a> . <a href="aiplatform_v1beta1.projects.locations.featureGroups.html">featureGroups</a> . <a href="aiplatform_v1beta1.projects.locations.featureGroups.featureMonitors.html">featureMonitors</a> . <a href="aiplatform_v1beta1.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.html">featureMonitorJobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, featureMonitorJobId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new feature monitor job.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a feature monitor job.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List feature monitor jobs.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, featureMonitorJobId=None, x__xgafv=None)</code>
<pre>Creates a new feature monitor job.
Args:
parent: string, Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}` (required)
body: object, The request body.
The object takes the form of:
{ # Vertex AI Feature Monitor Job.
"createTime": "A String", # Output only. Timestamp when this FeatureMonitorJob was created. Creation of a FeatureMonitorJob means that the job is pending / waiting for sufficient resources but may not have started running yet.
"description": "A String", # Optional. Description of the FeatureMonitor.
"driftBaseFeatureMonitorJobId": "A String", # Output only. FeatureMonitorJob ID comparing to which the drift is calculated.
"driftBaseSnapshotTime": "A String", # Output only. Data snapshot time comparing to which the drift is calculated.
"featureSelectionConfig": { # Feature selection configuration for the FeatureMonitor. # Output only. Feature selection config used when creating FeatureMonitorJob.
"featureConfigs": [ # Optional. A list of features to be monitored and each feature's drift threshold.
{ # Feature configuration.
"driftThreshold": 3.14, # Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. Must be in range [0, 1).
"featureId": "A String", # Required. The ID of the feature resource. Final component of the Feature's resource name.
},
],
},
"finalStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Final status of the FeatureMonitorJob.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobSummary": { # Summary from the FeatureMonitorJob. # Output only. Summary from the FeatureMonitorJob.
"featureStatsAndAnomalies": [ # Output only. Features and their stats and anomalies
{ # Stats and Anomaly generated by FeatureMonitorJobs. Anomaly only includes Drift.
"distributionDeviation": 3.14, # Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
"driftDetected": True or False, # If set to true, indicates current stats is detected as and comparing with baseline stats.
"driftDetectionThreshold": 3.14, # This is the threshold used when detecting drifts, which is set in FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold
"featureId": "A String", # Feature Id.
"featureMonitorId": "A String", # The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.
"featureMonitorJobId": "A String", # The ID of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.
"featureStats": "", # Feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.
"statsTime": "A String", # The timestamp we take snapshot for feature values to generate stats.
},
],
"totalSlotMs": "A String", # Output only. BigQuery slot milliseconds consumed.
},
"labels": { # Optional. The labels with user-defined metadata to organize your FeatureMonitorJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureMonitor(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`.
"triggerType": "A String", # Output only. Trigger type of the Feature Monitor Job.
}
featureMonitorJobId: string, Optional. Output only. System-generated ID for feature monitor job.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Vertex AI Feature Monitor Job.
"createTime": "A String", # Output only. Timestamp when this FeatureMonitorJob was created. Creation of a FeatureMonitorJob means that the job is pending / waiting for sufficient resources but may not have started running yet.
"description": "A String", # Optional. Description of the FeatureMonitor.
"driftBaseFeatureMonitorJobId": "A String", # Output only. FeatureMonitorJob ID comparing to which the drift is calculated.
"driftBaseSnapshotTime": "A String", # Output only. Data snapshot time comparing to which the drift is calculated.
"featureSelectionConfig": { # Feature selection configuration for the FeatureMonitor. # Output only. Feature selection config used when creating FeatureMonitorJob.
"featureConfigs": [ # Optional. A list of features to be monitored and each feature's drift threshold.
{ # Feature configuration.
"driftThreshold": 3.14, # Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. Must be in range [0, 1).
"featureId": "A String", # Required. The ID of the feature resource. Final component of the Feature's resource name.
},
],
},
"finalStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Final status of the FeatureMonitorJob.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobSummary": { # Summary from the FeatureMonitorJob. # Output only. Summary from the FeatureMonitorJob.
"featureStatsAndAnomalies": [ # Output only. Features and their stats and anomalies
{ # Stats and Anomaly generated by FeatureMonitorJobs. Anomaly only includes Drift.
"distributionDeviation": 3.14, # Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
"driftDetected": True or False, # If set to true, indicates current stats is detected as and comparing with baseline stats.
"driftDetectionThreshold": 3.14, # This is the threshold used when detecting drifts, which is set in FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold
"featureId": "A String", # Feature Id.
"featureMonitorId": "A String", # The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.
"featureMonitorJobId": "A String", # The ID of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.
"featureStats": "", # Feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.
"statsTime": "A String", # The timestamp we take snapshot for feature values to generate stats.
},
],
"totalSlotMs": "A String", # Output only. BigQuery slot milliseconds consumed.
},
"labels": { # Optional. The labels with user-defined metadata to organize your FeatureMonitorJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureMonitor(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`.
"triggerType": "A String", # Output only. Trigger type of the Feature Monitor Job.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get a feature monitor job.
Args:
name: string, Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Vertex AI Feature Monitor Job.
"createTime": "A String", # Output only. Timestamp when this FeatureMonitorJob was created. Creation of a FeatureMonitorJob means that the job is pending / waiting for sufficient resources but may not have started running yet.
"description": "A String", # Optional. Description of the FeatureMonitor.
"driftBaseFeatureMonitorJobId": "A String", # Output only. FeatureMonitorJob ID comparing to which the drift is calculated.
"driftBaseSnapshotTime": "A String", # Output only. Data snapshot time comparing to which the drift is calculated.
"featureSelectionConfig": { # Feature selection configuration for the FeatureMonitor. # Output only. Feature selection config used when creating FeatureMonitorJob.
"featureConfigs": [ # Optional. A list of features to be monitored and each feature's drift threshold.
{ # Feature configuration.
"driftThreshold": 3.14, # Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. Must be in range [0, 1).
"featureId": "A String", # Required. The ID of the feature resource. Final component of the Feature's resource name.
},
],
},
"finalStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Final status of the FeatureMonitorJob.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobSummary": { # Summary from the FeatureMonitorJob. # Output only. Summary from the FeatureMonitorJob.
"featureStatsAndAnomalies": [ # Output only. Features and their stats and anomalies
{ # Stats and Anomaly generated by FeatureMonitorJobs. Anomaly only includes Drift.
"distributionDeviation": 3.14, # Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
"driftDetected": True or False, # If set to true, indicates current stats is detected as and comparing with baseline stats.
"driftDetectionThreshold": 3.14, # This is the threshold used when detecting drifts, which is set in FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold
"featureId": "A String", # Feature Id.
"featureMonitorId": "A String", # The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.
"featureMonitorJobId": "A String", # The ID of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.
"featureStats": "", # Feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.
"statsTime": "A String", # The timestamp we take snapshot for feature values to generate stats.
},
],
"totalSlotMs": "A String", # Output only. BigQuery slot milliseconds consumed.
},
"labels": { # Optional. The labels with user-defined metadata to organize your FeatureMonitorJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureMonitor(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`.
"triggerType": "A String", # Output only. Trigger type of the Feature Monitor Job.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List feature monitor jobs.
Args:
parent: string, Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}` (required)
filter: string, Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be Examples: * `create_time > "2020-01-01"` FeatureMonitorJobs created after 2020-01-01.
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time`
pageSize: integer, Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
pageToken: string, Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for FeatureRegistryService.ListFeatureMonitorJobs.
"featureMonitorJobs": [ # The FeatureMonitorJobs matching the request.
{ # Vertex AI Feature Monitor Job.
"createTime": "A String", # Output only. Timestamp when this FeatureMonitorJob was created. Creation of a FeatureMonitorJob means that the job is pending / waiting for sufficient resources but may not have started running yet.
"description": "A String", # Optional. Description of the FeatureMonitor.
"driftBaseFeatureMonitorJobId": "A String", # Output only. FeatureMonitorJob ID comparing to which the drift is calculated.
"driftBaseSnapshotTime": "A String", # Output only. Data snapshot time comparing to which the drift is calculated.
"featureSelectionConfig": { # Feature selection configuration for the FeatureMonitor. # Output only. Feature selection config used when creating FeatureMonitorJob.
"featureConfigs": [ # Optional. A list of features to be monitored and each feature's drift threshold.
{ # Feature configuration.
"driftThreshold": 3.14, # Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. Must be in range [0, 1).
"featureId": "A String", # Required. The ID of the feature resource. Final component of the Feature's resource name.
},
],
},
"finalStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Final status of the FeatureMonitorJob.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobSummary": { # Summary from the FeatureMonitorJob. # Output only. Summary from the FeatureMonitorJob.
"featureStatsAndAnomalies": [ # Output only. Features and their stats and anomalies
{ # Stats and Anomaly generated by FeatureMonitorJobs. Anomaly only includes Drift.
"distributionDeviation": 3.14, # Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
"driftDetected": True or False, # If set to true, indicates current stats is detected as and comparing with baseline stats.
"driftDetectionThreshold": 3.14, # This is the threshold used when detecting drifts, which is set in FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold
"featureId": "A String", # Feature Id.
"featureMonitorId": "A String", # The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.
"featureMonitorJobId": "A String", # The ID of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.
"featureStats": "", # Feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.
"statsTime": "A String", # The timestamp we take snapshot for feature values to generate stats.
},
],
"totalSlotMs": "A String", # Output only. BigQuery slot milliseconds consumed.
},
"labels": { # Optional. The labels with user-defined metadata to organize your FeatureMonitorJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureMonitor(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`.
"triggerType": "A String", # Output only. Trigger type of the Feature Monitor Job.
},
],
"nextPageToken": "A String", # A token, which can be sent as ListFeatureMonitorJobsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
