Namespace Google.Apis.DiscoveryEngine.v1.Data

Classes

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.

GoogleCloudDiscoveryengineV1AlloyDbSource

AlloyDB source import data from.

GoogleCloudDiscoveryengineV1Answer

Defines an answer.

GoogleCloudDiscoveryengineV1AnswerCitation

Citation info for a segment.

GoogleCloudDiscoveryengineV1AnswerCitationSource

Citation source.

GoogleCloudDiscoveryengineV1AnswerGenerationSpec

The specification for answer generation.

GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec

The specification for user defined classifier.

GoogleCloudDiscoveryengineV1AnswerGroundingSupport

Grounding support for a claim in answer_text.

GoogleCloudDiscoveryengineV1AnswerQueryRequest

Request message for ConversationalSearchService.AnswerQuery method.

GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec

Answer generation specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec

Answer Generation Model specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec

Answer generation prompt specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec

End user specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData

End user metadata.

GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo

Chunk information.

GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata

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

GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec

Grounding specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec

Query understanding specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec

Query classification specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec

Query rephraser specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec

Query Rephraser Model specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec

GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec

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.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting

Safety settings.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec

Search specification.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams

Search parameters.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList

Search result list.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult

Search result.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo

Chunk information.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata

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

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo

Unstructured document information.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext

Document context.

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer

Extractive answer. Guide

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment

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

GoogleCloudDiscoveryengineV1AnswerQueryResponse

Response message for ConversationalSearchService.AnswerQuery method.

GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo

Query understanding information.

GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo

Query classification information.

GoogleCloudDiscoveryengineV1AnswerReference

Reference.

GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo

Chunk information.

GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata

Document metadata.

GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo

Structured search information.

GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo

Unstructured document information.

GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent

Chunk content.

GoogleCloudDiscoveryengineV1AnswerStep

Step information.

GoogleCloudDiscoveryengineV1AnswerStepAction

Action.

GoogleCloudDiscoveryengineV1AnswerStepActionObservation

Observation.

GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult

GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo

Chunk information.

GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo

Snippet information.

GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction

Search action.

GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata

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

GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse

Response message for DocumentService.BatchGetDocumentsMetadata method.

GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata

The metadata of a Document.

GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue

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

GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest

Request message for UserLicenseService.BatchUpdateUserLicenses method.

GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource

The inline source for the input config for BatchUpdateUserLicenses method.

GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

GoogleCloudDiscoveryengineV1BigQuerySource

BigQuery source import data from.

GoogleCloudDiscoveryengineV1BigtableOptions

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

GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn

The column of the Bigtable.

GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily

The column family of the Bigtable.

GoogleCloudDiscoveryengineV1BigtableSource

The Cloud Bigtable source for importing data.

GoogleCloudDiscoveryengineV1CheckGroundingRequest

Request message for GroundedGenerationService.CheckGrounding method.

GoogleCloudDiscoveryengineV1CheckGroundingResponse

Response message for the GroundedGenerationService.CheckGrounding method.

GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk

Fact chunk for grounding check.

GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim

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

GoogleCloudDiscoveryengineV1CheckGroundingSpec

Specification for the grounding check.

GoogleCloudDiscoveryengineV1Chunk

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

GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata

The annotation metadata includes structured content in the current chunk.

GoogleCloudDiscoveryengineV1ChunkChunkMetadata

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

GoogleCloudDiscoveryengineV1ChunkDocumentMetadata

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

GoogleCloudDiscoveryengineV1ChunkPageSpan

Page span of the chunk.

GoogleCloudDiscoveryengineV1ChunkStructuredContent

The structured content information.

GoogleCloudDiscoveryengineV1CloudSqlSource

Cloud SQL source import data from.

GoogleCloudDiscoveryengineV1CmekConfig

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

GoogleCloudDiscoveryengineV1CompleteQueryResponse

Response message for CompletionService.CompleteQuery method.

GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion

Suggestions as search queries.

GoogleCloudDiscoveryengineV1CompletionInfo

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

GoogleCloudDiscoveryengineV1CompletionSuggestion

Autocomplete suggestions that are imported from Customer.

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

GoogleCloudDiscoveryengineV1Conversation

External conversation proto definition.

GoogleCloudDiscoveryengineV1ConversationContext

