Module google_api_proto::google::cloud::discoveryengine::v1

Modules

• big_query_source
  Nested message and enum types in BigQuerySource.
• bigtable_options
  Nested message and enum types in BigtableOptions.
• complete_query_response
  Nested message and enum types in CompleteQueryResponse.
• completion_service_client
  Generated client implementations.
• conversation
  Nested message and enum types in Conversation.
• conversation_message
  Nested message and enum types in ConversationMessage.
• conversational_search_service_client
  Generated client implementations.
• data_store
  Nested message and enum types in DataStore.
• data_store_service_client
  Generated client implementations.
• document
  Nested message and enum types in Document.
• document_info
  Nested message and enum types in DocumentInfo.
• document_service_client
  Generated client implementations.
• engine
  Nested message and enum types in Engine.
• engine_service_client
  Generated client implementations.
• import_documents_request
  Nested message and enum types in ImportDocumentsRequest.
• import_error_config
  Nested message and enum types in ImportErrorConfig.
• import_suggestion_deny_list_entries_request
  Nested message and enum types in ImportSuggestionDenyListEntriesRequest.
• import_user_events_request
  Nested message and enum types in ImportUserEventsRequest.
• interval
  Nested message and enum types in Interval.
• recommend_response
  Nested message and enum types in RecommendResponse.
• recommendation_service_client
  Generated client implementations.
• recrawl_uris_response
  Nested message and enum types in RecrawlUrisResponse.
• schema
  Nested message and enum types in Schema.
• schema_service_client
  Generated client implementations.
• search_request
  Nested message and enum types in SearchRequest.
• search_response
  Nested message and enum types in SearchResponse.
• search_service_client
  Generated client implementations.
• site_search_engine_service_client
  Generated client implementations.
• site_verification_info
  Nested message and enum types in SiteVerificationInfo.
• suggestion_deny_list_entry
  Nested message and enum types in SuggestionDenyListEntry.
• target_site
  Nested message and enum types in TargetSite.
• user_event_service_client
  Generated client implementations.

Structs

• BatchCreateTargetSiteMetadata
  Metadata related to the progress of the [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.
• BatchCreateTargetSitesRequest
  Request message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] method.
• BatchCreateTargetSitesResponse
  Response message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] method.
• BatchVerifyTargetSitesMetadata
  Metadata related to the progress of the [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.
• BatchVerifyTargetSitesRequest
  Request message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] method.
• BatchVerifyTargetSitesResponse
  Response message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] method.
• BigQuerySource
  BigQuery source import data from.
• BigtableOptions
  The Bigtable Options object that contains information to support the import.
• BigtableSource
  The Cloud Bigtable source for importing data.
• CloudSqlSource
  Cloud SQL source import data from.
• CollectUserEventRequest
  Request message for CollectUserEvent method.
• CompleteQueryRequest
  Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] method.
• CompleteQueryResponse
  Response message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] method.
• CompletionInfo
  Detailed completion information including completion attribution token and clicked completion info.
• Conversation
  External conversation proto definition.
• ConversationContext
  Defines context of the conversation
• ConversationMessage
  Defines a conversation message.
• ConverseConversationRequest
  Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] method.
• ConverseConversationResponse
  Response message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] method.
• CreateConversationRequest
  Request for CreateConversation method.
• CreateDataStoreMetadata
  Metadata related to the progress of the [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
• CreateDataStoreRequest
  Request for [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] method.
• CreateDocumentRequest
  Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1.DocumentService.CreateDocument] method.
• CreateEngineMetadata
  Metadata related to the progress of the [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.
• CreateEngineRequest
  Request for [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] method.
• CreateSchemaMetadata
  Metadata for Create Schema LRO.
• CreateSchemaRequest
  Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1.SchemaService.CreateSchema] method.
• CreateTargetSiteMetadata
  Metadata related to the progress of the [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
• CreateTargetSiteRequest
  Request message for [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSite] method.
• CustomAttribute
  A custom attribute that is not explicitly modeled in a resource, e.g. [UserEvent][google.cloud.discoveryengine.v1.UserEvent].
• DataStore
  DataStore captures global settings and configs at the DataStore level.
• DeleteConversationRequest
  Request for DeleteConversation method.
• DeleteDataStoreMetadata
  Metadata related to the progress of the [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
• DeleteDataStoreRequest
  Request message for [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] method.
• DeleteDocumentRequest
  Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1.DocumentService.DeleteDocument] method.
• DeleteEngineMetadata
  Metadata related to the progress of the [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.
• DeleteEngineRequest
  Request message for [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] method.
• DeleteSchemaMetadata
  Metadata for DeleteSchema LRO.
• DeleteSchemaRequest
  Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1.SchemaService.DeleteSchema] method.
• DeleteTargetSiteMetadata
  Metadata related to the progress of the [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
• DeleteTargetSiteRequest
  Request message for [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSite] method.
• DisableAdvancedSiteSearchMetadata
  Metadata related to the progress of the [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.
• DisableAdvancedSiteSearchRequest
  Request message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] method.
• DisableAdvancedSiteSearchResponse
  Response message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] method.
• Document
  Document captures all raw metadata information of items to be recommended or searched.
• DocumentInfo
  Detailed document information associated with a user event.
• EnableAdvancedSiteSearchMetadata
  Metadata related to the progress of the [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.
• EnableAdvancedSiteSearchRequest
  Request message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] method.
• EnableAdvancedSiteSearchResponse
  Response message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] method.
