Vertex AI API (aiplatform:v1)

Additions

Methods


• ▼ ▲ aiplatform.projects.locations.retrieveContexts

  Path : v1/{+parent}:retrieveContexts

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

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Retrieves relevant contexts for a query.

• ▼ ▲ aiplatform.projects.locations.augmentPrompt

  Path : v1/{+parent}:augmentPrompt

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

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

• ▼ ▲ aiplatform.projects.locations.corroborateContent

  Path : v1/{+parent}:corroborateContent

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

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.

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

  Path : v1/{+parent}/cachedContents

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

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The parent resource where the cached content will be created

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.

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

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The resource name referring to the cached content

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets cached content configurations

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

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}

  HTTP Method : PATCH

  Parameters :

  name

  Description : Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}

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

  Location : path

  Required : Yes

  Type : string

  updateMask

  Description : Required. The list of fields to update.

  Location : query

  Type : string

  Format : google-fieldmask

  Parameter Order : name

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

  Description : Updates cached content configurations

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

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The resource name referring to the cached content

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Deletes cached content

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

  Path : v1/{+parent}/cachedContents

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

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The parent, which owns this collection of cached contents.

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

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists cached contents in a project

• ▼ ▲ aiplatform.projects.locations.reasoningEngines.query

  Path : v1/{+name}:query

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query

  HTTP Method : POST

  Parameters :

  name

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

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Queries using a reasoning engine.

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

  Path : v1/{+parent}/ragCorpora

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

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Creates a RagCorpus.

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

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}

  HTTP Method : PATCH

  Parameters :

  name

  Description : Output only. The resource name of the RagCorpus.

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Updates a RagCorpus.

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

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets a RagCorpus.

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

  Path : v1/{+parent}/ragCorpora

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

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`

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

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Optional. The standard list page size.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists RagCorpora in a Location.

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

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`

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

  Location : path

  Required : Yes

  Type : string

  force

  Description : Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.

  Location : query

  Type : boolean

  Parameter Order : name

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

  Description : Deletes a RagCorpus.

• ▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.import

  Path : v1/{+parent}/ragFiles:import

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Import files from Google Cloud Storage or Google Drive into a RagCorpus.

• ▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.get

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets a RagFile.

• ▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.list

  Path : v1/{+parent}/ragFiles

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`

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

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Optional. The standard list page size.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists RagFiles in a RagCorpus.

• ▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.delete

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Deletes a RagFile.

• ▼ ▲ aiplatform.media.upload

  Path : v1/{+parent}/ragFiles:upload

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

  Supportsmediaupload : Yes

  Mediaupload :

  Accept : */*

  Protocols :

  Simple :

  Multipart : Yes

  Path : /upload/v1/{+parent}/ragFiles:upload

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

  Description : Upload a file into a RagCorpus.