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.AclConfigService`

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

`google.cloud.discoveryengine.v1.AssistAnswerService`

Methods
`GetAssistAnswer`	Gets an `AssistAnswer`.

`google.cloud.discoveryengine.v1.AssistantService`

Methods
`AddContextFile`	Uploads a context file to use as source for the assist calls within the session.
`Assist`	Assists the user with a query.
`CreateAssistant`	Creates an `Assistant`.
`DeleteAssistant`	Deletes an `Assistant`.
`GetAssistant`	Gets an `Assistant`.
`ListAssistants`	Lists all `Assistant`s under an `Engine`.
`StreamAssist`	Assists the user with a query in a streaming fashion.
`UpdateAssistant`	Updates an `Assistant`

`google.cloud.discoveryengine.v1.CmekConfigService`

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

`google.cloud.discoveryengine.v1.CollectionService`

Methods
`DeleteCollection`	Deletes a `Collection`.

`google.cloud.discoveryengine.v1.CompletionService`

Methods
`AdvancedCompleteQuery`	Completes the user input with advanced keyword suggestions.
`CompleteQuery`	Completes the specified user input with keyword suggestions.
`ImportCompletionSuggestions`	Imports `CompletionSuggestion`s for a DataStore.
`ImportSuggestionDenyListEntries`	Imports all `SuggestionDenyListEntry` for a DataStore.
`PurgeCompletionSuggestions`	Permanently deletes all `CompletionSuggestion`s 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`.
`StreamAnswerQuery`	Answer query method (streaming).
`UpdateConversation`	Updates a Conversation.
`UpdateSession`	Updates a Session.

`google.cloud.discoveryengine.v1.DataConnectorService`

Methods
`GetDataConnector`	Gets the `DataConnector`.
`SetUpDataConnector`	Creates a `Collection` and sets up the `DataConnector` for it.
`UpdateDataConnector`	Updates a `DataConnector`.

`google.cloud.discoveryengine.v1.DataStoreService`

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

`google.cloud.discoveryengine.v1.DocumentService`

Methods
`BatchGetDocumentsMetadata`	Gets index freshness metadata for `Document`s.
`CreateDocument`	Creates a `Document`.
`DeleteDocument`	Deletes a `Document`.
`GetDocument`	Gets a `Document`.
`ImportDocuments`	Bulk import of multiple `Document`s.
`ListDocuments`	Gets a list of `Document`s.
`PurgeDocuments`	Permanently deletes all selected `Document`s 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 `Engine`s associated with the project.
`UpdateEngine`	Updates an `Engine`

`google.cloud.discoveryengine.v1.GroundedGenerationService`

Methods
`CheckGrounding`	Performs a grounding check.

`google.cloud.discoveryengine.v1.IdentityMappingStoreService`

Methods
`CreateIdentityMappingStore`	Creates a new Identity Mapping Store.
`DeleteIdentityMappingStore`	Deletes the Identity Mapping Store.
`GetIdentityMappingStore`	Gets the Identity Mapping Store.
`ImportIdentityMappings`	Imports a list of Identity Mapping Entries to an Identity Mapping Store.
`ListIdentityMappingStores`	Lists all Identity Mapping Stores.
`ListIdentityMappings`	Lists Identity Mappings in an Identity Mapping Store.
`PurgeIdentityMappings`	Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

`google.cloud.discoveryengine.v1.LicenseConfigService`

Methods
`CreateLicenseConfig`	Creates a `LicenseConfig`
`GetLicenseConfig`	Gets a `LicenseConfig`.
`UpdateLicenseConfig`	Updates the `LicenseConfig`

`google.cloud.discoveryengine.v1.PodcastService`

Methods

`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 `Schema`s.
`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.ServingConfigService`

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

`google.cloud.discoveryengine.v1.SessionService`

Methods
`CreateSession`	Creates a Session.
`DeleteSession`	Deletes a Session.
`GetSession`	Gets a Session.
`ListSessions`	Lists all Sessions by their parent `DataStore`.
`UpdateSession`	Updates a Session.

`google.cloud.discoveryengine.v1.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 `Sitemap`s in a `DataStore`.
`GetSiteSearchEngine`	Gets the `SiteSearchEngine`.
`GetTargetSite`	Gets a `TargetSite`.
`ListTargetSites`	Gets a list of `TargetSite`s.
`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.v1.UserLicenseService`

