Show / Hide Table of Contents

Namespace Google.Apis.DiscoveryEngine.v1alpha.Data

Classes

ApiservingMediaRequestInfo

Extra information added to operations that support Scotty media requests.

ApiservingMediaResponseInfo

This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }

GdataBlobstore2Info

Information to read/write to blobstore2.

GdataCompositeMedia

A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.

GdataContentTypeInfo

Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.

GdataDiffChecksumsResponse

Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

GdataDiffDownloadResponse

Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

GdataDiffUploadRequest

A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

GdataDiffUploadResponse

Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

GdataDiffVersionResponse

Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

GdataDownloadParameters

Parameters specific to media downloads.

GdataMedia

A reference to data stored on the filesystem, on GFS or in blobstore.

GdataObjectId

This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.

GoogleApiDistribution

Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.

GoogleApiDistributionBucketOptions

BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.

GoogleApiDistributionBucketOptionsExplicit

Specifies a set of buckets with arbitrary widths. There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.

GoogleApiDistributionBucketOptionsExponential

Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i

  • 1)).

GoogleApiDistributionBucketOptionsLinear

Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).

GoogleApiDistributionExemplar

Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.

GoogleApiDistributionRange

The range of the population values.

GoogleApiHttpBody

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.

GoogleApiMetric

A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.

GoogleApiMonitoredResource

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }}

GoogleApiMonitoredResourceMetadata

Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.

GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext

The error payload that is populated on LRO sync APIs, including the following: * google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector * google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun

GoogleCloudDiscoveryengineLoggingErrorContext

A description of the context in which an error occurred.

GoogleCloudDiscoveryengineLoggingErrorLog

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

GoogleCloudDiscoveryengineLoggingHttpRequestContext

HTTP request data that is related to a reported error.

GoogleCloudDiscoveryengineLoggingImportErrorContext

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

GoogleCloudDiscoveryengineLoggingServiceContext

Describes a running service that sends errors.

GoogleCloudDiscoveryengineLoggingSourceLocation

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

GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig

Configuration data for advance site search.

GoogleCloudDiscoveryengineV1AnswerGenerationSpec

The specification for answer generation.

GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec

The specification for user defined classifier.

GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

GoogleCloudDiscoveryengineV1CmekConfig

Configurations used to enable CMEK data encryption with Cloud KMS keys.

GoogleCloudDiscoveryengineV1Condition

Defines circumstances to be checked before allowing a behavior

GoogleCloudDiscoveryengineV1ConditionQueryTerm

Matcher for search request query

GoogleCloudDiscoveryengineV1ConditionTimeRange

Used for time-dependent conditions.

GoogleCloudDiscoveryengineV1Control

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

GoogleCloudDiscoveryengineV1ControlBoostAction

Adjusts order of products in returned list.

GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec

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

GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint

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

GoogleCloudDiscoveryengineV1ControlFilterAction

Specified which products may be included in results. Uses same filter as boost.

GoogleCloudDiscoveryengineV1ControlPromoteAction

Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for shoe keyword. The link can be outside of associated data store.

GoogleCloudDiscoveryengineV1ControlRedirectAction

Redirects a shopper to the provided URI.

GoogleCloudDiscoveryengineV1ControlSynonymsAction

Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".

GoogleCloudDiscoveryengineV1CreateDataStoreMetadata

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

GoogleCloudDiscoveryengineV1CreateEngineMetadata

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

GoogleCloudDiscoveryengineV1CreateSchemaMetadata

Metadata for Create Schema LRO.

GoogleCloudDiscoveryengineV1CreateSitemapMetadata

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

GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1DataStore

DataStore captures global settings and configs at the DataStore level.

GoogleCloudDiscoveryengineV1DataStoreBillingEstimation

Estimation of data size per data store.

GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore

Stores information regarding the serving configurations at DataStore level.

GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata

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

GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata

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

GoogleCloudDiscoveryengineV1DeleteEngineMetadata

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

GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata

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

GoogleCloudDiscoveryengineV1DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

GoogleCloudDiscoveryengineV1DeleteSitemapMetadata

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

GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata

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

GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1DocumentProcessingConfig

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.

GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig

Configuration for chunking config.

GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig

Configuration for the layout based chunking.

GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig

Related configurations applied to a specific type of document parser.

GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig

The digital parsing configurations for documents.

GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig

The layout parsing configurations for documents.

GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig

The OCR parsing configurations for documents.

GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata

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

GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1Engine

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

GoogleCloudDiscoveryengineV1EngineChatEngineConfig

Configurations for a Chat Engine.

GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig

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.

GoogleCloudDiscoveryengineV1EngineChatEngineMetadata

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

GoogleCloudDiscoveryengineV1EngineCommonConfig

Common configurations for an Engine.

GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig

Additional config specs for a Media Recommendation engine.

GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig

More feature configs of the selected engine type.

GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig

Feature configurations that are required for creating a Most Popular engine.

GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig

Custom threshold for cvr optimization_objective.

GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig

