Discovery Engine API.
- REST Resource: v1beta.projects
- 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.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.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.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.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.operations
- REST Resource: v1beta.projects.locations.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.operations
- REST Resource: v1alpha.projects
- REST Resource: v1alpha.projects.locations
- REST Resource: v1alpha.projects.locations.cmekConfigs
- 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.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.engines
- 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.answers
- 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.targetSites
- REST Resource: v1alpha.projects.locations.dataStores.suggestionDenyListEntries
- REST Resource: v1alpha.projects.locations.dataStores.userEvents
- 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.operations
- REST Resource: v1alpha.projects.locations.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.operations
- REST Resource: v1alpha.projects.operations
- REST Resource: v1.projects
- 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.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.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.engines
- 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.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.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.targetSites
- REST Resource: v1.projects.locations.dataStores.suggestionDenyListEntries
- REST Resource: v1.projects.locations.dataStores.userEvents
- REST Resource: v1.projects.locations.groundingConfigs
- REST Resource: v1.projects.locations.identityMappingStores.operations
- REST Resource: v1.projects.locations.operations
- REST Resource: v1.projects.locations.rankingConfigs
- REST Resource: v1.projects.locations.userEvents
- 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.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 | |
---|---|
complete |
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 . |
get |
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 |
train |
POST /v1beta/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel Trains a custom model. |
REST Resource: v1beta.projects.locations.collections.dataStores.branches
Methods | |
---|---|
batch |
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 | |
---|---|
complete |
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. |
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. |
search |
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite Performs a search. |
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 | |
---|---|
batch |
POST /v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:batchVerifyTargetSites Verify target sites' ownership and validity. |
disable |
POST /v1beta/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch Downgrade from advanced site search to basic site search. |
enable |
POST /v1beta/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch Upgrade from basic site search to advanced site search. |
fetch |
GET /v1beta/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus Returns list of target sites with its domain verification status. |
recrawl |
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.targetSites
Methods | |
---|---|
batch |
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 a Engine . |
delete |
DELETE /v1beta/{name=projects/*/locations/*/collections/*/engines/*} Deletes a Engine . |
get |
GET /v1beta/{name=projects/*/locations/*/collections/*/engines/*} Gets a 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. |
tune |
POST /v1beta/{name=projects/*/locations/*/collections/*/engines/*}:tune Tunes an existing engine. |
REST Resource: v1beta.projects.locations.collections.engines.completionConfig
Methods | |
---|---|
complete |
POST /v1beta/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery Completes the user input with advanced keyword suggestions. |
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. |
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. |
search |
POST /v1beta/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite Performs a search. |
REST Resource: v1beta.projects.locations.collections.engines.sessions
Methods | |
---|---|
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.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 | |
---|---|
complete |
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 . |
get |
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 | |
---|---|
batch |
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 | |
---|---|
complete |
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. |
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. |
search |
POST /v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite Performs a search. |
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 | |
---|---|
disable |
POST /v1beta/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch Downgrade from advanced site search to basic site search. |
enable |
POST /v1beta/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch Upgrade from basic site search to advanced site search. |
recrawl |
POST /v1beta/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:recrawlUris Request on-demand recrawl for a list of URIs. |
REST Resource: v1beta.projects.locations.dataStores.siteSearchEngine.targetSites
Methods | |
---|---|
batch |
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. |
list |
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.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.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.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. |
write |
POST /v1beta/{parent=projects/*/locations/*}/userEvents:write Writes a single user event. |
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.projects
Methods | |
---|---|
get |
GET /v1alpha/{name=projects/*} Gets a Project . |
provision |
POST /v1alpha/{name=projects/*}:provision Provisions the project resource. |
report |
POST /v1alpha/{project=projects/*}:reportConsentChange Updates service terms for this project. |
REST Resource: v1alpha.projects.locations
Methods | |
---|---|
estimate |
POST /v1alpha/{location=projects/*/locations/*}:estimateDataSize Estimates the data size to be used by a customer. |
get |
GET /v1alpha/{name=projects/*/locations/*/aclConfig} Gets the AclConfig . |
get |
GET /v1alpha/{name=projects/*/locations/*/cmekConfig} Gets the CmekConfig . |
update |
PATCH /v1alpha/{aclConfig.name=projects/*/locations/*/aclConfig} Default ACL configuration for use in a location of a customer's project. |
update |
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 | |
---|---|
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.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 | |
---|---|
complete |
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 . |
get |
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*} Gets a DataStore . |
get |
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/completionConfig} Gets a CompletionConfig |
get |
GET /v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig} Gets a DocumentProcessingConfig . |
get |
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 |
train |
POST /v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel Trains a custom model. |
update |
PATCH /v1alpha/{completionConfig.name=projects/*/locations/*/collections/*/dataStores/*/completionConfig} Updates the CompletionConfig s. |
update |
PATCH /v1alpha/{documentProcessingConfig.name=projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig} Updates the DocumentProcessingConfig . |
REST Resource: v1alpha.projects.locations.collections.dataStores.branches
Methods | |
---|---|
batch |
GET /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata Gets index freshness metadata for Document s. |
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 . |
get |
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 | |
---|---|
complete |
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. |
search |
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite Performs a search. |
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 | |
---|---|
batch |
POST /v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:batchVerifyTargetSites Verify target sites' ownership and validity. |
disable |
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch Downgrade from advanced site search to basic site search. |
enable |
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch Upgrade from basic site search to advanced site search. |
fetch |
GET /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus Returns list of target sites with its domain verification status. |
get |
GET /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:getUriPatternDocumentData Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. |
recrawl |
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:recrawlUris Request on-demand recrawl for a list of URIs. |
set |
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.targetSites
Methods | |
---|---|
batch |
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 a Engine . |
delete |
DELETE /v1alpha/{name=projects/*/locations/*/collections/*/engines/*} Deletes a Engine . |
get |
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*} Gets a Engine . |
get |
GET /v1alpha/{name=projects/*/locations/*/collections/*/engines/*/completionConfig} Gets a CompletionConfig |
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. |
tune |
POST /v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:tune Tunes an existing engine. |
update |
PATCH /v1alpha/{completionConfig.name=projects/*/locations/*/collections/*/engines/*/completionConfig} Updates the CompletionConfig s. |
REST Resource: v1alpha.projects.locations.collections.engines.completionConfig
Methods | |
---|---|
complete |
POST /v1alpha/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery Completes the user input with advanced keyword suggestions. |
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. |
search |
POST /v1alpha/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite Performs a search. |
REST Resource: v1alpha.projects.locations.collections.engines.sessions
Methods | |
---|---|
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 . |
patch |
PATCH /v1alpha/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*} Updates a Session. |
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.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 | |
---|---|
complete |
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 . |
get |
GET /v1alpha/{name=projects/*/locations/*/dataStores/*} Gets a DataStore . |
get |
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/completionConfig} Gets a CompletionConfig |
get |
GET /v1alpha/{name=projects/*/locations/*/dataStores/*/documentProcessingConfig} Gets a DocumentProcessingConfig . |
get |
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 |
update |
PATCH /v1alpha/{completionConfig.name=projects/*/locations/*/dataStores/*/completionConfig} Updates the CompletionConfig s. |
update |
PATCH /v1alpha/{documentProcessingConfig.name=projects/*/locations/*/dataStores/*/documentProcessingConfig} Updates the DocumentProcessingConfig . |
REST Resource: v1alpha.projects.locations.dataStores.branches
Methods | |
---|---|
batch |
GET /v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata Gets index freshness metadata for Document s. |
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 . |
get |
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 | |
---|---|
complete |
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. |
search |
POST /v1alpha/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite Performs a search. |
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 | |
---|---|
disable |
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch Downgrade from advanced site search to basic site search. |
enable |
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch Upgrade from basic site search to advanced site search. |
recrawl |
POST /v1alpha/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:recrawlUris Request on-demand recrawl for a list of URIs. |
REST Resource: v1alpha.projects.locations.dataStores.siteSearchEngine.targetSites
Methods | |
---|---|
batch |
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. |
list |
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.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.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.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 | |
---|---|
check |
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. |
write |
POST /v1alpha/{parent=projects/*/locations/*}/userEvents:write Writes a single user event. |
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.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.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 | |
---|---|
complete |
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 . |
get |
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 |
train |
POST /v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel Trains a custom model. |
REST Resource: v1.projects.locations.collections.dataStores.branches
Methods | |
---|---|
batch |
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.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. |
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. |
search |
POST /v1/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite Performs a search. |
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 | |
---|---|
batch |
POST /v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:batchVerifyTargetSites Verify target sites' ownership and validity. |
disable |
POST /v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch Downgrade from advanced site search to basic site search. |
enable |
POST /v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch Upgrade from basic site search to advanced site search. |
fetch |
GET /v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus Returns list of target sites with its domain verification status. |
recrawl |
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.targetSites
Methods | |
---|---|
batch |
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 a Engine . |
delete |
DELETE /v1/{name=projects/*/locations/*/collections/*/engines/*} Deletes a Engine . |
get |
GET /v1/{name=projects/*/locations/*/collections/*/engines/*} Gets a 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 |
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 | |
---|---|
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. |
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. |
search |
POST /v1/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite Performs a search. |
REST Resource: v1.projects.locations.collections.engines.sessions
Methods | |
---|---|
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.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 | |
---|---|
complete |
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 . |
get |
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 | |
---|---|
batch |
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.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. |
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. |
search |
POST /v1/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite Performs a search. |
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 | |
---|---|
disable |
POST /v1/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch Downgrade from advanced site search to basic site search. |
enable |
POST /v1/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch Upgrade from basic site search to advanced site search. |
recrawl |
POST /v1/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:recrawlUris Request on-demand recrawl for a list of URIs. |
REST Resource: v1.projects.locations.dataStores.siteSearchEngine.targetSites
Methods | |
---|---|
batch |
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.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.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.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. |
write |
POST /v1/{parent=projects/*/locations/*}/userEvents:write Writes a single user event. |
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. |