This preview documentation is deprecated.

Discovery for Media has been renamed to media recommendations. It is now part of Vertex AI Search, and you can manage it using the Search and Conversation console. We recommend that you use the Search and Conversation console. After March 31, 2024, the Discovery Engine console will no longer be available.

For information about what's changing, see Switch from Discovery for Media to media recommendations. For more information about recommendations in Vertex AI Search, see About recommendations.

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.

`google.cloud.discoveryengine.v1.ConversationalSearchService`

Methods
`ConverseConversation`	Converses a conversation.
`CreateConversation`	Creates a Conversation.
`DeleteConversation`	Deletes a Conversation.
`GetConversation`	Gets a Conversation.
`ListConversations`	Lists all Conversations by their parent `DataStore`.
`UpdateConversation`	Updates a Conversation.

`google.cloud.discoveryengine.v1.DocumentService`

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

`google.cloud.discoveryengine.v1.UserEventService`

Methods
`CollectUserEvent`	Writes a single user event from the browser.
`ImportUserEvents`	Bulk import of User events.
`WriteUserEvent`	Writes a single user event.

`google.cloud.discoveryengine.v1alpha.CompletionService`

Methods
`CompleteQuery`	Completes the specified user input with keyword suggestions.

`google.cloud.discoveryengine.v1alpha.ConversationalSearchService`

Methods
`ConverseConversation`	Converses a conversation.
`CreateConversation`	Creates a Conversation.
`DeleteConversation`	Deletes a Conversation.
`GetConversation`	Gets a Conversation.
`ListConversations`	Lists all Conversations by their parent `DataStore`.
`UpdateConversation`	Updates a Conversation.

`google.cloud.discoveryengine.v1alpha.DocumentService`

Methods
`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.v1alpha.InternalAdminService`

Methods

`google.cloud.discoveryengine.v1alpha.RecommendationService`

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

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

`google.cloud.discoveryengine.v1alpha.ServingConfigService`

Methods

`google.cloud.discoveryengine.v1alpha.SiteSearchEngineService`

Methods
`RecrawlUris`	Request on-demand recrawl for a list of URIs.

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

Methods
`LookupWidgetConfig`	Gets the Widget Config using the uuid.
`WidgetCompleteQuery`	Performs a user input completion with keyword suggestion.
`WidgetConverseConversation`	Converse a conversation with Widget.
`WidgetSearch`	Performs a search.

`google.cloud.discoveryengine.v1beta.CompletionService`

Methods
`CompleteQuery`	Completes the specified user input with keyword suggestions.

`google.cloud.discoveryengine.v1beta.ConversationalSearchService`

Methods
`ConverseConversation`	Converses a conversation.
`CreateConversation`	Creates a Conversation.
`DeleteConversation`	Deletes a Conversation.
`GetConversation`	Gets a Conversation.
`ListConversations`	Lists all Conversations by their parent `DataStore`.
`UpdateConversation`	Updates a Conversation.

`google.cloud.discoveryengine.v1beta.DocumentService`

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

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

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

`google.cloud.discoveryengine.v1beta.UserEventService`

Methods
`CollectUserEvent`	Writes a single user event from the browser.
`ImportUserEvents`	Bulk import of User events.
`WriteUserEvent`	Writes a single user event.

`google.cloud.location.Locations`

Methods

`google.longrunning.Operations`

Methods
`GetOperation`	Gets the latest state of a long-running operation.
`ListOperations`	Lists operations that match the specified filter in the request.