Discovery Engine API

Discovery Engine API.

Service: discoveryengine.googleapis.com

The Service name discoveryengine.googleapis.com is needed to create RPC client stubs.

google.cloud.discoveryengine.v1.CompletionService

Methods
CompleteQuery Completes the specified user input with keyword suggestions.
ImportCompletionSuggestions Imports CompletionSuggestions for a DataStore.
ImportSuggestionDenyListEntries Imports all SuggestionDenyListEntry for a DataStore.
PurgeCompletionSuggestions Permanently deletes all CompletionSuggestions for a DataStore.
PurgeSuggestionDenyListEntries Permanently deletes all SuggestionDenyListEntry for a DataStore.

google.cloud.discoveryengine.v1.ControlService

Methods
CreateControl Creates a Control.
DeleteControl Deletes a Control.
GetControl Gets a Control.
ListControls Lists all Controls by their parent DataStore.
UpdateControl Updates a Control.

google.cloud.discoveryengine.v1.ConversationalSearchService

Methods
AnswerQuery Answer query method.
ConverseConversation Converses a conversation.
CreateConversation Creates a Conversation.
CreateSession Creates a Session.
DeleteConversation Deletes a Conversation.
DeleteSession Deletes a Session.
GetAnswer Gets a Answer.
GetConversation Gets a Conversation.
GetSession Gets a Session.
ListConversations Lists all Conversations by their parent DataStore.
ListSessions Lists all Sessions by their parent DataStore.
UpdateConversation Updates a Conversation.
UpdateSession Updates a Session.

google.cloud.discoveryengine.v1.DataStoreService

Methods
CreateDataStore Creates a DataStore.
DeleteDataStore Deletes a DataStore.
GetDataStore Gets a DataStore.
ListDataStores Lists all the DataStores associated with the project.
UpdateDataStore Updates a DataStore

google.cloud.discoveryengine.v1.DocumentService

Methods
BatchGetDocumentsMetadata Gets index freshness metadata for Documents.
CreateDocument Creates a Document.
DeleteDocument Deletes a Document.
GetDocument Gets a Document.
ImportDocuments Bulk import of multiple Documents.
ListDocuments Gets a list of Documents.
PurgeDocuments Permanently deletes all selected Documents in a branch.
UpdateDocument Updates a Document.

google.cloud.discoveryengine.v1.EngineService

Methods
CreateEngine Creates a Engine.
DeleteEngine Deletes a Engine.
GetEngine Gets a Engine.
ListEngines Lists all the Engines associated with the project.
UpdateEngine Updates an Engine

google.cloud.discoveryengine.v1.GroundedGenerationService

Methods
CheckGrounding Performs a grounding check.

google.cloud.discoveryengine.v1.ProjectService

Methods
ProvisionProject Provisions the project resource.

google.cloud.discoveryengine.v1.RankService

Methods
Rank Ranks a list of text records based on the given input query.

google.cloud.discoveryengine.v1.RecommendationService

Methods
Recommend Makes a recommendation, which requires a contextual user event.

google.cloud.discoveryengine.v1.SchemaService

Methods
CreateSchema Creates a Schema.
DeleteSchema Deletes a Schema.
GetSchema Gets a Schema.
ListSchemas Gets a list of Schemas.
UpdateSchema Updates a Schema.

google.cloud.discoveryengine.v1.SearchService

Methods
Search Performs a search.
SearchLite Performs a search.

google.cloud.discoveryengine.v1.SearchTuningService

Methods
ListCustomModels Gets a list of all the custom models.
TrainCustomModel Trains a custom model.

google.cloud.discoveryengine.v1.SiteSearchEngineService

Methods
BatchCreateTargetSites Creates TargetSite in a batch.
BatchVerifyTargetSites Verify target sites' ownership and validity.
CreateTargetSite Creates a TargetSite.
DeleteTargetSite Deletes a TargetSite.
DisableAdvancedSiteSearch Downgrade from advanced site search to basic site search.
EnableAdvancedSiteSearch Upgrade from basic site search to advanced site search.
FetchDomainVerificationStatus Returns list of target sites with its domain verification status.
GetSiteSearchEngine Gets the SiteSearchEngine.
GetTargetSite Gets a TargetSite.
ListTargetSites Gets a list of TargetSites.
RecrawlUris Request on-demand recrawl for a list of URIs.
UpdateTargetSite Updates a TargetSite.