Defines context of the conversation

GoogleCloudDiscoveryengineV1ConversationMessage

Defines a conversation message.

GoogleCloudDiscoveryengineV1ConverseConversationRequest

Request message for ConversationalSearchService.ConverseConversation method.

GoogleCloudDiscoveryengineV1ConverseConversationResponse

Response message for ConversationalSearchService.ConverseConversation method.

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.

GoogleCloudDiscoveryengineV1CreateTargetSiteRequest

Request message for SiteSearchEngineService.CreateTargetSite method.

GoogleCloudDiscoveryengineV1CustomAttribute

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

GoogleCloudDiscoveryengineV1CustomTuningModel

Metadata that describes a custom tuned model.

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.

GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

GoogleCloudDiscoveryengineV1Document

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

GoogleCloudDiscoveryengineV1DocumentAclInfo

ACL Information of the Document.

GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction

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" } ], } ] } }

GoogleCloudDiscoveryengineV1DocumentContent

Unstructured data linked to this document.

GoogleCloudDiscoveryengineV1DocumentIndexStatus

Index status of the document.

GoogleCloudDiscoveryengineV1DocumentInfo

Detailed document information associated with a user event.

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.

GoogleCloudDiscoveryengineV1DoubleList

Double list.

GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata

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

GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

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.

GoogleCloudDiscoveryengineV1FactChunk

Fact Chunk.

GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

GoogleCloudDiscoveryengineV1FetchSitemapsResponse

Response message for SiteSearchEngineService.FetchSitemaps method.

GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata

Contains a Sitemap and its metadata.

GoogleCloudDiscoveryengineV1FhirStoreSource

Cloud FhirStore source import data from.

GoogleCloudDiscoveryengineV1FirestoreSource

Firestore source import data from.

GoogleCloudDiscoveryengineV1GcsSource

Cloud Storage location for input content.

GoogleCloudDiscoveryengineV1GroundingFact

Grounding Fact.

GoogleCloudDiscoveryengineV1HealthcareFhirConfig

Config to data store for HEALTHCARE_FHIR vertical.

GoogleCloudDiscoveryengineV1IdentityMappingEntry

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

GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata

IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings

GoogleCloudDiscoveryengineV1IdentityMappingStore

Identity Mapping Store which contains Identity Mapping Entries.

GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata

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

GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest

Request message for CompletionService.ImportCompletionSuggestions method.

GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource

The inline source for CompletionSuggestions.

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.

GoogleCloudDiscoveryengineV1ImportDocumentsRequest

Request message for Import methods.

GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource

The inline source for the input config for ImportDocuments method.

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.

GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest

Request message for IdentityMappingStoreService.ImportIdentityMappings

GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource

The inline source to import identity mapping entries from.

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.

GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest

Request message for CompletionService.ImportSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource

The inline source for SuggestionDenyListEntry.

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.

GoogleCloudDiscoveryengineV1ImportUserEventsRequest

Request message for the ImportUserEvents request.

GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource

The inline source for the input config for ImportUserEvents method.

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.

GoogleCloudDiscoveryengineV1Interval

A floating point interval.

GoogleCloudDiscoveryengineV1ListCmekConfigsResponse

Response message for CmekConfigService.ListCmekConfigs method.

GoogleCloudDiscoveryengineV1ListControlsResponse

Response for ListControls method.

GoogleCloudDiscoveryengineV1ListConversationsResponse

Response for ListConversations method.

GoogleCloudDiscoveryengineV1ListCustomModelsResponse

Response message for SearchTuningService.ListCustomModels method.

GoogleCloudDiscoveryengineV1ListDataStoresResponse

Response message for DataStoreService.ListDataStores method.

GoogleCloudDiscoveryengineV1ListDocumentsResponse

Response message for DocumentService.ListDocuments method.

GoogleCloudDiscoveryengineV1ListEnginesResponse

Response message for EngineService.ListEngines method.

GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse

Response message for IdentityMappingStoreService.ListIdentityMappingStores

GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse

Response message for IdentityMappingStoreService.ListIdentityMappings

GoogleCloudDiscoveryengineV1ListSchemasResponse

Response message for SchemaService.ListSchemas method.

GoogleCloudDiscoveryengineV1ListSessionsResponse

Response for ListSessions method.

GoogleCloudDiscoveryengineV1ListTargetSitesResponse

