Agent Platform API (aiplatform:v1beta1)

Additions

Methods


• ▼ ▲ aiplatform.projects.locations.agents.tasks.listEvents

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:listEvents

  Description : Lists a task's execution events -- trajectory steps, status changes, and task detail and artifact updates -- one page at a time. The unary counterpart of StreamTask with `snapshot` set: it reads the same stored events, in the same order and with the same content, and returns them in pages instead of on a stream, for callers that cannot hold a stream open. Like StreamTask, it reads the task's trajectory from interaction storage and never restores the runtime actor. Unlike StreamTask, it never waits: a task that has not started running yet returns no events. Storage can trail the live stream by a few seconds, so the newest events a participant sees on CreateTaskBidiStream may not be listed yet.

  HTTP Method : GET

  Path : v1beta1/{+task}:listEvents

  Parameters :

  task

  Type : string

  Required : Yes

  Location : path

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

  Description : Required. The task whose events to list. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}

  pageSize

  Type : integer

  Description : Optional. The maximum number of events to return. The service may return fewer. If unspecified (or <= 0), at most 100 are returned. The maximum is 1000; larger values are capped to 1000.

  Format : int32

  Location : query

  pageToken

  Type : string

  Description : Optional. A page token from a previous ListTaskEvents call. Listing continues immediately after the last event of that page. Following `next_page_token` from page to page never skips or repeats an event. This token is the same token that the StreamTask API uses and hence could be used interchangeably. Opaque: pass it back unchanged and send it only to the task it was issued for. A token this call cannot redeem is rejected with INVALID_ARGUMENT rather than listing from the start. When paginating, all other parameters except `page_size` must match the call that provided the page token.

  Location : query

  Parameter Order : task

  Scopes :

  • https://www.googleapis.com/auth/aiplatform
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

• ▼ ▲ aiplatform.projects.locations.agents.tasks.artifacts.move

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}/artifacts:move

  Description : Moves a file, including a `.link.json` link, from `path` in a task's workspace to `destination_path` in `destination_parent`'s workspace.

  Scopes :

  • https://www.googleapis.com/auth/aiplatform
  • https://www.googleapis.com/auth/cloud-platform

  Parameters :

  parent

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

  Location : path

  Description : Required. The task whose workspace holds the file. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}

  Required : Yes

  Type : string

  Parameter Order : parent

  HTTP Method : POST

  Path : v1beta1/{+parent}/artifacts:move