Vertex AI API (aiplatform:v1)

2024-02-10

6 new methods

Additions

    Methods
  • aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities

      Path : v1/{+featureView}:searchNearestEntities

      HTTP Method : POST

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities

      Description : Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

      Parameters :

        featureView

          Required : Yes

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

          Location : path

          Description : Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`

          Type : string

      Parameter Order : featureView

  • aiplatform.projects.locations.models.getIamPolicy

      Parameter Order : resource

      HTTP Method : POST

      Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      Path : v1/{+resource}:getIamPolicy

      Parameters :

        options.requestedPolicyVersion

          Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Type : integer

          Location : query

          Format : int32

        resource

          Location : path

          Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type : string

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

          Required : Yes

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy

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

  • aiplatform.projects.locations.models.setIamPolicy

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy

      Parameter Order : resource

      HTTP Method : POST

      Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Required : Yes

          Type : string

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

          Location : path

      Path : v1/{+resource}:setIamPolicy

  • aiplatform.projects.locations.models.testIamPermissions

      HTTP Method : POST

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

      Parameters :

        permissions

          Location : query

          Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

          Type : string

          Repeated : Yes

        resource

          Location : path

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

          Required : Yes

          Type : string

          Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

      Path : v1/{+resource}:testIamPermissions

      Parameter Order : resource

      Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions

  • aiplatform.projects.locations.publishers.models.generateContent

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

      Path : v1/{+model}:generateContent

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent

      Description : Generate content with multimodal inputs.

      Parameter Order : model

      HTTP Method : POST

      Parameters :

        model

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

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

          Location : path

          Type : string

          Required : Yes

  • aiplatform.projects.locations.endpoints.generateContent

      HTTP Method : POST

      Description : Generate content with multimodal inputs.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent

      Path : v1/{+model}:generateContent

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

      Parameters :

        model

          Type : string

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

          Required : Yes

          Location : path

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

      Parameter Order : model