Vertex AI API (aiplatform:v1beta1)

Deletions

Methods


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

  Path : v1beta1/{+parent}/sessions

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

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}` or `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Creates a new Session in a given project and location.

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

  Path : v1beta1/{+name}

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets details of the specific Session.

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

  Path : v1beta1/{+parent}/sessions

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

  HTTP Method : GET

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.

  Location : query

  Type : string

  filter

  Description : Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.

  Location : query

  Type : string

  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: * `create_time` * `update_time` Example: `create_time desc`.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists Sessions in a given project and location.

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

  Path : v1beta1/{+name}

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}

  HTTP Method : PATCH

  Parameters :

  name

  Description : Required. Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

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

  Location : path

  Required : Yes

  Type : string

  updateMask

  Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

  Location : query

  Type : string

  Format : google-fieldmask

  Parameter Order : name

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

  Description : Updates the specific Session.

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

  Path : v1beta1/{+name}

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}` or `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Deletes details of the specific Session.