google.cloud.discoveryengine.v1.UserEventService

Methods
CollectUserEvent Writes a single user event from the browser.
ImportUserEvents Bulk import of user events.
PurgeUserEvents Deletes permanently all user events specified by the filter provided.
WriteUserEvent Writes a single user event.

google.cloud.discoveryengine.v1alpha.AclConfigService

Methods
GetAclConfig Gets the AclConfig.
UpdateAclConfig Default ACL configuration for use in a location of a customer's project.

google.cloud.discoveryengine.v1alpha.ChunkService

Methods
GetChunk Gets a Document.
ListChunks Gets a list of Chunks.

google.cloud.discoveryengine.v1alpha.CmekConfigService

Methods
GetCmekConfig Gets the CmekConfig.
ListCmekConfigs Lists all the CmekConfigs with the project.
UpdateCmekConfig Provisions a CMEK key for use in a location of a customer's project.

google.cloud.discoveryengine.v1alpha.CompletionService

Methods
AdvancedCompleteQuery Completes the user input with advanced keyword suggestions.
CompleteQuery Completes the specified user input with keyword suggestions.
ImportCompletionSuggestions Imports CompletionSuggestions for a DataStore.
ImportSuggestionDenyListEntries Imports all SuggestionDenyListEntry for a DataStore.
PurgeCompletionSuggestions Permanently deletes all CompletionSuggestions for a DataStore.
PurgeSuggestionDenyListEntries Permanently deletes all SuggestionDenyListEntry for a DataStore.

google.cloud.discoveryengine.v1alpha.ControlService

Methods
CreateControl Creates a Control.
DeleteControl Deletes a Control.
GetControl Gets a Control.
ListControls Lists all Controls by their parent DataStore.
UpdateControl Updates a Control.

google.cloud.discoveryengine.v1alpha.ConversationalSearchService

Methods
AnswerQuery Answer query method.
ConverseConversation Converses a conversation.
CreateConversation Creates a Conversation.
CreateSession Creates a Session.
DeleteConversation Deletes a Conversation.
DeleteSession Deletes a Session.
GetAnswer Gets a Answer.
GetConversation Gets a Conversation.
GetSession Gets a Session.
ListConversations Lists all Conversations by their parent DataStore.
ListSessions Lists all Sessions by their parent DataStore.
UpdateConversation Updates a Conversation.
UpdateSession Updates a Session.

google.cloud.discoveryengine.v1alpha.DataStoreService

Methods
CreateDataStore Creates a DataStore.
DeleteDataStore Deletes a DataStore.
GetCompletionConfig Gets a CompletionConfig
GetDataStore Gets a DataStore.
GetDocumentProcessingConfig Gets a DocumentProcessingConfig.
ListDataStores Lists all the DataStores associated with the project.
UpdateCompletionConfig Updates the CompletionConfigs.
UpdateDataStore Updates a DataStore
UpdateDocumentProcessingConfig Updates the DocumentProcessingConfig.

google.cloud.discoveryengine.v1alpha.DocumentService

Methods
BatchGetDocumentsMetadata Gets index freshness metadata for Documents.
CreateDocument Creates a Document.
DeleteDocument Deletes a Document.
GetDocument Gets a Document.
GetProcessedDocument Gets the parsed layout information for a Document.
ImportDocuments Bulk import of multiple Documents.
ListDocuments Gets a list of Documents.
PurgeDocuments Permanently deletes all selected Documents in a branch.
UpdateDocument Updates a Document.

google.cloud.discoveryengine.v1alpha.EngineService

Methods
CreateEngine Creates a Engine.
DeleteEngine Deletes a Engine.
GetEngine Gets a Engine.
ListEngines Lists all the Engines associated with the project.
PauseEngine Pauses the training of an existing engine.
ResumeEngine Resumes the training of an existing engine.
TuneEngine Tunes an existing engine.
UpdateEngine Updates an Engine

