Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.

AgentGatewaySetting.Types

Container for nested types declared in the AgentGatewaySetting message type.

AgentGatewaySetting.Types.AgentGatewayReference

Reference to an Agent Gateway resource.

AlertPolicyConfig.Types

Container for nested types declared in the AlertPolicyConfig message type.

AlertPolicyConfig.Types.AlertEnrollment

The alert enrollment status.

AlertPolicyConfig.Types.AlertEnrollment.Types

Container for nested types declared in the AlertEnrollment message type.

Answer.Types

Container for nested types declared in the Answer message type.

Answer.Types.GroundingSupport

Grounding support for a claim in answer_text.

Answer.Types.QueryUnderstandingInfo

Query understanding information.

Answer.Types.QueryUnderstandingInfo.Types

Container for nested types declared in the QueryUnderstandingInfo message type.

Answer.Types.QueryUnderstandingInfo.Types.QueryClassificationInfo

Query classification information.

Answer.Types.QueryUnderstandingInfo.Types.QueryClassificationInfo.Types

Container for nested types declared in the QueryClassificationInfo message type.

Answer.Types.Reference.Types

Container for nested types declared in the Reference message type.

Answer.Types.Reference.Types.ChunkInfo

Chunk information.

Answer.Types.Reference.Types.ChunkInfo.Types

Container for nested types declared in the ChunkInfo message type.

Answer.Types.Reference.Types.ChunkInfo.Types.DocumentMetadata

Document metadata.

Answer.Types.Reference.Types.StructuredDocumentInfo

Structured search information.

Answer.Types.Reference.Types.UnstructuredDocumentInfo

Unstructured document information.

Answer.Types.Reference.Types.UnstructuredDocumentInfo.Types

Container for nested types declared in the UnstructuredDocumentInfo message type.

Answer.Types.Reference.Types.UnstructuredDocumentInfo.Types.ChunkContent

Chunk content.

Answer.Types.Step.Types

Container for nested types declared in the Step message type.

Answer.Types.Step.Types.Action

Action.

Answer.Types.Step.Types.Action.Types

Container for nested types declared in the Action message type.

Answer.Types.Step.Types.Action.Types.Observation

Observation.

Answer.Types.Step.Types.Action.Types.Observation.Types

Container for nested types declared in the Observation message type.

Answer.Types.Step.Types.Action.Types.Observation.Types.SearchResult

Answer.Types.Step.Types.Action.Types.Observation.Types.SearchResult.Types

Container for nested types declared in the SearchResult message type.

Answer.Types.Step.Types.Action.Types.Observation.Types.SearchResult.Types.ChunkInfo

Chunk information.

Answer.Types.Step.Types.Action.Types.Observation.Types.SearchResult.Types.SnippetInfo

Snippet information.

Answer.Types.Step.Types.Action.Types.SearchAction

Search action.

AnswerGenerationSpec

The specification for answer generation.

AnswerGenerationSpec.Types

Container for nested types declared in the AnswerGenerationSpec message type.

AnswerGenerationSpec.Types.UserDefinedClassifierSpec

The specification for user defined classifier.

AnswerName

Resource name for the Answer resource.

AnswerQueryRequest

Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] method.

AnswerQueryRequest.Types

Container for nested types declared in the AnswerQueryRequest message type.

AnswerQueryRequest.Types.AnswerGenerationSpec

Answer generation specification.

AnswerQueryRequest.Types.AnswerGenerationSpec.Types

Container for nested types declared in the AnswerGenerationSpec message type.

AnswerQueryRequest.Types.AnswerGenerationSpec.Types.ModelSpec

Answer Generation Model specification.

AnswerQueryRequest.Types.AnswerGenerationSpec.Types.PromptSpec

Answer generation prompt specification.

AnswerQueryRequest.Types.EndUserSpec

End user specification.

AnswerQueryRequest.Types.EndUserSpec.Types

Container for nested types declared in the EndUserSpec message type.

AnswerQueryRequest.Types.EndUserSpec.Types.EndUserMetaData

End user metadata.

AnswerQueryRequest.Types.EndUserSpec.Types.EndUserMetaData.Types

Container for nested types declared in the EndUserMetaData message type.

AnswerQueryRequest.Types.EndUserSpec.Types.EndUserMetaData.Types.ChunkInfo

Chunk information.

AnswerQueryRequest.Types.EndUserSpec.Types.EndUserMetaData.Types.ChunkInfo.Types

Container for nested types declared in the ChunkInfo message type.

AnswerQueryRequest.Types.EndUserSpec.Types.EndUserMetaData.Types.ChunkInfo.Types.DocumentMetadata

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

AnswerQueryRequest.Types.GroundingSpec

Grounding specification.

AnswerQueryRequest.Types.GroundingSpec.Types

Container for nested types declared in the GroundingSpec message type.

AnswerQueryRequest.Types.QueryUnderstandingSpec

Query understanding specification.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types

Container for nested types declared in the QueryUnderstandingSpec message type.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types.QueryClassificationSpec

Query classification specification.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types.QueryClassificationSpec.Types

Container for nested types declared in the QueryClassificationSpec message type.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types.QueryRephraserSpec

Query rephraser specification.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types.QueryRephraserSpec.Types

Container for nested types declared in the QueryRephraserSpec message type.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types.QueryRephraserSpec.Types.ModelSpec

Query Rephraser Model specification.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types.QueryRephraserSpec.Types.ModelSpec.Types

Container for nested types declared in the ModelSpec message type.

AnswerQueryRequest.Types.RelatedQuestionsSpec

AnswerQueryRequest.Types.SafetySpec

Safety specification. There are two use cases:

when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories.
when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.

AnswerQueryRequest.Types.SafetySpec.Types

Container for nested types declared in the SafetySpec message type.

AnswerQueryRequest.Types.SafetySpec.Types.SafetySetting

Safety settings.

AnswerQueryRequest.Types.SafetySpec.Types.SafetySetting.Types

Container for nested types declared in the SafetySetting message type.

AnswerQueryRequest.Types.SearchSpec

Search specification.

AnswerQueryRequest.Types.SearchSpec.Types

Container for nested types declared in the SearchSpec message type.

AnswerQueryRequest.Types.SearchSpec.Types.SearchParams

Search parameters.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList

Search result list.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types

Container for nested types declared in the SearchResultList message type.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult

Search result.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types

Container for nested types declared in the SearchResult message type.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types.ChunkInfo

Chunk information.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types.ChunkInfo.Types

Container for nested types declared in the ChunkInfo message type.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types.ChunkInfo.Types.DocumentMetadata

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

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types.UnstructuredDocumentInfo

Unstructured document information.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types.UnstructuredDocumentInfo.Types

Container for nested types declared in the UnstructuredDocumentInfo message type.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types.UnstructuredDocumentInfo.Types.DocumentContext

Document context.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types.UnstructuredDocumentInfo.Types.ExtractiveAnswer

Extractive answer. Guide

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.Types.UnstructuredDocumentInfo.Types.ExtractiveSegment

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

AnswerQueryResponse

Response message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] method.

AssistAnswer

AssistAnswer resource, main part of [AssistResponse][google.cloud.discoveryengine.v1.AssistResponse].

AssistAnswer.Types

Container for nested types declared in the AssistAnswer message type.

AssistAnswer.Types.CustomerPolicyEnforcementResult

Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.

AssistAnswer.Types.CustomerPolicyEnforcementResult.Types

Container for nested types declared in the CustomerPolicyEnforcementResult message type.

AssistAnswer.Types.CustomerPolicyEnforcementResult.Types.BannedPhraseEnforcementResult

Customer policy enforcement result for the banned phrase policy.

AssistAnswer.Types.CustomerPolicyEnforcementResult.Types.ModelArmorEnforcementResult

Customer policy enforcement result for the Model Armor policy.

AssistAnswer.Types.CustomerPolicyEnforcementResult.Types.PolicyEnforcementResult

Customer policy enforcement result for a single policy type.

AssistAnswer.Types.Reply

One part of the multi-part response of the assist call.

AssistAnswerName

Resource name for the AssistAnswer resource.

Assistant.Types

Container for nested types declared in the Assistant message type.

Assistant.Types.CustomerPolicy

Customer-defined policy for the assistant.

Assistant.Types.CustomerPolicy.Types

Container for nested types declared in the CustomerPolicy message type.

Assistant.Types.CustomerPolicy.Types.BannedPhrase

Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.

Assistant.Types.CustomerPolicy.Types.BannedPhrase.Types

Container for nested types declared in the BannedPhrase message type.

Assistant.Types.CustomerPolicy.Types.ModelArmorConfig

Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.

Assistant.Types.CustomerPolicy.Types.ModelArmorConfig.Types

Container for nested types declared in the ModelArmorConfig message type.

Assistant.Types.GenerationConfig

Configuration for the generation of the assistant response.

Assistant.Types.GenerationConfig.Types

Container for nested types declared in the GenerationConfig message type.

Assistant.Types.GenerationConfig.Types.SystemInstruction

System instruction, also known as the prompt preamble for LLM calls.

AssistantContent.Types

Container for nested types declared in the AssistantContent message type.

AssistantContent.Types.CodeExecutionResult

Result of executing ExecutableCode.

AssistantContent.Types.CodeExecutionResult.Types

Container for nested types declared in the CodeExecutionResult message type.

AssistantContent.Types.ExecutableCode

Code generated by the model that is meant to be executed by the model.

AssistantGroundedContent

A piece of content and possibly its grounding information.

Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding.

AssistantGroundedContent.Types

Container for nested types declared in the AssistantGroundedContent message type.

AssistantGroundedContent.Types.TextGroundingMetadata

Grounding details for text sources.

AssistantGroundedContent.Types.TextGroundingMetadata.Types

Container for nested types declared in the TextGroundingMetadata message type.

AssistantGroundedContent.Types.TextGroundingMetadata.Types.Reference

Referenced content and related document metadata.

AssistantGroundedContent.Types.TextGroundingMetadata.Types.Reference.Types

Container for nested types declared in the Reference message type.

AssistantGroundedContent.Types.TextGroundingMetadata.Types.Reference.Types.DocumentMetadata

Document metadata.

AssistantGroundedContent.Types.TextGroundingMetadata.Types.Reference.Types.DocumentMetadata.Types

Container for nested types declared in the DocumentMetadata message type.

AssistantGroundedContent.Types.TextGroundingMetadata.Types.Segment

Grounding information for a segment of the text.

AssistantGroundedContent.Types.TextGroundingMetadata.Types.VisualSegment

Grounding information for a visual segment.

AssistantName

Resource name for the Assistant resource.

AssistantService

Service for managing Assistant configuration and assisting users.

AssistantService.AssistantServiceBase

Base class for server-side implementations of AssistantService

AssistantService.AssistantServiceClient

Client for AssistantService

AssistantServiceClient

AssistantService client wrapper, for convenient use.

AssistantServiceClient.StreamAssistStream

Server streaming methods for StreamAssist(StreamAssistRequest, CallSettings).

AssistantServiceClientBuilder

Builder class for AssistantServiceClient to provide simple configuration of credentials, endpoint etc.

AssistantServiceClientImpl

AssistantService client wrapper implementation, for convenient use.

AssistantServiceSettings

Settings for AssistantServiceClient instances.

BAPConfig

The configuration for the BAP connector.

BAPConfig.Types

Container for nested types declared in the BAPConfig message type.

BAPConfig.Types.ToolspecOverride

Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI.

Mirrors the shape of the backend google.cloud.connectorexecution.v1.ToolspecOverride message, but is intentionally kept as a separate public type so the Discovery Engine API surface can evolve independently of the fed-API surface (AIP-215). Handlers convert between the two via helpers in //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.

BatchCreateTargetSiteMetadata

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

BatchCreateTargetSitesRequest

Request message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] method.

BatchCreateTargetSitesResponse

Response message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] method.

BatchGetDocumentsMetadataRequest

Request message for [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] method.

