2026-02-24
▼ ▲ aiplatform.projects.locations.publishers.models.invoke.invoke
Parameter Order :
Scopes :
Parameters :
endpoint
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
invokeId
Type : string
Location : path
Required : Yes
Description : Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
HTTP Method : POST
Path : v1beta1/{+endpoint}/invoke/{+invokeId}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}/invoke/{invokeId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}:wait
HTTP Method : POST
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:wait
Parameters :
name
Type : string
Description : The name of the operation resource to wait on.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$
Location : path
timeout
Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location : query
Format : google-duration
Type : string
Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.cancel
Parameter Order : name
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Path : v1beta1/{+name}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:cancel
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.list
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations
Parameters :
returnPartialSuccess
Location : query
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
pageSize
Format : int32
Description : The standard list page size.
Type : integer
Location : query
name
Description : The name of the operation's parent resource.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$
Required : Yes
Type : string
pageToken
Type : string
Description : The standard list page token.
Location : query
filter
Location : query
Description : The standard list filter.
Type : string
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.delete
Parameters :
name
Required : Yes
Description : The name of the operation resource to be deleted.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource.
Type : string
Path : v1beta1/{+name}
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.ragCorpora.ragDataSchemas.delete
Path : v1beta1/{+name}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the RagDataSchema resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragDataSchemas/[^/]+$
Type : string
Required : Yes
Location : path
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas/{ragDataSchemasId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a RagDataSchema.
Parameter Order : name
▼ ▲ aiplatform.projects.locations.ragCorpora.ragDataSchemas.create
Description : Creates a RagDataSchema.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/ragDataSchemas
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas
HTTP Method : POST
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Description : Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Location : path
ragDataSchemaId
Location : query
Description : Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
Type : string
▼ ▲ aiplatform.projects.locations.ragCorpora.ragDataSchemas.get
Parameters :
name
Description : Required. The name of the RagDataSchema resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragDataSchemas/[^/]+$
Location : path
Required : Yes
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas/{ragDataSchemasId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a RagDataSchema.
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.ragCorpora.ragDataSchemas.batchCreate
Description : Batch Create one or more RagDataSchemas
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas:batchCreate
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Type : string
Description : Required. The resource name of the RagCorpus to create the RagDataSchemas in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Required : Yes
HTTP Method : POST
Path : v1beta1/{+parent}/ragDataSchemas:batchCreate
▼ ▲ aiplatform.projects.locations.ragCorpora.ragDataSchemas.list
HTTP Method : GET
Description : Lists RagDataSchemas in a Location.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.
pageToken
Type : string
Location : query
Description : Optional. The standard list page token. Typically obtained via ListRagDataSchemasResponse.next_page_token of the previous VertexRagDataService.ListRagDataSchemas call.
parent
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Description : Required. The resource name of the RagCorpus from which to list the RagDataSchemas. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas
Parameter Order : parent
Path : v1beta1/{+parent}/ragDataSchemas
▼ ▲ aiplatform.projects.locations.ragCorpora.ragDataSchemas.batchDelete
Description : Batch Deletes one or more RagDataSchemas
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas:batchDelete
Path : v1beta1/{+parent}/ragDataSchemas:batchDelete
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Required : Yes
Description : Required. The resource name of the RagCorpus from which to delete the RagDataSchemas. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Type : string
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.batchCreate
HTTP Method : POST
Parameter Order : parent
Description : Batch Create one or more RagMetadatas
Parameters :
parent
Type : string
Description : Required. The parent resource where the RagMetadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Location : path
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata:batchCreate
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/ragMetadata:batchCreate
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.patch
HTTP Method : PATCH
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata/{ragMetadataId}
Path : v1beta1/{+name}
Parameter Order : name
Description : Updates a RagMetadata.
Parameters :
name
Location : path
Required : Yes
Type : string
Description : Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/ragMetadata/[^/]+$
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.create
Description : Creates a RagMetadata.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata
Parameter Order : parent
Path : v1beta1/{+parent}/ragMetadata
HTTP Method : POST
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Description : Required. The parent resource where this metadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Required : Yes
Location : path
Type : string
ragMetadataId
Description : Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
Type : string
Location : query
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.get
Parameter Order : name
Description : Gets a RagMetadata.
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata/{ragMetadataId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/ragMetadata/[^/]+$
Location : path
Type : string
Description : Required. The name of the RagMetadata resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
Required : Yes
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.list
Path : v1beta1/{+parent}/ragMetadata
Parameters :
parent
Required : Yes
Location : path
Description : Required. The resource name of the RagFile from which to list the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Type : string
pageSize
Location : query
Description : Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListRagMetadataResponse.next_page_token of the previous VertexRagDataService.ListRagMetadata call.
Type : string
Location : query
Description : Lists RagMetadata in a RagFile.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata
Parameter Order : parent
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.batchDelete
Parameters :
parent
Required : Yes
Type : string
Description : Required. The resource name of the RagFile from which to delete the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Parameter Order : parent
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata:batchDelete
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/ragMetadata:batchDelete
Description : Batch Deletes one or more RagMetadata.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.delete
Parameter Order : name
Path : v1beta1/{+name}
Description : Deletes a RagMetadata.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata/{ragMetadataId}
Parameters :
name
Required : Yes
Description : Required. The name of the RagMetadata resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/ragMetadata/[^/]+$
▼ ▲ aiplatform.reasoningEngines.feedbackEntries.operations.wait
Path : v1beta1/{+name}:wait
Parameter Order : name
Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameters :
timeout
Location : query
Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type : string
Format : google-duration
name
Type : string
Description : The name of the operation resource to wait on.
Required : Yes
Pattern : ^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$
Location : path
▼ ▲ aiplatform.reasoningEngines.feedbackEntries.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order : name
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}
Path : v1beta1/{+name}
HTTP Method : GET
Parameters :
name
Type : string
Pattern : ^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
Location : path
▼ ▲ aiplatform.reasoningEngines.feedbackEntries.operations.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters :
name
Required : Yes
Pattern : ^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Location : path
Type : string
▼ ▲ aiplatform.reasoningEngines.feedbackEntries.operations.cancel
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:cancel
Path : v1beta1/{+name}:cancel
Parameters :
name
Pattern : ^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Description : The name of the operation resource to be cancelled.
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
▼ ▲ aiplatform.reasoningEngines.feedbackEntries.operations.list
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations
Path : v1beta1/{+name}/operations
Parameters :
pageToken
Description : The standard list page token.
Location : query
Type : string
returnPartialSuccess
Type : boolean
Location : query
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
filter
Type : string
Description : The standard list filter.
Location : query
name
Pattern : ^reasoningEngines/[^/]+/feedbackEntries/[^/]+$
Description : The name of the operation's parent resource.
Location : path
Type : string
Required : Yes
pageSize
Type : integer
Description : The standard list page size.
Format : int32
Location : query
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.