Methods
`BatchUpdateUserLicenses`	Updates the User License.
`ListUserLicenses`	Lists the User Licenses.

`google.cloud.discoveryengine.v1.UserStoreService`

Methods
`CreateUserStore`	Creates a new User Store.
`DeleteUserStore`	Deletes the User Store.
`GetUserStore`	Gets the User Store.
`UpdateUserStore`	Updates the User Store.

`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.AgentService`

Methods
`CreateAgent`	Creates an `Agent`.
`DeleteAgent`	Deletes an `Agent`.
`GetAgent`	Gets an `Agent`.
`ImportAgentFile`	Imports a file to an `Agent`.
`ListAgents`	Lists all `Agent`s under an `Assistant` which were created by the caller.
`UpdateAgent`	Updates an `Agent`

`google.cloud.discoveryengine.v1alpha.AnalyticsService`

Methods
`ExportMetrics`	Exports metrics.

`google.cloud.discoveryengine.v1alpha.AssistAnswerService`

Methods
`GetAssistAnswer`	Gets an `AssistAnswer`.

`google.cloud.discoveryengine.v1alpha.AssistantService`

Methods
`AddContextFile`	Uploads a context file to use as source for the assist calls within the session.
`Assist`	Assists the user with a query.
`CreateAssistant`	Creates an `Assistant`.
`DeleteAssistant`	Deletes an `Assistant`.
`GetAssistant`	Gets an `Assistant`.
`ListAssistants`	Lists all `Assistant`s under an `Engine`.
`ListSessionFileMetadata`	Lists metadata for all files in the current session.
`RecommendQuestions`	Gets recommended questions for the given session.
`RemoveContextFile`	Removes a context file from a session.
`SelectContextFiles`	Selects context files to be used in a session.
`StreamAssist`	Assists the user with a query in a streaming fashion.
`UpdateAssistant`	Updates an `Assistant`

`google.cloud.discoveryengine.v1alpha.AuthorizationService`

Methods
`CreateAuthorization`	Creates an `Authorization`.
`DeleteAuthorization`	Deletes an `Authorization`.
`GetAuthorization`	Gets an `Authorization`.
`ListAuthorizations`	Lists all `Authorization`s under an `Engine`.
`UpdateAuthorization`	Updates an `Authorization`

`google.cloud.discoveryengine.v1alpha.BranchService`

Methods
`GetBranch`	Retrieves a `Branch`.
`ListBranches`	Lists all `Branch`s under the specified parent `DataStore`.

`google.cloud.discoveryengine.v1alpha.CannedQueryService`

Methods
`CreateCannedQuery`	Creates a `CannedQuery`.
`DeleteCannedQuery`	Deletes a `CannedQuery`.
`GetCannedQuery`	Gets a `CannedQuery`.
`ListActiveCannedQueryUserViews`	Lists the `CannedQueryUserView`s for all active `CannedQuery`s.
`ListCannedQueries`	Lists all `CannedQuery`s under an `Assistant`.
`UpdateCannedQuery`	Updates a `CannedQuery`.

`google.cloud.discoveryengine.v1alpha.ChunkService`

Methods
`GetChunk`	Gets a `Document`.
`ListChunks`	Gets a list of `Chunk`s.

`google.cloud.discoveryengine.v1alpha.CmekConfigService`

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

`google.cloud.discoveryengine.v1alpha.CollectionService`

Methods
`DeleteCollection`	Deletes a `Collection`.
`GetCollection`	Gets a `Collection`.
`ListCollections`	Gets a list of `Collection`s.
`UpdateCollection`	Updates a `Collection`.

