Vertex AI API (aiplatform:v1beta1)

Additions

Methods


• ▼ ▲ aiplatform.projects.locations.retrieveContexts

  HTTP Method: POST

  Path: v1beta1/{+parent}:retrieveContexts

  Parameters:

  parent

  Location: path

  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/[^/]+$

  Required: Yes

  Type: string

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

  Parameter Order: parent

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

  Description: Retrieves relevant contexts for a query.

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

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

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

  Description: Deletes a RagFile.

  Path: v1beta1/{+name}

  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/[^/]+$

  Required: Yes

  Type: string

  Location: path

  HTTP Method: DELETE

  Parameter Order: name

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

  Path: v1beta1/{+name}

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

  Parameters:

  name

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

  Location: path

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

  Required: Yes

  Type: string

  Description: Gets a RagFile.

  HTTP Method: GET

  Parameter Order: name

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

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

  Parameters:

  pageToken

  Type: string

  Location: query

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

  parent

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

  Type: string

  Required: Yes

  Location: path

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

  pageSize

  Location: query

  Format: int32

  Type: integer

  Description: Optional. The standard list page size.

  HTTP Method: GET

  Description: Lists RagFiles in a RagCorpus.

  Parameter Order: parent

  Path: v1beta1/{+parent}/ragFiles

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

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

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

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

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

  Parameter Order: parent

  HTTP Method: POST

  Parameters:

  parent

  Location: path

  Required: Yes

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

  Type: string

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

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

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

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

  Description: Deletes a RagCorpus.

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

  Parameters:

  force

  Type: boolean

  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

  name

  Required: Yes

  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

  Type: string

  Path: v1beta1/{+name}

  Parameter Order: name

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

  HTTP Method: DELETE

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

  Description: Lists RagCorpora in a Location.

  Path: v1beta1/{+parent}/ragCorpora

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

  Parameters:

  pageSize

  Description: Optional. The standard list page size.

  Type: integer

  Location: query

  Format: int32

  pageToken

  Type: string

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

  Location: query

  parent

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

  Type: string

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

  Required: Yes

  Location: path

  Parameter Order: parent

  HTTP Method: GET

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

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

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

  HTTP Method: POST

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

  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

  Type: string

  Required: Yes

  Description: Creates a RagCorpus.

  Parameter Order: parent

  Path: v1beta1/{+parent}/ragCorpora

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

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

  Description: Gets a RagCorpus.

  HTTP Method: GET

  Parameters:

  name

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

  Location: path

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

  Required: Yes

  Type: string

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

  Parameter Order: name

  Path: v1beta1/{+name}

• ▼ ▲ aiplatform.media.upload

  Mediaupload:

  Accept: */*

  Protocols:

  Simple:

  Multipart: Yes

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

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

  Supportsmediaupload: Yes

  Parameters:

  parent

  Location: path

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

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

  Required: Yes

  Type: string

  Parameter Order: parent

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

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

  Description: Upload a file into a RagCorpus.

  HTTP Method: POST