2024-03-29
▼ ▲ aiplatform.projects.locations.evaluateInstances
Description : Evaluates instances based on a given metric.
Parameter Order : location
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
location
Location : path
Description : Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Path : v1beta1/{+location}:evaluateInstances
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.retrieveContexts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : parent
Parameters :
parent
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}`.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Retrieves relevant contexts for a query.
Path : v1beta1/{+parent}:retrieveContexts
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.import
Path : v1beta1/{+parent}/ragFiles:import
HTTP Method : POST
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import
Description : Import files from Google Cloud Storage or Google Drive into a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.delete
Path : v1beta1/{+name}
Description : Deletes a RagFile.
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Description : Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
HTTP Method : DELETE
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}
Parameter Order : name
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.get
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}`
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Location : path
Description : Gets a RagFile.
Path : v1beta1/{+name}
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.list
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles
Parameters :
pageToken
Location : query
Description : Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.
Type : string
parent
Required : Yes
Type : string
Description : Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
pageSize
Description : Optional. The standard list page size.
Format : int32
Type : integer
Location : query
Parameter Order : parent
HTTP Method : GET
Path : v1beta1/{+parent}/ragFiles
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists RagFiles in a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.delete
Parameter Order : name
Description : Deletes a RagCorpus.
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
force
Location : query
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.
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Description : Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Type : string
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}
▼ ▲ aiplatform.projects.locations.ragCorpora.create
Parameter Order : parent
Description : Creates a RagCorpus.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora
HTTP Method : POST
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
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Path : v1beta1/{+parent}/ragCorpora
▼ ▲ aiplatform.projects.locations.ragCorpora.list
Parameters :
pageSize
Location : query
Description : Optional. The standard list page size.
Type : integer
Format : int32
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Description : Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`
pageToken
Location : query
Description : Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.
Type : string
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/ragCorpora
HTTP Method : GET
Parameter Order : parent
Description : Lists RagCorpora in a Location.
▼ ▲ aiplatform.projects.locations.ragCorpora.get
Path : v1beta1/{+name}
HTTP Method : GET
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}
Parameters :
name
Required : Yes
Type : string
Description : Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a RagCorpus.
▼ ▲ aiplatform.projects.locations.reasoningEngines.create
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Description : Creates a reasoning engine.
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Description : Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`
Type : string
Path : v1beta1/{+parent}/reasoningEngines
▼ ▲ aiplatform.projects.locations.reasoningEngines.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}
Description : Gets a reasoning engine.
HTTP Method : GET
Parameters :
name
Location : path
Description : Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}
Parameters :
name
Required : Yes
Location : path
Description : Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
Description : Deletes a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.query
Path : v1beta1/{+name}:query
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : Queries using a reasoning engine.
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Location : path
Required : Yes
Type : string
▼ ▲ aiplatform.projects.locations.reasoningEngines.list
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines
Description : Lists reasoning engines in a location.
Parameters :
pageSize
Format : int32
Description : Optional. The standard list page size.
Location : query
Type : integer
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageToken
Type : string
Description : Optional. The standard list page token.
Location : query
parent
Location : path
Description : Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Parameter Order : parent
HTTP Method : GET
Path : v1beta1/{+parent}/reasoningEngines
▼ ▲ aiplatform.media.upload
Path : v1beta1/{+parent}/ragFiles:upload
HTTP Method : POST
Parameter Order : parent
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Type : string
Supportsmediaupload : Yes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload
Scopes : https://www.googleapis.com/auth/cloud-platform
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/v1beta1/{+parent}/ragFiles:upload
Description : Upload a file into a RagCorpus.