Additional feature configurations for creating a recommended-for-you engine.

GoogleCloudDiscoveryengineV1EngineSearchEngineConfig

Configurations for a Search Engine.

GoogleCloudDiscoveryengineV1HealthcareFhirConfig

Config to data store for HEALTHCARE_FHIR vertical.

GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata

IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings

GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata

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

GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse

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.

GoogleCloudDiscoveryengineV1ImportDocumentsMetadata

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

GoogleCloudDiscoveryengineV1ImportDocumentsResponse

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.

GoogleCloudDiscoveryengineV1ImportErrorConfig

Configuration of destination for Import related errors.

GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse

Response message for IdentityMappingStoreService.ImportIdentityMappings

GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata

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

GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse

Response message for CompletionService.ImportSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1ImportUserEventsMetadata

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

GoogleCloudDiscoveryengineV1ImportUserEventsResponse

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.

GoogleCloudDiscoveryengineV1Project

Metadata and configurations for a Google Cloud project in the service.

GoogleCloudDiscoveryengineV1ProjectServiceTerms

Metadata about the terms of service.

GoogleCloudDiscoveryengineV1ProvisionProjectMetadata

Metadata associated with a project provision operation.

GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata

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

GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse

Response message for CompletionService.PurgeCompletionSuggestions method.

GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata

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

GoogleCloudDiscoveryengineV1PurgeDocumentsResponse

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.

GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata

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

GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1Schema

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

GoogleCloudDiscoveryengineV1SearchLinkPromotion

Promotion proto includes uri and other helping information to display the promotion.

GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec

A specification for configuring the behavior of content search.

GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec

A specification for configuring the extractive content in a search response.

GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec

A specification for configuring snippets in a search response.

GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec

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

GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec

Specification of the prompt to use with the model.

GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec

Specification of the model.

GoogleCloudDiscoveryengineV1ServingConfig

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.

GoogleCloudDiscoveryengineV1ServingConfigGenericConfig

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

GoogleCloudDiscoveryengineV1ServingConfigMediaConfig

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.

GoogleCloudDiscoveryengineV1SingleRegionKey

Metadata for single-regional CMEKs.

GoogleCloudDiscoveryengineV1SiteVerificationInfo

Verification information for target sites in advanced site search.

GoogleCloudDiscoveryengineV1Sitemap

A sitemap for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1TargetSite

A target site for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1TargetSiteFailureReason

Site search indexing failure reasons.

GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure

Failed due to insufficient quota.

GoogleCloudDiscoveryengineV1TrainCustomModelMetadata

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

GoogleCloudDiscoveryengineV1TrainCustomModelResponse

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

GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata

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

GoogleCloudDiscoveryengineV1UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1WorkspaceConfig

Config to store data store type configuration for workspace data

GoogleCloudDiscoveryengineV1alphaAclConfig

Access Control Configuration.

GoogleCloudDiscoveryengineV1alphaActionConfig

Informations to support actions on the connector.

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest

Request message for CompletionService.AdvancedCompleteQuery method. .

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec

Specification to boost suggestions based on the condtion of the suggestion.

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec

Boost applies to suggestions which match a condition.

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec

Specification of each suggestion type.

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse

Response message for CompletionService.AdvancedCompleteQuery method.

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion

Suggestions as content.

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion

Suggestions as people.

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion

Suggestions as search queries.

GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion

Suggestions from recent search history.

GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig

Configuration data for advance site search.

GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig

The connector level alert config.

GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment

The alert enrollment status.

GoogleCloudDiscoveryengineV1alphaAlloyDbSource

AlloyDB source import data from.

GoogleCloudDiscoveryengineV1alphaAnswer

Defines an answer.

GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment

Stores binarydata attached to text answer, e.g. image, video, audio, etc.

GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob

The media type and data of the blob.

GoogleCloudDiscoveryengineV1alphaAnswerCitation

Citation info for a segment.

GoogleCloudDiscoveryengineV1alphaAnswerCitationSource

Citation source.

GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec

The specification for answer generation.

GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec

The specification for user defined classifier.

GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport

Grounding support for a claim in answer_text.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest

Request message for ConversationalSearchService.AnswerQuery method.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec

Answer generation specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec

Answer Generation Model specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec

Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec

Answer generation prompt specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec

End user specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData

End user metadata.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo

Chunk information.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata

Document metadata contains the information of the document of the current chunk.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec

Grounding specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec

Query understanding specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec

Query classification specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec

Query rephraser specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec

Query Rephraser Model specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec

Related questions specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec

Safety specification. There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories. 2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting

Safety settings.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec

Search specification.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams

Search parameters.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList

Search result list.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult

Search result.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo

Chunk information.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata

Document metadata contains the information of the document of the current chunk.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo

Unstructured document information.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext

Document context.

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer

Extractive answer. Guide

GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment

Extractive segment. Guide Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.

GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse

Response message for ConversationalSearchService.AnswerQuery method.

GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo

Query understanding information.

GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo

Query classification information.

GoogleCloudDiscoveryengineV1alphaAnswerReference

Reference.

GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo

Chunk information.

GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata

Document metadata.

GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo

Structured search information.

GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo

Unstructured document information.

GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent

Chunk content.

GoogleCloudDiscoveryengineV1alphaAnswerStep

Step information.

GoogleCloudDiscoveryengineV1alphaAnswerStepAction

Action.

GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation

Observation.

GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult

GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo

Chunk information.

GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo

Snippet information.

GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction

Search action.

GoogleCloudDiscoveryengineV1alphaBAPConfig

The configuration for the BAP connector.

GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse

Response message for DocumentService.BatchGetDocumentsMetadata method.

GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata

The metadata of a Document.

GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue

The value of the matcher that was used to match the Document.

GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata

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

GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest

Request message for UserLicenseService.BatchUpdateUserLicenses method.

GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource

The inline source for the input config for BatchUpdateUserLicenses method.

GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse

Response message for UserLicenseService.BatchUpdateUserLicenses method.

GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

GoogleCloudDiscoveryengineV1alphaBigQuerySource

BigQuery source import data from.

GoogleCloudDiscoveryengineV1alphaBigtableOptions

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

GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn

The column of the Bigtable.

GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily

The column family of the Bigtable.

GoogleCloudDiscoveryengineV1alphaBigtableSource

The Cloud Bigtable source for importing data.

GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest

Request message for GroundedGenerationService.CheckGrounding method.

GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse

Response message for the GroundedGenerationService.CheckGrounding method.

GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk

Fact chunk for grounding check.

GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim

Text and citation info for a claim in the answer candidate.

GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec

Specification for the grounding check.

GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest

Request for CheckRequirement method.

GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse

Response for the CheckRequirement method.

GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult

Metric result. The metric are in the requirement_condition.

GoogleCloudDiscoveryengineV1alphaChunk

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata

The annotation metadata includes structured content in the current chunk.

GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata

Metadata of the current chunk. This field is only populated on SearchService.Search API.

GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata

Document metadata contains the information of the document of the current chunk.

GoogleCloudDiscoveryengineV1alphaChunkPageSpan

Page span of the chunk.

GoogleCloudDiscoveryengineV1alphaChunkStructuredContent

The structured content information.

GoogleCloudDiscoveryengineV1alphaCloudSqlSource

Cloud SQL source import data from.

GoogleCloudDiscoveryengineV1alphaCmekConfig

Configurations used to enable CMEK data encryption with Cloud KMS keys.

GoogleCloudDiscoveryengineV1alphaCollection

Collection is a container for configuring resources and access to a set of DataStores.

GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse

Response message for CompletionService.CompleteQuery method.

GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion

Suggestions as search queries.

GoogleCloudDiscoveryengineV1alphaCompletionInfo

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

GoogleCloudDiscoveryengineV1alphaCompletionSuggestion

Autocomplete suggestions that are imported from Customer.

GoogleCloudDiscoveryengineV1alphaCondition

Defines circumstances to be checked before allowing a behavior

GoogleCloudDiscoveryengineV1alphaConditionQueryTerm

Matcher for search request query

GoogleCloudDiscoveryengineV1alphaConditionTimeRange

Used for time-dependent conditions.

GoogleCloudDiscoveryengineV1alphaConnectorRun

A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //

GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun

Represents an entity that was synced in this ConnectorRun.

GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress

Represents the progress of a sync run.

GoogleCloudDiscoveryengineV1alphaControl

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

GoogleCloudDiscoveryengineV1alphaControlBoostAction

Adjusts order of products in returned list.

GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec

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

GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint

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

GoogleCloudDiscoveryengineV1alphaControlFilterAction

Specified which products may be included in results. Uses same filter as boost.

GoogleCloudDiscoveryengineV1alphaControlPromoteAction

Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for shoe keyword. The link can be outside of associated data store.

GoogleCloudDiscoveryengineV1alphaControlRedirectAction

Redirects a shopper to the provided URI.

GoogleCloudDiscoveryengineV1alphaControlSynonymsAction

Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".

GoogleCloudDiscoveryengineV1alphaConversation

External conversation proto definition.

GoogleCloudDiscoveryengineV1alphaConversationContext

Defines context of the conversation

GoogleCloudDiscoveryengineV1alphaConversationMessage

Defines a conversation message.

GoogleCloudDiscoveryengineV1alphaConverseConversationRequest

Request message for ConversationalSearchService.ConverseConversation method.

GoogleCloudDiscoveryengineV1alphaConverseConversationResponse

Response message for ConversationalSearchService.ConverseConversation method.

GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries

The historical crawl rate timeseries data, used for monitoring.

GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata

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

GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata

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

GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata

Metadata for EvaluationService.CreateEvaluation method.

GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata

Metadata for Create Schema LRO.

GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata

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

GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest

Request message for SiteSearchEngineService.CreateTargetSite method.

GoogleCloudDiscoveryengineV1alphaCustomAttribute

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

GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec

Defines custom fine tuning spec.

GoogleCloudDiscoveryengineV1alphaCustomTuningModel

Metadata that describes a custom tuned model.

GoogleCloudDiscoveryengineV1alphaDataConnector

Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.

GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig

Any params and credentials used specifically for EUA connectors.

GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig

The configuration for realtime sync to store additional params for realtime sync.

GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity

Represents an entity in the data source. For example, the Account object in Salesforce.

GoogleCloudDiscoveryengineV1alphaDataStore

DataStore captures global settings and configs at the DataStore level.

GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation

Estimation of data size per data store.

GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore

Stores information regarding the serving configurations at DataStore level.

GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries

The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.

GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata

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

GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata

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

GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata

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

GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata

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

GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata

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

GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata

Metadata for DeleteSchema LRO.

GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest

Request for DeleteSession method.

GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata

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

GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1alphaDestinationConfig

Defines target endpoints used to connect to third-party sources.

GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination

Defines a target endpoint

GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata

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

GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1alphaDocument

Document captures all raw metadata information of items to be recommended or searched.

GoogleCloudDiscoveryengineV1alphaDocumentAclInfo

ACL Information of the Document.

GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction

AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }

GoogleCloudDiscoveryengineV1alphaDocumentContent

Unstructured data linked to this document.

GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus

Index status of the document.

GoogleCloudDiscoveryengineV1alphaDocumentInfo

Detailed document information associated with a user event.

GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.

GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig

Configuration for chunking config.

GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig

Configuration for the layout based chunking.

GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig

Related configurations applied to a specific type of document parser.

GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig

The digital parsing configurations for documents.

GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig

The layout parsing configurations for documents.

GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig

The OCR parsing configurations for documents.

GoogleCloudDiscoveryengineV1alphaDoubleList

Double list.

GoogleCloudDiscoveryengineV1alphaEmbeddingConfig

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

GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata

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

GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1alphaEngine

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

GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig

Configurations for a Chat Engine.

GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig

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.

GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata

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

GoogleCloudDiscoveryengineV1alphaEngineCommonConfig

Common configurations for an Engine.

GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig

Additional config specs for a Media Recommendation engine.

GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig

More feature configs of the selected engine type.

GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig

Feature configurations that are required for creating a Most Popular engine.

GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig

Custom threshold for cvr optimization_objective.

GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig

Additional feature configurations for creating a recommended-for-you engine.

GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata

Additional information of a recommendation engine.

GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig

Configurations for a Search Engine.

GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig

Additional config specs for a similar-items engine.

GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata

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

GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest

Request message for EstimateBillingService.EstimateDataSize method

GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource

Data source contains files either in Cloud Storage or BigQuery.

GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource

Data source is a set of website patterns that we crawl to get the total number of websites.

GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern

URI patterns that we use to crawl.

GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse

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.

GoogleCloudDiscoveryengineV1alphaEvaluation

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec

Describes the specification of the evaluation.

GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec

Describes the specification of the query set.

GoogleCloudDiscoveryengineV1alphaFactChunk

Fact Chunk.

GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse

Response message for SiteSearchEngineService.FetchSitemaps method.

GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata

Contains a Sitemap and its metadata.

GoogleCloudDiscoveryengineV1alphaFhirStoreSource

Cloud FhirStore source import data from.

GoogleCloudDiscoveryengineV1alphaFieldConfig

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

GoogleCloudDiscoveryengineV1alphaFirestoreSource

Firestore source import data from.

GoogleCloudDiscoveryengineV1alphaGcsSource

Cloud Storage location for input content.

GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse

Response message for DataConnectorService.GetConnectorSecret.

GoogleCloudDiscoveryengineV1alphaGetSessionRequest

Request for GetSession method.

GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse

Response message for SiteSearchEngineService.GetUriPatternDocumentData method.

GoogleCloudDiscoveryengineV1alphaGroundingFact

Grounding Fact.

GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec

Defines guided search spec.

GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig

Config to data store for HEALTHCARE_FHIR vertical.

GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry

Identity Mapping Entry that maps an external identity to an internal identity.

GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata

IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings

GoogleCloudDiscoveryengineV1alphaIdentityMappingStore

Identity Mapping Store which contains Identity Mapping Entries.

GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig

The configuration for the identity data synchronization runs.

GoogleCloudDiscoveryengineV1alphaIdpConfig

Identity Provider Config.

GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig

Third party IDP Config.

GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata

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

GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest

Request message for CompletionService.ImportCompletionSuggestions method.

GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource

The inline source for CompletionSuggestions.

GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse

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.

GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata

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

GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest

Request message for Import methods.

GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource

The inline source for the input config for ImportDocuments method.

GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse

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.

