Vertex AI API (aiplatform:v1beta1)

2024-04-24

14 new methods | 1 removed method

Additions

    Methods
  • aiplatform.projects.locations.notebookExecutionJobs.delete

      HTTP Method: DELETE

      Parameter Order: name

      Path: v1beta1/{+name}

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}

      Parameters:

        name

          Type: string

          Description: Required. The name of the NotebookExecutionJob resource to be deleted.

          Required: Yes

          Location: path

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

      Description: Deletes a NotebookExecutionJob.

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

  • aiplatform.projects.locations.notebookExecutionJobs.get

      Parameter Order: name

      Parameters:

        name

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

          Required: Yes

          Description: Required. The name of the NotebookExecutionJob resource.

          Location: path

          Type: string

        view

          Location: query

          Description: Optional. The NotebookExecutionJob view. Defaults to BASIC.

          Enum Descriptions:

        • When unspecified, the API defaults to the BASIC view.
        • Includes all fields except for direct notebook inputs.
        • Includes all fields.
        • Type: string

          Enum:

        • NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED
        • NOTEBOOK_EXECUTION_JOB_VIEW_BASIC
        • NOTEBOOK_EXECUTION_JOB_VIEW_FULL

      Path: v1beta1/{+name}

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}

      HTTP Method: GET

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

      Description: Gets a NotebookExecutionJob.

  • aiplatform.projects.locations.notebookExecutionJobs.list

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs

      Path: v1beta1/{+parent}/notebookExecutionJobs

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

      Description: Lists NotebookExecutionJobs in a Location.

      HTTP Method: GET

      Parameters:

        view

          Type: string

          Enum Descriptions:

        • When unspecified, the API defaults to the BASIC view.
        • Includes all fields except for direct notebook inputs.
        • Includes all fields.
        • Description: Optional. The NotebookExecutionJob view. Defaults to BASIC.

          Enum:

        • NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED
        • NOTEBOOK_EXECUTION_JOB_VIEW_BASIC
        • NOTEBOOK_EXECUTION_JOB_VIEW_FULL
        • Location: query

        parent

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

          Location: path

          Description: Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`

          Required: Yes

          Type: string

        filter

          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"`

          Location: query

          Type: string

        pageToken

          Type: string

          Description: Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.

          Location: query

        orderBy

          Type: string

          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

        pageSize

          Location: query

          Type: integer

          Format: int32

          Description: Optional. The standard list page size.

      Parameter Order: parent

  • aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.get

      Parameter Order: name

      Description: Gets a ModelMonitoringJob.

      Path: v1beta1/{+name}

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}

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

      Parameters:

        name

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$

          Description: Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`

          Required: Yes

          Location: path

      HTTP Method: GET

  • aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.delete

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}

      Description: Deletes a ModelMonitoringJob.

      Path: v1beta1/{+name}

      Parameters:

        name

          Description: Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`

          Pattern: ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$

          Location: path

          Type: string

          Required: Yes

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

      HTTP Method: DELETE

      Parameter Order: name

  • aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.list

      Path: v1beta1/{+parent}/modelMonitoringJobs

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs

      Parameter Order: parent

      HTTP Method: GET

      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`

      Parameters:

        filter

          Location: query

          Description: The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).

          Type: string

        pageToken

          Type: string

          Description: The standard list page token.

          Location: query

        parent

          Type: string

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

          Required: Yes

          Description: Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`

          Location: path

        pageSize

          Description: The standard list page size.

          Location: query

          Type: integer

          Format: int32

        readMask

          Format: google-fieldmask

          Type: string

          Location: query

          Description: Mask specifying which fields to read

  • aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.create

      Path: v1beta1/{+parent}/modelMonitoringJobs

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

      Parameters:

        modelMonitoringJobId

          Type: string

          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])?$/`.

          Location: query

        parent

          Required: Yes

          Type: string

          Location: path

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

          Description: Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`

      Description: Creates a ModelMonitoringJob.

      HTTP Method: POST

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs

      Parameter Order: parent

  • aiplatform.projects.locations.modelMonitors.create

      HTTP Method: POST

      Parameter Order: parent

      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

          Required: Yes

          Type: string

          Location: path

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

          Description: Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`

      Path: v1beta1/{+parent}/modelMonitors

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors

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

  • aiplatform.projects.locations.modelMonitors.searchModelMonitoringAlerts

      Path: v1beta1/{+modelMonitor}:searchModelMonitoringAlerts

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

      Description: Returns the Model Monitoring alerts.

      Parameters:

        modelMonitor

          Type: string

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

          Location: path

          Required: Yes

          Description: Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`

      HTTP Method: POST

      Parameter Order: modelMonitor

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringAlerts

  • aiplatform.projects.locations.modelMonitors.patch

      Parameters:

        name

          Required: Yes

          Location: path

          Description: Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.

          Type: string

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

        updateMask

          Type: string

          Description: Required. Mask specifying which fields to update.

          Format: google-fieldmask

          Location: query

      Path: v1beta1/{+name}

      Description: Updates a ModelMonitor.

      HTTP Method: PATCH

      Parameter Order: name

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}

  • aiplatform.projects.locations.modelMonitors.get

      HTTP Method: GET

      Parameters:

        name

          Type: string

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

          Description: Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`

          Required: Yes

          Location: path

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}

      Parameter Order: name

      Path: v1beta1/{+name}

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

      Description: Gets a ModelMonitor.

  • aiplatform.projects.locations.modelMonitors.list

      Parameter Order: parent

      Description: Lists ModelMonitors in a Location.

      HTTP Method: GET

      Parameters:

        filter

          Description: The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).

          Type: string

          Location: query

        readMask

          Type: string

          Description: Mask specifying which fields to read.

          Location: query

          Format: google-fieldmask

        pageSize

          Description: The standard list page size.

          Type: integer

          Format: int32

          Location: query

        parent

          Type: string

          Description: Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`

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

          Required: Yes

          Location: path

        pageToken

          Description: The standard list page token.

          Type: string

          Location: query

      Path: v1beta1/{+parent}/modelMonitors

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors

  • aiplatform.projects.locations.modelMonitors.searchModelMonitoringStats

      Parameter Order: modelMonitor

      HTTP Method: POST

      Description: Searches Model Monitoring Stats generated within a given time window.

      Parameters:

        modelMonitor

          Location: path

          Type: string

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

          Required: Yes

          Description: Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`

      Path: v1beta1/{+modelMonitor}:searchModelMonitoringStats

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringStats

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

  • aiplatform.projects.locations.modelMonitors.delete

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}

      Description: Deletes a ModelMonitor.

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

      Parameter Order: name

      Parameters:

        force

          Description: Optional. Force delete the model monitor with schedules.

          Location: query

          Type: boolean

        name

          Required: Yes

          Location: path

          Description: Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`

          Type: string

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

      Path: v1beta1/{+name}

      HTTP Method: DELETE

Deletions

    Methods
  • aiplatform.projects.locations.endpoints.chat.completions

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

      Path: v1beta1/{+endpoint}/chat/completions

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

      Parameter Order: endpoint

      Parameters:

        endpoint

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

          Required: Yes

          Type: string

          Location: path

          Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/openapi`

      HTTP Method: POST

      Description: Exposes an OpenAI-compatible endpoint for chat completions.

1 new method | 14 removed methods

Additions

    Methods
  • aiplatform.projects.locations.endpoints.chat.completions

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

      Path: v1beta1/{+endpoint}/chat/completions

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

      Parameter Order: endpoint

      Parameters:

        endpoint

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

          Required: Yes

          Type: string

          Location: path

          Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/openapi`

      HTTP Method: POST

      Description: Exposes an OpenAI-compatible endpoint for chat completions.

Deletions

    Methods
  • 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:

        • When unspecified, the API defaults to the BASIC view.
        • Includes all fields except for direct notebook inputs.
        • Includes all fields.
        • Enum:

        • NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED
        • NOTEBOOK_EXECUTION_JOB_VIEW_BASIC
        • NOTEBOOK_EXECUTION_JOB_VIEW_FULL
        • 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:

        • When unspecified, the API defaults to the BASIC view.
        • Includes all fields except for direct notebook inputs.
        • Includes all fields.
        • Description: Optional. The NotebookExecutionJob view. Defaults to BASIC.

          Type: string

          Enum:

        • NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED
        • NOTEBOOK_EXECUTION_JOB_VIEW_BASIC
        • NOTEBOOK_EXECUTION_JOB_VIEW_FULL
        • 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}`

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

  • 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