google.cloud.discoveryengine.v1alpha.EstimateBillingService

Methods
EstimateDataSize Estimates the data size to be used by a customer.

google.cloud.discoveryengine.v1alpha.EvaluationService

Methods
CreateEvaluation Creates a Evaluation.
GetEvaluation Gets a Evaluation.
ListEvaluationResults Gets a list of results for a given a Evaluation.
ListEvaluations Gets a list of Evaluations.

google.cloud.discoveryengine.v1alpha.GroundedGenerationService

Methods
CheckGrounding Performs a grounding check.

google.cloud.discoveryengine.v1alpha.MetricService

Methods

google.cloud.discoveryengine.v1alpha.ProjectService

Methods
GetProject Gets a Project.
ProvisionProject Provisions the project resource.
ReportConsentChange Updates service terms for this project.

google.cloud.discoveryengine.v1alpha.RankService

Methods
Rank Ranks a list of text records based on the given input query.

google.cloud.discoveryengine.v1alpha.RecommendationService

Methods
Recommend Makes a recommendation, which requires a contextual user event.

google.cloud.discoveryengine.v1alpha.RequirementService

Methods
CheckRequirement Check a particular requirement.

google.cloud.discoveryengine.v1alpha.SampleQueryService

Methods
CreateSampleQuery Creates a SampleQuery
DeleteSampleQuery Deletes a SampleQuery.
GetSampleQuery Gets a SampleQuery.
ImportSampleQueries Bulk import of multiple SampleQuerys.
ListSampleQueries Gets a list of SampleQuerys.
UpdateSampleQuery Updates a SampleQuery.

google.cloud.discoveryengine.v1alpha.SampleQuerySetService

Methods
CreateSampleQuerySet Creates a SampleQuerySet
DeleteSampleQuerySet Deletes a SampleQuerySet.
GetSampleQuerySet Gets a SampleQuerySet.
ListSampleQuerySets Gets a list of SampleQuerySets.
UpdateSampleQuerySet Updates a SampleQuerySet.

google.cloud.discoveryengine.v1alpha.SchemaService

Methods
CreateSchema Creates a Schema.
DeleteSchema Deletes a Schema.
GetSchema Gets a Schema.
ListSchemas Gets a list of Schemas.
UpdateSchema Updates a Schema.

google.cloud.discoveryengine.v1alpha.SearchService

Methods
Search Performs a search.
SearchLite Performs a search.

google.cloud.discoveryengine.v1alpha.SearchTuningService

Methods
ListCustomModels Gets a list of all the custom models.
TrainCustomModel Trains a custom model.

google.cloud.discoveryengine.v1alpha.ServingConfigService

Methods
CreateServingConfig Creates a ServingConfig.
DeleteServingConfig Deletes a ServingConfig.
GetServingConfig Gets a ServingConfig.
ListServingConfigs Lists all ServingConfigs linked to this dataStore.
UpdateServingConfig Updates a ServingConfig.

google.cloud.discoveryengine.v1alpha.SiteSearchEngineService

Methods
BatchCreateTargetSites Creates TargetSite in a batch.
BatchVerifyTargetSites Verify target sites' ownership and validity.
CreateSitemap Creates a Sitemap.
CreateTargetSite Creates a TargetSite.
DeleteSitemap Deletes a Sitemap.
DeleteTargetSite Deletes a TargetSite.
DisableAdvancedSiteSearch Downgrade from advanced site search to basic site search.
EnableAdvancedSiteSearch Upgrade from basic site search to advanced site search.
FetchDomainVerificationStatus Returns list of target sites with its domain verification status.
FetchSitemaps Fetch Sitemaps in a DataStore.
GetSiteSearchEngine Gets the SiteSearchEngine.
GetTargetSite Gets a TargetSite.
GetUriPatternDocumentData Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
ListTargetSites Gets a list of TargetSites.
RecrawlUris Request on-demand recrawl for a list of URIs.
SetUriPatternDocumentData Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
UpdateTargetSite Updates a TargetSite.

