Discovery Engine API.
- REST Resource: v1beta.projects
- REST Resource: v1beta.projects.locations
- REST Resource: v1beta.projects.locations.cmekConfigs
- REST Resource: v1beta.projects.locations.collections.dataConnector.operations
- REST Resource: v1beta.projects.locations.collections.dataStores
- REST Resource: v1beta.projects.locations.collections.dataStores.branches
- REST Resource: v1beta.projects.locations.collections.dataStores.branches.documents
- REST Resource: v1beta.projects.locations.collections.dataStores.branches.operations
- REST Resource: v1beta.projects.locations.collections.dataStores.completionConfig
- REST Resource: v1beta.projects.locations.collections.dataStores.completionSuggestions
- REST Resource: v1beta.projects.locations.collections.dataStores.controls
- REST Resource: v1beta.projects.locations.collections.dataStores.conversations
- REST Resource: v1beta.projects.locations.collections.dataStores.customModels
- REST Resource: v1beta.projects.locations.collections.dataStores.models.operations
- REST Resource: v1beta.projects.locations.collections.dataStores.operations
- REST Resource: v1beta.projects.locations.collections.dataStores.schemas
- REST Resource: v1beta.projects.locations.collections.dataStores.schemas.operations
- REST Resource: v1beta.projects.locations.collections.dataStores.servingConfigs
- REST Resource: v1beta.projects.locations.collections.dataStores.sessions
- REST Resource: v1beta.projects.locations.collections.dataStores.sessions.answers
- REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine
- REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine.operations
- REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine.sitemaps
- REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine.targetSites
- REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations
- REST Resource: v1beta.projects.locations.collections.dataStores.suggestionDenyListEntries
- REST Resource: v1beta.projects.locations.collections.dataStores.userEvents
- REST Resource: v1beta.projects.locations.collections.engines
- REST Resource: v1beta.projects.locations.collections.engines.assistants
- REST Resource: v1beta.projects.locations.collections.engines.assistants.agents.operations
- REST Resource: v1beta.projects.locations.collections.engines.completionConfig
- REST Resource: v1beta.projects.locations.collections.engines.controls
- REST Resource: v1beta.projects.locations.collections.engines.conversations
- REST Resource: v1beta.projects.locations.collections.engines.operations
- REST Resource: v1beta.projects.locations.collections.engines.servingConfigs
- REST Resource: v1beta.projects.locations.collections.engines.sessions
- REST Resource: v1beta.projects.locations.collections.engines.sessions.answers
- REST Resource: v1beta.projects.locations.collections.engines.sessions.assistAnswers
- REST Resource: v1beta.projects.locations.collections.operations
- REST Resource: v1beta.projects.locations.dataStores
- REST Resource: v1beta.projects.locations.dataStores.branches
- REST Resource: v1beta.projects.locations.dataStores.branches.documents
- REST Resource: v1beta.projects.locations.dataStores.branches.operations
- REST Resource: v1beta.projects.locations.dataStores.completionConfig
- REST Resource: v1beta.projects.locations.dataStores.completionSuggestions
- REST Resource: v1beta.projects.locations.dataStores.controls
- REST Resource: v1beta.projects.locations.dataStores.conversations
- REST Resource: v1beta.projects.locations.dataStores.models.operations
- REST Resource: v1beta.projects.locations.dataStores.operations
- REST Resource: v1beta.projects.locations.dataStores.schemas
- REST Resource: v1beta.projects.locations.dataStores.servingConfigs
- REST Resource: v1beta.projects.locations.dataStores.sessions
- REST Resource: v1beta.projects.locations.dataStores.sessions.answers
- REST Resource: v1beta.projects.locations.dataStores.siteSearchEngine
- REST Resource: v1beta.projects.locations.dataStores.siteSearchEngine.sitemaps
- REST Resource: v1beta.projects.locations.dataStores.siteSearchEngine.targetSites
- REST Resource: v1beta.projects.locations.dataStores.suggestionDenyListEntries
- REST Resource: v1beta.projects.locations.dataStores.userEvents
- REST Resource: v1beta.projects.locations.evaluations
- REST Resource: v1beta.projects.locations.evaluations.operations
- REST Resource: v1beta.projects.locations.groundingConfigs
- REST Resource: v1beta.projects.locations.identityMappingStores
- REST Resource: v1beta.projects.locations.identityMappingStores.operations
- REST Resource: v1beta.projects.locations.licenseConfigs
- REST Resource: v1beta.projects.locations.operations
- REST Resource: v1beta.projects.locations.podcasts.operations
- REST Resource: v1beta.projects.locations.rankingConfigs
- REST Resource: v1beta.projects.locations.sampleQuerySets
- REST Resource: v1beta.projects.locations.sampleQuerySets.operations
- REST Resource: v1beta.projects.locations.sampleQuerySets.sampleQueries
- REST Resource: v1beta.projects.locations.userEvents
- REST Resource: v1beta.projects.locations.userStores
- REST Resource: v1beta.projects.locations.userStores.licenseConfigsUsageStats
- REST Resource: v1beta.projects.locations.userStores.userLicenses
- REST Resource: v1beta.projects.operations
- REST Resource: v1alpha.billingAccounts.billingAccountLicenseConfigs
- REST Resource: v1alpha.projects
- REST Resource: v1alpha.projects.locations
- REST Resource: v1alpha.projects.locations.authorizations
- REST Resource: v1alpha.projects.locations.cmekConfigs
- REST Resource: v1alpha.projects.locations.collections
- REST Resource: v1alpha.projects.locations.collections.dataConnector
- REST Resource: v1alpha.projects.locations.collections.dataConnector.connectorRuns
- REST Resource: v1alpha.projects.locations.collections.dataConnector.operations
- REST Resource: v1alpha.projects.locations.collections.dataStores
- REST Resource: v1alpha.projects.locations.collections.dataStores.branches
- REST Resource: v1alpha.projects.locations.collections.dataStores.branches.documents
- REST Resource: v1alpha.projects.locations.collections.dataStores.branches.documents.chunks
- REST Resource: v1alpha.projects.locations.collections.dataStores.branches.operations
- REST Resource: v1alpha.projects.locations.collections.dataStores.completionConfig
- REST Resource: v1alpha.projects.locations.collections.dataStores.completionSuggestions
- REST Resource: v1alpha.projects.locations.collections.dataStores.controls
- REST Resource: v1alpha.projects.locations.collections.dataStores.conversations
- REST Resource: v1alpha.projects.locations.collections.dataStores.customModels
- REST Resource: v1alpha.projects.locations.collections.dataStores.models.operations
- REST Resource: v1alpha.projects.locations.collections.dataStores.operations
- REST Resource: v1alpha.projects.locations.collections.dataStores.schemas
- REST Resource: v1alpha.projects.locations.collections.dataStores.schemas.operations
- REST Resource: v1alpha.projects.locations.collections.dataStores.servingConfigs
- REST Resource: v1alpha.projects.locations.collections.dataStores.sessions
- REST Resource: v1alpha.projects.locations.collections.dataStores.sessions.answers
- REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine
- REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine.operations
- REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine.sitemaps
- REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites
- REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations
- REST Resource: v1alpha.projects.locations.collections.dataStores.suggestionDenyListEntries
- REST Resource: v1alpha.projects.locations.collections.dataStores.userEvents
- REST Resource: v1alpha.projects.locations.collections.dataStores.widgetConfigs
- REST Resource: v1alpha.projects.locations.collections.engines
- REST Resource: v1alpha.projects.locations.collections.engines.analytics
- REST Resource: v1alpha.projects.locations.collections.engines.assistants
- REST Resource: v1alpha.projects.locations.collections.engines.assistants.agents
- REST Resource: v1alpha.projects.locations.collections.engines.assistants.agents.files
- REST Resource: v1alpha.projects.locations.collections.engines.assistants.agents.operations
- REST Resource: v1alpha.projects.locations.collections.engines.assistants.cannedQueries
- REST Resource: v1alpha.projects.locations.collections.engines.completionConfig
- REST Resource: v1alpha.projects.locations.collections.engines.controls
- REST Resource: v1alpha.projects.locations.collections.engines.conversations
- REST Resource: v1alpha.projects.locations.collections.engines.operations
- REST Resource: v1alpha.projects.locations.collections.engines.servingConfigs
- REST Resource: v1alpha.projects.locations.collections.engines.sessions
- REST Resource: v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.operations
- REST Resource: v1alpha.projects.locations.collections.engines.sessions.answers
- REST Resource: v1alpha.projects.locations.collections.engines.sessions.assistAnswers
- REST Resource: v1alpha.projects.locations.collections.engines.sessions.operations
- REST Resource: v1alpha.projects.locations.collections.engines.widgetConfigs
- REST Resource: v1alpha.projects.locations.collections.operations
- REST Resource: v1alpha.projects.locations.dataStores
- REST Resource: v1alpha.projects.locations.dataStores.branches
- REST Resource: v1alpha.projects.locations.dataStores.branches.documents
- REST Resource: v1alpha.projects.locations.dataStores.branches.documents.chunks
- REST Resource: v1alpha.projects.locations.dataStores.branches.operations
- REST Resource: v1alpha.projects.locations.dataStores.completionConfig
- REST Resource: v1alpha.projects.locations.dataStores.completionSuggestions
- REST Resource: v1alpha.projects.locations.dataStores.controls
- REST Resource: v1alpha.projects.locations.dataStores.conversations
- REST Resource: v1alpha.projects.locations.dataStores.models.operations
- REST Resource: v1alpha.projects.locations.dataStores.operations
- REST Resource: v1alpha.projects.locations.dataStores.schemas
- REST Resource: v1alpha.projects.locations.dataStores.servingConfigs
- REST Resource: v1alpha.projects.locations.dataStores.sessions
- REST Resource: v1alpha.projects.locations.dataStores.sessions.answers
- REST Resource: v1alpha.projects.locations.dataStores.siteSearchEngine
- REST Resource: v1alpha.projects.locations.dataStores.siteSearchEngine.sitemaps
- REST Resource: v1alpha.projects.locations.dataStores.siteSearchEngine.targetSites
- REST Resource: v1alpha.projects.locations.dataStores.suggestionDenyListEntries
- REST Resource: v1alpha.projects.locations.dataStores.userEvents
- REST Resource: v1alpha.projects.locations.dataStores.widgetConfigs
- REST Resource: v1alpha.projects.locations.evaluations
- REST Resource: v1alpha.projects.locations.evaluations.operations
- REST Resource: v1alpha.projects.locations.groundingConfigs
- REST Resource: v1alpha.projects.locations.identityMappingStores
- REST Resource: v1alpha.projects.locations.identityMappingStores.operations
- REST Resource: v1alpha.projects.locations.licenseConfigs
- REST Resource: v1alpha.projects.locations.notebooks
- REST Resource: v1alpha.projects.locations.notebooks.audioOverviews
- REST Resource: v1alpha.projects.locations.notebooks.sources
- REST Resource: v1alpha.projects.locations.operations
- REST Resource: v1alpha.projects.locations.podcasts.operations
- REST Resource: v1alpha.projects.locations.rankingConfigs
- REST Resource: v1alpha.projects.locations.requirements
- REST Resource: v1alpha.projects.locations.sampleQuerySets
- REST Resource: v1alpha.projects.locations.sampleQuerySets.operations
- REST Resource: v1alpha.projects.locations.sampleQuerySets.sampleQueries
- REST Resource: v1alpha.projects.locations.userEvents
- REST Resource: v1alpha.projects.locations.userStores
- REST Resource: v1alpha.projects.locations.userStores.licenseConfigsUsageStats
- REST Resource: v1alpha.projects.locations.userStores.operations
- REST Resource: v1alpha.projects.locations.userStores.userLicenses
- REST Resource: v1alpha.projects.operations
- REST Resource: v1.projects
- REST Resource: v1.projects.locations
- REST Resource: v1.projects.locations.cmekConfigs
- REST Resource: v1.projects.locations.collections
- REST Resource: v1.projects.locations.collections.dataConnector.operations
- REST Resource: v1.projects.locations.collections.dataStores
- REST Resource: v1.projects.locations.collections.dataStores.branches
- REST Resource: v1.projects.locations.collections.dataStores.branches.documents
- REST Resource: v1.projects.locations.collections.dataStores.branches.operations
- REST Resource: v1.projects.locations.collections.dataStores.completionConfig
- REST Resource: v1.projects.locations.collections.dataStores.completionSuggestions
- REST Resource: v1.projects.locations.collections.dataStores.controls
- REST Resource: v1.projects.locations.collections.dataStores.conversations
- REST Resource: v1.projects.locations.collections.dataStores.customModels
- REST Resource: v1.projects.locations.collections.dataStores.models.operations
- REST Resource: v1.projects.locations.collections.dataStores.operations
- REST Resource: v1.projects.locations.collections.dataStores.schemas
- REST Resource: v1.projects.locations.collections.dataStores.schemas.operations
- REST Resource: v1.projects.locations.collections.dataStores.servingConfigs
- REST Resource: v1.projects.locations.collections.dataStores.sessions
- REST Resource: v1.projects.locations.collections.dataStores.sessions.answers
- REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine
- REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine.operations
- REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine.sitemaps
- REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine.targetSites
- REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations
- REST Resource: v1.projects.locations.collections.dataStores.suggestionDenyListEntries
- REST Resource: v1.projects.locations.collections.dataStores.userEvents
- REST Resource: v1.projects.locations.collections.dataStores.widgetConfigs
- REST Resource: v1.projects.locations.collections.engines
- REST Resource: v1.projects.locations.collections.engines.assistants
- REST Resource: v1.projects.locations.collections.engines.assistants.agents.a2a.v1
- REST Resource: v1.projects.locations.collections.engines.assistants.agents.a2a.v1.message
- REST Resource: v1.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks
- REST Resource: v1.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs
- REST Resource: v1.projects.locations.collections.engines.assistants.agents.operations
- REST Resource: v1.projects.locations.collections.engines.completionConfig
- REST Resource: v1.projects.locations.collections.engines.controls
- REST Resource: v1.projects.locations.collections.engines.conversations
- REST Resource: v1.projects.locations.collections.engines.operations
- REST Resource: v1.projects.locations.collections.engines.servingConfigs
- REST Resource: v1.projects.locations.collections.engines.sessions
- REST Resource: v1.projects.locations.collections.engines.sessions.answers
- REST Resource: v1.projects.locations.collections.engines.sessions.assistAnswers
- REST Resource: v1.projects.locations.collections.engines.widgetConfigs
- REST Resource: v1.projects.locations.collections.operations
- REST Resource: v1.projects.locations.dataStores
- REST Resource: v1.projects.locations.dataStores.branches
- REST Resource: v1.projects.locations.dataStores.branches.documents
- REST Resource: v1.projects.locations.dataStores.branches.operations
- REST Resource: v1.projects.locations.dataStores.completionConfig
- REST Resource: v1.projects.locations.dataStores.completionSuggestions
- REST Resource: v1.projects.locations.dataStores.controls
- REST Resource: v1.projects.locations.dataStores.conversations
- REST Resource: v1.projects.locations.dataStores.models.operations
- REST Resource: v1.projects.locations.dataStores.operations
- REST Resource: v1.projects.locations.dataStores.schemas
- REST Resource: v1.projects.locations.dataStores.servingConfigs
- REST Resource: v1.projects.locations.dataStores.sessions
- REST Resource: v1.projects.locations.dataStores.sessions.answers
- REST Resource: v1.projects.locations.dataStores.siteSearchEngine
- REST Resource: v1.projects.locations.dataStores.siteSearchEngine.sitemaps
- REST Resource: v1.projects.locations.dataStores.siteSearchEngine.targetSites
- REST Resource: v1.projects.locations.dataStores.suggestionDenyListEntries
- REST Resource: v1.projects.locations.dataStores.userEvents
- REST Resource: v1.projects.locations.dataStores.widgetConfigs
- REST Resource: v1.projects.locations.groundingConfigs
- REST Resource: v1.projects.locations.identityMappingStores
- REST Resource: v1.projects.locations.identityMappingStores.operations
- REST Resource: v1.projects.locations.licenseConfigs
- REST Resource: v1.projects.locations.operations
- REST Resource: v1.projects.locations.podcasts.operations
- REST Resource: v1.projects.locations.rankingConfigs
- REST Resource: v1.projects.locations.userEvents
- REST Resource: v1.projects.locations.userStores
- REST Resource: v1.projects.locations.userStores.licenseConfigsUsageStats
- REST Resource: v1.projects.locations.userStores.userLicenses
- REST Resource: v1.projects.operations
Service: discoveryengine.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries . If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
-
https://discoveryengine.googleapis.com
REST Resource: v1beta.projects
| Methods | |
|---|---|
provision
|
POST /v1beta/{name=projects/*}:provision
Provisions the project resource. |
REST Resource: v1beta.projects.locations
| Methods | |
|---|---|
getAclConfig
|
GET /v1beta/{name=projects/*/locations/*/aclConfig}
Gets the AclConfig
. |
getCmekConfig
|
GET /v1beta/{name=projects/*/locations/*/cmekConfig}
Gets the CmekConfig
. |
obtainCrawlRate
|
POST /v1beta/{location=projects/*/locations/*}:obtainCrawlRate
Obtains the time series data of organic or dedicated crawl rate for monitoring. |
removeDedicatedCrawlRate
|
POST /v1beta/{location=projects/*/locations/*}:removeDedicatedCrawlRate
Removes the dedicated crawl rate for a craw_rate_scope. |
setDedicatedCrawlRate
|
POST /v1beta/{location=projects/*/locations/*}:setDedicatedCrawlRate
Sets the dedicated crawl rate for a crawl_rate_scope. |
updateAclConfig
|
PATCH /v1beta/{aclConfig.name=projects/*/locations/*/aclConfig}
Default ACL configuration for use in a location of a customer's project. |
updateCmekConfig
|
PATCH /v1beta/{config.name=projects/*/locations/*/cmekConfig}
Provisions a CMEK key for use in a location of a customer's project. |
REST Resource: v1beta.projects.locations.cmekConfigs
| Methods | |
|---|---|
delete
|
DELETE /v1beta/{name=projects/*/locations/*/cmekConfigs/*}
De-provisions a CmekConfig. |
get
|
GET /v1beta/{name=projects/*/locations/*/cmekConfigs/*}
Gets the CmekConfig
. |
list
|
GET /v1beta/{parent=projects/*/locations/*}/cmekConfigs
Lists all the CmekConfig
s with the project. |
patch
|
PATCH /v1beta/{config.name=projects/*/locations/*/cmekConfigs/*}
Provisions a CMEK key for use in a location of a customer's project. |
REST Resource: v1beta.projects.locations.collections.dataConnector.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataConnector/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataConnector}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.collections.dataStores
| Methods | |
|---|---|
completeQuery
|
GET /v1beta/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:completeQuery
Completes the specified user input with keyword suggestions. |
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*}/dataStores
Creates a DataStore
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}
Deletes a DataStore
. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}
Gets a DataStore
. |
getSiteSearchEngine
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}
Gets the SiteSearchEngine
. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*}/dataStores
Lists all the DataStore
s associated with the project. |
patch
|
PATCH /v1beta/{dataStore.name=projects/*/locations/*/collections/*/dataStores/*}
Updates a DataStore
|
trainCustomModel
|
POST /v1beta/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel
Trains a custom model. |
REST Resource: v1beta.projects.locations.collections.dataStores.branches
| Methods | |
|---|---|
batchGetDocumentsMetadata
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata
Gets index freshness metadata for Document
s. |
REST Resource: v1beta.projects.locations.collections.dataStores.branches.documents
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents
Creates a Document
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Deletes a Document
. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Gets a Document
. |
import
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:import
Bulk import of multiple Document
s. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents
Gets a list of Document
s. |
patch
|
PATCH /v1beta/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Updates a Document
. |
purge
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:purge
Permanently deletes all selected Document
s in a branch. |
REST Resource: v1beta.projects.locations.collections.dataStores.branches.operations
| Methods | |
|---|---|
cancel
|
POST /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.collections.dataStores.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1beta/{completionConfig=projects/*/locations/*/collections/*/dataStores/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
REST Resource: v1beta.projects.locations.collections.dataStores.completionSuggestions
| Methods | |
|---|---|
import
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:import
Imports CompletionSuggestion
s for a DataStore. |
purge
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:purge
Permanently deletes all CompletionSuggestion
s for a DataStore. |
REST Resource: v1beta.projects.locations.collections.dataStores.controls
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/controls
Creates a Control. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Deletes a Control. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Gets a Control. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1beta/{control.name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Updates a Control. |
REST Resource: v1beta.projects.locations.collections.dataStores.conversations
| Methods | |
|---|---|
converse
|
POST /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1beta/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Updates a Conversation. |
REST Resource: v1beta.projects.locations.collections.dataStores.customModels
| Methods | |
|---|---|
list
|
GET /v1beta/{dataStore=projects/*/locations/*/collections/*/dataStores/*}/customModels
Gets a list of all the custom models. |
REST Resource: v1beta.projects.locations.collections.dataStores.models.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.collections.dataStores.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.collections.dataStores.schemas
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/schemas
Creates a Schema
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Deletes a Schema
. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Gets a Schema
. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/schemas
Gets a list of Schema
s. |
patch
|
PATCH /v1beta/{schema.name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Updates a Schema
. |
REST Resource: v1beta.projects.locations.collections.dataStores.schemas.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.collections.dataStores.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1beta/{servingConfig.name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1beta.projects.locations.collections.dataStores.sessions
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions
Creates a Session. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Deletes a Session. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Gets a Session. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions
Lists all Sessions by their parent DataStore
. |
patch
|
PATCH /v1beta/{session.name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Updates a Session. |
REST Resource: v1beta.projects.locations.collections.dataStores.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine
| Methods | |
|---|---|
batchVerifyTargetSites
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:batchVerifyTargetSites
Verify target sites' ownership and validity. |
disableAdvancedSiteSearch
|
POST /v1beta/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch
Downgrade from advanced site search to basic site search. |
enableAdvancedSiteSearch
|
POST /v1beta/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch
Upgrade from basic site search to advanced site search. |
fetchDomainVerificationStatus
|
GET /v1beta/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus
Returns list of target sites with its domain verification status. |
recrawlUris
|
POST /v1beta/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:recrawlUris
Request on-demand recrawl for a list of URIs. |
REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine.sitemaps
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/sitemaps
Creates a Sitemap
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*}
Deletes a Sitemap
. |
fetch
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/sitemaps:fetch
Fetch Sitemap
s in a DataStore
. |
REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine.targetSites
| Methods | |
|---|---|
batchCreate
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites:batchCreate
Creates TargetSite
in a batch. |
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites
Creates a TargetSite
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Deletes a TargetSite
. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Gets a TargetSite
. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites
Gets a list of TargetSite
s. |
patch
|
PATCH /v1beta/{targetSite.name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Updates a TargetSite
. |
REST Resource: v1beta.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.collections.dataStores.suggestionDenyListEntries
| Methods | |
|---|---|
import
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:import
Imports all SuggestionDenyListEntry
for a DataStore. |
purge
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:purge
Permanently deletes all SuggestionDenyListEntry
for a DataStore. |
REST Resource: v1beta.projects.locations.collections.dataStores.userEvents
| Methods | |
|---|---|
collect
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import
Bulk import of user events. |
purge
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:purge
Deletes permanently all user events specified by the filter provided. |
write
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write
Writes a single user event. |
REST Resource: v1beta.projects.locations.collections.engines
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*}/engines
Creates an Engine
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/engines/*}
Deletes an Engine
. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*}
Gets an Engine
. |
getIamPolicy
|
GET /v1beta/{resource=projects/*/locations/*/collections/*/engines/*}:getIamPolicy
Gets the IAM access control policy for an Engine
. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*}/engines
Lists all the Engine
s associated with the project. |
patch
|
PATCH /v1beta/{engine.name=projects/*/locations/*/collections/*/engines/*}
Updates an Engine
|
pause
|
POST /v1beta/{name=projects/*/locations/*/collections/*/engines/*}:pause
Pauses the training of an existing Engine
. |
resume
|
POST /v1beta/{name=projects/*/locations/*/collections/*/engines/*}:resume
Resumes the training of an existing Engine
. |
setIamPolicy
|
POST /v1beta/{resource=projects/*/locations/*/collections/*/engines/*}:setIamPolicy
Sets the IAM access control policy for an Engine
. |
tune
|
POST /v1beta/{name=projects/*/locations/*/collections/*/engines/*}:tune
Tunes an existing Engine
. |
REST Resource: v1beta.projects.locations.collections.engines.assistants
| Methods | |
|---|---|
assist
|
POST /v1beta/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist
Assists the user with a query. |
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/assistants
Creates an Assistant
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Deletes an Assistant
. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Gets an Assistant
. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/assistants
Lists all Assistant
s under an Engine
. |
patch
|
PATCH /v1beta/{assistant.name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Updates an Assistant
|
streamAssist
|
POST /v1beta/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:streamAssist
Assists the user with a query in a streaming fashion. |
REST Resource: v1beta.projects.locations.collections.engines.assistants.agents.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1beta.projects.locations.collections.engines.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1beta/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
removeSuggestion
|
POST /v1beta/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:removeSuggestion
Removes the search history suggestion in an engine for a user. |
REST Resource: v1beta.projects.locations.collections.engines.controls
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/controls
Creates a Control. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/engines/*/controls/*}
Deletes a Control. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/controls/*}
Gets a Control. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1beta/{control.name=projects/*/locations/*/collections/*/engines/*/controls/*}
Updates a Control. |
REST Resource: v1beta.projects.locations.collections.engines.conversations
| Methods | |
|---|---|
converse
|
POST /v1beta/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1beta/{conversation.name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Updates a Conversation. |
REST Resource: v1beta.projects.locations.collections.engines.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.collections.engines.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1beta/{servingConfig.name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1beta.projects.locations.collections.engines.sessions
| Methods | |
|---|---|
addContextFile
|
POST /v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:addContextFile
Uploads a context file to use as source for the assist calls within the session. |
create
|
POST /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/sessions
Creates a Session. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Deletes a Session. |
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Gets a Session. |
list
|
GET /v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/sessions
Lists all Sessions by their parent DataStore
. |
patch
|
PATCH /v1beta/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Updates a Session. |
REST Resource: v1beta.projects.locations.collections.engines.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1beta.projects.locations.collections.engines.sessions.assistAnswers
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*/assistAnswers/*}
Gets an AssistAnswer
. |
REST Resource: v1beta.projects.locations.collections.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/collections/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/collections/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.dataStores
| Methods | |
|---|---|
completeQuery
|
GET /v1beta/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery
Completes the specified user input with keyword suggestions. |
create
|
POST /v1beta/{parent=projects/*/locations/*}/dataStores
Creates a DataStore
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*}
Deletes a DataStore
. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*}
Gets a DataStore
. |
getSiteSearchEngine
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/siteSearchEngine}
Gets the SiteSearchEngine
. |
list
|
GET /v1beta/{parent=projects/*/locations/*}/dataStores
Lists all the DataStore
s associated with the project. |
patch
|
PATCH /v1beta/{dataStore.name=projects/*/locations/*/dataStores/*}
Updates a DataStore
|
REST Resource: v1beta.projects.locations.dataStores.branches
| Methods | |
|---|---|
batchGetDocumentsMetadata
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata
Gets index freshness metadata for Document
s. |
REST Resource: v1beta.projects.locations.dataStores.branches.documents
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents
Creates a Document
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Deletes a Document
. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Gets a Document
. |
import
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:import
Bulk import of multiple Document
s. |
list
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents
Gets a list of Document
s. |
patch
|
PATCH /v1beta/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Updates a Document
. |
purge
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:purge
Permanently deletes all selected Document
s in a branch. |
REST Resource: v1beta.projects.locations.dataStores.branches.operations
| Methods | |
|---|---|
cancel
|
POST /v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/branches/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.dataStores.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1beta/{completionConfig=projects/*/locations/*/dataStores/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
REST Resource: v1beta.projects.locations.dataStores.completionSuggestions
| Methods | |
|---|---|
import
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:import
Imports CompletionSuggestion
s for a DataStore. |
purge
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:purge
Permanently deletes all CompletionSuggestion
s for a DataStore. |
REST Resource: v1beta.projects.locations.dataStores.controls
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/controls
Creates a Control. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*/controls/*}
Deletes a Control. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/controls/*}
Gets a Control. |
list
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1beta/{control.name=projects/*/locations/*/dataStores/*/controls/*}
Updates a Control. |
REST Resource: v1beta.projects.locations.dataStores.conversations
| Methods | |
|---|---|
converse
|
POST /v1beta/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1beta/{conversation.name=projects/*/locations/*/dataStores/*/conversations/*}
Updates a Conversation. |
REST Resource: v1beta.projects.locations.dataStores.models.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/models/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/models/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.dataStores.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.dataStores.schemas
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/schemas
Creates a Schema
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*/schemas/*}
Deletes a Schema
. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/schemas/*}
Gets a Schema
. |
list
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*}/schemas
Gets a list of Schema
s. |
patch
|
PATCH /v1beta/{schema.name=projects/*/locations/*/dataStores/*/schemas/*}
Updates a Schema
. |
REST Resource: v1beta.projects.locations.dataStores.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1beta/{servingConfig.name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1beta.projects.locations.dataStores.sessions
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/sessions
Creates a Session. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*/sessions/*}
Deletes a Session. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/sessions/*}
Gets a Session. |
list
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*}/sessions
Lists all Sessions by their parent DataStore
. |
patch
|
PATCH /v1beta/{session.name=projects/*/locations/*/dataStores/*/sessions/*}
Updates a Session. |
REST Resource: v1beta.projects.locations.dataStores.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1beta.projects.locations.dataStores.siteSearchEngine
| Methods | |
|---|---|
disableAdvancedSiteSearch
|
POST /v1beta/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch
Downgrade from advanced site search to basic site search. |
enableAdvancedSiteSearch
|
POST /v1beta/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch
Upgrade from basic site search to advanced site search. |
recrawlUris
|
POST /v1beta/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:recrawlUris
Request on-demand recrawl for a list of URIs. |
REST Resource: v1beta.projects.locations.dataStores.siteSearchEngine.sitemaps
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps
Creates a Sitemap
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/sitemaps/*}
Deletes a Sitemap
. |
fetch
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps:fetch
Fetch Sitemap
s in a DataStore
. |
REST Resource: v1beta.projects.locations.dataStores.siteSearchEngine.targetSites
| Methods | |
|---|---|
batchCreate
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites:batchCreate
Creates TargetSite
in a batch. |
create
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites
Creates a TargetSite
. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Deletes a TargetSite
. |
get
|
GET /v1beta/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Gets a TargetSite
. |
list
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites
Gets a list of TargetSite
s. |
patch
|
PATCH /v1beta/{targetSite.name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Updates a TargetSite
. |
REST Resource: v1beta.projects.locations.dataStores.suggestionDenyListEntries
| Methods | |
|---|---|
import
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/suggestionDenyListEntries:import
Imports all SuggestionDenyListEntry
for a DataStore. |
purge
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/**}/suggestionDenyListEntries:purge
Permanently deletes all SuggestionDenyListEntry
for a DataStore. |
REST Resource: v1beta.projects.locations.dataStores.userEvents
| Methods | |
|---|---|
collect
|
GET /v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:import
Bulk import of user events. |
purge
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:purge
Deletes permanently all user events specified by the filter provided. |
write
|
POST /v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:write
Writes a single user event. |
REST Resource: v1beta.projects.locations.evaluations
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*}/evaluations
Creates a Evaluation
. |
get
|
GET /v1beta/{name=projects/*/locations/*/evaluations/*}
Gets a Evaluation
. |
list
|
GET /v1beta/{parent=projects/*/locations/*}/evaluations
Gets a list of Evaluation
s. |
listResults
|
GET /v1beta/{evaluation=projects/*/locations/*/evaluations/*}:listResults
Gets a list of results for a given a Evaluation
. |
REST Resource: v1beta.projects.locations.evaluations.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/evaluations/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1beta.projects.locations.groundingConfigs
| Methods | |
|---|---|
check
|
POST /v1beta/{groundingConfig=projects/*/locations/*/groundingConfigs/*}:check
Performs a grounding check. |
REST Resource: v1beta.projects.locations.identityMappingStores
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*}/identityMappingStores
Creates a new Identity Mapping Store. |
delete
|
DELETE /v1beta/{name=projects/*/locations/*/identityMappingStores/*}
Deletes the Identity Mapping Store. |
get
|
GET /v1beta/{name=projects/*/locations/*/identityMappingStores/*}
Gets the Identity Mapping Store. |
importIdentityMappings
|
POST /v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:importIdentityMappings
Imports a list of Identity Mapping Entries to an Identity Mapping Store. |
list
|
GET /v1beta/{parent=projects/*/locations/*}/identityMappingStores
Lists all Identity Mapping Stores. |
listIdentityMappings
|
GET /v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:listIdentityMappings
Lists Identity Mappings in an Identity Mapping Store. |
purgeIdentityMappings
|
POST /v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings
Purges specified or all Identity Mapping Entries from an Identity Mapping Store. |
REST Resource: v1beta.projects.locations.identityMappingStores.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/identityMappingStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*/identityMappingStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.licenseConfigs
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*}/licenseConfigs
Creates a LicenseConfig
This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses. |
get
|
GET /v1beta/{name=projects/*/locations/*/licenseConfigs/*}
Gets a LicenseConfig
. |
patch
|
PATCH /v1beta/{licenseConfig.name=projects/*/locations/*/licenseConfigs/*}
Updates the LicenseConfig
|
REST Resource: v1beta.projects.locations.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta.projects.locations.podcasts.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/podcasts/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1beta.projects.locations.rankingConfigs
| Methods | |
|---|---|
rank
|
POST /v1beta/{rankingConfig=projects/*/locations/*/rankingConfigs/*}:rank
Ranks a list of text records based on the given input query. |
REST Resource: v1beta.projects.locations.sampleQuerySets
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*}/sampleQuerySets
Creates a SampleQuerySet
|
delete
|
DELETE /v1beta/{name=projects/*/locations/*/sampleQuerySets/*}
Deletes a SampleQuerySet
. |
get
|
GET /v1beta/{name=projects/*/locations/*/sampleQuerySets/*}
Gets a SampleQuerySet
. |
list
|
GET /v1beta/{parent=projects/*/locations/*}/sampleQuerySets
Gets a list of SampleQuerySet
s. |
patch
|
PATCH /v1beta/{sampleQuerySet.name=projects/*/locations/*/sampleQuerySets/*}
Updates a SampleQuerySet
. |
REST Resource: v1beta.projects.locations.sampleQuerySets.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1beta.projects.locations.sampleQuerySets.sampleQueries
| Methods | |
|---|---|
create
|
POST /v1beta/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries
Creates a SampleQuery
|
delete
|
DELETE /v1beta/{name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}
Deletes a SampleQuery
. |
get
|
GET /v1beta/{name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}
Gets a SampleQuery
. |
import
|
POST /v1beta/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries:import
Bulk import of multiple SampleQuery
s. |
list
|
GET /v1beta/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries
Gets a list of SampleQuery
s. |
patch
|
PATCH /v1beta/{sampleQuery.name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}
Updates a SampleQuery
. |
REST Resource: v1beta.projects.locations.userEvents
| Methods | |
|---|---|
collect
|
GET /v1beta/{parent=projects/*/locations/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1beta/{parent=projects/*/locations/*}/userEvents:import
Bulk import of user events. |
write
|
POST /v1beta/{parent=projects/*/locations/*}/userEvents:write
Writes a single user event. |
REST Resource: v1beta.projects.locations.userStores
| Methods | |
|---|---|
batchUpdateUserLicenses
|
POST /v1beta/{parent=projects/*/locations/*/userStores/*}:batchUpdateUserLicenses
Updates the User License. |
get
|
GET /v1beta/{name=projects/*/locations/*/userStores/*}
Gets the User Store. |
patch
|
PATCH /v1beta/{userStore.name=projects/*/locations/*/userStores/*}
Updates the User Store. |
REST Resource: v1beta.projects.locations.userStores.licenseConfigsUsageStats
| Methods | |
|---|---|
list
|
GET /v1beta/{parent=projects/*/locations/*/userStores/*}/licenseConfigsUsageStats
Lists all the LicenseConfigUsageStats
s associated with the project. |
REST Resource: v1beta.projects.locations.userStores.userLicenses
| Methods | |
|---|---|
list
|
GET /v1beta/{parent=projects/*/locations/*/userStores/*}/userLicenses
Lists the User Licenses. |
REST Resource: v1beta.projects.operations
| Methods | |
|---|---|
get
|
GET /v1beta/{name=projects/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta/{name=projects/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.billingAccounts.billingAccountLicenseConfigs
| Methods | |
|---|---|
distributeLicenseConfig
|
POST /v1alpha/{billingAccountLicenseConfig=billingAccounts/*/billingAccountLicenseConfigs/*}:distributeLicenseConfig
Distributes a LicenseConfig
from billing account level to project level. |
get
|
GET /v1alpha/{name=billingAccounts/*/billingAccountLicenseConfigs/*}
Gets a BillingAccountLicenseConfig
. |
list
|
GET /v1alpha/{parent=billingAccounts/*}/billingAccountLicenseConfigs
Lists all BillingAccountLicenseConfig
s for a given billing account. |
retractLicenseConfig
|
POST /v1alpha/{billingAccountLicenseConfig=billingAccounts/*/billingAccountLicenseConfigs/*}:retractLicenseConfig
This method is called from the billing account side to retract the LicenseConfig
from the given project back to the billing account. |
REST Resource: v1alpha.projects
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*}
Gets a Project
. |
patch
|
PATCH /v1alpha/{project.name=projects/*}
Updates the editable settings of a Discovery Engine Project. |
provision
|
POST /v1alpha/{name=projects/*}:provision
Provisions the project resource. |
reportConsentChange
|
POST /v1alpha/{project=projects/*}:reportConsentChange
Updates service terms for this project. |
REST Resource: v1alpha.projects.locations
| Methods | |
|---|---|
completeExternalIdentities
|
GET /v1alpha/{parent=projects/*/locations/*}:completeExternalIdentities
This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix. |
estimateDataSize
|
POST /v1alpha/{location=projects/*/locations/*}:estimateDataSize
Estimates the data size to be used by a customer. |
getAclConfig
|
GET /v1alpha/{name=projects/*/locations/*/aclConfig}
Gets the AclConfig
. |
getCmekConfig
|
GET /v1alpha/{name=projects/*/locations/*/cmekConfig}
Gets the CmekConfig
. |
obtainCrawlRate
|
POST /v1alpha/{location=projects/*/locations/*}:obtainCrawlRate
Obtains the time series data of organic or dedicated crawl rate for monitoring. |
queryConfigurablePricingUsageStats
|
GET /v1alpha/{project=projects/*}/locations/{location}:queryConfigurablePricingUsageStats
Queries configurable pricing usage stats for a project. |
removeDedicatedCrawlRate
|
POST /v1alpha/{location=projects/*/locations/*}:removeDedicatedCrawlRate
Removes the dedicated crawl rate for a craw_rate_scope. |
setDedicatedCrawlRate
|
POST /v1alpha/{location=projects/*/locations/*}:setDedicatedCrawlRate
Sets the dedicated crawl rate for a crawl_rate_scope. |
setUpDataConnector
|
POST /v1alpha/{parent=projects/*/locations/*}:setUpDataConnector
Creates a Collection
and sets up the DataConnector
for it. |
setUpDataConnectorV2
|
POST /v1alpha/{parent=projects/*/locations/*}:setUpDataConnectorV2
Creates a Collection
and sets up the DataConnector
for it. |
updateAclConfig
|
PATCH /v1alpha/{aclConfig.name=projects/*/locations/*/aclConfig}
Default ACL configuration for use in a location of a customer's project. |
updateCmekConfig
|
PATCH /v1alpha/{config.name=projects/*/locations/*/cmekConfig}
Provisions a CMEK key for use in a location of a customer's project. |
REST Resource: v1alpha.projects.locations.cmekConfigs
| Methods | |
|---|---|
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/cmekConfigs/*}
De-provisions a CmekConfig. |
get
|
GET /v1alpha/{name=projects/*/locations/*/cmekConfigs/*}
Gets the CmekConfig
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*}/cmekConfigs
Lists all the CmekConfig
s with the project. |
patch
|
PATCH /v1alpha/{config.name=projects/*/locations/*/cmekConfigs/*}
Provisions a CMEK key for use in a location of a customer's project. |
REST Resource: v1alpha.projects.locations.collections
| Methods | |
|---|---|
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*}
Deletes a Collection
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*}
Gets a Collection
. |
getDataConnector
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}
Gets the DataConnector
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*}/collections
Gets a list of Collection
s. |
patch
|
PATCH /v1alpha/{collection.name=projects/*/locations/*/collections/*}
Updates a Collection
. |
updateDataConnector
|
PATCH /v1alpha/{dataConnector.name=projects/*/locations/*/collections/*/dataConnector}
Updates a DataConnector
. |
REST Resource: v1alpha.projects.locations.collections.dataConnector
| Methods | |
|---|---|
acquireAccessToken
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:acquireAccessToken
Uses the per-user refresh token minted with AcquireAndStoreRefreshToken
to generate and return a new access token and its details. |
acquireAndStoreRefreshToken
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:acquireAndStoreRefreshToken
Exchanges OAuth authorization credentials for a refresh token and stores the refresh token and the scopes. |
buildActionInvocation
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:buildActionInvocation
Builds an action invocation using the DataConnector
. |
checkRefreshToken
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:checkRefreshToken
Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details. |
executeAction
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:executeAction
Executes a 3rd party action using the DataConnector
. |
fetchEntitiesTypes
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:FetchEntitiesTypes
Fetch the entities types for a DataConnector
. |
getConnectorSecret
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:getConnectorSecret
Get the secret for the associated connector. |
startConnectorRun
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataConnector}:startConnectorRun
Starts an immediate synchronization process for a DataConnector
. |
REST Resource: v1alpha.projects.locations.collections.dataConnector.connectorRuns
| Methods | |
|---|---|
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataConnector}/connectorRuns
Lists the ConnectorRun
s of a DataConnector
. |
REST Resource: v1alpha.projects.locations.collections.dataConnector.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.collections.dataStores
| Methods | |
|---|---|
addPatientFilter
|
POST /v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:addPatientFilter
Adds a group of patient IDs as a patient filter for the data store. |
completeQuery
|
GET /v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:completeQuery
Completes the specified user input with keyword suggestions. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*}/dataStores
Creates a DataStore
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*}
Deletes a DataStore
. |
deletePatientFilter
|
POST /v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:deletePatientFilter
Deletes the entire patient filter for the data store. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*}
Gets a DataStore
. |
getCompletionConfig
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/completionConfig}
Gets a CompletionConfig
|
getDocumentProcessingConfig
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig}
Gets a DocumentProcessingConfig
. |
getSiteSearchEngine
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}
Gets the SiteSearchEngine
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*}/dataStores
Lists all the DataStore
s associated with the project. |
patch
|
PATCH /v1alpha/{dataStore.name=projects/*/locations/*/collections/*/dataStores/*}
Updates a DataStore
|
removePatientFilter
|
POST /v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:removePatientFilter
Removes a group of patient IDs from the patient filter for the data store. |
replacePatientFilter
|
POST /v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:replacePatientFilter
Replaces the patient filter for the data store. |
trainCustomModel
|
POST /v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel
Trains a custom model. |
updateCompletionConfig
|
PATCH /v1alpha/{completionConfig.name=projects/*/locations/*/collections/*/dataStores/*/completionConfig}
Updates the CompletionConfig
s. |
updateDocumentProcessingConfig
|
PATCH /v1alpha/{documentProcessingConfig.name=projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig}
Updates the DocumentProcessingConfig
. |
REST Resource: v1alpha.projects.locations.collections.dataStores.branches
| Methods | |
|---|---|
batchGetDocumentsMetadata
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata
Gets index freshness metadata for Document
s. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}
Retrieves a Branch
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/branches
Lists all Branch
s under the specified parent DataStore
. |
REST Resource: v1alpha.projects.locations.collections.dataStores.branches.documents
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents
Creates a Document
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Deletes a Document
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Gets a Document
. |
getProcessedDocument
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}:getProcessedDocument
Gets the parsed layout information for a Document
. |
import
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:import
Bulk import of multiple Document
s. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents
Gets a list of Document
s. |
patch
|
PATCH /v1alpha/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Updates a Document
. |
purge
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:purge
Permanently deletes all selected Document
s in a branch. |
REST Resource: v1alpha.projects.locations.collections.dataStores.branches.documents.chunks
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*/chunks/*}
Gets a Document
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}/chunks
Gets a list of Chunk
s. |
REST Resource: v1alpha.projects.locations.collections.dataStores.branches.operations
| Methods | |
|---|---|
cancel
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.collections.dataStores.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1alpha/{completionConfig=projects/*/locations/*/collections/*/dataStores/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
REST Resource: v1alpha.projects.locations.collections.dataStores.completionSuggestions
| Methods | |
|---|---|
import
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:import
Imports CompletionSuggestion
s for a DataStore. |
purge
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:purge
Permanently deletes all CompletionSuggestion
s for a DataStore. |
REST Resource: v1alpha.projects.locations.collections.dataStores.controls
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/controls
Creates a Control. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Deletes a Control. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Gets a Control. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1alpha/{control.name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Updates a Control. |
REST Resource: v1alpha.projects.locations.collections.dataStores.conversations
| Methods | |
|---|---|
converse
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1alpha/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Updates a Conversation. |
REST Resource: v1alpha.projects.locations.collections.dataStores.customModels
| Methods | |
|---|---|
list
|
GET /v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}/customModels
Gets a list of all the custom models. |
REST Resource: v1alpha.projects.locations.collections.dataStores.models.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/models/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.collections.dataStores.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.collections.dataStores.schemas
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/schemas
Creates a Schema
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Deletes a Schema
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Gets a Schema
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/schemas
Gets a list of Schema
s. |
patch
|
PATCH /v1alpha/{schema.name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Updates a Schema
. |
REST Resource: v1alpha.projects.locations.collections.dataStores.schemas.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.collections.dataStores.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1alpha/{servingConfig.name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1alpha.projects.locations.collections.dataStores.sessions
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions
Creates a Session. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Deletes a Session. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Gets a Session. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions
Lists all Sessions by their parent DataStore
. |
patch
|
PATCH /v1alpha/{session.name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Updates a Session. |
REST Resource: v1alpha.projects.locations.collections.dataStores.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine
| Methods | |
|---|---|
batchVerifyTargetSites
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:batchVerifyTargetSites
Verify target sites' ownership and validity. |
disableAdvancedSiteSearch
|
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch
Downgrade from advanced site search to basic site search. |
enableAdvancedSiteSearch
|
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch
Upgrade from basic site search to advanced site search. |
fetchDomainVerificationStatus
|
GET /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus
Returns list of target sites with its domain verification status. |
getUriPatternDocumentData
|
GET /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:getUriPatternDocumentData
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. |
recrawlUris
|
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:recrawlUris
Request on-demand recrawl for a list of URIs. |
setUriPatternDocumentData
|
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:setUriPatternDocumentData
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. |
REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine.sitemaps
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/sitemaps
Creates a Sitemap
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*}
Deletes a Sitemap
. |
fetch
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/sitemaps:fetch
Fetch Sitemap
s in a DataStore
. |
REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites
| Methods | |
|---|---|
batchCreate
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites:batchCreate
Creates TargetSite
in a batch. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites
Creates a TargetSite
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Deletes a TargetSite
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Gets a TargetSite
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites
Gets a list of TargetSite
s. |
patch
|
PATCH /v1alpha/{targetSite.name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Updates a TargetSite
. |
REST Resource: v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.collections.dataStores.suggestionDenyListEntries
| Methods | |
|---|---|
import
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:import
Imports all SuggestionDenyListEntry
for a DataStore. |
purge
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:purge
Permanently deletes all SuggestionDenyListEntry
for a DataStore. |
REST Resource: v1alpha.projects.locations.collections.dataStores.userEvents
| Methods | |
|---|---|
collect
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import
Bulk import of user events. |
purge
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:purge
Deletes permanently all user events specified by the filter provided. |
write
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write
Writes a single user event. |
REST Resource: v1alpha.projects.locations.collections.engines
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*}/engines
Creates an Engine
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*}
Deletes an Engine
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*}
Gets an Engine
. |
getCompletionConfig
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/completionConfig}
Gets a CompletionConfig
|
getIamPolicy
|
GET /v1alpha/{resource=projects/*/locations/*/collections/*/engines/*}:getIamPolicy
Gets the IAM access control policy for an Engine
. |
getWorkspaceSettings
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:getWorkspaceSettings
Get Workspace settings for the end user. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*}/engines
Lists all the Engine
s associated with the project. |
patch
|
PATCH /v1alpha/{engine.name=projects/*/locations/*/collections/*/engines/*}
Updates an Engine
|
pause
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:pause
Pauses the training of an existing Engine
. |
resume
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:resume
Resumes the training of an existing Engine
. |
setIamPolicy
|
POST /v1alpha/{resource=projects/*/locations/*/collections/*/engines/*}:setIamPolicy
Sets the IAM access control policy for an Engine
. |
tune
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:tune
Tunes an existing Engine
. |
updateCompletionConfig
|
PATCH /v1alpha/{completionConfig.name=projects/*/locations/*/collections/*/engines/*/completionConfig}
Updates the CompletionConfig
s. |
REST Resource: v1alpha.projects.locations.collections.engines.analytics
| Methods | |
|---|---|
exportMetrics
|
POST /v1alpha/{analytics=projects/*/locations/*/collections/*/engines/*/analytics}:exportMetrics
Exports metrics. |
getConfig
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/analytics/config}
Gets the AnalyticsConfig. |
updateConfig
|
PATCH /v1alpha/{analyticsConfig.name=projects/*/locations/*/collections/*/engines/*/analytics/config}
Updates the AnalyticsConfig for analytics. |
REST Resource: v1alpha.projects.locations.collections.engines.assistants
| Methods | |
|---|---|
assist
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist
Assists the user with a query. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/assistants
Creates an Assistant
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Deletes an Assistant
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Gets an Assistant
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/assistants
Lists all Assistant
s under an Engine
. |
patch
|
PATCH /v1alpha/{assistant.name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Updates an Assistant
|
streamAssist
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:streamAssist
Assists the user with a query in a streaming fashion. |
REST Resource: v1alpha.projects.locations.collections.engines.assistants.agents
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/agents
Creates an Agent
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}
Deletes an Agent
. |
deploy
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:deploy
Deploys an Agent
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}
Gets an Agent
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/agents
Lists all Agent
s under an Assistant
which were created by the caller. |
patch
|
PATCH /v1alpha/{agent.name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}
Updates an Agent
|
rejectAgent
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:rejectAgent
Rejects an Agent offered to the public. |
requestAgentReview
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:requestAgentReview
Presents an Agent to admins by making it available for review. |
withdrawAgent
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:withdrawAgent
Withdraws an Agent offered to the public. |
REST Resource: v1alpha.projects.locations.collections.engines.assistants.agents.files
| Methods | |
|---|---|
import
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/files:import
Imports a file to an Agent
. |
REST Resource: v1alpha.projects.locations.collections.engines.assistants.agents.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1alpha.projects.locations.collections.engines.assistants.cannedQueries
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/cannedQueries
Creates a CannedQuery
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/cannedQueries/*}
Deletes a CannedQuery
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/cannedQueries/*}
Gets a CannedQuery
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/cannedQueries
Lists all CannedQuery
s under an Assistant
. |
listActiveCannedQueryUserViews
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/cannedQueries:listActiveCannedQueryUserViews
Lists the CannedQueryUserView
s for all active CannedQuery
s. |
patch
|
PATCH /v1alpha/{cannedQuery.name=projects/*/locations/*/collections/*/engines/*/assistants/*/cannedQueries/*}
Updates a CannedQuery
. |
REST Resource: v1alpha.projects.locations.collections.engines.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1alpha/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
removeSuggestion
|
POST /v1alpha/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:removeSuggestion
Removes the search history suggestion in an engine for a user. |
REST Resource: v1alpha.projects.locations.collections.engines.controls
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/controls
Creates a Control. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/controls/*}
Deletes a Control. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/controls/*}
Gets a Control. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1alpha/{control.name=projects/*/locations/*/collections/*/engines/*/controls/*}
Updates a Control. |
REST Resource: v1alpha.projects.locations.collections.engines.conversations
| Methods | |
|---|---|
converse
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1alpha/{conversation.name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Updates a Conversation. |
REST Resource: v1alpha.projects.locations.collections.engines.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.collections.engines.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1alpha/{servingConfig.name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1alpha.projects.locations.collections.engines.sessions
| Methods | |
|---|---|
addContextFile
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:addContextFile
Uploads a context file to use as source for the assist calls within the session. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/sessions
Creates a Session. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Deletes a Session. |
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Gets a Session. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/sessions
Lists all Sessions by their parent DataStore
. |
listSessionFileMetadata
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:listSessionFileMetadata
Lists metadata for all files in the current session. |
patch
|
PATCH /v1alpha/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Updates a Session. |
recommendQuestions
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:recommendQuestions
Gets recommended questions for the given session. |
removeContextFile
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:removeContextFile
Removes a context file from a session. |
selectContextFiles
|
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:selectContextFiles
Selects context files to be used in a session. |
REST Resource: v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*/alphaEvolveExperiments/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1alpha.projects.locations.collections.engines.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1alpha.projects.locations.collections.engines.sessions.assistAnswers
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*/assistAnswers/*}
Gets an AssistAnswer
. |
REST Resource: v1alpha.projects.locations.collections.engines.sessions.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1alpha.projects.locations.collections.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/collections/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/collections/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.dataStores
| Methods | |
|---|---|
addPatientFilter
|
POST /v1alpha/{dataStore=projects/*/locations/*/dataStores/*}:addPatientFilter
Adds a group of patient IDs as a patient filter for the data store. |
completeQuery
|
GET /v1alpha/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery
Completes the specified user input with keyword suggestions. |
create
|
POST /v1alpha/{parent=projects/*/locations/*}/dataStores
Creates a DataStore
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*}
Deletes a DataStore
. |
deletePatientFilter
|
POST /v1alpha/{dataStore=projects/*/locations/*/dataStores/*}:deletePatientFilter
Deletes the entire patient filter for the data store. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*}
Gets a DataStore
. |
getCompletionConfig
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/completionConfig}
Gets a CompletionConfig
|
getDocumentProcessingConfig
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/documentProcessingConfig}
Gets a DocumentProcessingConfig
. |
getSiteSearchEngine
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/siteSearchEngine}
Gets the SiteSearchEngine
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*}/dataStores
Lists all the DataStore
s associated with the project. |
patch
|
PATCH /v1alpha/{dataStore.name=projects/*/locations/*/dataStores/*}
Updates a DataStore
|
removePatientFilter
|
POST /v1alpha/{dataStore=projects/*/locations/*/dataStores/*}:removePatientFilter
Removes a group of patient IDs from the patient filter for the data store. |
replacePatientFilter
|
POST /v1alpha/{dataStore=projects/*/locations/*/dataStores/*}:replacePatientFilter
Replaces the patient filter for the data store. |
updateCompletionConfig
|
PATCH /v1alpha/{completionConfig.name=projects/*/locations/*/dataStores/*/completionConfig}
Updates the CompletionConfig
s. |
updateDocumentProcessingConfig
|
PATCH /v1alpha/{documentProcessingConfig.name=projects/*/locations/*/dataStores/*/documentProcessingConfig}
Updates the DocumentProcessingConfig
. |
REST Resource: v1alpha.projects.locations.dataStores.branches
| Methods | |
|---|---|
batchGetDocumentsMetadata
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata
Gets index freshness metadata for Document
s. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*}
Retrieves a Branch
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*}/branches
Lists all Branch
s under the specified parent DataStore
. |
REST Resource: v1alpha.projects.locations.dataStores.branches.documents
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents
Creates a Document
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Deletes a Document
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Gets a Document
. |
getProcessedDocument
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}:getProcessedDocument
Gets the parsed layout information for a Document
. |
import
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:import
Bulk import of multiple Document
s. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents
Gets a list of Document
s. |
patch
|
PATCH /v1alpha/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Updates a Document
. |
purge
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:purge
Permanently deletes all selected Document
s in a branch. |
REST Resource: v1alpha.projects.locations.dataStores.branches.documents.chunks
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*/chunks/*}
Gets a Document
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*/documents/*}/chunks
Gets a list of Chunk
s. |
REST Resource: v1alpha.projects.locations.dataStores.branches.operations
| Methods | |
|---|---|
cancel
|
POST /v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/branches/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.dataStores.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1alpha/{completionConfig=projects/*/locations/*/dataStores/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
REST Resource: v1alpha.projects.locations.dataStores.completionSuggestions
| Methods | |
|---|---|
import
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:import
Imports CompletionSuggestion
s for a DataStore. |
purge
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:purge
Permanently deletes all CompletionSuggestion
s for a DataStore. |
REST Resource: v1alpha.projects.locations.dataStores.controls
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/controls
Creates a Control. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*/controls/*}
Deletes a Control. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/controls/*}
Gets a Control. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1alpha/{control.name=projects/*/locations/*/dataStores/*/controls/*}
Updates a Control. |
REST Resource: v1alpha.projects.locations.dataStores.conversations
| Methods | |
|---|---|
converse
|
POST /v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1alpha/{conversation.name=projects/*/locations/*/dataStores/*/conversations/*}
Updates a Conversation. |
REST Resource: v1alpha.projects.locations.dataStores.models.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/models/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/models/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.dataStores.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.dataStores.schemas
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/schemas
Creates a Schema
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*/schemas/*}
Deletes a Schema
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/schemas/*}
Gets a Schema
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*}/schemas
Gets a list of Schema
s. |
patch
|
PATCH /v1alpha/{schema.name=projects/*/locations/*/dataStores/*/schemas/*}
Updates a Schema
. |
REST Resource: v1alpha.projects.locations.dataStores.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1alpha/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1alpha/{servingConfig.name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1alpha/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1alpha/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1alpha/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1alpha/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1alpha.projects.locations.dataStores.sessions
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/sessions
Creates a Session. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*/sessions/*}
Deletes a Session. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/sessions/*}
Gets a Session. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*}/sessions
Lists all Sessions by their parent DataStore
. |
patch
|
PATCH /v1alpha/{session.name=projects/*/locations/*/dataStores/*/sessions/*}
Updates a Session. |
REST Resource: v1alpha.projects.locations.dataStores.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1alpha.projects.locations.dataStores.siteSearchEngine
| Methods | |
|---|---|
disableAdvancedSiteSearch
|
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch
Downgrade from advanced site search to basic site search. |
enableAdvancedSiteSearch
|
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch
Upgrade from basic site search to advanced site search. |
recrawlUris
|
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:recrawlUris
Request on-demand recrawl for a list of URIs. |
REST Resource: v1alpha.projects.locations.dataStores.siteSearchEngine.sitemaps
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps
Creates a Sitemap
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/sitemaps/*}
Deletes a Sitemap
. |
fetch
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps:fetch
Fetch Sitemap
s in a DataStore
. |
REST Resource: v1alpha.projects.locations.dataStores.siteSearchEngine.targetSites
| Methods | |
|---|---|
batchCreate
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites:batchCreate
Creates TargetSite
in a batch. |
create
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites
Creates a TargetSite
. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Deletes a TargetSite
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Gets a TargetSite
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites
Gets a list of TargetSite
s. |
patch
|
PATCH /v1alpha/{targetSite.name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Updates a TargetSite
. |
REST Resource: v1alpha.projects.locations.dataStores.suggestionDenyListEntries
| Methods | |
|---|---|
import
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/suggestionDenyListEntries:import
Imports all SuggestionDenyListEntry
for a DataStore. |
purge
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/**}/suggestionDenyListEntries:purge
Permanently deletes all SuggestionDenyListEntry
for a DataStore. |
REST Resource: v1alpha.projects.locations.dataStores.userEvents
| Methods | |
|---|---|
collect
|
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:import
Bulk import of user events. |
purge
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:purge
Deletes permanently all user events specified by the filter provided. |
write
|
POST /v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:write
Writes a single user event. |
REST Resource: v1alpha.projects.locations.evaluations
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*}/evaluations
Creates a Evaluation
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/evaluations/*}
Gets a Evaluation
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*}/evaluations
Gets a list of Evaluation
s. |
listResults
|
GET /v1alpha/{evaluation=projects/*/locations/*/evaluations/*}:listResults
Gets a list of results for a given a Evaluation
. |
REST Resource: v1alpha.projects.locations.evaluations.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1alpha.projects.locations.groundingConfigs
| Methods | |
|---|---|
check
|
POST /v1alpha/{groundingConfig=projects/*/locations/*/groundingConfigs/*}:check
Performs a grounding check. |
REST Resource: v1alpha.projects.locations.identityMappingStores
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*}/identityMappingStores
Creates a new Identity Mapping Store. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/identityMappingStores/*}
Deletes the Identity Mapping Store. |
get
|
GET /v1alpha/{name=projects/*/locations/*/identityMappingStores/*}
Gets the Identity Mapping Store. |
importIdentityMappings
|
POST /v1alpha/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:importIdentityMappings
Imports a list of Identity Mapping Entries to an Identity Mapping Store. |
list
|
GET /v1alpha/{parent=projects/*/locations/*}/identityMappingStores
Lists all Identity Mapping Stores. |
listIdentityMappings
|
GET /v1alpha/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:listIdentityMappings
Lists Identity Mappings in an Identity Mapping Store. |
purgeIdentityMappings
|
POST /v1alpha/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings
Purges specified or all Identity Mapping Entries from an Identity Mapping Store. |
REST Resource: v1alpha.projects.locations.identityMappingStores.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/identityMappingStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/identityMappingStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.licenseConfigs
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*}/licenseConfigs
Creates a LicenseConfig
This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses. |
get
|
GET /v1alpha/{name=projects/*/locations/*/licenseConfigs/*}
Gets a LicenseConfig
. |
patch
|
PATCH /v1alpha/{licenseConfig.name=projects/*/locations/*/licenseConfigs/*}
Updates the LicenseConfig
|
REST Resource: v1alpha.projects.locations.notebooks
| Methods | |
|---|---|
batchDelete
|
POST /v1alpha/{parent=projects/*/locations/*}/notebooks:batchDelete
Batch deletes Notebooks. |
create
|
POST /v1alpha/{parent=projects/*/locations/*}/notebooks
Creates a notebook. |
get
|
GET /v1alpha/{name=projects/*/locations/*/notebooks/*}
Gets a notebook. |
listRecentlyViewed
|
GET /v1alpha/{parent=projects/*/locations/*}/notebooks:listRecentlyViewed
Lists the notebooks ordered by last view time. |
share
|
POST /v1alpha/{name=projects/*/locations/*/notebooks/*}:share
Shares a notebook to other accounts. |
REST Resource: v1alpha.projects.locations.notebooks.audioOverviews
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/notebooks/*}/audioOverviews
Generates a new audio overview. |
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/notebooks/*/audioOverviews/*}
Deletes an audio overview. |
REST Resource: v1alpha.projects.locations.notebooks.sources
| Methods | |
|---|---|
batchCreate
|
POST /v1alpha/{parent=projects/*/locations/*/notebooks/*}/sources:batchCreate
Creates a list of Source
s. |
batchDelete
|
POST /v1alpha/{parent=projects/*/locations/*/notebooks/*}/sources:batchDelete
Deletes multiple sources |
get
|
GET /v1alpha/{name=projects/*/locations/*/notebooks/*/sources/*}
Gets a Source
. |
REST Resource: v1alpha.projects.locations.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.podcasts.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/podcasts/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1alpha.projects.locations.rankingConfigs
| Methods | |
|---|---|
rank
|
POST /v1alpha/{rankingConfig=projects/*/locations/*/rankingConfigs/*}:rank
Ranks a list of text records based on the given input query. |
REST Resource: v1alpha.projects.locations.requirements
| Methods | |
|---|---|
checkRequirement
|
POST /v1alpha/{location=projects/*/locations/*}/requirements:checkRequirement
Check a particular requirement. |
REST Resource: v1alpha.projects.locations.sampleQuerySets
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*}/sampleQuerySets
Creates a SampleQuerySet
|
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/sampleQuerySets/*}
Deletes a SampleQuerySet
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/sampleQuerySets/*}
Gets a SampleQuerySet
. |
list
|
GET /v1alpha/{parent=projects/*/locations/*}/sampleQuerySets
Gets a list of SampleQuerySet
s. |
patch
|
PATCH /v1alpha/{sampleQuerySet.name=projects/*/locations/*/sampleQuerySets/*}
Updates a SampleQuerySet
. |
REST Resource: v1alpha.projects.locations.sampleQuerySets.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1alpha.projects.locations.sampleQuerySets.sampleQueries
| Methods | |
|---|---|
create
|
POST /v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries
Creates a SampleQuery
|
delete
|
DELETE /v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}
Deletes a SampleQuery
. |
get
|
GET /v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}
Gets a SampleQuery
. |
import
|
POST /v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries:import
Bulk import of multiple SampleQuery
s. |
list
|
GET /v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries
Gets a list of SampleQuery
s. |
patch
|
PATCH /v1alpha/{sampleQuery.name=projects/*/locations/*/sampleQuerySets/*/sampleQueries/*}
Updates a SampleQuery
. |
REST Resource: v1alpha.projects.locations.userEvents
| Methods | |
|---|---|
collect
|
GET /v1alpha/{parent=projects/*/locations/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1alpha/{parent=projects/*/locations/*}/userEvents:import
Bulk import of user events. |
write
|
POST /v1alpha/{parent=projects/*/locations/*}/userEvents:write
Writes a single user event. |
REST Resource: v1alpha.projects.locations.userStores
| Methods | |
|---|---|
batchUpdateUserLicenses
|
POST /v1alpha/{parent=projects/*/locations/*/userStores/*}:batchUpdateUserLicenses
Updates the User License. |
get
|
GET /v1alpha/{name=projects/*/locations/*/userStores/*}
Gets the User Store. |
patch
|
PATCH /v1alpha/{userStore.name=projects/*/locations/*/userStores/*}
Updates the User Store. |
REST Resource: v1alpha.projects.locations.userStores.licenseConfigsUsageStats
| Methods | |
|---|---|
list
|
GET /v1alpha/{parent=projects/*/locations/*/userStores/*}/licenseConfigsUsageStats
Lists all the LicenseConfigUsageStats
s associated with the project. |
REST Resource: v1alpha.projects.locations.userStores.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/locations/*/userStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*/locations/*/userStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1alpha.projects.locations.userStores.userLicenses
| Methods | |
|---|---|
list
|
GET /v1alpha/{parent=projects/*/locations/*/userStores/*}/userLicenses
Lists the User Licenses. |
REST Resource: v1alpha.projects.operations
| Methods | |
|---|---|
get
|
GET /v1alpha/{name=projects/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1alpha/{name=projects/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects
| Methods | |
|---|---|
provision
|
POST /v1/{name=projects/*}:provision
Provisions the project resource. |
REST Resource: v1.projects.locations
| Methods | |
|---|---|
getAclConfig
|
GET /v1/{name=projects/*/locations/*/aclConfig}
Gets the AclConfig
. |
getCmekConfig
|
GET /v1/{name=projects/*/locations/*/cmekConfig}
Gets the CmekConfig
. |
setUpDataConnector
|
POST /v1/{parent=projects/*/locations/*}:setUpDataConnector
Creates a Collection
and sets up the DataConnector
for it. |
setUpDataConnectorV2
|
POST /v1/{parent=projects/*/locations/*}:setUpDataConnectorV2
Creates a Collection
and sets up the DataConnector
for it. |
updateAclConfig
|
PATCH /v1/{aclConfig.name=projects/*/locations/*/aclConfig}
Default ACL configuration for use in a location of a customer's project. |
updateCmekConfig
|
PATCH /v1/{config.name=projects/*/locations/*/cmekConfig}
Provisions a CMEK key for use in a location of a customer's project. |
REST Resource: v1.projects.locations.cmekConfigs
| Methods | |
|---|---|
delete
|
DELETE /v1/{name=projects/*/locations/*/cmekConfigs/*}
De-provisions a CmekConfig. |
get
|
GET /v1/{name=projects/*/locations/*/cmekConfigs/*}
Gets the CmekConfig
. |
list
|
GET /v1/{parent=projects/*/locations/*}/cmekConfigs
Lists all the CmekConfig
s with the project. |
patch
|
PATCH /v1/{config.name=projects/*/locations/*/cmekConfigs/*}
Provisions a CMEK key for use in a location of a customer's project. |
REST Resource: v1.projects.locations.collections
| Methods | |
|---|---|
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*}
Deletes a Collection
. |
getDataConnector
|
GET /v1/{name=projects/*/locations/*/collections/*/dataConnector}
Gets the DataConnector
. |
updateDataConnector
|
PATCH /v1/{dataConnector.name=projects/*/locations/*/collections/*/dataConnector}
Updates a DataConnector
. |
REST Resource: v1.projects.locations.collections.dataConnector.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataConnector/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*/dataConnector}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.collections.dataStores
| Methods | |
|---|---|
completeQuery
|
GET /v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:completeQuery
Completes the specified user input with keyword suggestions. |
create
|
POST /v1/{parent=projects/*/locations/*/collections/*}/dataStores
Creates a DataStore
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*}
Deletes a DataStore
. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*}
Gets a DataStore
. |
getSiteSearchEngine
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}
Gets the SiteSearchEngine
. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*}/dataStores
Lists all the DataStore
s associated with the project. |
patch
|
PATCH /v1/{dataStore.name=projects/*/locations/*/collections/*/dataStores/*}
Updates a DataStore
|
trainCustomModel
|
POST /v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel
Trains a custom model. |
REST Resource: v1.projects.locations.collections.dataStores.branches
| Methods | |
|---|---|
batchGetDocumentsMetadata
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata
Gets index freshness metadata for Document
s. |
REST Resource: v1.projects.locations.collections.dataStores.branches.documents
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents
Creates a Document
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Deletes a Document
. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Gets a Document
. |
import
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:import
Bulk import of multiple Document
s. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents
Gets a list of Document
s. |
patch
|
PATCH /v1/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
Updates a Document
. |
purge
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:purge
Permanently deletes all selected Document
s in a branch. |
REST Resource: v1.projects.locations.collections.dataStores.branches.operations
| Methods | |
|---|---|
cancel
|
POST /v1/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.collections.dataStores.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1/{completionConfig=projects/*/locations/*/collections/*/dataStores/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
REST Resource: v1.projects.locations.collections.dataStores.completionSuggestions
| Methods | |
|---|---|
import
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:import
Imports CompletionSuggestion
s for a DataStore. |
purge
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:purge
Permanently deletes all CompletionSuggestion
s for a DataStore. |
REST Resource: v1.projects.locations.collections.dataStores.controls
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/controls
Creates a Control. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Deletes a Control. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Gets a Control. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1/{control.name=projects/*/locations/*/collections/*/dataStores/*/controls/*}
Updates a Control. |
REST Resource: v1.projects.locations.collections.dataStores.conversations
| Methods | |
|---|---|
converse
|
POST /v1/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
Updates a Conversation. |
REST Resource: v1.projects.locations.collections.dataStores.customModels
| Methods | |
|---|---|
list
|
GET /v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}/customModels
Gets a list of all the custom models. |
REST Resource: v1.projects.locations.collections.dataStores.models.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/models/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.collections.dataStores.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.collections.dataStores.schemas
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/schemas
Creates a Schema
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Deletes a Schema
. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Gets a Schema
. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/schemas
Gets a list of Schema
s. |
patch
|
PATCH /v1/{schema.name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}
Updates a Schema
. |
REST Resource: v1.projects.locations.collections.dataStores.schemas.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.collections.dataStores.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1/{servingConfig.name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1.projects.locations.collections.dataStores.sessions
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions
Creates a Session. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Deletes a Session. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Gets a Session. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions
Lists all Sessions by their parent DataStore
. |
patch
|
PATCH /v1/{session.name=projects/*/locations/*/collections/*/dataStores/*/sessions/*}
Updates a Session. |
REST Resource: v1.projects.locations.collections.dataStores.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine
| Methods | |
|---|---|
batchVerifyTargetSites
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:batchVerifyTargetSites
Verify target sites' ownership and validity. |
disableAdvancedSiteSearch
|
POST /v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch
Downgrade from advanced site search to basic site search. |
enableAdvancedSiteSearch
|
POST /v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch
Upgrade from basic site search to advanced site search. |
fetchDomainVerificationStatus
|
GET /v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus
Returns list of target sites with its domain verification status. |
recrawlUris
|
POST /v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:recrawlUris
Request on-demand recrawl for a list of URIs. |
REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine.sitemaps
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/sitemaps
Creates a Sitemap
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*}
Deletes a Sitemap
. |
fetch
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/sitemaps:fetch
Fetch Sitemap
s in a DataStore
. |
REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine.targetSites
| Methods | |
|---|---|
batchCreate
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites:batchCreate
Creates TargetSite
in a batch. |
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites
Creates a TargetSite
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Deletes a TargetSite
. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Gets a TargetSite
. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites
Gets a list of TargetSite
s. |
patch
|
PATCH /v1/{targetSite.name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}
Updates a TargetSite
. |
REST Resource: v1.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.collections.dataStores.suggestionDenyListEntries
| Methods | |
|---|---|
import
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:import
Imports all SuggestionDenyListEntry
for a DataStore. |
purge
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/suggestionDenyListEntries:purge
Permanently deletes all SuggestionDenyListEntry
for a DataStore. |
REST Resource: v1.projects.locations.collections.dataStores.userEvents
| Methods | |
|---|---|
collect
|
GET /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import
Bulk import of user events. |
purge
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:purge
Deletes permanently all user events specified by the filter provided. |
write
|
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write
Writes a single user event. |
REST Resource: v1.projects.locations.collections.engines
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/collections/*}/engines
Creates an Engine
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/engines/*}
Deletes an Engine
. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*}
Gets an Engine
. |
getIamPolicy
|
GET /v1/{resource=projects/*/locations/*/collections/*/engines/*}:getIamPolicy
Gets the IAM access control policy for an Engine
. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*}/engines
Lists all the Engine
s associated with the project. |
patch
|
PATCH /v1/{engine.name=projects/*/locations/*/collections/*/engines/*}
Updates an Engine
|
setIamPolicy
|
POST /v1/{resource=projects/*/locations/*/collections/*/engines/*}:setIamPolicy
Sets the IAM access control policy for an Engine
. |
REST Resource: v1.projects.locations.collections.engines.assistants
| Methods | |
|---|---|
assist
|
POST /v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist
Assists the user with a query. |
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/engines/*}/assistants
Creates an Assistant
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Deletes an Assistant
. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Gets an Assistant
. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/engines/*}/assistants
Lists all Assistant
s under an Engine
. |
patch
|
PATCH /v1/{assistant.name=projects/*/locations/*/collections/*/engines/*/assistants/*}
Updates an Assistant
|
streamAssist
|
POST /v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:streamAssist
Assists the user with a query in a streaming fashion. |
REST Resource: v1.projects.locations.collections.engines.assistants.agents.a2a.v1
| Methods | |
|---|---|
getCard
|
GET /v1/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/a2a/v1/card
GetAgentCard returns the agent card for the agent. |
REST Resource: v1.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks
| Methods | |
|---|---|
cancel
|
POST /v1/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/a2a/v1/{name=tasks/*}:cancel
Cancel a task from the agent. |
get
|
GET /v1/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/a2a/v1/{name=tasks/*}
Get the current state of a task from the agent. |
subscribe
|
GET /v1/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/a2a/v1/{name=tasks/*}:subscribe
TaskSubscription is a streaming call that will return a stream of task update events. |
REST Resource: v1.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs
| Methods | |
|---|---|
create
|
POST /v1/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/a2a/v1/{parent=tasks/*/pushNotificationConfigs}
Set a push notification config for a task. |
delete
|
DELETE /v1/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/a2a/v1/{name=tasks/*/pushNotificationConfigs/*}
Delete a push notification config for a task. |
get
|
GET /v1/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/a2a/v1/{name=tasks/*/pushNotificationConfigs/*}
Get a push notification config for a task. |
list
|
GET /v1/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/a2a/v1/{parent=tasks/*}/pushNotificationConfigs
Get a list of push notifications configured for a task. |
REST Resource: v1.projects.locations.collections.engines.assistants.agents.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1.projects.locations.collections.engines.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
REST Resource: v1.projects.locations.collections.engines.controls
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/engines/*}/controls
Creates a Control. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/engines/*/controls/*}
Deletes a Control. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/controls/*}
Gets a Control. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/engines/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1/{control.name=projects/*/locations/*/collections/*/engines/*/controls/*}
Updates a Control. |
REST Resource: v1.projects.locations.collections.engines.conversations
| Methods | |
|---|---|
converse
|
POST /v1/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/engines/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/engines/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1/{conversation.name=projects/*/locations/*/collections/*/engines/*/conversations/*}
Updates a Conversation. |
REST Resource: v1.projects.locations.collections.engines.operations
| Methods | |
|---|---|
cancel
|
POST /v1/{name=projects/*/locations/*/collections/*/engines/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.collections.engines.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1/{servingConfig.name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1.projects.locations.collections.engines.sessions
| Methods | |
|---|---|
addContextFile
|
POST /v1/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:addContextFile
Uploads a context file to use as source for the assist calls within the session. |
create
|
POST /v1/{parent=projects/*/locations/*/collections/*/engines/*}/sessions
Creates a Session. |
delete
|
DELETE /v1/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Deletes a Session. |
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Gets a Session. |
list
|
GET /v1/{parent=projects/*/locations/*/collections/*/engines/*}/sessions
Lists all Sessions by their parent DataStore
. |
patch
|
PATCH /v1/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*}
Updates a Session. |
REST Resource: v1.projects.locations.collections.engines.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1.projects.locations.collections.engines.sessions.assistAnswers
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/engines/*/sessions/*/assistAnswers/*}
Gets an AssistAnswer
. |
REST Resource: v1.projects.locations.collections.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/collections/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/collections/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.dataStores
| Methods | |
|---|---|
completeQuery
|
GET /v1/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery
Completes the specified user input with keyword suggestions. |
create
|
POST /v1/{parent=projects/*/locations/*}/dataStores
Creates a DataStore
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*}
Deletes a DataStore
. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*}
Gets a DataStore
. |
getSiteSearchEngine
|
GET /v1/{name=projects/*/locations/*/dataStores/*/siteSearchEngine}
Gets the SiteSearchEngine
. |
list
|
GET /v1/{parent=projects/*/locations/*}/dataStores
Lists all the DataStore
s associated with the project. |
patch
|
PATCH /v1/{dataStore.name=projects/*/locations/*/dataStores/*}
Updates a DataStore
|
REST Resource: v1.projects.locations.dataStores.branches
| Methods | |
|---|---|
batchGetDocumentsMetadata
|
GET /v1/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata
Gets index freshness metadata for Document
s. |
REST Resource: v1.projects.locations.dataStores.branches.documents
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents
Creates a Document
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Deletes a Document
. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Gets a Document
. |
import
|
POST /v1/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:import
Bulk import of multiple Document
s. |
list
|
GET /v1/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents
Gets a list of Document
s. |
patch
|
PATCH /v1/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
Updates a Document
. |
purge
|
POST /v1/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:purge
Permanently deletes all selected Document
s in a branch. |
REST Resource: v1.projects.locations.dataStores.branches.operations
| Methods | |
|---|---|
cancel
|
POST /v1/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/dataStores/*/branches/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.dataStores.completionConfig
| Methods | |
|---|---|
completeQuery
|
POST /v1/{completionConfig=projects/*/locations/*/dataStores/*/completionConfig}:completeQuery
Completes the user input with advanced keyword suggestions. |
REST Resource: v1.projects.locations.dataStores.completionSuggestions
| Methods | |
|---|---|
import
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:import
Imports CompletionSuggestion
s for a DataStore. |
purge
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:purge
Permanently deletes all CompletionSuggestion
s for a DataStore. |
REST Resource: v1.projects.locations.dataStores.controls
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/controls
Creates a Control. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*/controls/*}
Deletes a Control. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/controls/*}
Gets a Control. |
list
|
GET /v1/{parent=projects/*/locations/*/dataStores/*}/controls
Lists all Controls by their parent DataStore
. |
patch
|
PATCH /v1/{control.name=projects/*/locations/*/dataStores/*/controls/*}
Updates a Control. |
REST Resource: v1.projects.locations.dataStores.conversations
| Methods | |
|---|---|
converse
|
POST /v1/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse
Converses a conversation. |
create
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/conversations
Creates a Conversation. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*/conversations/*}
Deletes a Conversation. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/conversations/*}
Gets a Conversation. |
list
|
GET /v1/{parent=projects/*/locations/*/dataStores/*}/conversations
Lists all Conversations by their parent DataStore
. |
patch
|
PATCH /v1/{conversation.name=projects/*/locations/*/dataStores/*/conversations/*}
Updates a Conversation. |
REST Resource: v1.projects.locations.dataStores.models.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/models/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/dataStores/*/models/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.dataStores.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/dataStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.dataStores.schemas
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/schemas
Creates a Schema
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*/schemas/*}
Deletes a Schema
. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/schemas/*}
Gets a Schema
. |
list
|
GET /v1/{parent=projects/*/locations/*/dataStores/*}/schemas
Gets a list of Schema
s. |
patch
|
PATCH /v1/{schema.name=projects/*/locations/*/dataStores/*/schemas/*}
Updates a Schema
. |
REST Resource: v1.projects.locations.dataStores.servingConfigs
| Methods | |
|---|---|
answer
|
POST /v1/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:answer
Answer query method. |
create
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/servingConfigs
Creates a ServingConfig. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Deletes a ServingConfig. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Gets a ServingConfig. |
list
|
GET /v1/{parent=projects/*/locations/*/dataStores/*}/servingConfigs
Lists all ServingConfigs linked to this dataStore. |
patch
|
PATCH /v1/{servingConfig.name=projects/*/locations/*/dataStores/*/servingConfigs/*}
Updates a ServingConfig. |
recommend
|
POST /v1/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:recommend
Makes a recommendation, which requires a contextual user event. |
search
|
POST /v1/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:search
Performs a search. |
searchLite
|
POST /v1/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite
Performs a search. |
streamAnswer
|
POST /v1/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:streamAnswer
Answer query method (streaming). |
REST Resource: v1.projects.locations.dataStores.sessions
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/sessions
Creates a Session. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*/sessions/*}
Deletes a Session. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/sessions/*}
Gets a Session. |
list
|
GET /v1/{parent=projects/*/locations/*/dataStores/*}/sessions
Lists all Sessions by their parent DataStore
. |
patch
|
PATCH /v1/{session.name=projects/*/locations/*/dataStores/*/sessions/*}
Updates a Session. |
REST Resource: v1.projects.locations.dataStores.sessions.answers
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/sessions/*/answers/*}
Gets a Answer. |
REST Resource: v1.projects.locations.dataStores.siteSearchEngine
| Methods | |
|---|---|
disableAdvancedSiteSearch
|
POST /v1/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch
Downgrade from advanced site search to basic site search. |
enableAdvancedSiteSearch
|
POST /v1/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch
Upgrade from basic site search to advanced site search. |
recrawlUris
|
POST /v1/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:recrawlUris
Request on-demand recrawl for a list of URIs. |
REST Resource: v1.projects.locations.dataStores.siteSearchEngine.sitemaps
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps
Creates a Sitemap
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/sitemaps/*}
Deletes a Sitemap
. |
fetch
|
GET /v1/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps:fetch
Fetch Sitemap
s in a DataStore
. |
REST Resource: v1.projects.locations.dataStores.siteSearchEngine.targetSites
| Methods | |
|---|---|
batchCreate
|
POST /v1/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites:batchCreate
Creates TargetSite
in a batch. |
create
|
POST /v1/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites
Creates a TargetSite
. |
delete
|
DELETE /v1/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Deletes a TargetSite
. |
get
|
GET /v1/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Gets a TargetSite
. |
list
|
GET /v1/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites
Gets a list of TargetSite
s. |
patch
|
PATCH /v1/{targetSite.name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}
Updates a TargetSite
. |
REST Resource: v1.projects.locations.dataStores.suggestionDenyListEntries
| Methods | |
|---|---|
import
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/suggestionDenyListEntries:import
Imports all SuggestionDenyListEntry
for a DataStore. |
purge
|
POST /v1/{parent=projects/*/locations/*/dataStores/**}/suggestionDenyListEntries:purge
Permanently deletes all SuggestionDenyListEntry
for a DataStore. |
REST Resource: v1.projects.locations.dataStores.userEvents
| Methods | |
|---|---|
collect
|
GET /v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:import
Bulk import of user events. |
purge
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:purge
Deletes permanently all user events specified by the filter provided. |
write
|
POST /v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:write
Writes a single user event. |
REST Resource: v1.projects.locations.groundingConfigs
| Methods | |
|---|---|
check
|
POST /v1/{groundingConfig=projects/*/locations/*/groundingConfigs/*}:check
Performs a grounding check. |
REST Resource: v1.projects.locations.identityMappingStores
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*}/identityMappingStores
Creates a new Identity Mapping Store. |
delete
|
DELETE /v1/{name=projects/*/locations/*/identityMappingStores/*}
Deletes the Identity Mapping Store. |
get
|
GET /v1/{name=projects/*/locations/*/identityMappingStores/*}
Gets the Identity Mapping Store. |
importIdentityMappings
|
POST /v1/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:importIdentityMappings
Imports a list of Identity Mapping Entries to an Identity Mapping Store. |
list
|
GET /v1/{parent=projects/*/locations/*}/identityMappingStores
Lists all Identity Mapping Stores. |
listIdentityMappings
|
GET /v1/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:listIdentityMappings
Lists Identity Mappings in an Identity Mapping Store. |
purgeIdentityMappings
|
POST /v1/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings
Purges specified or all Identity Mapping Entries from an Identity Mapping Store. |
REST Resource: v1.projects.locations.identityMappingStores.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/identityMappingStores/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/identityMappingStores/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.licenseConfigs
| Methods | |
|---|---|
create
|
POST /v1/{parent=projects/*/locations/*}/licenseConfigs
Creates a LicenseConfig
This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses. |
get
|
GET /v1/{name=projects/*/locations/*/licenseConfigs/*}
Gets a LicenseConfig
. |
patch
|
PATCH /v1/{licenseConfig.name=projects/*/locations/*/licenseConfigs/*}
Updates the LicenseConfig
|
REST Resource: v1.projects.locations.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.podcasts.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/podcasts/*/operations/*}
Gets the latest state of a long-running operation. |
REST Resource: v1.projects.locations.rankingConfigs
| Methods | |
|---|---|
rank
|
POST /v1/{rankingConfig=projects/*/locations/*/rankingConfigs/*}:rank
Ranks a list of text records based on the given input query. |
REST Resource: v1.projects.locations.userEvents
| Methods | |
|---|---|
collect
|
GET /v1/{parent=projects/*/locations/*}/userEvents:collect
Writes a single user event from the browser. |
import
|
POST /v1/{parent=projects/*/locations/*}/userEvents:import
Bulk import of user events. |
write
|
POST /v1/{parent=projects/*/locations/*}/userEvents:write
Writes a single user event. |
REST Resource: v1.projects.locations.userStores
| Methods | |
|---|---|
batchUpdateUserLicenses
|
POST /v1/{parent=projects/*/locations/*/userStores/*}:batchUpdateUserLicenses
Updates the User License. |
get
|
GET /v1/{name=projects/*/locations/*/userStores/*}
Gets the User Store. |
patch
|
PATCH /v1/{userStore.name=projects/*/locations/*/userStores/*}
Updates the User Store. |
REST Resource: v1.projects.locations.userStores.licenseConfigsUsageStats
| Methods | |
|---|---|
list
|
GET /v1/{parent=projects/*/locations/*/userStores/*}/licenseConfigsUsageStats
Lists all the LicenseConfigUsageStats
s associated with the project. |
REST Resource: v1.projects.locations.userStores.userLicenses
| Methods | |
|---|---|
list
|
GET /v1/{parent=projects/*/locations/*/userStores/*}/userLicenses
Lists the User Licenses. |
REST Resource: v1.projects.operations
| Methods | |
|---|---|
cancel
|
POST /v1/{name=projects/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1/{name=projects/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*}/operations
Lists operations that match the specified filter in the request. |