BatchGetDocumentsMetadataRequest.Types

Container for nested types declared in the BatchGetDocumentsMetadataRequest message type.

BatchGetDocumentsMetadataRequest.Types.FhirMatcher

Matcher for the [Document][google.cloud.discoveryengine.v1.Document]s by FHIR resource names.

BatchGetDocumentsMetadataRequest.Types.Matcher

Matcher for the [Document][google.cloud.discoveryengine.v1.Document]s. Currently supports matching by exact URIs.

BatchGetDocumentsMetadataRequest.Types.UrisMatcher

Matcher for the [Document][google.cloud.discoveryengine.v1.Document]s by exact uris.

BatchGetDocumentsMetadataResponse

Response message for [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] method.

BatchGetDocumentsMetadataResponse.Types

Container for nested types declared in the BatchGetDocumentsMetadataResponse message type.

BatchGetDocumentsMetadataResponse.Types.DocumentMetadata

The metadata of a [Document][google.cloud.discoveryengine.v1.Document].

BatchGetDocumentsMetadataResponse.Types.DocumentMetadata.Types

Container for nested types declared in the DocumentMetadata message type.

BatchGetDocumentsMetadataResponse.Types.DocumentMetadata.Types.MatcherValue

The value of the matcher that was used to match the [Document][google.cloud.discoveryengine.v1.Document].

BatchUpdateUserLicensesMetadata

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

BatchUpdateUserLicensesRequest

Request message for [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] method.

BatchUpdateUserLicensesRequest.Types

Container for nested types declared in the BatchUpdateUserLicensesRequest message type.

BatchUpdateUserLicensesRequest.Types.InlineSource

The inline source for the input config for BatchUpdateUserLicenses method.

BatchUpdateUserLicensesResponse

Response message for [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] method.

BatchVerifyTargetSitesMetadata

Metadata related to the progress of the [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.

BatchVerifyTargetSitesRequest

Request message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] method.

BatchVerifyTargetSitesResponse

Response message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] method.

BigQuerySource

BigQuery source import data from.

BigtableOptions

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

BigtableOptions.Types

Container for nested types declared in the BigtableOptions message type.

BigtableOptions.Types.BigtableColumn

The column of the Bigtable.

BigtableOptions.Types.BigtableColumnFamily

The column family of the Bigtable.

BigtableSource

The Cloud Bigtable source for importing data.

BillingAccountLicenseConfigName

Resource name for the BillingAccountLicenseConfig resource.

BranchName

Resource name for the Branch resource.

CheckGroundingRequest

Request message for [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] method.

CheckGroundingResponse

Response message for the [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] method.

CheckGroundingResponse.Types

Container for nested types declared in the CheckGroundingResponse message type.

CheckGroundingResponse.Types.CheckGroundingFactChunk

Fact chunk for grounding check.

CheckGroundingResponse.Types.Claim

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

CheckGroundingSpec

Specification for the grounding check.

Chunk

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

Chunk.Types

Container for nested types declared in the Chunk message type.

Chunk.Types.AnnotationMetadata

The annotation metadata includes structured content in the current chunk.

Chunk.Types.ChunkMetadata

Metadata of the current chunk. This field is only populated on [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] API.

Chunk.Types.DocumentMetadata

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

Chunk.Types.PageSpan

Page span of the chunk.

Chunk.Types.StructuredContent

The structured content information.

ChunkName

Resource name for the Chunk resource.

Citation

Source attributions for content.

Citation.Types

Container for nested types declared in the Citation message type.

CitationMetadata

A collection of source attributions for a piece of content.

CliConfig

The configuration for the CLI execution based connectors.

CloudSqlSource

Cloud SQL source import data from.

CmekConfig

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

CmekConfig.Types

Container for nested types declared in the CmekConfig message type.

CmekConfigName

Resource name for the CmekConfig resource.

CmekConfigService

Service for managing CMEK related tasks

CmekConfigService.CmekConfigServiceBase

Base class for server-side implementations of CmekConfigService

CmekConfigService.CmekConfigServiceClient

Client for CmekConfigService

CmekConfigServiceClient

CmekConfigService client wrapper, for convenient use.

CmekConfigServiceClientBuilder

Builder class for CmekConfigServiceClient to provide simple configuration of credentials, endpoint etc.

CmekConfigServiceClientImpl

CmekConfigService client wrapper implementation, for convenient use.

CmekConfigServiceSettings

Settings for CmekConfigServiceClient instances.

CollectUserEventRequest

Request message for CollectUserEvent method.

Collection

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

CollectionName

Resource name for the Collection resource.

CollectionService

Service for managing [Collection][google.cloud.discoveryengine.v1.Collection]s.

CollectionService.CollectionServiceBase

Base class for server-side implementations of CollectionService

CollectionService.CollectionServiceClient

Client for CollectionService

CollectionServiceClient

CollectionService client wrapper, for convenient use.

CollectionServiceClientBuilder

Builder class for CollectionServiceClient to provide simple configuration of credentials, endpoint etc.

CollectionServiceClientImpl

CollectionService client wrapper implementation, for convenient use.

CollectionServiceSettings

Settings for CollectionServiceClient instances.

CompleteQueryRequest

Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] method.

CompleteQueryResponse

Response message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] method.

CompleteQueryResponse.Types

Container for nested types declared in the CompleteQueryResponse message type.

CompleteQueryResponse.Types.QuerySuggestion

Suggestions as search queries.

CompletionConfigName

Resource name for the CompletionConfig resource.

CompletionInfo

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

CompletionService

Service for Auto-Completion.

CompletionService.CompletionServiceBase

Base class for server-side implementations of CompletionService

CompletionService.CompletionServiceClient

Client for CompletionService

CompletionServiceClient

CompletionService client wrapper, for convenient use.

CompletionServiceClientBuilder

Builder class for CompletionServiceClient to provide simple configuration of credentials, endpoint etc.

CompletionServiceClientImpl

CompletionService client wrapper implementation, for convenient use.

CompletionServiceSettings

Settings for CompletionServiceClient instances.

CompletionSuggestion

Autocomplete suggestions that are imported from Customer.

Condition

Defines circumstances to be checked before allowing a behavior

Condition.Types

Container for nested types declared in the Condition message type.

Condition.Types.QueryTerm

Matcher for search request query

Condition.Types.TimeRange

Used for time-dependent conditions.

ContentPolicyName

Resource name for the ContentPolicy resource.

Control

Defines a conditioned behavior to employ during serving. Must be attached to a [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to be considered at serving time. Permitted actions dependent on SolutionType.

Control.Types

Container for nested types declared in the Control message type.

Control.Types.BoostAction

Adjusts order of products in returned list.

Control.Types.BoostAction.Types

Container for nested types declared in the BoostAction message type.

Control.Types.BoostAction.Types.InterpolationBoostSpec

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

Control.Types.BoostAction.Types.InterpolationBoostSpec.Types

Container for nested types declared in the InterpolationBoostSpec message type.

Control.Types.BoostAction.Types.InterpolationBoostSpec.Types.ControlPoint

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

Control.Types.FilterAction

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

Control.Types.PromoteAction

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.

Control.Types.RedirectAction

Redirects a shopper to the provided URI.

Control.Types.SynonymsAction

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

ControlName

Resource name for the Control resource.

ControlService

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

ControlService.ControlServiceBase

Base class for server-side implementations of ControlService

ControlService.ControlServiceClient

Client for ControlService

ControlServiceClient

ControlService client wrapper, for convenient use.

ControlServiceClientBuilder

Builder class for ControlServiceClient to provide simple configuration of credentials, endpoint etc.

ControlServiceClientImpl

ControlService client wrapper implementation, for convenient use.

ControlServiceSettings

Settings for ControlServiceClient instances.

Conversation

External conversation proto definition.

Conversation.Types

Container for nested types declared in the Conversation message type.

ConversationContext

Defines context of the conversation

ConversationMessage

Defines a conversation message.

ConversationName

Resource name for the Conversation resource.

ConversationalSearchService

Service for conversational search.

ConversationalSearchService.ConversationalSearchServiceBase

Base class for server-side implementations of ConversationalSearchService

ConversationalSearchService.ConversationalSearchServiceClient

Client for ConversationalSearchService

ConversationalSearchServiceClient

ConversationalSearchService client wrapper, for convenient use.

ConversationalSearchServiceClient.StreamAnswerQueryStream

Server streaming methods for StreamAnswerQuery(AnswerQueryRequest, CallSettings).

ConversationalSearchServiceClientBuilder

Builder class for ConversationalSearchServiceClient to provide simple configuration of credentials, endpoint etc.

ConversationalSearchServiceClientImpl

ConversationalSearchService client wrapper implementation, for convenient use.

ConversationalSearchServiceSettings

Settings for ConversationalSearchServiceClient instances.

ConverseConversationRequest

Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] method.

ConverseConversationResponse

Response message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] method.

CreateAssistantRequest

Request for the [AssistantService.CreateAssistant][google.cloud.discoveryengine.v1.AssistantService.CreateAssistant] method.

CreateControlRequest

Request for CreateControl method.

CreateConversationRequest

Request for CreateConversation method.

CreateDataStoreMetadata

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

CreateDataStoreRequest

Request for [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] method.

CreateDocumentRequest

Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1.DocumentService.CreateDocument] method.

CreateEngineMetadata

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

CreateEngineRequest

Request for [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] method.

CreateIdentityMappingStoreRequest

Request message for [IdentityMappingStoreService.CreateIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.CreateIdentityMappingStore]

CreateLicenseConfigRequest

Request message for [LicenseConfigService.CreateLicenseConfig][google.cloud.discoveryengine.v1.LicenseConfigService.CreateLicenseConfig] method.

CreateSchemaMetadata

Metadata for Create Schema LRO.

CreateSchemaRequest

Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1.SchemaService.CreateSchema] method.

CreateServingConfigRequest

Request for CreateServingConfig method.

CreateSessionRequest

Request for CreateSession method.

CreateSitemapMetadata

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

CreateSitemapRequest

Request message for [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap] method.

CreateTargetSiteMetadata

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

CreateTargetSiteRequest

Request message for [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSite] method.

CryptoKeyVersionsName

Resource name for the CryptoKeyVersions resource.

CryptoKeysName

Resource name for the CryptoKeys resource.

CustomAttribute

A custom attribute that is not explicitly modeled in a resource, e.g. [UserEvent][google.cloud.discoveryengine.v1.UserEvent].

CustomTuningModel

Metadata that describes a custom tuned model.

CustomTuningModel.Types

Container for nested types declared in the CustomTuningModel message type.

CustomTuningModelName

Resource name for the CustomTuningModel resource.

DataConnector

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

DataConnector.Types

Container for nested types declared in the DataConnector message type.

DataConnector.Types.ConnectorMetadata

User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).

DataConnector.Types.EndUserConfig

Any params and credentials used specifically for EUA connectors.

DataConnector.Types.FederatedConfig

Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.

DataConnector.Types.RealtimeSyncConfig

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

DataConnector.Types.RealtimeSyncConfig.Types

Container for nested types declared in the RealtimeSyncConfig message type.

DataConnector.Types.RealtimeSyncConfig.Types.StreamingError

Streaming error details.

DataConnector.Types.RealtimeSyncConfig.Types.StreamingError.Types

Container for nested types declared in the StreamingError message type.

DataConnector.Types.SourceEntity

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

DataConnectorName

Resource name for the DataConnector resource.

DataConnectorService

Service for data connector management.

DataConnectorService.DataConnectorServiceBase

Base class for server-side implementations of DataConnectorService

DataConnectorService.DataConnectorServiceClient

Client for DataConnectorService

DataConnectorServiceClient

DataConnectorService client wrapper, for convenient use.

DataConnectorServiceClientBuilder

Builder class for DataConnectorServiceClient to provide simple configuration of credentials, endpoint etc.

DataConnectorServiceClientImpl

DataConnectorService client wrapper implementation, for convenient use.

DataConnectorServiceSettings

Settings for DataConnectorServiceClient instances.

DataProtectionPolicy

Contains the data protection policy config for a DataStore or a connector.

DataProtectionPolicy.Types

Container for nested types declared in the DataProtectionPolicy message type.

DataProtectionPolicy.Types.SensitiveDataProtectionPolicy

Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.

DataStore

DataStore captures global settings and configs at the DataStore level.

DataStore.Types

Container for nested types declared in the DataStore message type.

DataStore.Types.BillingEstimation

Estimation of data size per data store.

DataStore.Types.FederatedSearchConfig

Stores information for federated search.

DataStore.Types.FederatedSearchConfig.Types

Container for nested types declared in the FederatedSearchConfig message type.

DataStore.Types.FederatedSearchConfig.Types.AlloyDbConfig

Stores information for connecting to AlloyDB.

DataStore.Types.FederatedSearchConfig.Types.AlloyDbConfig.Types

Container for nested types declared in the AlloyDbConfig message type.

DataStore.Types.FederatedSearchConfig.Types.AlloyDbConfig.Types.AlloyDbAiNaturalLanguageConfig

Configuration for AlloyDB AI Natural Language.

DataStore.Types.FederatedSearchConfig.Types.AlloyDbConfig.Types.AlloyDbConnectionConfig

Configuration for connecting to AlloyDB.

DataStore.Types.FederatedSearchConfig.Types.AlloyDbConfig.Types.AlloyDbConnectionConfig.Types

Container for nested types declared in the AlloyDbConnectionConfig message type.

DataStore.Types.FederatedSearchConfig.Types.NotebooklmConfig

Config for connecting to NotebookLM Enterprise.

DataStore.Types.FederatedSearchConfig.Types.ThirdPartyOauthConfig

Stores information for third party applicationOAuth.

DataStore.Types.ServingConfigDataStore

Stores information regarding the serving configurations at DataStore level.

DataStoreName

Resource name for the DataStore resource.

DataStoreService

Service for managing [DataStore][google.cloud.discoveryengine.v1.DataStore] configuration.

DataStoreService.DataStoreServiceBase

Base class for server-side implementations of DataStoreService

DataStoreService.DataStoreServiceClient

Client for DataStoreService

DataStoreServiceClient

DataStoreService client wrapper, for convenient use.

DataStoreServiceClientBuilder

Builder class for DataStoreServiceClient to provide simple configuration of credentials, endpoint etc.

DataStoreServiceClientImpl

DataStoreService client wrapper implementation, for convenient use.

DataStoreServiceSettings

Settings for DataStoreServiceClient instances.

DeleteAssistantRequest

Request message for the [AssistantService.DeleteAssistant][google.cloud.discoveryengine.v1.AssistantService.DeleteAssistant] method.

DeleteCmekConfigMetadata

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

DeleteCmekConfigRequest

Request message for [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig] method.

DeleteCollectionMetadata

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

DeleteCollectionRequest

Request message for [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

DeleteControlRequest

Request for DeleteControl method.

DeleteConversationRequest

Request for DeleteConversation method.

DeleteDataStoreMetadata

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

DeleteDataStoreRequest

Request message for [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] method.

DeleteDocumentRequest

Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1.DocumentService.DeleteDocument] method.

DeleteEngineMetadata

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

DeleteEngineRequest

Request message for [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] method.

DeleteIdentityMappingStoreMetadata

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

DeleteIdentityMappingStoreRequest

Request message for [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore]

DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

DeleteSchemaRequest

Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1.SchemaService.DeleteSchema] method.

DeleteServingConfigRequest

Request for DeleteServingConfig method.

DeleteSessionRequest

Request for DeleteSession method.

DeleteSitemapMetadata

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

DeleteSitemapRequest

Request message for [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap] method.

DeleteTargetSiteMetadata

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

DeleteTargetSiteRequest

Request message for [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSite] method.

DestinationConfig

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

DestinationConfig.Types

Container for nested types declared in the DestinationConfig message type.

DestinationConfig.Types.Destination

Defines a target endpoint

DisableAdvancedSiteSearchMetadata

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

DisableAdvancedSiteSearchRequest

Request message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] method.

DisableAdvancedSiteSearchResponse

Response message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] method.

DistributeLicenseConfigRequest

Request message for [LicenseConfigService.DistributeLicenseConfig][google.cloud.discoveryengine.v1.LicenseConfigService.DistributeLicenseConfig] method.

DistributeLicenseConfigResponse

Response message for [LicenseConfigService.DistributeLicenseConfig][google.cloud.discoveryengine.v1.LicenseConfigService.DistributeLicenseConfig] method.

Document

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

Document.Types

Container for nested types declared in the Document message type.

Document.Types.AclInfo

ACL Information of the Document.

Document.Types.AclInfo.Types

Container for nested types declared in the AclInfo message type.

Document.Types.AclInfo.Types.AccessRestriction

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

Document.Types.Content

Unstructured data linked to this document.

Document.Types.IndexStatus

Index status of the document.

DocumentInfo

Detailed document information associated with a user event.

DocumentName

Resource name for the Document resource.

DocumentProcessingConfig

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

DocumentProcessingConfig.Types

Container for nested types declared in the DocumentProcessingConfig message type.

DocumentProcessingConfig.Types.ChunkingConfig

Configuration for chunking config.

DocumentProcessingConfig.Types.ChunkingConfig.Types

Container for nested types declared in the ChunkingConfig message type.

DocumentProcessingConfig.Types.ChunkingConfig.Types.LayoutBasedChunkingConfig

Configuration for the layout based chunking.

DocumentProcessingConfig.Types.ParsingConfig

Related configurations applied to a specific type of document parser.

DocumentProcessingConfig.Types.ParsingConfig.Types

Container for nested types declared in the ParsingConfig message type.

DocumentProcessingConfig.Types.ParsingConfig.Types.DigitalParsingConfig

The digital parsing configurations for documents.

DocumentProcessingConfig.Types.ParsingConfig.Types.LayoutParsingConfig

The layout parsing configurations for documents.

DocumentProcessingConfig.Types.ParsingConfig.Types.OcrParsingConfig

The OCR parsing configurations for documents.

DocumentProcessingConfigName

Resource name for the DocumentProcessingConfig resource.

DocumentService

Service for ingesting [Document][google.cloud.discoveryengine.v1.Document] information of the customer's website.

DocumentService.DocumentServiceBase

Base class for server-side implementations of DocumentService

DocumentService.DocumentServiceClient

Client for DocumentService

DocumentServiceClient

DocumentService client wrapper, for convenient use.

DocumentServiceClientBuilder

Builder class for DocumentServiceClient to provide simple configuration of credentials, endpoint etc.

DocumentServiceClientImpl

DocumentService client wrapper implementation, for convenient use.

DocumentServiceSettings

Settings for DocumentServiceClient instances.

DoubleList

Double list.

DynamicTool

Configuration for dynamic tools.

EnableAdvancedSiteSearchMetadata

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

EnableAdvancedSiteSearchRequest

Request message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] method.

EnableAdvancedSiteSearchResponse

Response message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] method.

Engine

Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1.Engine].

Engine.Types

Container for nested types declared in the Engine message type.

Engine.Types.ChatEngineConfig

Configurations for a Chat Engine.

Engine.Types.ChatEngineConfig.Types

Container for nested types declared in the ChatEngineConfig message type.

Engine.Types.ChatEngineConfig.Types.AgentCreationConfig

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][google.cloud.discoveryengine.v1.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] API after engine creation.

Engine.Types.ChatEngineMetadata

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

Engine.Types.CommonConfig

Common configurations for an Engine.

Engine.Types.KnowledgeGraphConfig

Configuration message for the Knowledge Graph.

Engine.Types.KnowledgeGraphConfig.Types

Container for nested types declared in the KnowledgeGraphConfig message type.

Engine.Types.KnowledgeGraphConfig.Types.FeatureConfig

Feature config for the Knowledge Graph.

Engine.Types.MediaRecommendationEngineConfig

Additional config specs for a Media Recommendation engine.

Engine.Types.MediaRecommendationEngineConfig.Types

Container for nested types declared in the MediaRecommendationEngineConfig message type.

Engine.Types.MediaRecommendationEngineConfig.Types.EngineFeaturesConfig

More feature configs of the selected engine type.

Engine.Types.MediaRecommendationEngineConfig.Types.MostPopularFeatureConfig

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

Engine.Types.MediaRecommendationEngineConfig.Types.OptimizationObjectiveConfig

Custom threshold for cvr optimization_objective.

Engine.Types.MediaRecommendationEngineConfig.Types.RecommendedForYouFeatureConfig

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

Engine.Types.SearchEngineConfig

Configurations for a Search Engine.

EngineName

Resource name for the Engine resource.

EngineService

Service for managing [Engine][google.cloud.discoveryengine.v1.Engine] configuration.

EngineService.EngineServiceBase

Base class for server-side implementations of EngineService

EngineService.EngineServiceClient

Client for EngineService

EngineServiceClient

EngineService client wrapper, for convenient use.

EngineServiceClientBuilder

Builder class for EngineServiceClient to provide simple configuration of credentials, endpoint etc.

EngineServiceClientImpl

EngineService client wrapper implementation, for convenient use.

EngineServiceSettings

Settings for EngineServiceClient instances.

FactChunk

Fact Chunk.

Feedback

Information about the user feedback. This information will be used for logging and metrics purpose.

Feedback.Types

Container for nested types declared in the Feedback message type.

Feedback.Types.ConversationInfo

The conversation information such as the question index and session name.

FetchDomainVerificationStatusRequest

Request message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] method.

FetchDomainVerificationStatusResponse

Response message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] method.

FetchSitemapsRequest

Request message for [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] method.

FetchSitemapsRequest.Types

Container for nested types declared in the FetchSitemapsRequest message type.

FetchSitemapsRequest.Types.Matcher

Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s. Currently only supports uris matcher.

FetchSitemapsRequest.Types.UrisMatcher

Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s by their uris.

FetchSitemapsResponse

Response message for [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] method.

FetchSitemapsResponse.Types

Container for nested types declared in the FetchSitemapsResponse message type.

FetchSitemapsResponse.Types.SitemapMetadata

Contains a [Sitemap][google.cloud.discoveryengine.v1.Sitemap] and its metadata.

FhirResourceName

Resource name for the FhirResource resource.

FhirStoreName

Resource name for the FhirStore resource.

FhirStoreSource

Cloud FhirStore source import data from.

FirestoreSource

Firestore source import data from.

GcsSource

Cloud Storage location for input content.

GenerateGroundedContentRequest

Top-level message sent by the client for the GenerateGroundedContent method.

GenerateGroundedContentRequest.Types

Container for nested types declared in the GenerateGroundedContentRequest message type.

GenerateGroundedContentRequest.Types.DynamicRetrievalConfiguration

Describes the options to customize dynamic retrieval.

GenerateGroundedContentRequest.Types.DynamicRetrievalConfiguration.Types

Container for nested types declared in the DynamicRetrievalConfiguration message type.

GenerateGroundedContentRequest.Types.DynamicRetrievalConfiguration.Types.DynamicRetrievalPredictor

Describes the predictor settings for dynamic retrieval.

GenerateGroundedContentRequest.Types.DynamicRetrievalConfiguration.Types.DynamicRetrievalPredictor.Types

Container for nested types declared in the DynamicRetrievalPredictor message type.

GenerateGroundedContentRequest.Types.GenerationSpec

Content generation specification.

GenerateGroundedContentRequest.Types.GenerationSpec.Types

Container for nested types declared in the GenerationSpec message type.

GenerateGroundedContentRequest.Types.GroundingSource

Grounding source.

GenerateGroundedContentRequest.Types.GroundingSource.Types

Container for nested types declared in the GroundingSource message type.

GenerateGroundedContentRequest.Types.GroundingSource.Types.EnterpriseWebRetrievalSource

Params for using enterprise web retrieval as grounding source.