google.cloud.discoveryengine.v1alpha.UserEventService

Methods
CollectUserEvent Writes a single user event from the browser.
ImportUserEvents Bulk import of user events.
PurgeUserEvents Deletes permanently all user events specified by the filter provided.
WriteUserEvent Writes a single user event.

google.cloud.discoveryengine.v1alpha.WidgetConfigService

Methods

google.cloud.discoveryengine.v1alpha.WidgetService

Methods
LookupWidgetConfig Gets the Widget Config using the uuid.
WidgetAcquireAndStoreRefreshToken Proxy to DataConnectorService.AcquireAndStoreRefreshToken.
WidgetAdvancedCompleteQuery Performs a user input completion with keyword suggestion in advanced mode.
WidgetAnswerQuery Answer query with Widget.
WidgetCompleteQuery Performs a user input completion with keyword suggestion.
WidgetConverseConversation Converse a conversation with Widget.
WidgetDeleteSession Proxy to ConversationalSearchService.DeleteSession.
WidgetExecuteAction Proxy to DataConnectorService.ExecuteAction.
WidgetGetSession Proxy to ConversationalSearchService.GetSession.
WidgetHomepageFetchDocuments Fetch documents for Homepage with Widget.
WidgetListSessions Proxy to ConversationalSearchService.ListSessions.
WidgetSearch Performs a search.
WidgetStreamAnswerQuery Streaming answer query with Widget.
WidgetUpdateSession Proxy to ConversationalSearchService.UpdateSession.
WidgetWriteUserEvent Writes a single user event from the browser with Widget.

google.cloud.discoveryengine.v1beta.CompletionService

Methods
AdvancedCompleteQuery Completes the user input with advanced keyword suggestions.
CompleteQuery Completes the specified user input with keyword suggestions.
ImportCompletionSuggestions Imports CompletionSuggestions for a DataStore.
ImportSuggestionDenyListEntries Imports all SuggestionDenyListEntry for a DataStore.
PurgeCompletionSuggestions Permanently deletes all CompletionSuggestions for a DataStore.
PurgeSuggestionDenyListEntries Permanently deletes all SuggestionDenyListEntry for a DataStore.

google.cloud.discoveryengine.v1beta.ControlService

Methods
CreateControl Creates a Control.
DeleteControl Deletes a Control.
GetControl Gets a Control.
ListControls Lists all Controls by their parent DataStore.
UpdateControl Updates a Control.

google.cloud.discoveryengine.v1beta.ConversationalSearchService

Methods
AnswerQuery Answer query method.
ConverseConversation Converses a conversation.
CreateConversation Creates a Conversation.
CreateSession Creates a Session.
DeleteConversation Deletes a Conversation.
DeleteSession Deletes a Session.
GetAnswer Gets a Answer.
GetConversation Gets a Conversation.
GetSession Gets a Session.
ListConversations Lists all Conversations by their parent DataStore.
ListSessions Lists all Sessions by their parent DataStore.
UpdateConversation Updates a Conversation.
UpdateSession Updates a Session.

google.cloud.discoveryengine.v1beta.DataStoreService

Methods
CreateDataStore Creates a DataStore.
DeleteDataStore Deletes a DataStore.
GetDataStore Gets a DataStore.
ListDataStores Lists all the DataStores associated with the project.
UpdateDataStore Updates a DataStore

google.cloud.discoveryengine.v1beta.DocumentService

Methods
BatchGetDocumentsMetadata Gets index freshness metadata for Documents.
CreateDocument Creates a Document.
DeleteDocument Deletes a Document.
GetDocument Gets a Document.
ImportDocuments Bulk import of multiple Documents.
ListDocuments Gets a list of Documents.
PurgeDocuments Permanently deletes all selected Documents in a branch.
UpdateDocument Updates a Document.

google.cloud.discoveryengine.v1beta.EngineService

Methods
CreateEngine Creates a Engine.
DeleteEngine Deletes a Engine.
GetEngine Gets a Engine.
ListEngines Lists all the Engines associated with the project.
PauseEngine Pauses the training of an existing engine.
ResumeEngine Resumes the training of an existing engine.
TuneEngine Tunes an existing engine.
UpdateEngine Updates an Engine