GoogleCloudDiscoveryengineV1alphaImportErrorConfig

Configuration of destination for Import related errors.

GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest

Request message for IdentityMappingStoreService.ImportIdentityMappings

GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource

The inline source to import identity mapping entries from.

GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse

Response message for IdentityMappingStoreService.ImportIdentityMappings

GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata

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

GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest

Request message for SampleQueryService.ImportSampleQueries method.

GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource

The inline source for SampleQuerys.

GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse

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

GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata

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

GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest

Request message for CompletionService.ImportSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource

The inline source for SuggestionDenyListEntry.

GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse

Response message for CompletionService.ImportSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata

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

GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest

Request message for the ImportUserEvents request.

GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource

The inline source for the input config for ImportUserEvents method.

GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse

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.

GoogleCloudDiscoveryengineV1alphaInterval

A floating point interval.

GoogleCloudDiscoveryengineV1alphaLanguageInfo

Language info for DataStore.

GoogleCloudDiscoveryengineV1alphaListChunksResponse

Response message for ChunkService.ListChunks method.

GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse

Response message for CmekConfigService.ListCmekConfigs method.

GoogleCloudDiscoveryengineV1alphaListCollectionsResponse

Response message for CollectionService.ListCollections method.

GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse

Response for DataConnectorService.ListConnectorRuns method.

GoogleCloudDiscoveryengineV1alphaListControlsResponse

Response for ListControls method.

GoogleCloudDiscoveryengineV1alphaListConversationsResponse

Response for ListConversations method.

GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse

Response message for SearchTuningService.ListCustomModels method.

GoogleCloudDiscoveryengineV1alphaListDataStoresResponse

Response message for DataStoreService.ListDataStores method.

GoogleCloudDiscoveryengineV1alphaListDocumentsResponse

Response message for DocumentService.ListDocuments method.

GoogleCloudDiscoveryengineV1alphaListEnginesResponse

Response message for EngineService.ListEngines method.

GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse

Response message for EvaluationService.ListEvaluationResults method.

GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult

Represents the results of an evaluation for a single SampleQuery.

GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse

Response message for EvaluationService.ListEvaluations method.

GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse

Response message for IdentityMappingStoreService.ListIdentityMappingStores

GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse

Response message for IdentityMappingStoreService.ListIdentityMappings

GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse

Response message for SampleQueryService.ListSampleQueries method.

GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse

Response message for SampleQuerySetService.ListSampleQuerySets method.

GoogleCloudDiscoveryengineV1alphaListSchemasResponse

Response message for SchemaService.ListSchemas method.

GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse

Response for ListServingConfigs method.

GoogleCloudDiscoveryengineV1alphaListSessionsRequest

Request for ListSessions method.

GoogleCloudDiscoveryengineV1alphaListSessionsResponse

Response for ListSessions method.

GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse

Response message for SiteSearchEngineService.ListTargetSites method.

GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse

Response message for UserLicenseService.ListUserLicenses.

GoogleCloudDiscoveryengineV1alphaMediaInfo

Media-specific user event information.

GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig

Configuration for Natural Language Query Understanding.

GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest

Request message for CrawlRateManagementService.ObtainCrawlRate method.

GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse

Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.

GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries

The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.

GoogleCloudDiscoveryengineV1alphaPageInfo

Detailed page information.

GoogleCloudDiscoveryengineV1alphaPanelInfo

Detailed panel information associated with a user event.

GoogleCloudDiscoveryengineV1alphaPauseEngineRequest

Request for pausing training of an engine.

GoogleCloudDiscoveryengineV1alphaPrincipal

Principal identifier of a user or a group.

GoogleCloudDiscoveryengineV1alphaProcessedDocument

Document captures all raw metadata information of items to be recommended or searched.

GoogleCloudDiscoveryengineV1alphaProject

Metadata and configurations for a Google Cloud project in the service.

GoogleCloudDiscoveryengineV1alphaProjectServiceTerms

Metadata about the terms of service.

GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata

Metadata associated with a project provision operation.

GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest

Request for ProjectService.ProvisionProject method.

GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata

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

GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest

Request message for CompletionService.PurgeCompletionSuggestions method.

GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse

Response message for CompletionService.PurgeCompletionSuggestions method.

GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata

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

GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest

Request message for DocumentService.PurgeDocuments method.

GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource

The inline source for the input config for DocumentService.PurgeDocuments method.

GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse

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.

GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig

Configuration of destination for Purge related errors.

GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest

Request message for IdentityMappingStoreService.PurgeIdentityMappings

GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource

The inline source to purge identity mapping entries from.

GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata

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

GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata

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

GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest

Request message for PurgeUserEvents method.

GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse

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

GoogleCloudDiscoveryengineV1alphaQualityMetrics

Describes the metrics produced by the evaluation.

GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics

Stores the metric values at specific top-k levels.

GoogleCloudDiscoveryengineV1alphaQuery

Defines a user inputed query.

GoogleCloudDiscoveryengineV1alphaRankRequest