GenerateGroundedContentRequest.Types.GroundingSource.Types.GoogleSearchSource

Google Search config parameters.

GenerateGroundedContentRequest.Types.GroundingSource.Types.InlineSource

Message to be used for grounding based on inline content.

GenerateGroundedContentRequest.Types.GroundingSource.Types.SearchSource

Message to be used for grounding with Vertex AI Search.

GenerateGroundedContentRequest.Types.GroundingSpec

Grounding specification.

GenerateGroundedContentResponse

Response for the GenerateGroundedContent method.

GenerateGroundedContentResponse.Types

Container for nested types declared in the GenerateGroundedContentResponse message type.

GenerateGroundedContentResponse.Types.Candidate

A response candidate generated from the model.

GenerateGroundedContentResponse.Types.Candidate.Types

Container for nested types declared in the Candidate message type.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata

Citation for the generated content.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types

Container for nested types declared in the GroundingMetadata message type.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.DynamicRetrievalMetadata

Describes the metadata about dynamic retrieval.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.DynamicRetrievalPredictorMetadata

Describes the metadata about the dynamic retrieval predictor.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.DynamicRetrievalPredictorMetadata.Types

Container for nested types declared in the DynamicRetrievalPredictorMetadata message type.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.GroundingSupport

Grounding info for a claim in the candidate and its support.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.ImageMetadata

Metadata about an image from the web search.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.ImageMetadata.Types

Container for nested types declared in the ImageMetadata message type.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.ImageMetadata.Types.Image

Metadata about the image.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.ImageMetadata.Types.WebsiteInfo

Metadata about the website that the image is from.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.RetrievalMetadata

Describes the metadata associated with a retrieval step.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.RetrievalMetadata.Types

Container for nested types declared in the RetrievalMetadata message type.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.SearchEntryPoint

Google search entry point.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.VideoMetadata

Metadata about a video from the web search.

GetAclConfigRequest

Request message for GetAclConfigRequest method.

GetAnswerRequest

Request for GetAnswer method.

GetAssistantRequest

Request message for the [AssistantService.GetAssistant][google.cloud.discoveryengine.v1.AssistantService.GetAssistant] method.

GetCmekConfigRequest

Request message for GetCmekConfigRequest method.

GetControlRequest

Request for GetControl method.

GetConversationRequest

Request for GetConversation method.

GetDataConnectorRequest

Request for [DataConnectorService.GetDataConnector][google.cloud.discoveryengine.v1.DataConnectorService.GetDataConnector] method.

GetDataStoreRequest

Request message for [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1.DataStoreService.GetDataStore] method.

GetDocumentRequest

Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] method.

GetEngineRequest

Request message for [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] method.

GetIdentityMappingStoreRequest

Request message for [IdentityMappingStoreService.GetIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.GetIdentityMappingStore]

GetLicenseConfigRequest

Request message for [LicenseConfigService.GetLicenseConfig][google.cloud.discoveryengine.v1.LicenseConfigService.GetLicenseConfig] method.

GetSchemaRequest

Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] method.

GetServingConfigRequest

Request for GetServingConfig method.

GetSessionRequest

Request for GetSession method.

GetSiteSearchEngineRequest

Request message for [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetSiteSearchEngine] method.

GetTargetSiteRequest

Request message for [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetTargetSite] method.

GetUserStoreRequest

Request message for [UserStoreService.GetUserStore][google.cloud.discoveryengine.v1.UserStoreService.GetUserStore]

GetWidgetConfigRequest

Request for [WidgetConfigService.GetWidgetConfig][google.cloud.discoveryengine.v1.WidgetConfigService.GetWidgetConfig] method.

GetWidgetConfigRequest.Types

Container for nested types declared in the GetWidgetConfigRequest message type.

GetWidgetConfigRequest.Types.GetWidgetConfigRequestOption

Options for GetWidgetConfigRequest.

GroundedGenerationContent

Base structured datatype containing multi-part content of a message.

GroundedGenerationContent.Types

Container for nested types declared in the GroundedGenerationContent message type.

GroundedGenerationContent.Types.Part

Single part of content.

GroundedGenerationService

Service for grounded generation.

GroundedGenerationService.GroundedGenerationServiceBase

Base class for server-side implementations of GroundedGenerationService

GroundedGenerationService.GroundedGenerationServiceClient

Client for GroundedGenerationService

GroundedGenerationServiceClient

GroundedGenerationService client wrapper, for convenient use.

GroundedGenerationServiceClient.StreamGenerateGroundedContentStream

Bidirectional streaming methods for StreamGenerateGroundedContent(CallSettings, BidirectionalStreamingSettings).

GroundedGenerationServiceClientBuilder

Builder class for GroundedGenerationServiceClient to provide simple configuration of credentials, endpoint etc.

GroundedGenerationServiceClientImpl

GroundedGenerationService client wrapper implementation, for convenient use.

GroundedGenerationServiceSettings

Settings for GroundedGenerationServiceClient instances.

GroundingConfigName

Resource name for the GroundingConfig resource.

GroundingFact

Grounding Fact.

HealthcareFhirConfig

Config to data store for HEALTHCARE_FHIR vertical.

IdentityMappingEntry

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

IdentityMappingEntryOperationMetadata

IdentityMappingEntry LongRunningOperation metadata for [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] and [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings]

IdentityMappingStore

Identity Mapping Store which contains Identity Mapping Entries.

IdentityMappingStoreName

Resource name for the IdentityMappingStore resource.

IdentityMappingStoreService

Service for managing Identity Mapping Stores.

IdentityMappingStoreService.IdentityMappingStoreServiceBase

Base class for server-side implementations of IdentityMappingStoreService

IdentityMappingStoreService.IdentityMappingStoreServiceClient

Client for IdentityMappingStoreService

IdentityMappingStoreServiceClient

IdentityMappingStoreService client wrapper, for convenient use.

IdentityMappingStoreServiceClientBuilder

Builder class for IdentityMappingStoreServiceClient to provide simple configuration of credentials, endpoint etc.

IdentityMappingStoreServiceClientImpl

IdentityMappingStoreService client wrapper implementation, for convenient use.

IdentityMappingStoreServiceSettings

Settings for IdentityMappingStoreServiceClient instances.

IdentityScheduleConfig

The configuration for the identity data synchronization runs.

IdpConfig

Identity Provider Config.

IdpConfig.Types

Container for nested types declared in the IdpConfig message type.

IdpConfig.Types.ExternalIdpConfig

Third party IDP Config.

ImportCompletionSuggestionsMetadata

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

ImportCompletionSuggestionsRequest

Request message for [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] method.

ImportCompletionSuggestionsRequest.Types

Container for nested types declared in the ImportCompletionSuggestionsRequest message type.

ImportCompletionSuggestionsRequest.Types.InlineSource

The inline source for CompletionSuggestions.

ImportCompletionSuggestionsResponse

Response of the [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.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.

ImportDocumentsMetadata

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

ImportDocumentsRequest

Request message for Import methods.

ImportDocumentsRequest.Types

Container for nested types declared in the ImportDocumentsRequest message type.

ImportDocumentsRequest.Types.InlineSource

The inline source for the input config for ImportDocuments method.

ImportDocumentsResponse

Response of the [ImportDocumentsRequest][google.cloud.discoveryengine.v1.ImportDocumentsRequest]. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

ImportErrorConfig

Configuration of destination for Import related errors.

ImportIdentityMappingsRequest

Request message for [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings]

ImportIdentityMappingsRequest.Types

Container for nested types declared in the ImportIdentityMappingsRequest message type.

ImportIdentityMappingsRequest.Types.InlineSource

The inline source to import identity mapping entries from.

ImportIdentityMappingsResponse

Response message for [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings]

ImportSuggestionDenyListEntriesMetadata

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

ImportSuggestionDenyListEntriesRequest

Request message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] method.

ImportSuggestionDenyListEntriesRequest.Types

Container for nested types declared in the ImportSuggestionDenyListEntriesRequest message type.

ImportSuggestionDenyListEntriesRequest.Types.InlineSource

The inline source for SuggestionDenyListEntry.

ImportSuggestionDenyListEntriesResponse

Response message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] method.

ImportUserEventsMetadata

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

ImportUserEventsRequest

Request message for the ImportUserEvents request.

ImportUserEventsRequest.Types

Container for nested types declared in the ImportUserEventsRequest message type.

ImportUserEventsRequest.Types.InlineSource

The inline source for the input config for ImportUserEvents method.

ImportUserEventsResponse

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

Interval

A floating point interval.

LicenseConfig

Information about users' licenses.

LicenseConfig.Types

Container for nested types declared in the LicenseConfig message type.

LicenseConfigName

Resource name for the LicenseConfig resource.

LicenseConfigService

Service for managing license config related resources.

LicenseConfigService.LicenseConfigServiceBase

Base class for server-side implementations of LicenseConfigService

LicenseConfigService.LicenseConfigServiceClient

Client for LicenseConfigService

LicenseConfigServiceClient

LicenseConfigService client wrapper, for convenient use.

LicenseConfigServiceClientBuilder

Builder class for LicenseConfigServiceClient to provide simple configuration of credentials, endpoint etc.

LicenseConfigServiceClientImpl

LicenseConfigService client wrapper implementation, for convenient use.

LicenseConfigServiceSettings

Settings for LicenseConfigServiceClient instances.

LicenseConfigUsageStats

Stats about users' licenses.

ListAssistantsRequest

Request message for the [AssistantService.ListAssistants][google.cloud.discoveryengine.v1.AssistantService.ListAssistants] method.

ListAssistantsResponse

Response message for the [AssistantService.ListAssistants][google.cloud.discoveryengine.v1.AssistantService.ListAssistants] method.

ListCmekConfigsRequest

Request message for [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] method.

ListCmekConfigsResponse

Response message for [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] method.

ListControlsRequest

Request for ListControls method.

ListControlsResponse

Response for ListControls method.

ListConversationsRequest

Request for ListConversations method.

ListConversationsResponse

Response for ListConversations method.

ListCustomModelsRequest

Request message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] method.

ListCustomModelsResponse

Response message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] method.

ListDataStoresRequest

Request message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] method.

ListDataStoresResponse

Response message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] method.

ListDocumentsRequest

Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] method.

ListDocumentsResponse

Response message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] method.

ListEnginesRequest

Request message for [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] method.

ListEnginesResponse

Response message for [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] method.

ListIdentityMappingStoresRequest

Request message for [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores]

ListIdentityMappingStoresResponse

Response message for [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores]

ListIdentityMappingsRequest

Request message for [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings]

ListIdentityMappingsResponse

Response message for [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings]

ListLicenseConfigsRequest

Request message for [LicenseConfigService.ListLicenseConfigs][google.cloud.discoveryengine.v1.LicenseConfigService.ListLicenseConfigs] method.

ListLicenseConfigsResponse

Response message for [LicenseConfigService.ListLicenseConfigs][google.cloud.discoveryengine.v1.LicenseConfigService.ListLicenseConfigs] method.

ListLicenseConfigsUsageStatsRequest

Request message for [UserLicenseService.ListLicenseConfigsUsageStats][google.cloud.discoveryengine.v1.UserLicenseService.ListLicenseConfigsUsageStats] method.

ListLicenseConfigsUsageStatsResponse

Response message for [UserLicenseService.ListLicenseConfigsUsageStats][google.cloud.discoveryengine.v1.UserLicenseService.ListLicenseConfigsUsageStats] method.

ListSchemasRequest

Request message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] method.

ListSchemasResponse

Response message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] method.

ListServingConfigsRequest

Request for ListServingConfigs method.

ListServingConfigsResponse

Response for ListServingConfigs method.

ListSessionsRequest

Request for ListSessions method.

ListSessionsResponse

Response for ListSessions method.

ListTargetSitesRequest

Request message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] method.

ListTargetSitesResponse

Response message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] method.

ListUserLicensesRequest

Request message for [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses].

