2024-04-23
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.delete
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a NotebookExecutionJob.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the NotebookExecutionJob resource to be deleted.
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$
Path : v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a NotebookExecutionJob.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}
Path : v1beta1/{+name}
Parameters :
view
Description : Optional. The NotebookExecutionJob view. Defaults to BASIC.
Type : string
Enum Descriptions :
Enum :
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$
Description : Required. The name of the NotebookExecutionJob resource.
Location : path
Type : string
Required : Yes
Parameter Order : name
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.list
HTTP Method : GET
Parameters :
parent
Required : Yes
Description : Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
pageToken
Location : query
Type : string
Description : Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
pageSize
Type : integer
Format : int32
Description : Optional. The standard list page size.
Location : query
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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
Location : query
Type : string
filter
Type : string
Location : query
Description : Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
view
Enum Descriptions :
Description : Optional. The NotebookExecutionJob view. Defaults to BASIC.
Type : string
Enum :
Location : query
Path : v1beta1/{+parent}/notebookExecutionJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs
Description : Lists NotebookExecutionJobs in a Location.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.modelMonitors.get
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Required : Yes
Description : Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`
Type : string
Location : path
HTTP Method : GET
Path : v1beta1/{+name}
Description : Gets a ModelMonitor.
▼ ▲ aiplatform.projects.locations.modelMonitors.list
HTTP Method : GET
Description : Lists ModelMonitors in a Location.
Path : v1beta1/{+parent}/modelMonitors
Parameters :
pageToken
Type : string
Description : The standard list page token.
Location : query
filter
Description : The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
readMask
Description : Mask specifying which fields to read.
Location : query
Format : google-fieldmask
Type : string
pageSize
Description : The standard list page size.
Type : integer
Location : query
Format : int32
parent
Description : Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors
▼ ▲ aiplatform.projects.locations.modelMonitors.patch
Parameters :
updateMask
Type : string
Description : Required. Mask specifying which fields to update.
Format : google-fieldmask
Location : query
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Type : string
Description : Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.
Required : Yes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
Description : Updates a ModelMonitor.
HTTP Method : PATCH
Parameter Order : name
▼ ▲ aiplatform.projects.locations.modelMonitors.delete
Path : v1beta1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`
Location : path
force
Location : query
Description : Optional. Force delete the model monitor with schedules.
Type : boolean
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a ModelMonitor.
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}
▼ ▲ aiplatform.projects.locations.modelMonitors.create
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors
HTTP Method : POST
Path : v1beta1/{+parent}/modelMonitors
Description : Creates a ModelMonitor.
Parameters :
modelMonitorId
Type : string
Location : query
Description : Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
parent
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`
▼ ▲ aiplatform.projects.locations.modelMonitors.searchModelMonitoringStats
HTTP Method : POST
Parameter Order : modelMonitor
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringStats
Path : v1beta1/{+modelMonitor}:searchModelMonitoringStats
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Searches Model Monitoring Stats generated within a given time window.
Parameters :
modelMonitor
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Description : Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`
Location : path
Type : string
▼ ▲ aiplatform.projects.locations.modelMonitors.searchModelMonitoringAlerts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringAlerts
Parameters :
modelMonitor
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Description : Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`
Required : Yes
Type : string
HTTP Method : POST
Path : v1beta1/{+modelMonitor}:searchModelMonitoringAlerts
Parameter Order : modelMonitor
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the Model Monitoring alerts.
▼ ▲ aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.create
HTTP Method : POST
Parameter Order : parent
Description : Creates a ModelMonitoringJob.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
modelMonitoringJobId
Description : Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
Type : string
Location : query
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Required : Yes
Description : Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
Path : v1beta1/{+parent}/modelMonitoringJobs
▼ ▲ aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.get
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}
HTTP Method : GET
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$
Location : path
Description : Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`
Path : v1beta1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a ModelMonitoringJob.
▼ ▲ aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.list
Path : v1beta1/{+parent}/modelMonitoringJobs
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs
HTTP Method : GET
Parameters :
pageToken
Description : The standard list page token.
Location : query
Type : string
parent
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Description : Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`
pageSize
Type : integer
Format : int32
Description : The standard list page size.
Location : query
filter
Type : string
Location : query
Description : The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
readMask
Description : Mask specifying which fields to read
Location : query
Format : google-fieldmask
Type : string
Description : Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs`
▼ ▲ aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.delete
Parameter Order : name
Description : Deletes a ModelMonitoringJob.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}
Path : v1beta1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`
HTTP Method : DELETE
▼ ▲ aiplatform.projects.locations.endpoints.chat.completions
Parameter Order : endpoint
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions
Path : v1beta1/{+endpoint}/chat/completions
Parameters :
endpoint
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type : string
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/openapi`
Location : path
Required : Yes
Description : Exposes an OpenAI-compatible endpoint for chat completions.