Response message for SiteSearchEngineService.ListTargetSites method.

GoogleCloudDiscoveryengineV1ListUserLicensesResponse

Response message for UserLicenseService.ListUserLicenses.

GoogleCloudDiscoveryengineV1MediaInfo

Media-specific user event information.

GoogleCloudDiscoveryengineV1PageInfo

Detailed page information.

GoogleCloudDiscoveryengineV1PanelInfo

Detailed panel information associated with a user event.

GoogleCloudDiscoveryengineV1Principal

Principal identifier of a user or a group.

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.

GoogleCloudDiscoveryengineV1ProvisionProjectRequest

Request for ProjectService.ProvisionProject method.

GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata

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

GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest

Request message for CompletionService.PurgeCompletionSuggestions method.

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.

GoogleCloudDiscoveryengineV1PurgeDocumentsRequest

Request message for DocumentService.PurgeDocuments method.

GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource

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

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.

GoogleCloudDiscoveryengineV1PurgeErrorConfig

Configuration of destination for Purge related errors.

GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest

Request message for IdentityMappingStoreService.PurgeIdentityMappings

GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource

The inline source to purge identity mapping entries from.

GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata

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

GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

GoogleCloudDiscoveryengineV1PurgeUserEventsRequest

Request message for PurgeUserEvents method.

GoogleCloudDiscoveryengineV1Query

Defines a user inputed query.

GoogleCloudDiscoveryengineV1RankRequest

Request message for RankService.Rank method.

GoogleCloudDiscoveryengineV1RankResponse

Response message for RankService.Rank method.

GoogleCloudDiscoveryengineV1RankingRecord

Record message for RankService.Rank method.

GoogleCloudDiscoveryengineV1RecommendRequest

Request message for Recommend method.

GoogleCloudDiscoveryengineV1RecommendResponse

Response message for Recommend method.

GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

GoogleCloudDiscoveryengineV1RecrawlUrisRequest

Request message for SiteSearchEngineService.RecrawlUris method.

GoogleCloudDiscoveryengineV1Reply

Defines a reply message to user.

GoogleCloudDiscoveryengineV1SafetyRating

Safety rating corresponding to the generated content.

GoogleCloudDiscoveryengineV1Schema

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

GoogleCloudDiscoveryengineV1SearchInfo

Detailed search information.

GoogleCloudDiscoveryengineV1SearchLinkPromotion

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

GoogleCloudDiscoveryengineV1SearchRequest

Request message for SearchService.Search method.

GoogleCloudDiscoveryengineV1SearchRequestBoostSpec

Boost specification to boost certain documents.

GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec

Boost applies to documents which match a condition.

GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec

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

GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint

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

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.

GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec

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.

GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec

Specifies features for display, like match highlighting.

GoogleCloudDiscoveryengineV1SearchRequestFacetSpec

A facet specification to perform faceted search.

GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey

Specifies how a facet is computed.

GoogleCloudDiscoveryengineV1SearchRequestImageQuery

Specifies the image query input.

GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec

The specification for returning the document relevance score.

GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec

Specification for search as you type in search requests.

GoogleCloudDiscoveryengineV1SearchRequestSessionSpec

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.

GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec

The specification for query spell correction.

GoogleCloudDiscoveryengineV1SearchResponse

Response message for SearchService.Search method.

GoogleCloudDiscoveryengineV1SearchResponseFacet

A facet result.

GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue

A facet value which contains value names and their count.

GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

GoogleCloudDiscoveryengineV1SearchResponseSearchResult

Represents the search results.

GoogleCloudDiscoveryengineV1SearchResponseSessionInfo

Information about the session.

GoogleCloudDiscoveryengineV1SearchResponseSummary

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

GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation

Citation info for a segment.

GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata

Citation metadata.

GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource

Citation source.

GoogleCloudDiscoveryengineV1SearchResponseSummaryReference

Document reference.

GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent

Chunk content.

GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes

Safety Attribute categories and their associated confidence scores.

GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata

Summary with metadata information.

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.

GoogleCloudDiscoveryengineV1Session

External session proto definition.

GoogleCloudDiscoveryengineV1SessionTurn

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

GoogleCloudDiscoveryengineV1SingleRegionKey

Metadata for single-regional CMEKs.