ListUserLicensesResponse

Response message for [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses].

LocationName

Resource name for the Location resource.

MediaInfo

Media-specific user event information.

NaturalLanguageQueryUnderstandingConfig

Configuration for Natural Language Query Understanding.

NaturalLanguageQueryUnderstandingConfig.Types

Container for nested types declared in the NaturalLanguageQueryUnderstandingConfig message type.

NotebookName

Resource name for the Notebook resource.

ObservabilityConfig

Observability config for a resource.

PageInfo

Detailed page information.

PanelInfo

Detailed panel information associated with a user event.

Principal

Principal identifier of a user or a group.

Project

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

Project.Types

Container for nested types declared in the Project message type.

Project.Types.ConfigurableBillingStatus

Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in customer_provided_config due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.

Project.Types.ConfigurableBillingStatus.Types

Container for nested types declared in the ConfigurableBillingStatus message type.

Project.Types.ConfigurableBillingStatus.Types.AgentSearchTokenSubscriptionStatus

Per-model Agent Search TPM subscription status. One entry per active core_subscription.agent_search_token_subscriptions[*] entry in the customer-provided config; populated by UpdateProject and GetProject.

The lifecycle scalars on this message (start_time, terminate_time, update_type, tpm_threshold_next_update_time) are per (project, model_version) — siblings of the whole-relationship start_time / terminate_time / update_type on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.

Project.Types.CustomerProvidedConfig

Customer provided configurations.

Project.Types.CustomerProvidedConfig.Types

Container for nested types declared in the CustomerProvidedConfig message type.

Project.Types.CustomerProvidedConfig.Types.NotebooklmConfig

Configuration for NotebookLM.

Project.Types.CustomerProvidedConfig.Types.NotebooklmConfig.Types

Container for nested types declared in the NotebooklmConfig message type.

Project.Types.CustomerProvidedConfig.Types.NotebooklmConfig.Types.DataProtectionPolicy

Data protection policy config for NotebookLM.

Project.Types.CustomerProvidedConfig.Types.NotebooklmConfig.Types.DataProtectionPolicy.Types

Container for nested types declared in the DataProtectionPolicy message type.

Project.Types.CustomerProvidedConfig.Types.NotebooklmConfig.Types.DataProtectionPolicy.Types.SensitiveDataProtectionPolicy

Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.

Project.Types.CustomerProvidedConfig.Types.NotebooklmConfig.Types.ModelArmorConfig

Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.

Project.Types.CustomerProvidedConfig.Types.ResourceAccessControlConfig

Controls resource-level access control for Gemini Enterprise users.

Project.Types.ServiceTerms

Metadata about the terms of service.

Project.Types.ServiceTerms.Types

Container for nested types declared in the ServiceTerms message type.

ProjectName

Resource name for the Project resource.

ProjectService

Service for operations on the [Project][google.cloud.discoveryengine.v1.Project].

ProjectService.ProjectServiceBase

Base class for server-side implementations of ProjectService

ProjectService.ProjectServiceClient

Client for ProjectService

ProjectServiceClient

ProjectService client wrapper, for convenient use.

ProjectServiceClientBuilder

Builder class for ProjectServiceClient to provide simple configuration of credentials, endpoint etc.

ProjectServiceClientImpl

ProjectService client wrapper implementation, for convenient use.

ProjectServiceSettings

Settings for ProjectServiceClient instances.

ProvisionProjectMetadata

Metadata associated with a project provision operation.

ProvisionProjectRequest

Request for [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1.ProjectService.ProvisionProject] method.

ProvisionProjectRequest.Types

Container for nested types declared in the ProvisionProjectRequest message type.

ProvisionProjectRequest.Types.SaasParams

Parameters for Agentspace.

PurgeCompletionSuggestionsMetadata

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

PurgeCompletionSuggestionsRequest

Request message for [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] method.

PurgeCompletionSuggestionsResponse

Response message for [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

PurgeDocumentsMetadata

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

PurgeDocumentsRequest

Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] method.

PurgeDocumentsRequest.Types

Container for nested types declared in the PurgeDocumentsRequest message type.

PurgeDocumentsRequest.Types.InlineSource

The inline source for the input config for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] method.

PurgeDocumentsResponse

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

PurgeErrorConfig

Configuration of destination for Purge related errors.

PurgeIdentityMappingsRequest

Request message for [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings]

PurgeIdentityMappingsRequest.Types

Container for nested types declared in the PurgeIdentityMappingsRequest message type.

PurgeIdentityMappingsRequest.Types.InlineSource

The inline source to purge identity mapping entries from.

PurgeSuggestionDenyListEntriesMetadata

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

PurgeSuggestionDenyListEntriesRequest

Request message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] method.

PurgeSuggestionDenyListEntriesResponse

Response message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] method.

PurgeUserEventsMetadata

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

PurgeUserEventsRequest

Request message for PurgeUserEvents method.

PurgeUserEventsResponse

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

Query

Defines a user inputed query.

RankRequest

Request message for [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] method.

RankResponse

Response message for [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] method.

RankService

Service for ranking text records.

RankService.RankServiceBase

Base class for server-side implementations of RankService

RankService.RankServiceClient

Client for RankService

RankServiceClient

RankService client wrapper, for convenient use.

RankServiceClientBuilder

Builder class for RankServiceClient to provide simple configuration of credentials, endpoint etc.

RankServiceClientImpl

RankService client wrapper implementation, for convenient use.

RankServiceSettings

Settings for RankServiceClient instances.

RankingConfigName

Resource name for the RankingConfig resource.

RankingRecord

Record message for [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] method.

RecommendRequest

Request message for Recommend method.

RecommendResponse

Response message for Recommend method.

RecommendResponse.Types

Container for nested types declared in the RecommendResponse message type.

RecommendResponse.Types.RecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

RecommendationService

Service for making recommendations.

RecommendationService.RecommendationServiceBase

Base class for server-side implementations of RecommendationService

RecommendationService.RecommendationServiceClient

Client for RecommendationService

RecommendationServiceClient

RecommendationService client wrapper, for convenient use.

RecommendationServiceClientBuilder

Builder class for RecommendationServiceClient to provide simple configuration of credentials, endpoint etc.

RecommendationServiceClientImpl

RecommendationService client wrapper implementation, for convenient use.

RecommendationServiceSettings

Settings for RecommendationServiceClient instances.

RecrawlUrisMetadata

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

RecrawlUrisRequest

Request message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] method.

RecrawlUrisResponse

Response message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] method.

RecrawlUrisResponse.Types

Container for nested types declared in the RecrawlUrisResponse message type.

RecrawlUrisResponse.Types.FailureInfo

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

RecrawlUrisResponse.Types.FailureInfo.Types

Container for nested types declared in the FailureInfo message type.

RecrawlUrisResponse.Types.FailureInfo.Types.FailureReason

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

RecrawlUrisResponse.Types.FailureInfo.Types.FailureReason.Types

Container for nested types declared in the FailureReason message type.

Reply

Defines a reply message to user.

RetractLicenseConfigRequest

Request message for [LicenseConfigService.RetractLicenseConfig][google.cloud.discoveryengine.v1.LicenseConfigService.RetractLicenseConfig] method.

RetractLicenseConfigResponse

Response message for [LicenseConfigService.RetractLicenseConfig][google.cloud.discoveryengine.v1.LicenseConfigService.RetractLicenseConfig] method.

SafetyRating

Safety rating corresponding to the generated content.

SafetyRating.Types

Container for nested types declared in the SafetyRating message type.

Schema

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

SchemaName

Resource name for the Schema resource.

SchemaService

Service for managing [Schema][google.cloud.discoveryengine.v1.Schema]s.

SchemaService.SchemaServiceBase

Base class for server-side implementations of SchemaService

SchemaService.SchemaServiceClient

Client for SchemaService

SchemaServiceClient

SchemaService client wrapper, for convenient use.

SchemaServiceClientBuilder

Builder class for SchemaServiceClient to provide simple configuration of credentials, endpoint etc.

SchemaServiceClientImpl

SchemaService client wrapper implementation, for convenient use.

SchemaServiceSettings

Settings for SchemaServiceClient instances.

SearchInfo

Detailed search information.

SearchLinkPromotion

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

SearchRequest

Request message for [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method.

SearchRequest.Types

Container for nested types declared in the SearchRequest message type.

SearchRequest.Types.BoostSpec

Boost specification to boost certain documents.

SearchRequest.Types.BoostSpec.Types

Container for nested types declared in the BoostSpec message type.

SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec

Boost applies to documents which match a condition.

SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types

Container for nested types declared in the ConditionBoostSpec message type.

SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec

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

SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec.Types

Container for nested types declared in the BoostControlSpec message type.

SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec.Types.ControlPoint

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

SearchRequest.Types.ContentSearchSpec

A specification for configuring the behavior of content search.

SearchRequest.Types.ContentSearchSpec.Types

Container for nested types declared in the ContentSearchSpec message type.

SearchRequest.Types.ContentSearchSpec.Types.ChunkSpec

Specifies the chunk spec to be returned from the search response. Only available if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]

SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec

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

SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec

A specification for configuring snippets in a search response.

SearchRequest.Types.ContentSearchSpec.Types.SummarySpec

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

SearchRequest.Types.ContentSearchSpec.Types.SummarySpec.Types

Container for nested types declared in the SummarySpec message type.

SearchRequest.Types.ContentSearchSpec.Types.SummarySpec.Types.ModelPromptSpec

Specification of the prompt to use with the model.

SearchRequest.Types.ContentSearchSpec.Types.SummarySpec.Types.ModelSpec

Specification of the model.

SearchRequest.Types.CrowdingSpec

Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.

SearchRequest.Types.CrowdingSpec.Types

Container for nested types declared in the CrowdingSpec message type.

SearchRequest.Types.CustomRankingParams

Configuration parameters for the Custom Ranking feature.

SearchRequest.Types.DataStoreSpec

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.

SearchRequest.Types.DisplaySpec

Specifies features for display, like match highlighting.

SearchRequest.Types.DisplaySpec.Types

Container for nested types declared in the DisplaySpec message type.

SearchRequest.Types.FacetSpec

A facet specification to perform faceted search.

SearchRequest.Types.FacetSpec.Types

Container for nested types declared in the FacetSpec message type.

SearchRequest.Types.FacetSpec.Types.FacetKey

Specifies how a facet is computed.

SearchRequest.Types.ImageQuery

Specifies the image query input.

SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec

Specification to enable natural language understanding capabilities for search requests.

SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec.Types

Container for nested types declared in the NaturalLanguageQueryUnderstandingSpec message type.

SearchRequest.Types.QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

SearchRequest.Types.QueryExpansionSpec.Types

Container for nested types declared in the QueryExpansionSpec message type.

SearchRequest.Types.RelevanceFilterSpec

Relevance filtering specification.

SearchRequest.Types.RelevanceFilterSpec.Types

Container for nested types declared in the RelevanceFilterSpec message type.

SearchRequest.Types.RelevanceFilterSpec.Types.RelevanceThresholdSpec

Specification for relevance filtering on a specific sub-search.

SearchRequest.Types.RelevanceScoreSpec

The specification for returning the document relevance score.

SearchRequest.Types.SearchAddonSpec

SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.

SearchRequest.Types.SearchAsYouTypeSpec

Specification for search as you type in search requests.

SearchRequest.Types.SearchAsYouTypeSpec.Types

Container for nested types declared in the SearchAsYouTypeSpec message type.

SearchRequest.Types.SearchAsYouTypeSpec.Types.Field

A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.

SearchRequest.Types.SessionSpec

Session specification.

SearchRequest.Types.SpellCorrectionSpec

The specification for query spell correction.

SearchRequest.Types.SpellCorrectionSpec.Types

Container for nested types declared in the SpellCorrectionSpec message type.

SearchResponse