Request message for RankService.Rank method.

GoogleCloudDiscoveryengineV1alphaRankResponse

Response message for RankService.Rank method.

GoogleCloudDiscoveryengineV1alphaRankingRecord

Record message for RankService.Rank method.

GoogleCloudDiscoveryengineV1alphaRecommendRequest

Request message for Recommend method.

GoogleCloudDiscoveryengineV1alphaRecommendResponse

Response message for Recommend method.

GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata

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

GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest

Request message for SiteSearchEngineService.RecrawlUris method.

GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse

Response message for SiteSearchEngineService.RecrawlUris method.

GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo

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

GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason

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

GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata

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

GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest

Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.

GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse

Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.

GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest

Request message for CompletionService.RemoveSuggestion method.

GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse

Response message for CompletionService.RemoveSuggestion method.

GoogleCloudDiscoveryengineV1alphaReply

Defines a reply message to user.

GoogleCloudDiscoveryengineV1alphaReplyReference

Defines reference in reply.

GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest

Request for ReportConsentChange method.

GoogleCloudDiscoveryengineV1alphaRequirement

A data requirement.

GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding

Specifies a metrics query and bind its result to a variable which will be used in the condition.

GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding

Specifies a multi-level threshold to apply to apply to a metric_bindings in the condition CEL expression.

GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue

Specifies a threshold value for a given severity.

GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding

Specifies a samples query and bind its result to a variable which will be used in the condition.

GoogleCloudDiscoveryengineV1alphaResumeEngineRequest

Request for resuming training of an engine.

GoogleCloudDiscoveryengineV1alphaSafetyRating

Safety rating corresponding to the generated content.

GoogleCloudDiscoveryengineV1alphaSampleQuery

Sample Query captures metadata to be used for evaluation.

GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry

Query Entry captures metadata to be used for search evaluation.

GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget

Defines the parameters of the query's expected outcome.

GoogleCloudDiscoveryengineV1alphaSampleQuerySet

A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.

GoogleCloudDiscoveryengineV1alphaSchema

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

GoogleCloudDiscoveryengineV1alphaSearchInfo

Detailed search information.

GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion

Promotion proto includes uri and other helping information to display the promotion.

GoogleCloudDiscoveryengineV1alphaSearchRequest

Request message for SearchService.Search method.

GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec

Boost specification to boost certain documents.

GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec

Boost applies to documents which match a condition.

GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec

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

GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint

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

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

A specification for configuring the behavior of content search.

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec

A specification for configuring the extractive content in a search response.

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec

A specification for configuring snippets in a search response.

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec

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

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec

Specification of the prompt to use with the model.

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec

Specification of the model.

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec

Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.

GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec

Specifies features for display, like match highlighting.

GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec

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

GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector

Embedding vector.

GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec

A facet specification to perform faceted search.

GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey

Specifies how a facet is computed.

GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery

Specifies the image query input.

GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec

Specification to enable natural language understanding capabilities for search requests.

GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec

The specification for personalization.

GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec

The specification for returning the document relevance score.

GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec

Specification for search as you type in search requests.

GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec

Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec

The specification for query spell correction.

GoogleCloudDiscoveryengineV1alphaSearchResponse

Response message for SearchService.Search method.

GoogleCloudDiscoveryengineV1alphaSearchResponseFacet

A facet result.

GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue

A facet value which contains value names and their count.

GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo

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

GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult

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.

GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute

Useful attribute for search result refinements.

GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo

Information describing what natural language understanding was done on the input query.

GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter

The filters that were extracted from the input query represented in a structured form.

GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression

Logical And operator.

GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression

The expression denoting the filter that was extracted from the input query.

GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint

Constraint of a geolocation field. Name of the geolocation field as defined in the schema.

GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint

Constraint expression of a number field. Example: price < 100.

GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression

Logical Or operator.

GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint

Constraint expression of a string field.

GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult

OneBoxResult is a holder for all results of specific type that we want to display in UI differently.

GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult

Represents the search results.

GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo

Information about the session.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummary

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

GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryBlobAttachment

Stores binarydata attached to text answer, e.g. image, video, audio, etc.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryBlobAttachmentBlob

Stores type and data of the blob.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation

Citation info for a segment.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata

Citation metadata.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource

Citation source.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference

Document reference.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent

Chunk content.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes

Safety Attribute categories and their associated confidence scores.

GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata

Summary with metadata information.

GoogleCloudDiscoveryengineV1alphaServingConfig

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.

GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig

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

GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig

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.

GoogleCloudDiscoveryengineV1alphaSession

External session proto definition.

GoogleCloudDiscoveryengineV1alphaSessionTurn

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

GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata

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

GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest

Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.

GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse

Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.

GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata

Metadata for DataConnectorService.SetUpDataConnector method.

GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest

Request for DataConnectorService.SetUpDataConnector method.

GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata

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

GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest

