View Source API Reference google_api_discovery_engine v0.7.0

Modules

API client metadata for GoogleApi.DiscoveryEngine.V1beta.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.DiscoveryEngine.V1beta.

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

A description of the context in which an error occurred.

An error log which is reported to the Error Reporting system.

The error payload that is populated on LRO import APIs, including the following: google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents

Indicates a location in the source code of the service for which errors are reported.

Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

DataStore captures global settings and configs at the DataStore level.

Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.

Related configurations applied to a specific type of document parser.

Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Metadata that describes the training and serving parameters of an Engine.

Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

Additional information of a Chat Engine. Fields in this message are output only.

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

Response of the 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 ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Response message for CompletionService.ImportSuggestionDenyListEntries method.

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

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.

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

Defines the structure and layout of a type of document data.

Verification information for target sites in advanced site search.

Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Attributes

  • chunkInfo (type: list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo.t), default: nil) - If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
  • document (type: String.t, default: nil) - Document resource name.
  • snippetInfo (type: list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo.t), default: nil) - If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
  • title (type: String.t, default: nil) - Title.
  • uri (type: String.t, default: nil) - URI for the document.

Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

DataStore captures global settings and configs at the DataStore level.

Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.

Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Metadata that describes the training and serving parameters of an Engine.

Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

Additional information of a Chat Engine. Fields in this message are output only.

Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.

Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.

Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.

Response of the 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.

Response of the 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.

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Response message for CompletionService.ImportSuggestionDenyListEntries method.

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

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.

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for SiteSearchEngineService.RecrawlUris method.

Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.

Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.

Defines the structure and layout of a type of document data.

Represents a turn, including a query from the user and a answer from service.

Verification information for target sites in advanced site search.

Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.

Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.

Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for ConversationalSearchService.AnswerQuery method.

Response message for ConversationalSearchService.AnswerQuery method.

Attributes

  • chunkInfo (type: list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo.t), default: nil) - If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
  • document (type: String.t, default: nil) - Document resource name.
  • snippetInfo (type: list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo.t), default: nil) - If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
  • title (type: String.t, default: nil) - Title.
  • uri (type: String.t, default: nil) - URI for the document.

Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

The Bigtable Options object that contains information to support the import.

Request message for GroundedGenerationService.CheckGrounding method.

Response message for the GroundedGenerationService.CheckGrounding method.

Response message for CompletionService.CompleteQuery method.

Detailed completion information including completion attribution token and clicked completion info.

Request message for ConversationalSearchService.ConverseConversation method.

Response message for ConversationalSearchService.ConverseConversation method.

Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.CreateTargetSite method.

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

DataStore captures global settings and configs at the DataStore level.

Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Response message for 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. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.

Related configurations applied to a specific type of document parser.

Defines embedding config, used for bring your own embeddings feature.

Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Metadata that describes the training and serving parameters of an Engine.

Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

Additional information of a Chat Engine. Fields in this message are output only.

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

Response of the 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.

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportSuggestionDenyListEntries method.

Response message for CompletionService.ImportSuggestionDenyListEntries method.

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

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.

Response message for DataStoreService.ListDataStores method.

Response message for SiteSearchEngineService.ListTargetSites method.

Detailed panel information associated with a user event.

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

RecommendationResult represents a generic recommendation result with associated metadata.

Request message for SiteSearchEngineService.RecrawlUris method.

Defines the structure and layout of a type of document data.

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

A specification for configuring a summary returned in a search response.

The specification that uses customized query embedding vector to do semantic document retrieval.

Specification to determine under which conditions query expansion should occur.

Debug information specifically related to forward geocoding issues arising from Geolocation Search.

Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.

Information describing query expansion including whether expansion has occurred.

Summary of the top N search result specified by the summary spec.

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.

Specifies the configurations needed for Generic Discovery.Currently we support: * content_search_spec: configuration for generic content search.

Specifies the configurations needed for Media Discovery. Currently we support: demote_content_watched: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. promote_fresh_content: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Represents a turn, including a query from the user and a answer from service.

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.

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for SearchTuningService.TrainCustomModel method.

Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.

A transaction represents the entire purchase transaction.

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.

The response message for Operations.ListOperations.

This resource represents a long-running operation that is the result of a network API call.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp