Agent Platform API (aiplatform:v1beta1)

▼ ▲ aiplatform.projects.locations.servingProfiles.get

Parameter Order : name

HTTP Method : GET

Parameters :

name

Type : string

Location : path

Description : Required. The name of the ServingProfile resource. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}`

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

Required : Yes

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

Description : Gets a ServingProfile.

Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}

Path : v1beta1/{+name}

▼ ▲ aiplatform.projects.locations.servingProfiles.create

Parameter Order : parent

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

Description : Creates a ServingProfile.

HTTP Method : POST

Parameters :

parent

Required : Yes

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

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

Location : path

Type : string

servingProfileId

Location : query

Type : string

Description : Required. The ID to use for the ServingProfile, which will become the final component of the ServingProfile's resource name. This value should be 1-63 characters, and valid characters are `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.

Path : v1beta1/{+parent}/servingProfiles

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

▼ ▲ aiplatform.projects.locations.servingProfiles.delete

Parameter Order : name

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

Description : Deletes a ServingProfile.

HTTP Method : DELETE

Parameters :

name

Required : Yes

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

Description : Required. The name of the ServingProfile resource to be deleted. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}`

Location : path

Type : string

Path : v1beta1/{+name}

Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}

▼ ▲ aiplatform.projects.locations.servingProfiles.patch

Parameter Order : name

Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}

Path : v1beta1/{+name}

HTTP Method : PATCH

Parameters :

name

Required : Yes

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

Description : Identifier. The resource name of the ServingProfile.

Location : path

Type : string

updateMask

Type : string

Location : query

Description : Optional. The list of fields to update; see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. If omitted, all populated (non-empty) mutable fields are updated; if set to `["*"]`, all mutable fields are fully replaced (unpopulated values are cleared).

Format : google-fieldmask

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

Description : Updates a ServingProfile.

▼ ▲ aiplatform.projects.locations.servingProfiles.list

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

Path : v1beta1/{+parent}/servingProfiles

HTTP Method : GET

Parameters :

pageSize

Type : integer

Location : query

Description : Optional. The standard list page size. If unspecified, at most 100 ServingProfiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format : int32

pageToken

Type : string

Location : query

Description : Optional. The standard list page token.

parent

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

Required : Yes

Type : string

Location : path

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

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

Description : Lists ServingProfiles in a Location.

Parameter Order : parent

▼ ▲ aiplatform.projects.locations.memoryBanks.ingestEvents

Parameter Order : parent

Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}:ingestEvents

Path : v1beta1/{+parent}:ingestEvents

HTTP Method : POST

Parameters :

parent

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

Required : Yes

Description : Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

Type : string

Location : path

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

Description : Ingests events for a Memory Bank.

▼ ▲ aiplatform.projects.locations.memoryBanks.memories.retrieveProfiles

Path : v1beta1/{+parent}/memories:retrieveProfiles

Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieveProfiles

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

Description : Retrieves profiles.

HTTP Method : POST

Parameters :

parent

Location : path

Type : string

Description : Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

Required : Yes

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

Parameter Order : parent

▼ ▲ aiplatform.memoryBanks.ingestEvents

Parameter Order : parent

Flat Path : v1beta1/memoryBanks/{memoryBanksId}:ingestEvents

Path : v1beta1/{+parent}:ingestEvents

HTTP Method : POST

Parameters :

parent

Type : string

Location : path

Description : Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

Pattern : ^memoryBanks/[^/]+$

Required : Yes

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

Description : Ingests events for a Memory Bank.

▼ ▲ aiplatform.memoryBanks.memories.retrieveProfiles

Parameter Order : parent

Flat Path : v1beta1/memoryBanks/{memoryBanksId}/memories:retrieveProfiles

Path : v1beta1/{+parent}/memories:retrieveProfiles

HTTP Method : POST

Parameters :

parent

Required : Yes

Pattern : ^memoryBanks/[^/]+$

Location : path

Type : string

Description : Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

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

Description : Retrieves profiles.

▼ ▲ aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex

Parameters :

updateMask

Description : Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask.

Format : google-fieldmask

Type : string

Location : query