`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 `CompletionSuggestion`s for a DataStore.
`ImportSuggestionDenyListEntries`	Imports all `SuggestionDenyListEntry` for a DataStore.
`PurgeCompletionSuggestions`	Permanently deletes all `CompletionSuggestion`s for a DataStore.
`PurgeSuggestionDenyListEntries`	Permanently deletes all `SuggestionDenyListEntry` for a DataStore.
`RemoveSuggestion`	Removes the search history suggestion in an engine for a user.

`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`.
`StreamAnswerQuery`	Answer query method (streaming).
`UpdateConversation`	Updates a Conversation.
`UpdateSession`	Updates a Session.

`google.cloud.discoveryengine.v1alpha.CrawlRateManagementService`

Methods
`ObtainCrawlRate`	Obtains the time series data of organic or dedicated crawl rate for monitoring.
`RemoveDedicatedCrawlRate`	Removes the dedicated crawl rate for a craw_rate_scope.
`SetDedicatedCrawlRate`	Sets the dedicated crawl rate for a crawl_rate_scope.

`google.cloud.discoveryengine.v1alpha.DataConnectorService`

Methods
`AcquireAccessToken`	Uses the per-user refresh token minted with `AcquireAndStoreRefreshToken` to generate and return a new access token and its details.
`AcquireAndStoreRefreshToken`	Exchanges OAuth authorization credentials for a refresh token and stores the refresh token and the scopes.
`BuildActionInvocation`	Builds an action invocation using the `DataConnector`.
`CheckRefreshToken (deprecated)`	Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details.
`ExecuteAction`	Executes a 3rd party action using the `DataConnector`.
`FetchEntitiesTypes`	Fetch the entities types for a `DataConnector`.
`GetConnectorSecret`	Get the secret for the associated connector.
`GetDataConnector`	Gets the `DataConnector`.
`ListConnectorRuns`	Lists the `ConnectorRun`s of a `DataConnector`.
`SetUpDataConnector`	Creates a `Collection` and sets up the `DataConnector` for it.
`StartConnectorRun`	Starts an immediate synchronization process for a `DataConnector`.
`UpdateDataConnector`	Updates a `DataConnector`.

`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 `DataStore`s associated with the project.
`UpdateCompletionConfig`	Updates the `CompletionConfig`s.
`UpdateDataStore`	Updates a `DataStore`
`UpdateDocumentProcessingConfig`	Updates the `DocumentProcessingConfig`.

`google.cloud.discoveryengine.v1alpha.DocumentService`

Methods
`BatchGetDocumentsMetadata`	Gets index freshness metadata for `Document`s.
`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 `Document`s.
`ListDocuments`	Gets a list of `Document`s.
`PurgeDocuments`	Permanently deletes all selected `Document`s 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`.
`GetWorkspaceSettings`	Get Workspace settings for the end user.
`ListEngines`	Lists all the `Engine`s 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.
`GetConfigurablePricingUsageStats`	Gets configurable pricing usage stats.

`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 `Evaluation`s.

`google.cloud.discoveryengine.v1alpha.GroundedGenerationService`

Methods
`CheckGrounding`	Performs a grounding check.

`google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService`

Methods
`CreateIdentityMappingStore`	Creates a new Identity Mapping Store.
`DeleteIdentityMappingStore`	Deletes the Identity Mapping Store.
`GetIdentityMappingStore`	Gets the Identity Mapping Store.
`ImportIdentityMappings`	Imports a list of Identity Mapping Entries to an Identity Mapping Store.
`ListIdentityMappingStores`	Lists all Identity Mapping Stores.
`ListIdentityMappings`	Lists Identity Mappings in an Identity Mapping Store.
`PurgeIdentityMappings`	Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

`google.cloud.discoveryengine.v1alpha.LicenseConfigService`

Methods
`CreateLicenseConfig`	Creates a `LicenseConfig`
`DistributeLicenseConfig`	Distributes a `LicenseConfig` from billing account level to project level.
`GetBillingAccountLicenseConfig`	Gets a `BillingAccountLicenseConfig`.
`GetLicenseConfig`	Gets a `LicenseConfig`.
`ListBillingAccountLicenseConfigs`	Lists all `BillingAccountLicenseConfig`s for a given billing account.
`RetractLicenseConfig`	This method is called from the billing account side to retract the `LicenseConfig` from the given project back to the billing account.
`UpdateLicenseConfig`	Updates the `LicenseConfig`

`google.cloud.discoveryengine.v1alpha.MetricService`

Methods

`google.cloud.discoveryengine.v1alpha.PodcastService`

Methods

`google.cloud.discoveryengine.v1alpha.ProjectService`

Methods
`GetProject`	Gets a `Project`.
`ProvisionProject`	Provisions the project resource.
`ReportConsentChange`	Updates service terms for this project.
`UpdateProject`	Updates the editable settings of a Discovery Engine 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 `SampleQuery`s.
`ListSampleQueries`	Gets a list of `SampleQuery`s.
`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 `SampleQuerySet`s.
`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 `Schema`s.
`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.SessionService`

Methods
`CreateSession`	Creates a Session.
`DeleteSession`	Deletes a Session.
`GetSession`	Gets a Session.
`ListFiles`	Lists metadata for all files in the current session.
`ListSessions`	Lists all Sessions by their parent `DataStore`.
`UpdateSession`	Updates a Session.

`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 `Sitemap`s 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 `TargetSite`s.
`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.UserLicenseService`

