2024-04-05
▼ ▲ aiplatform.media.upload
Parameters:
parent
Description: Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location: path
HTTP Method: POST
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload
Supportsmediaupload: Yes
Path: v1beta1/{+parent}/ragFiles:upload
Scopes: https://www.googleapis.com/auth/cloud-platform
Mediaupload:
Accept: */*
Protocols:
Simple:
Path: /upload/v1beta1/{+parent}/ragFiles:upload
Multipart: Yes
Description: Upload a file into a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.delete
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}
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}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Type: string
Parameter Order: name
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.get
Description: Gets a RagFile.
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}
HTTP Method: GET
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Description: Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Required: Yes
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.import
Path: v1beta1/{+parent}/ragFiles:import
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import
Parameters:
parent
Location: path
Description: Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Type: string
Description: Import files from Google Cloud Storage or Google Drive into a RagCorpus.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.list
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
pageToken
Location: query
Type: string
Description: Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.
pageSize
Format: int32
Description: Optional. The standard list page size.
Type: integer
Location: query
HTTP Method: GET
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists RagFiles in a RagCorpus.
Path: v1beta1/{+parent}/ragFiles
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles
▼ ▲ aiplatform.projects.locations.ragCorpora.list
Description: Lists RagCorpora in a Location.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora
Path: v1beta1/{+parent}/ragCorpora
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
pageToken
Description: Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.
Type: string
Location: query
pageSize
Type: integer
Format: int32
Description: Optional. The standard list page size.
Location: query
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`
Required: Yes
Location: path
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.ragCorpora.delete
Description: Deletes a RagCorpus.
Parameters:
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.
Type: boolean
Location: query
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Description: Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: DELETE
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}
▼ ▲ aiplatform.projects.locations.ragCorpora.create
HTTP Method: POST
Description: Creates a RagCorpus.
Parameter Order: parent
Path: v1beta1/{+parent}/ragCorpora
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Description: Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora
▼ ▲ aiplatform.projects.locations.ragCorpora.get
Path: v1beta1/{+name}
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}
Description: Gets a RagCorpus.
Parameters:
name
Description: Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Pattern: ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Type: string
Required: Yes
Location: path
▼ ▲ aiplatform.projects.locations.retrieveContexts
Path: v1beta1/{+parent}:retrieveContexts
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
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}`.
Location: path
Type: string
Parameter Order: parent
Description: Retrieves relevant contexts for a query.