Classes
AlloyDbSource
AlloyDB source import data from.
Answer
Defines an answer.
Answer.Types
Container for nested types declared in the Answer message type.
Answer.Types.Citation
Citation info for a segment.
Answer.Types.CitationSource
Citation source.
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
Reference.
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
Step information.
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.
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.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.RelatedQuestionsSpec
Related questions specification.
AnswerQueryRequest.Types.SafetySpec
Safety specification.
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.
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].
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.
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.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.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.
ChunkName
Resource name for the Chunk 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.
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.
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.FilterAction
Specified which products may be included in results. Uses same filter as boost.
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.
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.
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.
CreateSchemaMetadata
Metadata for Create Schema LRO.
CreateSchemaRequest
Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1.SchemaService.CreateSchema] method.
CreateSessionRequest
Request for CreateSession 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].
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.
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.
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.
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.
DeleteSchemaMetadata
Metadata for DeleteSchema LRO.
DeleteSchemaRequest
Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1.SchemaService.DeleteSchema] method.
DeleteSessionRequest
Request for DeleteSession 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.
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.
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.
FactChunk
Fact Chunk.
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.
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.GroundingSource
Grounding source.
GenerateGroundedContentRequest.Types.GroundingSource.Types
Container for nested types declared in the GroundingSource message type.
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
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.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.
GetAnswerRequest
Request for GetAnswer method.
GetControlRequest
Request for GetControl method.
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.
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.
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.
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.
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.
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.
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.
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.
LocationName
Resource name for the Location resource.
MediaInfo
Media-specific user event information.
PageInfo
Detailed page information.
PanelInfo
Detailed panel information associated with a user event.
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.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.
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.
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.
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.
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.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.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.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.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.SessionSpec
Session specification.
Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
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.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.
ServingConfigName
Resource name for the ServingConfig resource.
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.
SessionName
Resource name for the Session 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.
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.
UpdateControlRequest
Request for UpdateControl method.
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.
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.
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.
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
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.QueryUnderstandingSpec.Types.QueryClassificationSpec.Types.Type
Query classification types.
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.
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].
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.
ChunkName.ResourceNameType
The possible contents of ChunkName.
CollectionName.ResourceNameType
The possible contents of CollectionName.
CompletionSuggestion.RankingInfoOneofCase
Enum of possible cases for the "ranking_info" oneof.
Control.ActionOneofCase
Enum of possible cases for the "action" oneof.
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.
CustomTuningModel.Types.ModelState
The state of the model.
CustomTuningModelName.ResourceNameType
The possible contents of CustomTuningModelName.
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.
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.
EngineName.ResourceNameType
The possible contents of EngineName.
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.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.
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.
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.
LocationName.ResourceNameType
The possible contents of LocationName.
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.
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.
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.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.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.
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.
SearchUseCase
Defines a further subdivision of SolutionType.
Specifically applies to
[SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
ServingConfigName.ResourceNameType
The possible contents of ServingConfigName.
Session.Types.State
Enumeration of the state of the session.
SessionName.ResourceNameType
The possible contents of SessionName.
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.
TrainCustomModelRequest.TrainingInputOneofCase
Enum of possible cases for the "training_input" oneof.
WorkspaceConfig.Types.Type
Specifies the type of Workspace App supported by this DataStore