Response message for [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method.

SearchResponse.Types

Container for nested types declared in the SearchResponse message type.

A facet result.

Container for nested types declared in the Facet message type.

A facet value which contains value names and their count.

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo

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

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types

Container for nested types declared in the NaturalLanguageQueryUnderstandingInfo message type.

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter

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

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types

Container for nested types declared in the StructuredExtractedFilter message type.

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.AndExpression

Logical And operator.

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.Expression

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

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.GeolocationConstraint

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

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.NumberConstraint

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

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.NumberConstraint.Types

Container for nested types declared in the NumberConstraint message type.

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.OrExpression

Logical Or operator.

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.StringConstraint

Constraint expression of a string field.

SearchResponse.Types.QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

SearchResponse.Types.SearchResult

Represents the search results.

SearchResponse.Types.SearchResult.Types

Container for nested types declared in the SearchResult message type.

SearchResponse.Types.SearchResult.Types.RankSignals

A set of ranking signals.

SearchResponse.Types.SearchResult.Types.RankSignals.Types

Container for nested types declared in the RankSignals message type.

SearchResponse.Types.SearchResult.Types.RankSignals.Types.CustomSignal

Custom clearbox signal represented by name and value pair.

SearchResponse.Types.SearchResult.Types.RetrievalSignals

Contains a set of signals used by the relevance filter.

SearchResponse.Types.SearchResult.Types.RetrievalSignals.Types

Container for nested types declared in the RetrievalSignals message type.

SearchResponse.Types.SessionInfo

Information about the session.

SearchResponse.Types.Summary

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

SearchResponse.Types.Summary.Types

Container for nested types declared in the Summary message type.

SearchResponse.Types.Summary.Types.Citation

Citation info for a segment.

SearchResponse.Types.Summary.Types.CitationMetadata

Citation metadata.

SearchResponse.Types.Summary.Types.CitationSource

Citation source.

SearchResponse.Types.Summary.Types.Reference

Document reference.

SearchResponse.Types.Summary.Types.Reference.Types

Container for nested types declared in the Reference message type.

SearchResponse.Types.Summary.Types.Reference.Types.ChunkContent

Chunk content.

SearchResponse.Types.Summary.Types.SafetyAttributes

Safety Attribute categories and their associated confidence scores.

SearchResponse.Types.Summary.Types.SummaryWithMetadata

Summary with metadata information.

SearchService

Service for search.

SearchService.SearchServiceBase

Base class for server-side implementations of SearchService

SearchService.SearchServiceClient

Client for SearchService

SearchServiceClient

SearchService client wrapper, for convenient use.

SearchServiceClientBuilder

Builder class for SearchServiceClient to provide simple configuration of credentials, endpoint etc.

SearchServiceClientImpl

SearchService client wrapper implementation, for convenient use.

SearchServiceSettings

Settings for SearchServiceClient instances.

SearchTuningService

Service for search tuning.

SearchTuningService.SearchTuningServiceBase

Base class for server-side implementations of SearchTuningService

SearchTuningService.SearchTuningServiceClient

Client for SearchTuningService

SearchTuningServiceClient

SearchTuningService client wrapper, for convenient use.

SearchTuningServiceClientBuilder

Builder class for SearchTuningServiceClient to provide simple configuration of credentials, endpoint etc.

SearchTuningServiceClientImpl

SearchTuningService client wrapper implementation, for convenient use.

SearchTuningServiceSettings

Settings for SearchTuningServiceClient instances.

ServiceName

Resource name for the Service resource.

ServingConfig

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.

ServingConfig.Types

Container for nested types declared in the ServingConfig message type.

ServingConfig.Types.GenericConfig

Specifies the configurations needed for Generic Discovery.Currently we support:

content_search_spec: configuration for generic content search.

ServingConfig.Types.MediaConfig

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][google.cloud.discoveryengine.v1.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

ServingConfigName

Resource name for the ServingConfig resource.

ServingConfigService

Service for operations related to [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig].

ServingConfigService.ServingConfigServiceBase

Base class for server-side implementations of ServingConfigService

ServingConfigService.ServingConfigServiceClient

Client for ServingConfigService

ServingConfigServiceClient

ServingConfigService client wrapper, for convenient use.

ServingConfigServiceClientBuilder

Builder class for ServingConfigServiceClient to provide simple configuration of credentials, endpoint etc.

ServingConfigServiceClientImpl

ServingConfigService client wrapper implementation, for convenient use.

ServingConfigServiceSettings

Settings for ServingConfigServiceClient instances.

Session

External session proto definition.

Session.Types

Container for nested types declared in the Session message type.

Session.Types.Turn

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

SessionConfig

Configuration for the session.

SessionConfig.Types

Container for nested types declared in the SessionConfig message type.

SessionConfig.Types.SessionTtl

Defines the TTL for sessions.

SessionName

Resource name for the Session resource.

SessionService

Service for managing Sessions and Session-related resources.

SessionService.SessionServiceBase

Base class for server-side implementations of SessionService

SessionService.SessionServiceClient

Client for SessionService

SessionServiceClient

SessionService client wrapper, for convenient use.

SessionServiceClientBuilder

Builder class for SessionServiceClient to provide simple configuration of credentials, endpoint etc.

SessionServiceClientImpl

SessionService client wrapper implementation, for convenient use.

SessionServiceSettings

Settings for SessionServiceClient instances.

SetUpDataConnectorMetadata

Metadata for [DataConnectorService.SetUpDataConnector][google.cloud.discoveryengine.v1.DataConnectorService.SetUpDataConnector] method.

SetUpDataConnectorRequest

Request for [DataConnectorService.SetUpDataConnector][google.cloud.discoveryengine.v1.DataConnectorService.SetUpDataConnector] method.

SingleRegionKey

Metadata for single-regional CMEKs.

SiteSearchEngine

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

SiteSearchEngineName

Resource name for the SiteSearchEngine resource.

SiteSearchEngineService

Service for managing site search related resources.

SiteSearchEngineService.SiteSearchEngineServiceBase

Base class for server-side implementations of SiteSearchEngineService

SiteSearchEngineService.SiteSearchEngineServiceClient

Client for SiteSearchEngineService

SiteSearchEngineServiceClient

SiteSearchEngineService client wrapper, for convenient use.

SiteSearchEngineServiceClientBuilder

Builder class for SiteSearchEngineServiceClient to provide simple configuration of credentials, endpoint etc.

SiteSearchEngineServiceClientImpl

SiteSearchEngineService client wrapper implementation, for convenient use.

SiteSearchEngineServiceSettings

Settings for SiteSearchEngineServiceClient instances.

SiteVerificationInfo

Verification information for target sites in advanced site search.

SiteVerificationInfo.Types

Container for nested types declared in the SiteVerificationInfo message type.

Sitemap

A sitemap for the SiteSearchEngine.

SitemapName

Resource name for the Sitemap resource.

SpannerSource

The Spanner source for importing data

StreamAssistRequest

Request for the [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] method.

StreamAssistRequest.Types

Container for nested types declared in the StreamAssistRequest message type.

StreamAssistRequest.Types.AgentsSpec

Specification of agents that are used to serve the request.

StreamAssistRequest.Types.AgentsSpec.Types

Container for nested types declared in the AgentsSpec message type.

StreamAssistRequest.Types.AgentsSpec.Types.AgentSpec

Specification of an agent.

StreamAssistRequest.Types.GenerationSpec

Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.

StreamAssistRequest.Types.ToolsSpec

Specification of tools that are used to serve the request.

StreamAssistRequest.Types.ToolsSpec.Types

Container for nested types declared in the ToolsSpec message type.

StreamAssistRequest.Types.ToolsSpec.Types.ImageGenerationSpec

Specification of the image generation tool.

StreamAssistRequest.Types.ToolsSpec.Types.VertexAiSearchSpec

Specification of the Vertex AI Search tool.

StreamAssistRequest.Types.ToolsSpec.Types.VideoGenerationSpec

Specification of the video generation tool.

StreamAssistRequest.Types.ToolsSpec.Types.WebGroundingSpec

Specification of the web grounding tool.

StreamAssistResponse

Response for the [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] method.

StreamAssistResponse.Types

Container for nested types declared in the StreamAssistResponse message type.

StreamAssistResponse.Types.ConnectorAuthError

Describes an authentication error for a specific data connector.

StreamAssistResponse.Types.InvokedSkill

Represents a skill used during the assist call.

StreamAssistResponse.Types.SessionInfo

Information about the session.

SuggestionDenyListEntry

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

SuggestionDenyListEntry.Types

Container for nested types declared in the SuggestionDenyListEntry message type.

TargetSite

A target site for the SiteSearchEngine.

TargetSite.Types

Container for nested types declared in the TargetSite message type.

TargetSite.Types.FailureReason

Site search indexing failure reasons.

TargetSite.Types.FailureReason.Types

Container for nested types declared in the FailureReason message type.

TargetSite.Types.FailureReason.Types.QuotaFailure

Failed due to insufficient quota.

TargetSiteName

Resource name for the TargetSite resource.

TemplateName

Resource name for the Template resource.

Tenant

Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.

TextInput

Defines text input.

TrainCustomModelMetadata

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

TrainCustomModelRequest

Request message for [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1.SearchTuningService.TrainCustomModel] method.

TrainCustomModelRequest.Types

Container for nested types declared in the TrainCustomModelRequest message type.

TrainCustomModelRequest.Types.GcsTrainingInput

Cloud Storage training data input.

TrainCustomModelResponse

Response of the [TrainCustomModelRequest][google.cloud.discoveryengine.v1.TrainCustomModelRequest]. This message is returned by the google.longrunning.Operations.response field.

TransactionInfo

A transaction represents the entire purchase transaction.

UpdateAclConfigRequest

Request message for UpdateAclConfig method.

UpdateAssistantRequest

Request message for the [AssistantService.UpdateAssistant][google.cloud.discoveryengine.v1.AssistantService.UpdateAssistant] method.

UpdateCmekConfigMetadata

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

UpdateCmekConfigRequest

Request message for UpdateCmekConfig method. rpc.

UpdateControlRequest

Request for UpdateControl method.

UpdateConversationRequest

Request for UpdateConversation method.

UpdateDataConnectorRequest

Request message for [DataConnectorService.UpdateDataConnector][google.cloud.discoveryengine.v1.DataConnectorService.UpdateDataConnector] method.

UpdateDataStoreRequest

Request message for [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1.DataStoreService.UpdateDataStore] method.

UpdateDocumentRequest

Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument] method.

UpdateEngineRequest

Request message for [EngineService.UpdateEngine][google.cloud.discoveryengine.v1.EngineService.UpdateEngine] method.

UpdateLicenseConfigRequest

Request message for [LicenseConfigService.UpdateLicenseConfig][google.cloud.discoveryengine.v1.LicenseConfigService.UpdateLicenseConfig] method.

UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

UpdateSchemaRequest

Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1.SchemaService.UpdateSchema] method.

UpdateServingConfigRequest

Request for UpdateServingConfig method.

UpdateSessionRequest

Request for UpdateSession method.

UpdateTargetSiteMetadata

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

UpdateTargetSiteRequest

Request message for [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSite] method.

UpdateUserStoreRequest

Request message for [UserStoreService.UpdateUserStore][google.cloud.discoveryengine.v1.UserStoreService.UpdateUserStore] method.

UpdateWidgetConfigRequest

Request for [WidgetConfigService.UpdateWidgetConfig][google.cloud.discoveryengine.v1.WidgetConfigService.UpdateWidgetConfig] method.

UserEvent

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

UserEventService

Service for ingesting end user actions on a website to Discovery Engine API.

UserEventService.UserEventServiceBase

Base class for server-side implementations of UserEventService

UserEventService.UserEventServiceClient

Client for UserEventService

UserEventServiceClient

UserEventService client wrapper, for convenient use.

UserEventServiceClientBuilder

Builder class for UserEventServiceClient to provide simple configuration of credentials, endpoint etc.

UserEventServiceClientImpl

UserEventService client wrapper implementation, for convenient use.