• Engine
  Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1.Engine].
• FetchDomainVerificationStatusRequest
  Request message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] method.
• FetchDomainVerificationStatusResponse
  Response message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] method.
• FhirStoreSource
  Cloud FhirStore source import data from.
• FirestoreSource
  Firestore source import data from.
• GcsSource
  Cloud Storage location for input content.
• GetConversationRequest
  Request for GetConversation method.
• GetDataStoreRequest
  Request message for [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1.DataStoreService.GetDataStore] method.
• GetDocumentRequest
  Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] method.
• GetEngineRequest
  Request message for [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] method.
• GetSchemaRequest
  Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] method.
• GetSiteSearchEngineRequest
  Request message for [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetSiteSearchEngine] method.
• GetTargetSiteRequest
  Request message for [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetTargetSite] method.
• ImportDocumentsMetadata
  Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
• ImportDocumentsRequest
  Request message for Import methods.
• ImportDocumentsResponse
  Response of the [ImportDocumentsRequest][google.cloud.discoveryengine.v1.ImportDocumentsRequest]. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
• ImportErrorConfig
  Configuration of destination for Import related errors.
• ImportSuggestionDenyListEntriesMetadata
  Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
• ImportSuggestionDenyListEntriesRequest
  Request message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] method.
• ImportSuggestionDenyListEntriesResponse
  Response message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] method.
• ImportUserEventsMetadata
  Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
• ImportUserEventsRequest
  Request message for the ImportUserEvents request.
• ImportUserEventsResponse
  Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
• Interval
  A floating point interval.
• ListConversationsRequest
  Request for ListConversations method.
• ListConversationsResponse
  Response for ListConversations method.
• ListDataStoresRequest
  Request message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] method.
• ListDataStoresResponse
  Response message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] method.
• ListDocumentsRequest
  Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] method.
• ListDocumentsResponse
  Response message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] method.
• ListEnginesRequest
  Request message for [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] method.
• ListEnginesResponse
  Response message for [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] method.
• ListSchemasRequest
  Request message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] method.
• ListSchemasResponse
  Response message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] method.
• ListTargetSitesRequest
  Request message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] method.
• ListTargetSitesResponse
  Response message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] method.
• MediaInfo
  Media-specific user event information.
• PageInfo
  Detailed page information.
• PanelInfo
  Detailed panel information associated with a user event.
• PurgeDocumentsMetadata
  Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
• PurgeDocumentsRequest
  Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] method.
• PurgeDocumentsResponse
  Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
• PurgeSuggestionDenyListEntriesMetadata
  Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
• PurgeSuggestionDenyListEntriesRequest
  Request message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] method.
• PurgeSuggestionDenyListEntriesResponse
  Response message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] method.
• RecommendRequest
  Request message for Recommend method.
• RecommendResponse
  Response message for Recommend method.
• RecrawlUrisMetadata
  Metadata related to the progress of the [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] operation. This will be returned by the google.longrunning.Operation.metadata field.
• RecrawlUrisRequest
  Request message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] method.
• RecrawlUrisResponse
  Response message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] method.
• Reply
  Defines a reply message to user.
• Schema
  Defines the structure and layout of a type of document data.
• SearchInfo
  Detailed search information.
• SearchRequest
  Request message for [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method.
• SearchResponse
  Response message for [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method.
• SiteSearchEngine
  SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
• SiteVerificationInfo
  Verification information for target sites in advanced site search.
• SpannerSource
  The Spanner source for importing data
• SuggestionDenyListEntry
  Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
• TargetSite
  A target site for the SiteSearchEngine.
• TextInput
  Defines text input.
• TransactionInfo
  A transaction represents the entire purchase transaction.
• UpdateConversationRequest
  Request for UpdateConversation method.
• UpdateDataStoreRequest
  Request message for [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1.DataStoreService.UpdateDataStore] method.
• UpdateDocumentRequest
  Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument] method.
• UpdateEngineRequest
  Request message for [EngineService.UpdateEngine][google.cloud.discoveryengine.v1.EngineService.UpdateEngine] method.
• UpdateSchemaMetadata
  Metadata for UpdateSchema LRO.
• UpdateSchemaRequest
  Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1.SchemaService.UpdateSchema] method.
• UpdateTargetSiteMetadata
  Metadata related to the progress of the [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
• UpdateTargetSiteRequest
  Request message for [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSite] method.
• UserEvent
  UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers’ website.
• UserInfo
  Information of an end user.
• WriteUserEventRequest
  Request message for WriteUserEvent method.

Enums

• IndustryVertical
  The industry vertical associated with the [DataStore][google.cloud.discoveryengine.v1.DataStore].
• SearchAddOn
  Add-on that provides additional functionality for search.
• SearchTier
  Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.
• SolutionType
  The type of solution.