GoogleCloudDiscoveryengineV1SiteSearchEngine

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

GoogleCloudDiscoveryengineV1SiteVerificationInfo

Verification information for target sites in advanced site search.

GoogleCloudDiscoveryengineV1Sitemap

A sitemap for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1SpannerSource

The Spanner source for importing data

GoogleCloudDiscoveryengineV1SuggestionDenyListEntry

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

GoogleCloudDiscoveryengineV1TargetSite

A target site for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1TargetSiteFailureReason

Site search indexing failure reasons.

GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure

Failed due to insufficient quota.

GoogleCloudDiscoveryengineV1TextInput

Defines text input.

GoogleCloudDiscoveryengineV1TrainCustomModelMetadata

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

GoogleCloudDiscoveryengineV1TrainCustomModelRequest

Request message for SearchTuningService.TrainCustomModel method.

GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput

Cloud Storage training data input.

GoogleCloudDiscoveryengineV1TrainCustomModelResponse

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

GoogleCloudDiscoveryengineV1TransactionInfo

A transaction represents the entire purchase transaction.

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.

GoogleCloudDiscoveryengineV1UserEvent

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

GoogleCloudDiscoveryengineV1UserInfo

Information of an end user.

GoogleCloudDiscoveryengineV1UserLicense

User License information assigned by the admin.

GoogleCloudDiscoveryengineV1WorkspaceConfig

Config to store data store type configuration for workspace data

GoogleCloudDiscoveryengineV1alphaAclConfig

Access Control Configuration.

GoogleCloudDiscoveryengineV1alphaActionConfig

Informations to support actions on the connector.

GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig

Configuration data for advance site search.

GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig

The connector level alert config.

GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment

The alert enrollment status.

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.

GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport

Grounding support for a claim in answer_text.

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.

GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata

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

GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse

Response message for UserLicenseService.BatchUpdateUserLicenses method.

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.

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

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.

GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec

Defines custom fine tuning spec.

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.

GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

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.

GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata

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

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

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.

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.

GoogleCloudDiscoveryengineV1alphaFieldConfig

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

GoogleCloudDiscoveryengineV1alphaGetSessionRequest

Request for GetSession method.

GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse

Response message for SiteSearchEngineService.GetUriPatternDocumentData method.

GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig

Config to data store for HEALTHCARE_FHIR vertical.

GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata

IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings

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.

GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse

GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata

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

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.

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.

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.

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.

GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse

GoogleCloudDiscoveryengineV1alphaInterval

A floating point interval.

GoogleCloudDiscoveryengineV1alphaLanguageInfo

Language info for DataStore.

GoogleCloudDiscoveryengineV1alphaListSessionsRequest

Request for ListSessions method.

GoogleCloudDiscoveryengineV1alphaListSessionsResponse

Response for ListSessions method.

GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig

Configuration for Natural Language Query Understanding.

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.

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.

GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata

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

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.

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.

GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata

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

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.

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.

GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata

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

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.

GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse

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

GoogleCloudDiscoveryengineV1alphaSafetyRating

Safety rating corresponding to the generated content.

GoogleCloudDiscoveryengineV1alphaSchema

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

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

GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec

The specification for query spell correction.

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.

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.

GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata

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

GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse

Response message for SiteSearchEngineService.SetUriPatternDocumentData method.

GoogleCloudDiscoveryengineV1alphaSingleRegionKey

Metadata for single-regional CMEKs.

GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo

Verification information for target sites in advanced site search.

GoogleCloudDiscoveryengineV1alphaSitemap

A sitemap for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1alphaTargetSite

A target site for the SiteSearchEngine.

GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason

Site search indexing failure reasons.

GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure

Failed due to insufficient quota.

GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata

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

GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse

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

GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata

Metadata associated with a tune operation.

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.

GoogleCloudDiscoveryengineV1alphaUserInfo

Information of an end user.

GoogleCloudDiscoveryengineV1alphaUserLicense

User License information assigned by the admin.

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

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

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

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

GoogleCloudDiscoveryengineV1betaInterval

A floating point interval.

GoogleCloudDiscoveryengineV1betaLanguageInfo

Language info for DataStore.

GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig

Configuration for Natural Language Query Understanding.

GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse

GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries

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

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

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.

GoogleTypeTimeZone

Represents a time zone from the IANA Time Zone Database.