Agent Platform API (aiplatform:v1)

Additions

Methods


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

  Description : Cancels an interaction by id. This only applies to background interactions that are still running.

  HTTP Method : POST

  Path : v1/{+name}/cancel

  Parameters :

  name

  Required : Yes

  Description : Required. The name of the interaction to cancel. Format: `interactions/{interaction}`.

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

  Type : string

  Location : path

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

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/interactionsHttp/{interactionsHttpId}/cancel

  Parameter Order : name

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

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/interactionsHttp/{interactionsHttpId}

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

  Parameters :

  lastEventId

  Location : query

  Type : string

  Description : If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.

  name

  Description : Required. The name of the interaction to retrieve. Format: interactions/{interaction}

  Location : path

  Required : Yes

  Type : string

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

  stream

  Description : If true, streams the interaction events as Server-Sent Events.

  Location : query

  Type : boolean

  Parameter Order : name

  Path : v1/{+name}

  HTTP Method : GET

  Description : Retrieves the full details of a single interaction based on its `Interaction.id`.

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

  Path : v1/{+parent}/interactionsHttp

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

  HTTP Method : POST

  Parameters :

  parent

  Required : Yes

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

  Location : path

  Description : Required. The parent resource where this interaction will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API only.

  Type : string

  Description : Creates a new interaction.

  Parameter Order : parent

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

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

  Parameters :

  name

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

  Type : string

  Location : path

  Description : Required. The name of the interaction to delete. Format: interactions/{interaction}

  Required : Yes

  Description : Deletes an interaction.

  Path : v1/{+name}

  Deprecated : Yes

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/interactions/{interactionsId}

  Parameter Order : name

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

  HTTP Method : DELETE

• ▼ ▲ aiplatform.projects.locations.interactions.createStream

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/interactions:createStream

  Parameters :

  projectsId

  Location : path

  Type : string

  Required : Yes

  locationsId

  Location : path

  Required : Yes

  Type : string

  Parameter Order :

  • projectsId
  • locationsId

  Description : Creates an interaction and streams the response.

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

  Path : v1/projects/{projectsId}/locations/{locationsId}/interactions:createStream

  HTTP Method : POST

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

  Parameter Order :

  • projectsId
  • locationsId

  Parameters :

  projectsId

  Type : string

  Required : Yes

  Location : path

  locationsId

  Required : Yes

  Type : string

  Location : path

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/interactions:create

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

  Path : v1/projects/{projectsId}/locations/{locationsId}/interactions:create

  HTTP Method : POST

  Description : Creates an interaction.

• ▼ ▲ aiplatform.interactions.getPoll

  HTTP Method : GET

  Flat Path : v1/interactions/{interactionsId}:poll

  Parameter Order : name

  Path : v1/{+name}:poll

  Description : Fully typed proto, unary version of GetInteraction that returns Interaction proto.

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

  Parameters :

  lastEventId

  Description : If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.

  Type : string

  Location : query

  name

  Pattern : ^interactions/[^/]+$

  Description : Required. The name of the interaction to retrieve. Format: interactions/{interaction}

  Required : Yes

  Type : string

  Location : path

  stream

  Location : query

  Type : boolean

  Description : If true, streams the interaction events as Server-Sent Events.

• ▼ ▲ aiplatform.interactions.cancel

  Parameter Order : name

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

  Description : Cancels an interaction.

  Parameters :

  name

  Type : string

  Pattern : ^interactions/[^/]+$

  Location : path

  Description : Required. The name of the interaction to cancel. Format: `interactions/{interaction}`.

  Required : Yes

  HTTP Method : POST

  Flat Path : v1/interactions/{interactionsId}:cancel

  Path : v1/{+name}:cancel

• ▼ ▲ aiplatform.interactions.getStream

  Path : v1/{+name}:stream

  Flat Path : v1/interactions/{interactionsId}:stream

  Parameters :

  lastEventId

  Location : query

  Type : string

  Description : If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.

  stream

  Location : query

  Description : If true, streams the interaction events as Server-Sent Events.

  Type : boolean

  name

  Pattern : ^interactions/[^/]+$

  Location : path

  Type : string

  Required : Yes

  Description : Required. The name of the interaction to retrieve. Format: interactions/{interaction}

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

  Description : Fully typed proto, streaming version of GetInteraction that returns Interaction proto.

  HTTP Method : GET

  Parameter Order : name