UserEventServiceSettings

Settings for UserEventServiceClient instances.

UserInfo

Information of an end user.

UserInfo.Types

Container for nested types declared in the UserInfo message type.

UserInfo.Types.PreciseLocation

Precise location info with multiple representation options.

UserLicense

User License information assigned by the admin.

UserLicense.Types

Container for nested types declared in the UserLicense message type.

UserLicenseService

Service for managing User Licenses.

UserLicenseService.UserLicenseServiceBase

Base class for server-side implementations of UserLicenseService

UserLicenseService.UserLicenseServiceClient

Client for UserLicenseService

UserLicenseServiceClient

UserLicenseService client wrapper, for convenient use.

UserLicenseServiceClientBuilder

Builder class for UserLicenseServiceClient to provide simple configuration of credentials, endpoint etc.

UserLicenseServiceClientImpl

UserLicenseService client wrapper implementation, for convenient use.

UserLicenseServiceSettings

Settings for UserLicenseServiceClient instances.

UserStore

Configures metadata that is used for End User entities.

UserStoreName

Resource name for the UserStore resource.

UserStoreService

Service for managing User Stores.

UserStoreService.UserStoreServiceBase

Base class for server-side implementations of UserStoreService

UserStoreService.UserStoreServiceClient

Client for UserStoreService

UserStoreServiceClient

UserStoreService client wrapper, for convenient use.

UserStoreServiceClientBuilder

Builder class for UserStoreServiceClient to provide simple configuration of credentials, endpoint etc.

UserStoreServiceClientImpl

UserStoreService client wrapper implementation, for convenient use.

UserStoreServiceSettings

Settings for UserStoreServiceClient instances.

WidgetConfig

WidgetConfig captures configs at the Widget level.

WidgetConfig.Types

Container for nested types declared in the WidgetConfig message type.

WidgetConfig.Types.AccessSettings

Describes widget access settings.

WidgetConfig.Types.AssistantSettings

Describes the assistant settings of the widget.

WidgetConfig.Types.AssistantSettings.Types

Container for nested types declared in the AssistantSettings message type.

WidgetConfig.Types.BatchAuthStatus

Describes the batch authorization status for a batch_authorization_group.

WidgetConfig.Types.CollectionComponent

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