google.cloud.discoveryengine.v1beta.EvaluationService

Methods
CreateEvaluation Creates a Evaluation.
GetEvaluation Gets a Evaluation.
ListEvaluationResults Gets a list of results for a given a Evaluation.
ListEvaluations Gets a list of Evaluations.

google.cloud.discoveryengine.v1beta.GroundedGenerationService

Methods
CheckGrounding Performs a grounding check.

google.cloud.discoveryengine.v1beta.ProjectService

Methods
ProvisionProject Provisions the project resource.

google.cloud.discoveryengine.v1beta.RankService

Methods
Rank Ranks a list of text records based on the given input query.

google.cloud.discoveryengine.v1beta.RecommendationService

Methods
Recommend Makes a recommendation, which requires a contextual user event.

google.cloud.discoveryengine.v1beta.SampleQueryService

Methods
CreateSampleQuery Creates a SampleQuery
DeleteSampleQuery Deletes a SampleQuery.
GetSampleQuery Gets a SampleQuery.
ImportSampleQueries Bulk import of multiple SampleQuerys.
ListSampleQueries Gets a list of SampleQuerys.
UpdateSampleQuery Updates a SampleQuery.

google.cloud.discoveryengine.v1beta.SampleQuerySetService

Methods
CreateSampleQuerySet Creates a SampleQuerySet
DeleteSampleQuerySet Deletes a SampleQuerySet.
GetSampleQuerySet Gets a SampleQuerySet.
ListSampleQuerySets Gets a list of SampleQuerySets.
UpdateSampleQuerySet Updates a SampleQuerySet.

google.cloud.discoveryengine.v1beta.SchemaService

Methods
CreateSchema Creates a Schema.
DeleteSchema Deletes a Schema.
GetSchema Gets a Schema.
ListSchemas Gets a list of Schemas.
UpdateSchema Updates a Schema.

google.cloud.discoveryengine.v1beta.SearchService

Methods
Search Performs a search.
SearchLite Performs a search.

google.cloud.discoveryengine.v1beta.SearchTuningService

Methods
ListCustomModels Gets a list of all the custom models.
TrainCustomModel Trains a custom model.

google.cloud.discoveryengine.v1beta.ServingConfigService

Methods
GetServingConfig Gets a ServingConfig.
ListServingConfigs Lists all ServingConfigs linked to this dataStore.
UpdateServingConfig Updates a ServingConfig.

google.cloud.discoveryengine.v1beta.SiteSearchEngineService

Methods
BatchCreateTargetSites Creates TargetSite in a batch.
BatchVerifyTargetSites Verify target sites' ownership and validity.
CreateSitemap Creates a Sitemap.
CreateTargetSite Creates a TargetSite.
DeleteSitemap Deletes a Sitemap.
DeleteTargetSite Deletes a TargetSite.
DisableAdvancedSiteSearch Downgrade from advanced site search to basic site search.
EnableAdvancedSiteSearch Upgrade from basic site search to advanced site search.
FetchDomainVerificationStatus Returns list of target sites with its domain verification status.
FetchSitemaps Fetch Sitemaps in a DataStore.
GetSiteSearchEngine Gets the SiteSearchEngine.
GetTargetSite Gets a TargetSite.
ListTargetSites Gets a list of TargetSites.
RecrawlUris Request on-demand recrawl for a list of URIs.
UpdateTargetSite Updates a TargetSite.

google.cloud.discoveryengine.v1beta.UserEventService

Methods
CollectUserEvent Writes a single user event from the browser.
ImportUserEvents Bulk import of user events.
PurgeUserEvents Deletes permanently all user events specified by the filter provided.
WriteUserEvent Writes a single user event.

google.cloud.location.Locations

Methods

google.longrunning.Operations

Methods
CancelOperation Starts asynchronous cancellation on a long-running operation.
GetOperation Gets the latest state of a long-running operation.
ListOperations Lists operations that match the specified filter in the request.