Methods
`BatchUpdateUserLicenses`	Updates the User License.
`ListUserLicenses`	Lists the User Licenses.

`google.cloud.discoveryengine.v1alpha.UserStoreService`

Methods
`CreateUserStore`	Creates a new User Store.
`DeleteUserStore`	Deletes the User Store.
`GetUserStore`	Gets the User Store.
`UpdateUserStore`	Updates the User Store.

`google.cloud.discoveryengine.v1alpha.WidgetConfigService`

Methods
`GetWidgetConfig`	Gets a `WidgetConfig`.
`UpdateWidgetConfig`	Update a WidgetConfig.

`google.cloud.discoveryengine.v1alpha.WidgetService`

Methods
`LookupWidgetConfig`	Do not call this API directly.
`WidgetAcquireAccessToken (deprecated)`	Do not call this API directly.
`WidgetAcquireAndStoreRefreshToken`	Do not call this API directly.
`WidgetAddContextFile`	Do not call this API directly.
`WidgetAdvancedCompleteQuery`	Do not call this API directly.
`WidgetAnswerQuery`	Do not call this API directly.
`WidgetAssist`	Do not call this API directly.
`WidgetCompleteQuery`	Do not call this API directly.
`WidgetConverseConversation`	Do not call this API directly.
`WidgetCreateSession`	Do not call this API directly.
`WidgetDeleteSession`	Do not call this API directly.
`WidgetExecuteAction`	Do not call this API directly.
`WidgetGetSession`	Do not call this API directly.
`WidgetHomepageFetchDocuments`	Do not call this API directly.
`WidgetListSessions`	Do not call this API directly.
`WidgetRemoveContextFile`	Do not call this API directly.
`WidgetSearch`	Do not call this API directly.
`WidgetSearchSessions`	Do not call this API directly.
`WidgetSelectContextFiles`	Do not call this API directly.
`WidgetStreamAnswerQuery`	Do not call this API directly.
`WidgetUpdateSession`	Do not call this API directly.
`WidgetWriteUserEvent`	Do not call this API directly.

`google.cloud.discoveryengine.v1beta.AclConfigService`

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

`google.cloud.discoveryengine.v1beta.AssistAnswerService`

Methods
`GetAssistAnswer`	Gets an `AssistAnswer`.

`google.cloud.discoveryengine.v1beta.AssistantService`

Methods
`AddContextFile`	Uploads a context file to use as source for the assist calls within the session.
`Assist`	Assists the user with a query.
`CreateAssistant`	Creates an `Assistant`.
`DeleteAssistant`	Deletes an `Assistant`.
`GetAssistant`	Gets an `Assistant`.
`ListAssistants`	Lists all `Assistant`s under an `Engine`.
`StreamAssist`	Assists the user with a query in a streaming fashion.
`UpdateAssistant`	Updates an `Assistant`

`google.cloud.discoveryengine.v1beta.CmekConfigService`

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