For SaaS / Business engines, when LookupWidgetConfig is called with view = WITH_AVAILABLE_CONNECTORS, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED (or NO_AUTH), an empty connector_auth_state.authorization_uri (the widget calls WidgetBuildAuthorizationUrl on the user's "Connect" click), and synthetic placeholder values in name / id (see field comments). Fields that only make sense for materialized connectors (data_store_components, tenant, action_connector) are left unset for placeholder entries.

WidgetConfig.Types.ConnectorAuthState

Read-only connector in CollectionComponent auth state.

WidgetConfig.Types.ConnectorAuthState.Types

Container for nested types declared in the ConnectorAuthState message type.

WidgetConfig.Types.CustomerProvidedConfig

Customer provided configurations.

WidgetConfig.Types.CustomerProvidedConfig.Types

Container for nested types declared in the CustomerProvidedConfig message type.

WidgetConfig.Types.DataStoreComponent

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

WidgetConfig.Types.DataStoreComponent.Types

Container for nested types declared in the DataStoreComponent message type.

WidgetConfig.Types.DataStoreUiConfig

UI component configuration for data store.

WidgetConfig.Types.FacetField

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

WidgetConfig.Types.HomepageSetting

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

WidgetConfig.Types.HomepageSetting.Types

Container for nested types declared in the HomepageSetting message type.

WidgetConfig.Types.HomepageSetting.Types.Shortcut

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

WidgetConfig.Types.Image

Options to store an image.

WidgetConfig.Types.Node

Represents a single reusable computational or logical unit.

WidgetConfig.Types.Node.Types

Container for nested types declared in the Node message type.

WidgetConfig.Types.UIComponentField

Facet field that maps to a UI Component.

WidgetConfig.Types.UIComponentField.Types

Container for nested types declared in the UIComponentField message type.

WidgetConfig.Types.UiBrandingSettings

Describes widget UI branding settings.

WidgetConfig.Types.UiSettings

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

WidgetConfig.Types.UiSettings.Types

Container for nested types declared in the UiSettings message type.

WidgetConfig.Types.UiSettings.Types.GenerativeAnswerConfig

Describes configuration for generative answer.

WidgetConfig.Types.UiSettings.Types.GenerativeAnswerConfig.Types

Container for nested types declared in the GenerativeAnswerConfig message type.

WidgetConfig.Types.UiSettings.Types.ModelConfigInfo

The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from model_configs.

The backend is the single source of truth for this configuration; clients should render resolved_models directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization.

WidgetConfig.Types.UiSettings.Types.ModelConfigInfo.Types

Container for nested types declared in the ModelConfigInfo message type.

WidgetConfig.Types.UiSettings.Types.ModelConfigInfo.Types.ResolvedModel

A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.

WidgetConfig.Types.UiSettings.Types.ModelConfigInfo.Types.ResolvedModel.Types

Container for nested types declared in the ResolvedModel message type.

WidgetConfig.Types.UiSettings.Types.ModelConfigInfo.Types.ResolvedModel.Types.AdminView

Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.

WidgetConfig.Types.UiSettings.Types.SearchAddonSpec

SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.

WidgetConfigName

Resource name for the WidgetConfig resource.

WidgetConfigService

Service for managing [WidgetConfig][google.cloud.discoveryengine.v1.WidgetConfig] configuration.

WidgetConfigService.WidgetConfigServiceBase

Base class for server-side implementations of WidgetConfigService

WidgetConfigService.WidgetConfigServiceClient

Client for WidgetConfigService

WidgetConfigServiceClient

WidgetConfigService client wrapper, for convenient use.

WidgetConfigServiceClientBuilder

Builder class for WidgetConfigServiceClient to provide simple configuration of credentials, endpoint etc.

WidgetConfigServiceClientImpl

WidgetConfigService client wrapper implementation, for convenient use.

WidgetConfigServiceSettings

Settings for WidgetConfigServiceClient instances.

WorkspaceConfig

Config to store data store type configuration for workspace data

WorkspaceConfig.Types

Container for nested types declared in the WorkspaceConfig message type.

WriteUserEventRequest

Request message for WriteUserEvent method.

Enums

AclConfigName.ResourceNameType

The possible contents of AclConfigName.

ActionConfig.ActionConfigParamsOneofCase

Enum of possible cases for the "action_config_params" oneof.

AdvancedCompleteQueryRequest.Types.SuggestionType

Suggestion type to return.

AdvancedCompleteQueryResponse.Types.ContentSuggestion.Types.ContentType

The type of the content returned for content suggestions.

AdvancedCompleteQueryResponse.Types.PersonSuggestion.Types.PersonType

Classifies the person by identity source and entity kind; GOOGLE_GROUP takes precedence for groups regardless of their identity source.

AgentGatewayName.ResourceNameType

The possible contents of AgentGatewayName.

AlertPolicyConfig.Types.AlertEnrollment.Types.EnrollStates

The enrollment status enum for the alert.

Answer.Types.AnswerSkippedReason

An enum for answer skipped reasons.

Answer.Types.QueryUnderstandingInfo.Types.QueryClassificationInfo.Types.Type

Query classification types.

Answer.Types.Reference.ContentOneofCase

Enum of possible cases for the "content" oneof.

Answer.Types.State

Enumeration of the state of the answer generation.

Answer.Types.Step.Types.Action.ActionOneofCase

Enum of possible cases for the "action" oneof.

Answer.Types.Step.Types.State

Enumeration of the state of the step.

AnswerName.ResourceNameType

The possible contents of AnswerName.

AnswerQueryRequest.Types.EndUserSpec.Types.EndUserMetaData.ContentOneofCase

Enum of possible cases for the "content" oneof.

AnswerQueryRequest.Types.GroundingSpec.Types.FilteringLevel

Level to filter based on answer grounding.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types.QueryClassificationSpec.Types.Type

Query classification types.

AnswerQueryRequest.Types.QueryUnderstandingSpec.Types.QueryRephraserSpec.Types.ModelSpec.Types.ModelType

Query rephraser types. Currently only supports single-hop (max_rephrase_steps = 1) model selections. For multi-hop (max_rephrase_steps > 1), there is only one default model.

AnswerQueryRequest.Types.SafetySpec.Types.SafetySetting.Types.HarmBlockThreshold

Probability based thresholds levels for blocking.

AnswerQueryRequest.Types.SearchSpec.InputOneofCase

Enum of possible cases for the "input" oneof.

AnswerQueryRequest.Types.SearchSpec.Types.SearchResultList.Types.SearchResult.ContentOneofCase

Enum of possible cases for the "content" oneof.

AssistAnswer.Types.AssistSkippedReason

Possible reasons for not answering an assist call.

AssistAnswer.Types.CustomerPolicyEnforcementResult.Types.ModelArmorEnforcementResult.ResultOneofCase

Enum of possible cases for the "result" oneof.

AssistAnswer.Types.CustomerPolicyEnforcementResult.Types.PolicyEnforcementResult.EnforcementResultOneofCase

Enum of possible cases for the "enforcement_result" oneof.

AssistAnswer.Types.CustomerPolicyEnforcementResult.Types.Verdict

The verdict of the customer policy enforcement.

AssistAnswer.Types.CustomerPolicyEnforcementResult.Types.ViolationSource

If the assist call was skipped due to a policy violation, this contains the source of the violation.

AssistAnswer.Types.Reply.ReplyOneofCase

Enum of possible cases for the "reply" oneof.

AssistAnswer.Types.State

State of the answer generation.

AssistAnswerName.ResourceNameType

The possible contents of AssistAnswerName.

Assistant.Types.CustomerPolicy.Types.BannedPhrase.Types.BannedPhraseMatchType

The matching method for the banned phrase.

Assistant.Types.CustomerPolicy.Types.ModelArmorConfig.Types.FailureMode

Determines the behavior when Model Armor fails to process a request.

Assistant.Types.WebGroundingType

The type of web grounding to use.

AssistantContent.DataOneofCase

Enum of possible cases for the "data" oneof.

AssistantContent.Types.CodeExecutionResult.Types.Outcome

Enumeration of possible outcomes of the code execution.

AssistantGroundedContent.MetadataOneofCase

Enum of possible cases for the "metadata" oneof.

AssistantGroundedContent.Types.TextGroundingMetadata.Types.Reference.Types.DocumentMetadata.Types.Language

Language of the referenced content. For now, it is only used for code.

AssistantName.ResourceNameType

The possible contents of AssistantName.

BAPConfig.Types.ConnectorMode

Use cases supported by this BAP connector.

BatchGetDocumentsMetadataRequest.Types.Matcher.MatcherOneofCase

Enum of possible cases for the "matcher" oneof.

BatchGetDocumentsMetadataResponse.Types.DocumentMetadata.Types.MatcherValue.MatcherValueOneofCase

Enum of possible cases for the "matcher_value" oneof.

BatchGetDocumentsMetadataResponse.Types.State

The state of the [Document][google.cloud.discoveryengine.v1.Document].

BatchUpdateUserLicensesRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

BigQuerySource.PartitionOneofCase

Enum of possible cases for the "partition" oneof.

BigtableOptions.Types.Encoding

The encoding mode of a Bigtable column or column family.

BigtableOptions.Types.Type

The type of values in a Bigtable column or column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.

BillingAccountLicenseConfigName.ResourceNameType

The possible contents of BillingAccountLicenseConfigName.

BranchName.ResourceNameType

The possible contents of BranchName.

Chunk.Types.StructureType

Defines the types of the structured content that can be extracted.

ChunkName.ResourceNameType

The possible contents of ChunkName.

Citation.Types.PhishBlockThreshold

These are available confidence level user can set to block malicious urls with chosen confidence and above. For understanding different confidence of webrisk, please refer to https://cloud.google.com/web-risk/docs/reference/rpc/google.cloud.webrisk.v1eap1#confidencelevel

CmekConfig.Types.NotebookLMState

States of NotebookLM.

CmekConfig.Types.State

States of the CmekConfig.

CmekConfigName.ResourceNameType

The possible contents of CmekConfigName.

CollectionName.ResourceNameType

The possible contents of CollectionName.

CompletionConfigName.ResourceNameType

The possible contents of CompletionConfigName.

CompletionSuggestion.RankingInfoOneofCase

Enum of possible cases for the "ranking_info" oneof.

ConnectorType

The type of connector. New values may be added to this enum in the future.

ContentPolicyName.ResourceNameType

The possible contents of ContentPolicyName.

Control.ActionOneofCase

Enum of possible cases for the "action" oneof.

Control.Types.BoostAction.BoostSpecOneofCase

Enum of possible cases for the "boost_spec" oneof.

Control.Types.BoostAction.Types.InterpolationBoostSpec.Types.AttributeType

The attribute(or function) for which the custom ranking is to be applied.

Control.Types.BoostAction.Types.InterpolationBoostSpec.Types.InterpolationType

The interpolation type to be applied. Default will be linear (Piecewise Linear).

ControlName.ResourceNameType

The possible contents of ControlName.

Conversation.Types.State

Enumeration of the state of the conversation.

ConversationMessage.MessageOneofCase

Enum of possible cases for the "message" oneof.

ConversationName.ResourceNameType

The possible contents of ConversationName.

CreateDataStoreRequest.CmekOptionsOneofCase

Enum of possible cases for the "cmek_options" oneof.

CreateIdentityMappingStoreRequest.CmekOptionsOneofCase

Enum of possible cases for the "cmek_options" oneof.

CryptoKeyVersionsName.ResourceNameType

The possible contents of CryptoKeyVersionsName.

CryptoKeysName.ResourceNameType

The possible contents of CryptoKeysName.

CustomTuningModel.Types.ModelState

The state of the model.

CustomTuningModelName.ResourceNameType

The possible contents of CustomTuningModelName.

DataConnector.DataConnectorParamsOneofCase

Enum of possible cases for the "data_connector_params" oneof.

DataConnector.Types.BlockingReason

User actions that must be completed before the connector can start syncing data.

DataConnector.Types.ConnectorMode

The modes enabled for this connector. INGESTION, ACTIONS, FEDERATED, OR EUA

DataConnector.Types.EndUserConfig.AuthConfigOneofCase

Enum of possible cases for the "auth_config" oneof.

DataConnector.Types.FederatedConfig.AuthConfigOneofCase

Enum of possible cases for the "auth_config" oneof.

DataConnector.Types.RealtimeSyncConfig.Types.StreamingError.Types.StreamingErrorReason

Broad types of streaming errors.

DataConnector.Types.SourceEntity.EntityParamsOneofCase

Enum of possible cases for the "entity_params" oneof.

DataConnector.Types.State

The state of connector.

DataConnector.Types.SyncMode

Defines the data synchronization mode supported by the data connector.

DataConnectorName.ResourceNameType

The possible contents of DataConnectorName.

DataStore.Types.ConfigurableBillingApproach

Configuration for configurable billing approach.

DataStore.Types.ContentConfig

Content config of the data store.

DataStore.Types.FederatedSearchConfig.DataSourceConfigOneofCase

Enum of possible cases for the "data_source_config" oneof.

DataStore.Types.FederatedSearchConfig.Types.AlloyDbConfig.Types.AlloyDbConnectionConfig.Types.AuthMode

Auth mode.

DataStoreName.ResourceNameType

The possible contents of DataStoreName.

DestinationConfig.DestinationConfigParamsOneofCase

Enum of possible cases for the "destination_config_params" oneof.

DestinationConfig.Types.Destination.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

Document.DataOneofCase

Enum of possible cases for the "data" oneof.

Document.Types.Content.ContentOneofCase

Enum of possible cases for the "content" oneof.

DocumentInfo.DocumentDescriptorOneofCase

Enum of possible cases for the "document_descriptor" oneof.

DocumentName.ResourceNameType

The possible contents of DocumentName.

DocumentProcessingConfig.Types.ChunkingConfig.ChunkModeOneofCase

Enum of possible cases for the "chunk_mode" oneof.

DocumentProcessingConfig.Types.ParsingConfig.TypeDedicatedConfigOneofCase

Enum of possible cases for the "type_dedicated_config" oneof.

DocumentProcessingConfigName.ResourceNameType

The possible contents of DocumentProcessingConfigName.

Engine.EngineConfigOneofCase

Enum of possible cases for the "engine_config" oneof.

Engine.EngineMetadataOneofCase

Enum of possible cases for the "engine_metadata" oneof.

Engine.Types.AppType

The app of the engine.

Engine.Types.ConfigurableBillingApproach

Configuration for configurable billing approach.

Engine.Types.FeatureState

The state of the feature for the engine.

Engine.Types.MarketplaceAgentVisibility

Represents which marketplace agents are visible to any users in agent gallery.

Engine.Types.MediaRecommendationEngineConfig.Types.EngineFeaturesConfig.TypeDedicatedConfigOneofCase

Enum of possible cases for the "type_dedicated_config" oneof.

Engine.Types.MediaRecommendationEngineConfig.Types.TrainingState

The training state of the engine.

Engine.Types.ModelState

The status of the model for the engine.

EngineName.ResourceNameType

The possible contents of EngineName.

Feedback.Types.FeedbackSource

Source of the feedback as per integration.

Feedback.Types.FeedbackType

The type of the feedback user gives.

Feedback.Types.Reason

The reason why user gives a negative feedback.

FetchSitemapsRequest.Types.Matcher.MatcherOneofCase

Enum of possible cases for the "matcher" oneof.

FhirResourceName.ResourceNameType

The possible contents of FhirResourceName.

FhirStoreName.ResourceNameType

The possible contents of FhirStoreName.

GenerateGroundedContentRequest.Types.DynamicRetrievalConfiguration.Types.DynamicRetrievalPredictor.Types.Version

The version of the predictor to be used in dynamic retrieval.

GenerateGroundedContentRequest.Types.GenerationSpec.Types.ProvisionedThroughputSetting

Setting for provisioned throughput.

GenerateGroundedContentRequest.Types.GroundingSource.SourceOneofCase

Enum of possible cases for the "source" oneof.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.DynamicRetrievalPredictorMetadata.Types.Version

The version of the predictor which was used in dynamic retrieval.

GenerateGroundedContentResponse.Types.Candidate.Types.GroundingMetadata.Types.RetrievalMetadata.Types.Source

Describes the source to which the metadata is associated to.

GroundedGenerationContent.Types.Part.DataOneofCase

Enum of possible cases for the "data" oneof.

GroundingConfigName.ResourceNameType

The possible contents of GroundingConfigName.

HarmCategory

Harm categories that will block the content.

IdentityMappingEntry.IdentityProviderIdOneofCase

Enum of possible cases for the "identity_provider_id" oneof.

IdentityMappingStoreName.ResourceNameType

The possible contents of IdentityMappingStoreName.

IdpConfig.Types.IdpType

Identity Provider Type.

ImportCompletionSuggestionsRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

ImportDocumentsRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

ImportDocumentsRequest.Types.ReconciliationMode

Indicates how imported documents are reconciled with the existing documents created or imported before.

ImportErrorConfig.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

ImportIdentityMappingsRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

ImportSuggestionDenyListEntriesRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

ImportUserEventsRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

IndustryVertical

The industry vertical associated with the [DataStore][google.cloud.discoveryengine.v1.DataStore].

Interval.MaxOneofCase

Enum of possible cases for the "max" oneof.

Interval.MinOneofCase

Enum of possible cases for the "min" oneof.

LicenseConfig.Types.State

License config state enumeration.

LicenseConfigName.ResourceNameType

The possible contents of LicenseConfigName.

LocationName.ResourceNameType

The possible contents of LocationName.

ModelInfoView

Selects which "view" of the model selector configuration the backend computes for WidgetConfig.UiSettings.ModelConfigInfo.

The end-user views (END_USER_WEB, END_USER_MOBILE) return the user-facing model selector for their respective surface; the ADMIN view returns the set surfaced on the Cloud Console admin "Feature Control" page, with ModelConfigInfo.ResolvedModel.admin_view populated on each entry.

NaturalLanguageQueryUnderstandingConfig.Types.Mode

Mode of Natural Language Query Understanding. When the NaturalLanguageQueryUnderstandingConfig.Mode is ENABLED, the natural language understanding capabilities will be enabled for a search request if the NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition in the SearchRequest is ENABLED.

NotebookName.ResourceNameType

The possible contents of NotebookName.

Principal.PrincipalOneofCase

Enum of possible cases for the "principal" oneof.

Project.Types.ConfigurableBillingStatus.Types.UpdateType

The type of update performed on the configurable billing configuration.

Project.Types.ServiceTerms.Types.State

The agreement states this terms of service.

ProjectName.ResourceNameType

The possible contents of ProjectName.

PurgeDocumentsRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

PurgeErrorConfig.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

PurgeIdentityMappingsRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

Query.ContentOneofCase

Enum of possible cases for the "content" oneof.

RankingConfigName.ResourceNameType

The possible contents of RankingConfigName.

RecrawlUrisResponse.Types.FailureInfo.Types.FailureReason.Types.CorpusType

CorpusType for the failed crawling operation.

SafetyRating.Types.HarmProbability

Harm probability levels in the content.

SafetyRating.Types.HarmSeverity

Harm severity levels.

Schema.SchemaOneofCase

Enum of possible cases for the "schema" oneof.

SchemaName.ResourceNameType

The possible contents of SchemaName.

SearchAddOn

Add-on that provides additional functionality for search.

SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec.Types.AttributeType

The attribute(or function) for which the custom ranking is to be applied.

SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec.Types.InterpolationType

The interpolation type to be applied. Default will be linear (Piecewise Linear).

SearchRequest.Types.ContentSearchSpec.Types.SearchResultMode

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

SearchRequest.Types.CrowdingSpec.Types.Mode

Enum describing the mode to use for documents that are crowded away. They can be dropped or demoted to the later pages.

SearchRequest.Types.DisplaySpec.Types.MatchHighlightingCondition

Enum describing under which condition match highlighting should occur.

SearchRequest.Types.ImageQuery.ImageOneofCase

Enum of possible cases for the "image" oneof.

SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec.Types.ExtractedFilterBehavior

Enum describing how extracted filters are applied to the search.

SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec.Types.FilterExtractionCondition

Enum describing under which condition filter extraction should occur.

SearchRequest.Types.QueryExpansionSpec.Types.Condition

Enum describing under which condition query expansion should occur.

SearchRequest.Types.RankingExpressionBackend

The backend to use for the ranking expression evaluation.

SearchRequest.Types.RelevanceFilterSpec.Types.RelevanceThresholdSpec.RelevanceThresholdSpecOneofCase

Enum of possible cases for the "relevance_threshold_spec" oneof.

SearchRequest.Types.RelevanceThreshold

The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.

SearchRequest.Types.SearchAsYouTypeSpec.Types.Condition

Enum describing under which condition search as you type should occur.

SearchRequest.Types.SpellCorrectionSpec.Types.Mode

Enum describing under which mode spell correction should occur.

Enum of possible cases for the "facet_value" oneof.

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.Expression.ExprOneofCase

Enum of possible cases for the "expr" oneof.

SearchResponse.Types.NaturalLanguageQueryUnderstandingInfo.Types.StructuredExtractedFilter.Types.NumberConstraint.Types.Comparison

The comparison operation that was performed.

Discovery Engine v1 API - Namespace Google.Cloud.DiscoveryEngine.V1 (1.17.0) Stay organized with collections Save and categorize content based on your preferences.

Classes

Discovery Engine v1 API - Namespace Google.Cloud.DiscoveryEngine.V1 (1.17.0)