Vertex AI API (aiplatform:v1)

Additions

Methods


• ▼ ▲ aiplatform.projects.locations.generateSyntheticData

  Path : v1/{+location}:generateSyntheticData

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData

  HTTP Method : POST

  Parameters :

  location

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

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : location

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

  Description : Generates synthetic data based on the provided configuration.

• ▼ ▲ aiplatform.projects.locations.evaluationRuns.create

  Path : v1/{+parent}/evaluationRuns

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns

  HTTP Method : POST

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Creates an Evaluation Run.

• ▼ ▲ aiplatform.projects.locations.evaluationRuns.get

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets an Evaluation Run.

• ▼ ▲ aiplatform.projects.locations.evaluationRuns.list

  Path : v1/{+parent}/evaluationRuns

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns

  HTTP Method : GET

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Optional. The maximum number of Evaluation Runs to return.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.

  Location : query

  Type : string

  filter

  Description : Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).

  Location : query

  Type : string

  orderBy

  Description : Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists Evaluation Runs.

• ▼ ▲ aiplatform.projects.locations.evaluationRuns.delete

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Deletes an Evaluation Run.

• ▼ ▲ aiplatform.projects.locations.evaluationRuns.cancel

  Path : v1/{+name}:cancel

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel

  HTTP Method : POST

  Parameters :

  name

  Description : Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.

• ▼ ▲ aiplatform.projects.locations.evaluationSets.create

  Path : v1/{+parent}/evaluationSets

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationSets

  HTTP Method : POST

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Creates an Evaluation Set.

• ▼ ▲ aiplatform.projects.locations.evaluationSets.get

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets an Evaluation Set.

• ▼ ▲ aiplatform.projects.locations.evaluationSets.list

  Path : v1/{+parent}/evaluationSets

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationSets

  HTTP Method : GET

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Optional. The maximum number of Evaluation Sets to return.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.

  Location : query

  Type : string

  filter

  Description : Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).

  Location : query

  Type : string

  orderBy

  Description : Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists Evaluation Sets.

• ▼ ▲ aiplatform.projects.locations.evaluationSets.delete

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Deletes an Evaluation Set.

• ▼ ▲ aiplatform.projects.locations.evaluationSets.patch

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}

  HTTP Method : PATCH

  Parameters :

  name

  Description : Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`

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

  Location : path

  Required : Yes

  Type : string

  updateMask

  Description : Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.

  Location : query

  Type : string

  Format : google-fieldmask

  Parameter Order : name

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

  Description : Updates an Evaluation Set.

• ▼ ▲ aiplatform.projects.locations.evaluationItems.create

  Path : v1/{+parent}/evaluationItems

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationItems

  HTTP Method : POST

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Creates an Evaluation Item.

• ▼ ▲ aiplatform.projects.locations.evaluationItems.get

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets an Evaluation Item.

• ▼ ▲ aiplatform.projects.locations.evaluationItems.list

  Path : v1/{+parent}/evaluationItems

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationItems

  HTTP Method : GET

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Optional. The maximum number of Evaluation Items to return.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.

  Location : query

  Type : string

  filter

  Description : Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).

  Location : query

  Type : string

  orderBy

  Description : Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists Evaluation Items.

• ▼ ▲ aiplatform.projects.locations.evaluationItems.delete

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Deletes an Evaluation Item.