Vertex AI API (aiplatform:v1beta1)

▼ ▲ aiplatform.projects.locations.endpoints.predictLongRunning

Path: v1beta1/{+endpoint}:predictLongRunning

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning

HTTP Method: POST

Parameters:

endpoint

Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: endpoint

Scopes:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

▼ ▲ aiplatform.projects.locations.endpoints.fetchPredictOperation

Path: v1beta1/{+endpoint}:fetchPredictOperation

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation

HTTP Method: POST

Parameters:

endpoint

Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: endpoint

Scopes:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

Description: Fetch an asynchronous online prediction operation.

▼ ▲ aiplatform.projects.locations.publishers.models.predictLongRunning

Path: v1beta1/{+endpoint}:predictLongRunning

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning

HTTP Method: POST

Parameters:

endpoint

Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

Pattern: ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: endpoint

Scopes:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

▼ ▲ aiplatform.projects.locations.publishers.models.fetchPredictOperation

Path: v1beta1/{+endpoint}:fetchPredictOperation

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation

HTTP Method: POST

Parameters:

endpoint

Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

Pattern: ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: endpoint

Scopes:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

Description: Fetch an asynchronous online prediction operation.

▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.create

Path: v1beta1/{+parent}/featureMonitors

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors

HTTP Method: POST

Parameters:

parent

Description: Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`

Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$

Location: path

Required: Yes

Type: string

featureMonitorId

Description: Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup.

Location: query

Type: string

Parameter Order: parent

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: Creates a new FeatureMonitor in a given project, location and FeatureGroup.

▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.get

Path: v1beta1/{+name}

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}

HTTP Method: GET

Parameters:

name

Description: Required. The name of the FeatureMonitor resource.

Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: name

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: Gets details of a single FeatureMonitor.

▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.list

Path: v1beta1/{+parent}/featureMonitors

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors

HTTP Method: GET

Parameters:

parent

Description: Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`

Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$

Location: path

Required: Yes

Type: string

filter

Description: Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod".

Location: query

Type: string

pageSize

Description: Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

Location: query

Type: integer

Format: int32

pageToken

Description: Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.

Location: query

Type: string

orderBy

Description: 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` * `update_time`

Location: query

Type: string

Parameter Order: parent

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: Lists FeatureGroups in a given project and location.

▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.delete

Path: v1beta1/{+name}

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}

HTTP Method: DELETE

Parameters:

name

Description: Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`

Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: name

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: Deletes a single FeatureMonitor.

▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create

Path: v1beta1/{+parent}/featureMonitorJobs

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs

HTTP Method: POST

Parameters:

parent

Description: Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`

Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$

Location: path

Required: Yes

Type: string

featureMonitorJobId

Description: Optional. Output only. System-generated ID for feature monitor job.

Location: query

Type: string

Format: int64

Parameter Order: parent

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: Creates a new feature monitor job.

▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get

Path: v1beta1/{+name}

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}

HTTP Method: GET

Parameters:

name

Description: Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`

Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: name

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: Get a feature monitor job.

▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list

Path: v1beta1/{+parent}/featureMonitorJobs

Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs

HTTP Method: GET

Parameters:

parent

Description: Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`

Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$

Location: path

Required: Yes

Type: string

filter

Description: 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.

Location: query

Type: string

pageSize

Description: 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.

Location: query

Type: integer

Format: int32

pageToken

Description: 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.

Location: query

Type: string

orderBy

Description: 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`

Location: query

Type: string

Parameter Order: parent

Scopes: https://www.googleapis.com/auth/cloud-platform

Description: List feature monitor jobs.

▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.get

Parameters:

featureStatsAndAnomalySpec.latestStatsCount

Description: Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.

Location: query

Type: integer

Format: int32

featureStatsAndAnomalySpec.statsTimeRange.startTime

Description: Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

Location: query

Type: string

Format: google-datetime

featureStatsAndAnomalySpec.statsTimeRange.endTime

Description: Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

Location: query

Type: string

Format: google-datetime

▼ ▲ aiplatform.projects.locations.featureGroups.features.get

Parameters:

featureStatsAndAnomalySpec.latestStatsCount

Description: Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.

Location: query

Type: integer

Format: int32

featureStatsAndAnomalySpec.statsTimeRange.startTime

Description: Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

Location: query

Type: string

Format: google-datetime

featureStatsAndAnomalySpec.statsTimeRange.endTime

Description: Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

Location: query

Type: string

Format: google-datetime