Request message for SiteSearchEngineService.SetUriPatternDocumentData method.

GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse

Response message for SiteSearchEngineService.SetUriPatternDocumentData method.

GoogleCloudDiscoveryengineV1alphaSingleRegionKey

Metadata for single-regional CMEKs.

GoogleCloudDiscoveryengineV1alphaSiteSearchEngine

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo

Verification information for target sites in advanced site search.

GoogleCloudDiscoveryengineV1alphaSitemap

A sitemap for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1alphaSpannerSource

The Spanner source for importing data

GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest

Request message for DataConnectorService.StartConnectorRun method.

GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry

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

GoogleCloudDiscoveryengineV1alphaTargetSite

A target site for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason

Site search indexing failure reasons.

GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure

Failed due to insufficient quota.

GoogleCloudDiscoveryengineV1alphaTextInput

Defines text input.

GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata

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

GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest

Request message for SearchTuningService.TrainCustomModel method.

GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput

Cloud Storage training data input.

GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse

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

GoogleCloudDiscoveryengineV1alphaTransactionInfo

A transaction represents the entire purchase transaction.

GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata

Metadata associated with a tune operation.

GoogleCloudDiscoveryengineV1alphaTuneEngineRequest

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

GoogleCloudDiscoveryengineV1alphaTuneEngineResponse

Response associated with a tune operation.

GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata

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

GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata

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

GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata

Metadata for UpdateSchema LRO.

GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest

Request for UpdateSession method.

GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1alphaUserEvent

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

GoogleCloudDiscoveryengineV1alphaUserInfo

Information of an end user.

GoogleCloudDiscoveryengineV1alphaUserLicense

User License information assigned by the admin.

GoogleCloudDiscoveryengineV1alphaWidgetConfig

WidgetConfig captures configs at the Widget level.

GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings

Describes widget access settings.

GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings

Describes the assistant settings of the widget.

GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent

Read-only collection component that contains data store collections fields that may be used for filtering

GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig

Customer provided configurations.

GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent

Read-only data store component that contains data stores fields that may be used for filtering, it's the child of CollectionComponent.

GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig

UI component configuration for data store.

GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField

Facet fields that store the mapping of fields to end user widget appearance.

GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting

Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.

GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut

Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.

GoogleCloudDiscoveryengineV1alphaWidgetConfigImage

Options to store an image.

GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField

Facet field that maps to a UI Component.

GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings

Describes widget UI branding settings.

GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings

Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.

GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig

Describes configuration for generative answer.

GoogleCloudDiscoveryengineV1alphaWorkspaceConfig

Config to store data store type configuration for workspace data

GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig

Configuration data for advance site search.

GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

GoogleCloudDiscoveryengineV1betaCmekConfig

Configurations used to enable CMEK data encryption with Cloud KMS keys.

GoogleCloudDiscoveryengineV1betaCondition

Defines circumstances to be checked before allowing a behavior

GoogleCloudDiscoveryengineV1betaConditionQueryTerm

Matcher for search request query

GoogleCloudDiscoveryengineV1betaConditionTimeRange

Used for time-dependent conditions.

GoogleCloudDiscoveryengineV1betaControl

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

GoogleCloudDiscoveryengineV1betaControlBoostAction

Adjusts order of products in returned list.

GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec

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

GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint

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

GoogleCloudDiscoveryengineV1betaControlFilterAction

Specified which products may be included in results. Uses same filter as boost.

GoogleCloudDiscoveryengineV1betaControlPromoteAction

Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for shoe keyword. The link can be outside of associated data store.

GoogleCloudDiscoveryengineV1betaControlRedirectAction

Redirects a shopper to the provided URI.

GoogleCloudDiscoveryengineV1betaControlSynonymsAction

Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".

GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries

The historical crawl rate timeseries data, used for monitoring.

GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata

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

GoogleCloudDiscoveryengineV1betaCreateEngineMetadata

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

GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata

Metadata for EvaluationService.CreateEvaluation method.

GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata

Metadata for Create Schema LRO.

GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata

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

GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1betaDataStore

DataStore captures global settings and configs at the DataStore level.

GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation

Estimation of data size per data store.

GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore

Stores information regarding the serving configurations at DataStore level.

GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries

The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.

GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata

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

GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata

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

GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata

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

GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata

Metadata for DeleteSchema LRO.

GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata

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

GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata

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

GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.

GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig

Configuration for chunking config.

GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig

Configuration for the layout based chunking.

GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig

Related configurations applied to a specific type of document parser.

GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig

The digital parsing configurations for documents.

GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig

The layout parsing configurations for documents.

GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig

The OCR parsing configurations for documents.

GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata

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

GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1betaEngine

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

GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig

Configurations for a Chat Engine.

GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig

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.

GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata

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

GoogleCloudDiscoveryengineV1betaEngineCommonConfig

Common configurations for an Engine.

GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig

Additional config specs for a Media Recommendation engine.

GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig

More feature configs of the selected engine type.

GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig

Feature configurations that are required for creating a Most Popular engine.

GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig

Custom threshold for cvr optimization_objective.

GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig

Additional feature configurations for creating a recommended-for-you engine.

GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig

Configurations for a Search Engine.

GoogleCloudDiscoveryengineV1betaEvaluation

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec

Describes the specification of the evaluation.

GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec

Describes the specification of the query set.

GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig

Config to data store for HEALTHCARE_FHIR vertical.

GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata

IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings

GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata

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

GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse

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.

GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata

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

GoogleCloudDiscoveryengineV1betaImportDocumentsResponse

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.

GoogleCloudDiscoveryengineV1betaImportErrorConfig

Configuration of destination for Import related errors.

GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse

Response message for IdentityMappingStoreService.ImportIdentityMappings

GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata

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

GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse

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

GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata

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

GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse

Response message for CompletionService.ImportSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata

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

GoogleCloudDiscoveryengineV1betaImportUserEventsResponse

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.

GoogleCloudDiscoveryengineV1betaInterval

A floating point interval.

GoogleCloudDiscoveryengineV1betaLanguageInfo

Language info for DataStore.

GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig

Configuration for Natural Language Query Understanding.

GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse

Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.

GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries

The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.

GoogleCloudDiscoveryengineV1betaProject

Metadata and configurations for a Google Cloud project in the service.

GoogleCloudDiscoveryengineV1betaProjectServiceTerms

Metadata about the terms of service.

GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata

Metadata associated with a project provision operation.

GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata

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

GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse

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.

GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata

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

GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1betaQualityMetrics

Describes the metrics produced by the evaluation.

GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics

Stores the metric values at specific top-k levels.

GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata

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

GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse

Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.

GoogleCloudDiscoveryengineV1betaSchema

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

GoogleCloudDiscoveryengineV1betaSearchLinkPromotion

Promotion proto includes uri and other helping information to display the promotion.

GoogleCloudDiscoveryengineV1betaSearchRequest

Request message for SearchService.Search method.

GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec

Boost specification to boost certain documents.

GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec

Boost applies to documents which match a condition.

GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec

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

GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint

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

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec

A specification for configuring the behavior of content search.

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec

A specification for configuring the extractive content in a search response.

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec

A specification for configuring snippets in a search response.

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec

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

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec

Specification of the prompt to use with the model.

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec

Specification of the model.

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec

Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.

GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec

Specifies features for display, like match highlighting.

GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec

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

GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector

Embedding vector.

GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec

A facet specification to perform faceted search.

GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey

Specifies how a facet is computed.

GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery

Specifies the image query input.

GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec

Specification to enable natural language understanding capabilities for search requests.

GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec

The specification for personalization.

GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec

The specification for returning the document relevance score.

GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec

Specification for search as you type in search requests.

GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec

Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec

The specification for query spell correction.

GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata

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

GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse

Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.

GoogleCloudDiscoveryengineV1betaSingleRegionKey

Metadata for single-regional CMEKs.

GoogleCloudDiscoveryengineV1betaSiteVerificationInfo

Verification information for target sites in advanced site search.

GoogleCloudDiscoveryengineV1betaSitemap

A sitemap for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1betaTargetSite

A target site for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason

Site search indexing failure reasons.

GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure

Failed due to insufficient quota.

GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata

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

GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse

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

GoogleCloudDiscoveryengineV1betaTuneEngineMetadata

Metadata associated with a tune operation.

GoogleCloudDiscoveryengineV1betaTuneEngineResponse

Response associated with a tune operation.

GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata

Metadata for UpdateSchema LRO.

GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1betaUserInfo

Information of an end user.

GoogleCloudDiscoveryengineV1betaWorkspaceConfig

Config to store data store type configuration for workspace data

GoogleCloudNotebooklmV1alphaSourceId

SourceId is the last segment of the source's resource name.

GoogleCloudNotebooklmV1alphaUploadSourceFileRequest

Request for the SourceService.UploadSourceFile method.

GoogleCloudNotebooklmV1alphaUploadSourceFileResponse

Response for the SourceService.UploadSourceFile method.

GoogleLongrunningCancelOperationRequest

The request message for Operations.CancelOperation.

GoogleLongrunningListOperationsResponse

The response message for Operations.ListOperations.

GoogleLongrunningOperation

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

GoogleMonitoringV3Point

A single data point in a time series.

GoogleMonitoringV3TimeInterval

A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.

GoogleMonitoringV3TimeSeries

A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.

GoogleMonitoringV3TypedValue

A single strongly-typed value.

GoogleProtobufEmpty

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); }

GoogleRpcStatus

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.

GoogleTypeDate

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

GoogleTypeDateTime

Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

GoogleTypeExpr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

GoogleTypeTimeZone

Represents a time zone from the IANA Time Zone Database.

In this article
Back to top Generated by DocFX