`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 `CompletionSuggestion`s for a DataStore.
`ImportSuggestionDenyListEntries`	Imports all `SuggestionDenyListEntry` for a DataStore.
`PurgeCompletionSuggestions`	Permanently deletes all `CompletionSuggestion`s for a DataStore.
`PurgeSuggestionDenyListEntries`	Permanently deletes all `SuggestionDenyListEntry` for a DataStore.
`RemoveSuggestion`	Removes the search history suggestion in an engine for a user.

`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`.
`StreamAnswerQuery`	Answer query method (streaming).
`UpdateConversation`	Updates a Conversation.
`UpdateSession`	Updates a Session.

`google.cloud.discoveryengine.v1beta.CrawlRateManagementService`

Methods
`ObtainCrawlRate`	Obtains the time series data of organic or dedicated crawl rate for monitoring.
`RemoveDedicatedCrawlRate`	Removes the dedicated crawl rate for a craw_rate_scope.
`SetDedicatedCrawlRate`	Sets the dedicated crawl rate for a crawl_rate_scope.

`google.cloud.discoveryengine.v1beta.DataStoreService`

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

`google.cloud.discoveryengine.v1beta.DocumentService`

Methods
`BatchGetDocumentsMetadata`	Gets index freshness metadata for `Document`s.
`CreateDocument`	Creates a `Document`.
`DeleteDocument`	Deletes a `Document`.
`GetDocument`	Gets a `Document`.
`ImportDocuments`	Bulk import of multiple `Document`s.
`ListDocuments`	Gets a list of `Document`s.
`PurgeDocuments`	Permanently deletes all selected `Document`s 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 `Engine`s 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 `Evaluation`s.

`google.cloud.discoveryengine.v1beta.GroundedGenerationService`

Methods
`CheckGrounding`	Performs a grounding check.

`google.cloud.discoveryengine.v1beta.IdentityMappingStoreService`

Methods
`CreateIdentityMappingStore`	Creates a new Identity Mapping Store.
`DeleteIdentityMappingStore`	Deletes the Identity Mapping Store.
`GetIdentityMappingStore`	Gets the Identity Mapping Store.
`ImportIdentityMappings`	Imports a list of Identity Mapping Entries to an Identity Mapping Store.
`ListIdentityMappingStores`	Lists all Identity Mapping Stores.
`ListIdentityMappings`	Lists Identity Mappings in an Identity Mapping Store.
`PurgeIdentityMappings`	Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

`google.cloud.discoveryengine.v1beta.LicenseConfigService`

Methods
`CreateLicenseConfig`	Creates a `LicenseConfig`
`GetLicenseConfig`	Gets a `LicenseConfig`.
`UpdateLicenseConfig`	Updates the `LicenseConfig`

`google.cloud.discoveryengine.v1beta.PodcastService`

Methods

`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 `SampleQuery`s.
`ListSampleQueries`	Gets a list of `SampleQuery`s.
`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 `SampleQuerySet`s.
`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 `Schema`s.
`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.SessionService`

Methods
`CreateSession`	Creates a Session.
`DeleteSession`	Deletes a Session.
`GetSession`	Gets a Session.
`ListSessions`	Lists all Sessions by their parent `DataStore`.
`UpdateSession`	Updates a Session.

`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 `Sitemap`s in a `DataStore`.
`GetSiteSearchEngine`	Gets the `SiteSearchEngine`.
`GetTargetSite`	Gets a `TargetSite`.
`ListTargetSites`	Gets a list of `TargetSite`s.
`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.discoveryengine.v1beta.UserLicenseService`

Methods
`BatchUpdateUserLicenses`	Updates the User License.
`ListUserLicenses`	Lists the User Licenses.

`google.cloud.discoveryengine.v1beta.UserStoreService`

Methods
`CreateUserStore`	Creates a new User Store.
`DeleteUserStore`	Deletes the User Store.
`GetUserStore`	Gets the User Store.
`UpdateUserStore`	Updates the User Store.

`google.cloud.location.Locations`

Methods

`google.cloud.notebooklm.v1alpha.AudioOverviewService`

Methods
`CreateAudioOverview`	Generates a new audio overview.
`DeleteAudioOverview`	Deletes an audio overview.

`google.cloud.notebooklm.v1alpha.NotebookService`

Methods
`BatchDeleteNotebooks`	Batch deletes Notebooks.
`CreateNotebook`	Creates a notebook.
`GetNotebook`	Gets a notebook.
`ListRecentlyViewedNotebooks`	Lists the notebooks ordered by last view time.
`ShareNotebook`	Shares a notebook to other accounts.

`google.cloud.notebooklm.v1alpha.SourceService`

Methods
`BatchCreateSources`	Creates a list of `Source`s.
`BatchDeleteSources`	Deletes multiple sources
`GetSource`	Gets a `Source`.

`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.

Discovery Engine API Stay organized with collections Save and categorize content based on your preferences.

Service: discoveryengine.googleapis.com

Discovery Engine API