Agent Platform API . vertexExpress

Instance Methods

Eligibility()

Returns the Eligibility Resource.

close()

Close httplib2 connections.

retrieveExpressProject(getDefaultApiKey=None, x__xgafv=None)

Retrieves the project for Vertex AI Express Mode.

signUp(body=None, x__xgafv=None)

Signs up the user for Vertex AI Express Mode. If the user is already signed up, the existing ExpressProject will be returned.

Method Details

close()
Close httplib2 connections.
retrieveExpressProject(getDefaultApiKey=None, x__xgafv=None)
Retrieves the project for Vertex AI Express Mode.

Args:
  getDefaultApiKey: boolean, Optional. Whether to return the default API key string in the response.
  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 ExpressModeService.RetrieveExpressProject.
  "expressProject": { # The project for Vertex AI Express Mode. # The project for Vertex AI Express Mode.
    "createTime": "A String", # Output only. The time the project was created.
    "defaultApiKey": "A String", # Output only. The default API key string of the project.
    "projectId": "A String", # Output only. The ID of the project.
    "projectNumber": "A String", # Output only. The number of the project.
    "region": "A String", # Output only. The region of the project.
  },
}
signUp(body=None, x__xgafv=None)
Signs up the user for Vertex AI Express Mode. If the user is already signed up, the existing ExpressProject will be returned.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request message for ExpressModeService.SignUp.
  "getDefaultApiKey": True or False, # Optional. Whether to return the default API key string in the response.
  "region": "A String", # Required. The desired region for the express project.
  "tosAccepted": True or False, # Required. Whether the Terms of Service are accepted.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The project for Vertex AI Express Mode.
  "createTime": "A String", # Output only. The time the project was created.
  "defaultApiKey": "A String", # Output only. The default API key string of the project.
  "projectId": "A String", # Output only. The ID of the project.
  "projectNumber": "A String", # Output only. The number of the project.
  "region": "A String", # Output only. The region of the project.
}