Module google_api_proto::google::cloud::discoveryengine::v1beta

source ·

Modules§

Structs§

  • AlloyDB source import data from.
  • Defines an answer.
  • Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.
  • Response message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.
  • Metadata related to the progress of the [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] method.
  • Response message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] method.
  • Request message for [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] method.
  • Response message for [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] method.
  • Metadata related to the progress of the [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] method.
  • Response message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] method.
  • BigQuery source import data from.
  • The Bigtable Options object that contains information to support the import.
  • The Cloud Bigtable source for importing data.
  • Request message for [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] method.
  • Response message for the [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] method.
  • Specification for the grounding check.
  • Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
  • Cloud SQL source import data from.
  • Request message for CollectUserEvent method.
  • Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
  • Response message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
  • Detailed completion information including completion attribution token and clicked completion info.
  • Autocomplete suggestions that are imported from Customer.
  • Defines circumstances to be checked before allowing a behavior
  • Defines a conditioned behavior to employ during serving. Must be attached to a [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] to be considered at serving time. Permitted actions dependent on SolutionType.
  • External conversation proto definition.
  • Defines context of the conversation
  • Defines a conversation message.
  • Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
  • Response message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
  • Request for CreateControl method.
  • Request for CreateConversation method.
  • Metadata related to the progress of the [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request for [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] method.
  • Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] method.
  • Metadata related to the progress of the [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request for [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] method.
  • Metadata for [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] method.
  • Request message for [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] method.
  • Request message for [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.CreateSampleQuery] method.
  • Request message for [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.CreateSampleQuerySet] method.
  • Metadata for Create Schema LRO.
  • Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] method.
  • Request for CreateSession method.
  • Metadata related to the progress of the [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] method.
  • A custom attribute that is not explicitly modeled in a resource, e.g. [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent].
  • Metadata that describes a custom tuned model.
  • DataStore captures global settings and configs at the DataStore level.
  • Request for DeleteControl method.
  • Request for DeleteConversation method.
  • Metadata related to the progress of the [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] method.
  • Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] method.
  • Metadata related to the progress of the [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] method.
  • Request message for [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.DeleteSampleQuery] method.
  • Request message for [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.DeleteSampleQuerySet] method.
  • Metadata for DeleteSchema LRO.
  • Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] method.
  • Request for DeleteSession method.
  • Metadata related to the progress of the [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] method.
  • Metadata related to the progress of the [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] method.
  • Response message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] method.
  • Document captures all raw metadata information of items to be recommended or searched.
  • Detailed document information associated with a user event.
  • A singleton resource of [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. It’s empty when [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is created, which defaults to digital parser. The first call to [DataStoreService.UpdateDocumentProcessingConfig][] method will initialize the config.
  • Double list.
  • Defines embedding config, used for bring your own embeddings feature.
  • Metadata related to the progress of the [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] method.
  • Response message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] method.
  • Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1beta.Engine].
  • An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
  • Fact Chunk.
  • Request message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] method.
  • Response message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] method.
  • Cloud FhirStore source import data from.
  • Firestore source import data from.
  • Cloud Storage location for input content.
  • Request for GetAnswer method.
  • Request for GetControl method.
  • Request for GetConversation method.
  • Request message for [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.GetDataStore] method.
  • Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] method.
  • Request message for [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] method.
  • Request message for [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.GetEvaluation] method.
  • Request message for [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.GetSampleQuery] method.
  • Request message for [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.GetSampleQuerySet] method.
  • Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] method.
  • Request for GetServingConfig method.
  • Request for GetSession method.
  • Request message for [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetSiteSearchEngine] method.
  • Request message for [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetTargetSite] method.
  • Grounding Fact.
  • Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] method.
  • Response of the [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
  • Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
  • Request message for Import methods.
  • Response of the [ImportDocumentsRequest][google.cloud.discoveryengine.v1beta.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.
  • Configuration of destination for Import related errors.
  • Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] method.
  • Response of the [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
  • Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
  • Request message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] method.
  • Response message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] method.
  • Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
  • Request message for the ImportUserEvents request.
  • 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.
  • A floating point interval.
  • Language info for DataStore.
  • Request for ListControls method.
  • Response for ListControls method.
  • Request for ListConversations method.
  • Response for ListConversations method.
  • Request message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] method.
  • Response message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] method.
  • Request message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] method.
  • Response message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] method.
  • Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.
  • Response message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.
  • Request message for [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] method.
  • Response message for [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] method.
  • Request message for [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] method.
  • Response message for [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] method.
  • Request message for [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] method.
  • Response message for [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] method.
  • Request message for [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] method.
  • Response message for [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] method.
  • Request message for [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] method.
  • Response message for [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] method.
  • Request message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.
  • Response message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.
  • Request for ListServingConfigs method.
  • Response for ListServingConfigs method.
  • Request for ListSessions method.
  • Response for ListSessions method.
  • Request message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] method.
  • Response message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] method.
  • Media-specific user event information.
  • Detailed page information.
  • Detailed panel information associated with a user event.
  • Request for pausing training of an engine.
  • Metadata and configurations for a Google Cloud project in the service.
  • Metadata associated with a project provision operation.
  • Request for [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1beta.ProjectService.ProvisionProject] method.
  • Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.
  • Request message for [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] method.
  • Response message for [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] method.
  • Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.
  • Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
  • Configuration of destination for Purge related errors.
  • Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
  • Request message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] method.
  • Response message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] method.
  • Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for PurgeUserEvents method.
  • Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
  • Describes the metrics produced by the evaluation.
  • Defines a user inputed query.
  • Request message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.
  • Response message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.
  • Record message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.
  • Request message for Recommend method.
  • Response message for Recommend method.
  • Metadata related to the progress of the [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] method.
  • Response message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] method.
  • Defines a reply message to user.
  • Request for resuming training of an engine.
  • Sample Query captures metadata to be used for evaluation.
  • A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
  • Defines the structure and layout of a type of document data.
  • Detailed search information.
  • Request message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
  • Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
  • Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
  • External session proto definition.
  • SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
  • Verification information for target sites in advanced site search.
  • The Spanner source for importing data
  • Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
  • A target site for the SiteSearchEngine.
  • Defines text input.
  • Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
  • Request message for [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel] method.
  • Response of the [TrainCustomModelRequest][google.cloud.discoveryengine.v1beta.TrainCustomModelRequest]. This message is returned by the google.longrunning.Operations.response field.
  • A transaction represents the entire purchase transaction.
  • Metadata associated with a tune operation.
  • Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
  • Response associated with a tune operation.
  • Request for UpdateControl method.
  • Request for UpdateConversation method.
  • Request message for [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.UpdateDataStore] method.
  • Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] method.
  • Request message for [EngineService.UpdateEngine][google.cloud.discoveryengine.v1beta.EngineService.UpdateEngine] method.
  • Request message for [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.UpdateSampleQuery] method.
  • Request message for [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.UpdateSampleQuerySet] method.
  • Metadata for UpdateSchema LRO.
  • Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] method.
  • Request for UpdateServingConfig method.
  • Request for UpdateSession method.
  • Metadata related to the progress of the [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.UpdateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
  • Request message for [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.UpdateTargetSite] method.
  • UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
  • Information of an end user.
  • Request message for WriteUserEvent method.

Enums§

  • The industry vertical associated with the [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
  • Add-on that provides additional functionality for search.
  • Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.
  • Defines a further subdivision of SolutionType. Specifically applies to [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
  • The type of solution.