Vertex AI API (aiplatform:v1beta1)

▼ ▲ aiplatform.evaluateDataset

Flat Path : v1beta1:evaluateDataset

Description : Evaluates a dataset based on a set of given metrics.

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

HTTP Method : POST

Path : v1beta1:evaluateDataset

▼ ▲ aiplatform.generateInstanceRubrics

HTTP Method : POST

Description : Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.

Flat Path : v1beta1:generateInstanceRubrics

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

Path : v1beta1:generateInstanceRubrics

▼ ▲ aiplatform.evaluateInstances

Description : Evaluates instances based on a given metric.

Flat Path : v1beta1:evaluateInstances

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

Path : v1beta1:evaluateInstances

HTTP Method : POST

▼ ▲ aiplatform.projects.locations.interactions.createStream

Parameter Order :

• projectsId
• locationsId

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

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

HTTP Method : POST

Parameters :

projectsId

Type : string

Required : Yes

Location : path

locationsId

Location : path

Type : string

Required : Yes

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

Description : Creates an interaction and streams the response.

▼ ▲ aiplatform.projects.locations.interactions.create

HTTP Method : POST

Parameters :

projectsId

Required : Yes

Type : string

Location : path

locationsId

Location : path

Required : Yes

Type : string

Parameter Order :

• projectsId
• locationsId

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

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

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

Description : Creates an interaction.

▼ ▲ aiplatform.interactions.getStream

Parameters :

name

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

Pattern : ^interactions/[^/]+$

Type : string

Required : Yes

Location : path

stream

Location : query

Type : boolean

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

Parameter Order : name

Path : v1beta1/{+name}:stream

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

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

HTTP Method : GET

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

▼ ▲ aiplatform.interactions.getPoll

Path : v1beta1/{+name}:poll

Parameters :

stream

Type : boolean

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

Location : query

name

Location : path

Required : Yes

Type : string

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

Pattern : ^interactions/[^/]+$

HTTP Method : GET

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

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

Parameter Order : name

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

▼ ▲ aiplatform.interactionsInternal.list

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

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

Flat Path : v1beta1/interactionsInternal

Parameters :

page_token

Type : string

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.

Location : query

page_size

Type : integer

Location : query

Format : int32

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.

Path : v1beta1/interactionsInternal

HTTP Method : GET