Vertex AI API (aiplatform:v1beta1)

Additions

Methods


• ▼ ▲ aiplatform.interactionsInternal.list

  Flat Path : v1beta1/interactionsInternal

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

  HTTP Method : GET

  Description : Internal version of ListInteractions that returns a list of Interactions.

  Parameters :

  page_token

  Type : string

  Location : query

  Description : Optional. A page token, received from a previous `ListInteractions` call. Provide the `next_page_token` returned in the response as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListInteractions` must match the call that provided the page token.

  page_size

  Description : Optional. The maximum number of `Interactions` to return (per page). The service may return fewer `Interactions`. If unspecified, at most 10 `Interactions` will be returned. The maximum size limit is 20 `Interactions` per page.

  Type : integer

  Location : query

  Format : int32

  Path : v1beta1/interactionsInternal

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

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

  Parameters :

  locationsId

  Required : Yes

  Type : string

  Location : path

  projectsId

  Required : Yes

  Location : path

  Type : string

  Description : Creates an interaction.

  Parameter Order :

  • projectsId
  • locationsId

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

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

  HTTP Method : POST

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

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

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

  HTTP Method : POST

  Parameter Order :

  • projectsId
  • locationsId

  Parameters :

  projectsId

  Required : Yes

  Location : path

  Type : string

  locationsId

  Type : string

  Location : path

  Required : Yes

  Description : Creates an interaction and streams the response.

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

• ▼ ▲ aiplatform.interactions.getStream

  Path : v1beta1/{+name}:stream

  HTTP Method : GET

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

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

  Parameters :

  stream

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

  Type : boolean

  Location : query

  name

  Type : string

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

  Pattern : ^interactions/[^/]+$

  Required : Yes

  Location : path

  Parameter Order : name

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

• ▼ ▲ aiplatform.interactions.getPoll

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

  HTTP Method : GET

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

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

  Path : v1beta1/{+name}:poll

  Parameter Order : name

  Parameters :

  name

  Location : path

  Type : string

  Pattern : ^interactions/[^/]+$

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

  Required : Yes

  stream

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

  Type : boolean

  Location : query