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

Classes

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.

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.

BranchName

Resource name for the Branch resource.

CloudSqlSource

Cloud SQL source import data from.

CollectUserEventRequest

Request message for CollectUserEvent method.

CollectionName

Resource name for the Collection resource.

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.

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.

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.

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.

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.

CreateSchemaMetadata

Metadata for Create Schema LRO.

CreateSchemaRequest

Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1.SchemaService.CreateSchema] 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.

CustomAttribute

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

DataStore

DataStore captures global settings and configs at the DataStore level.

DataStore.Types

Container for nested types declared in the DataStore message type.

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.

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.

DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

DeleteSchemaRequest

Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1.SchemaService.DeleteSchema] 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.

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.

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

Unstructured data linked to this document.

DocumentInfo

Detailed document information associated with a user event.

DocumentName

Resource name for the Document 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.

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

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.

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.

GetConversationRequest

Request for GetConversation 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.

GetSchemaRequest

Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] 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.

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.

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.

ListConversationsRequest

Request for ListConversations method.

ListConversationsResponse

Response for ListConversations 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.

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.

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.

MediaInfo

Media-specific user event information.

PageInfo

Detailed page information.

PanelInfo

Detailed panel information associated with a user event.

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.

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.

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.

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.

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.

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

A struct to define data stores to filter on in a search call.

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

SearchResponse.Types.Facet

A facet result.

SearchResponse.Types.Facet.Types

Container for nested types declared in the Facet message type.

SearchResponse.Types.Facet.Types.FacetValue

A facet value which contains value names and their count.

SearchResponse.Types.QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

SearchResponse.Types.SearchResult

Represents the search results.

SearchResponse.Types.Summary

Summary of the top N search result 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.

ServingConfigName

Resource name for the ServingConfig resource.

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.

SpannerSource

The Spanner source for importing data

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.

TextInput

Defines text input.

TransactionInfo

A transaction represents the entire purchase transaction.

UpdateConversationRequest

Request for UpdateConversation 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.

UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

UpdateSchemaRequest

Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1.SchemaService.UpdateSchema] 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.

UserEvent

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' 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.

WriteUserEventRequest

Request message for WriteUserEvent method.

Enums

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.

BranchName.ResourceNameType

The possible contents of BranchName.

CollectionName.ResourceNameType

The possible contents of CollectionName.

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.

DataStore.Types.ContentConfig

Content config of the data store.

DataStoreName.ResourceNameType

The possible contents of DataStoreName.

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.

Engine.EngineConfigOneofCase

Enum of possible cases for the "engine_config" oneof.

Engine.EngineMetadataOneofCase

Enum of possible cases for the "engine_metadata" oneof.

EngineName.ResourceNameType

The possible contents of EngineName.

FhirStoreName.ResourceNameType

The possible contents of FhirStoreName.

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.

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.

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

CorpusType for the failed crawling operation.

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.ImageQuery.ImageOneofCase

Enum of possible cases for the "image" oneof.

SearchRequest.Types.QueryExpansionSpec.Types.Condition

Enum describing under which condition query expansion should occur.

SearchRequest.Types.SpellCorrectionSpec.Types.Mode

Enum describing under which mode spell correction should occur.

SearchResponse.Types.Facet.Types.FacetValue.FacetValueOneofCase

Enum of possible cases for the "facet_value" oneof.

SearchResponse.Types.Summary.Types.SummarySkippedReason

An Enum for summary-skipped reasons.

SearchTier

Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.

ServingConfigName.ResourceNameType

The possible contents of ServingConfigName.

SiteSearchEngineName.ResourceNameType

The possible contents of SiteSearchEngineName.

SiteVerificationInfo.Types.SiteVerificationState

Site verification state.

SolutionType

The type of solution.

SuggestionDenyListEntry.Types.MatchOperator

Operator for matching with the generated suggestions.

TargetSite.Types.FailureReason.FailureOneofCase

Enum of possible cases for the "failure" oneof.

TargetSite.Types.IndexingStatus

Target site indexing status enumeration.

TargetSite.Types.Type

Possible target site types.

TargetSiteName.ResourceNameType

The possible contents of TargetSiteName.