Package com.google.cloud.discoveryengine.v1beta

Interface Summary

Interface	Description
BigQuerySourceOrBuilder
CollectUserEventRequestOrBuilder
CompleteQueryRequestOrBuilder
CompleteQueryResponse.QuerySuggestionOrBuilder
CompleteQueryResponseOrBuilder
CompletionInfoOrBuilder
ConversationContextOrBuilder
ConversationMessageOrBuilder
ConversationOrBuilder
ConverseConversationRequestOrBuilder
ConverseConversationResponseOrBuilder
CreateConversationRequestOrBuilder
CreateDocumentRequestOrBuilder
CreateSchemaMetadataOrBuilder
CreateSchemaRequestOrBuilder
CustomAttributeOrBuilder
DeleteConversationRequestOrBuilder
DeleteDocumentRequestOrBuilder
DeleteSchemaMetadataOrBuilder
DeleteSchemaRequestOrBuilder
Document.ContentOrBuilder
DocumentInfoOrBuilder
DocumentOrBuilder
DoubleListOrBuilder
GcsSourceOrBuilder
GetConversationRequestOrBuilder
GetDocumentRequestOrBuilder
GetSchemaRequestOrBuilder
ImportDocumentsMetadataOrBuilder
ImportDocumentsRequest.InlineSourceOrBuilder
ImportDocumentsRequestOrBuilder
ImportDocumentsResponseOrBuilder
ImportErrorConfigOrBuilder
ImportUserEventsMetadataOrBuilder
ImportUserEventsRequest.InlineSourceOrBuilder
ImportUserEventsRequestOrBuilder
ImportUserEventsResponseOrBuilder
IntervalOrBuilder
ListConversationsRequestOrBuilder
ListConversationsResponseOrBuilder
ListDocumentsRequestOrBuilder
ListDocumentsResponseOrBuilder
ListSchemasRequestOrBuilder
ListSchemasResponseOrBuilder
MediaInfoOrBuilder
PageInfoOrBuilder
PanelInfoOrBuilder
PurgeDocumentsMetadataOrBuilder
PurgeDocumentsRequestOrBuilder
PurgeDocumentsResponseOrBuilder
RecommendRequestOrBuilder
RecommendResponse.RecommendationResultOrBuilder
RecommendResponseOrBuilder
Reply.ReferenceOrBuilder	Deprecated
ReplyOrBuilder
SchemaOrBuilder
SearchInfoOrBuilder
SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
SearchRequest.BoostSpecOrBuilder
SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder
SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
SearchRequest.ContentSearchSpecOrBuilder
SearchRequest.EmbeddingSpec.EmbeddingVectorOrBuilder
SearchRequest.EmbeddingSpecOrBuilder
SearchRequest.FacetSpec.FacetKeyOrBuilder
SearchRequest.FacetSpecOrBuilder
SearchRequest.ImageQueryOrBuilder
SearchRequest.QueryExpansionSpecOrBuilder
SearchRequest.SpellCorrectionSpecOrBuilder
SearchRequestOrBuilder
SearchResponse.Facet.FacetValueOrBuilder
SearchResponse.FacetOrBuilder
SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder
SearchResponse.GuidedSearchResultOrBuilder
SearchResponse.QueryExpansionInfoOrBuilder
SearchResponse.SearchResultOrBuilder
SearchResponse.Summary.SafetyAttributesOrBuilder
SearchResponse.SummaryOrBuilder
SearchResponseOrBuilder
TextInputOrBuilder
TransactionInfoOrBuilder
UpdateConversationRequestOrBuilder
UpdateDocumentRequestOrBuilder
UpdateSchemaMetadataOrBuilder
UpdateSchemaRequestOrBuilder
UserEventOrBuilder
UserInfoOrBuilder
WriteUserEventRequestOrBuilder

Class Summary

Class	Description
BigQuerySource	BigQuery source import data from.
BigQuerySource.Builder	BigQuery source import data from.
BranchName
BranchName.Builder	Builder for projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}.
BranchName.ProjectLocationCollectionDataStoreBranchBuilder	Builder for projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
CollectUserEventRequest	Request message for CollectUserEvent method.
CollectUserEventRequest.Builder	Request message for CollectUserEvent method.
CommonProto
CompleteQueryRequest	Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
CompleteQueryRequest.Builder	Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
CompleteQueryResponse	Response message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
CompleteQueryResponse.Builder	Response message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
CompleteQueryResponse.QuerySuggestion	Suggestions as search queries.
CompleteQueryResponse.QuerySuggestion.Builder	Suggestions as search queries.
CompletionInfo	Detailed completion information including completion attribution token and clicked completion info.
CompletionInfo.Builder	Detailed completion information including completion attribution token and clicked completion info.
CompletionServiceProto
Conversation	External conversation proto definition.
Conversation.Builder	External conversation proto definition.
ConversationalSearchServiceProto
ConversationContext	Defines context of the conversation
ConversationContext.Builder	Defines context of the conversation
ConversationMessage	Defines a conversation message.
ConversationMessage.Builder	Defines a conversation message.
ConversationName
ConversationName.Builder	Builder for projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}.
ConversationName.ProjectLocationCollectionDataStoreConversationBuilder	Builder for projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}.
ConversationProto
ConverseConversationRequest	Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
ConverseConversationRequest.Builder	Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
ConverseConversationResponse	Response message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
ConverseConversationResponse.Builder	Response message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
CreateConversationRequest	Request for CreateConversation method.
CreateConversationRequest.Builder	Request for CreateConversation method.
CreateDocumentRequest	Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] method.
CreateDocumentRequest.Builder	Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] method.
CreateSchemaMetadata	Metadata for Create Schema LRO.
CreateSchemaMetadata.Builder	Metadata for Create Schema LRO.
CreateSchemaRequest	Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] method.
CreateSchemaRequest.Builder	Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] method.
CustomAttribute	A custom attribute that is not explicitly modeled in a resource, e.g.
CustomAttribute.Builder	A custom attribute that is not explicitly modeled in a resource, e.g.
DataStoreName
DataStoreName.Builder	Builder for projects/{project}/locations/{location}/dataStores/{data_store}.
DataStoreName.ProjectLocationCollectionDataStoreBuilder	Builder for projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.
DeleteConversationRequest	Request for DeleteConversation method.
DeleteConversationRequest.Builder	Request for DeleteConversation method.
DeleteDocumentRequest	Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] method.
DeleteDocumentRequest.Builder	Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] method.
DeleteSchemaMetadata	Metadata for DeleteSchema LRO.
DeleteSchemaMetadata.Builder	Metadata for DeleteSchema LRO.
DeleteSchemaRequest	Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] method.
DeleteSchemaRequest.Builder	Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] method.
Document	Document captures all raw metadata information of items to be recommended or searched.
Document.Builder	Document captures all raw metadata information of items to be recommended or searched.
Document.Content	Unstructured data linked to this document.
Document.Content.Builder	Unstructured data linked to this document.
DocumentInfo	Detailed document information associated with a user event.
DocumentInfo.Builder	Detailed document information associated with a user event.
DocumentName
DocumentName.Builder	Builder for projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}.
DocumentName.ProjectLocationCollectionDataStoreBranchDocumentBuilder	Builder for projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.
DocumentProto
DocumentServiceProto
DoubleList	Double list.
DoubleList.Builder	Double list.
GcsSource	Cloud Storage location for input content.
GcsSource.Builder	Cloud Storage location for input content.
GetConversationRequest	Request for GetConversation method.
GetConversationRequest.Builder	Request for GetConversation method.
GetDocumentRequest	Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] method.
GetDocumentRequest.Builder	Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] method.
GetSchemaRequest	Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] method.
GetSchemaRequest.Builder	Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] method.
ImportConfigProto
ImportDocumentsMetadata	Metadata related to the progress of the ImportDocuments operation.
ImportDocumentsMetadata.Builder	Metadata related to the progress of the ImportDocuments operation.
ImportDocumentsRequest	Request message for Import methods.
ImportDocumentsRequest.Builder	Request message for Import methods.
ImportDocumentsRequest.InlineSource	The inline source for the input config for ImportDocuments method.
ImportDocumentsRequest.InlineSource.Builder	The inline source for the input config for ImportDocuments method.
ImportDocumentsResponse	Response of the [ImportDocumentsRequest][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest].
ImportDocumentsResponse.Builder	Response of the [ImportDocumentsRequest][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest].
ImportErrorConfig	Configuration of destination for Import related errors.
ImportErrorConfig.Builder	Configuration of destination for Import related errors.
ImportUserEventsMetadata	Metadata related to the progress of the Import operation.
ImportUserEventsMetadata.Builder	Metadata related to the progress of the Import operation.
ImportUserEventsRequest	Request message for the ImportUserEvents request.
ImportUserEventsRequest.Builder	Request message for the ImportUserEvents request.
ImportUserEventsRequest.InlineSource	The inline source for the input config for ImportUserEvents method.
ImportUserEventsRequest.InlineSource.Builder	The inline source for the input config for ImportUserEvents method.
ImportUserEventsResponse	Response of the ImportUserEventsRequest.
ImportUserEventsResponse.Builder	Response of the ImportUserEventsRequest.
Interval	A floating point interval.
Interval.Builder	A floating point interval.
ListConversationsRequest	Request for ListConversations method.
ListConversationsRequest.Builder	Request for ListConversations method.
ListConversationsResponse	Response for ListConversations method.
ListConversationsResponse.Builder	Response for ListConversations method.
ListDocumentsRequest	Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.
ListDocumentsRequest.Builder	Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.
ListDocumentsResponse	Response message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.
ListDocumentsResponse.Builder	Response message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] method.
ListSchemasRequest	Request message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.
ListSchemasRequest.Builder	Request message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.
ListSchemasResponse	Response message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.
ListSchemasResponse.Builder	Response message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] method.
MediaInfo	Media-specific user event information.
MediaInfo.Builder	Media-specific user event information.
PageInfo	Detailed page information.
PageInfo.Builder	Detailed page information.
PanelInfo	Detailed panel information associated with a user event.
PanelInfo.Builder	Detailed panel information associated with a user event.
PurgeConfigProto
PurgeDocumentsMetadata	Metadata related to the progress of the PurgeDocuments operation.
PurgeDocumentsMetadata.Builder	Metadata related to the progress of the PurgeDocuments operation.
PurgeDocumentsRequest	Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.
PurgeDocumentsRequest.Builder	Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.
PurgeDocumentsResponse	Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.
PurgeDocumentsResponse.Builder	Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.
RecommendationServiceProto
RecommendRequest	Request message for Recommend method.
RecommendRequest.Builder	Request message for Recommend method.
RecommendResponse	Response message for Recommend method.
RecommendResponse.Builder	Response message for Recommend method.
RecommendResponse.RecommendationResult	RecommendationResult represents a generic recommendation result with associated metadata.
RecommendResponse.RecommendationResult.Builder	RecommendationResult represents a generic recommendation result with associated metadata.
Reply	Defines a reply message to user.
Reply.Builder	Defines a reply message to user.
Reply.Reference	Deprecated
Reply.Reference.Builder	Defines reference in reply.
Schema	Defines the structure and layout of a type of document data.
Schema.Builder	Defines the structure and layout of a type of document data.
SchemaName
SchemaName.Builder	Builder for projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}.
SchemaName.ProjectLocationCollectionDataStoreSchemaBuilder	Builder for projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.
SchemaProto
SchemaServiceProto
SearchInfo	Detailed search information.
SearchInfo.Builder	Detailed search information.
SearchRequest	Request message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
SearchRequest.BoostSpec	Boost specification to boost certain documents.
SearchRequest.BoostSpec.Builder	Boost specification to boost certain documents.
SearchRequest.BoostSpec.ConditionBoostSpec	Boost applies to documents which match a condition.
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	Boost applies to documents which match a condition.
SearchRequest.Builder	Request message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
SearchRequest.ContentSearchSpec	A specification for configuring the behavior of content search.
SearchRequest.ContentSearchSpec.Builder	A specification for configuring the behavior of content search.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec	A specification for configuring the extractive content in a search response.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	A specification for configuring the extractive content in a search response.
SearchRequest.ContentSearchSpec.SnippetSpec	A specification for configuring snippets in a search response.
SearchRequest.ContentSearchSpec.SnippetSpec.Builder	A specification for configuring snippets in a search response.
SearchRequest.ContentSearchSpec.SummarySpec	A specification for configuring a summary returned in a search response.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	A specification for configuring a summary returned in a search response.
SearchRequest.EmbeddingSpec	The specification that uses customized query embedding vector to do semantic document retrieval.
SearchRequest.EmbeddingSpec.Builder	The specification that uses customized query embedding vector to do semantic document retrieval.
SearchRequest.EmbeddingSpec.EmbeddingVector	Embedding vector.
SearchRequest.EmbeddingSpec.EmbeddingVector.Builder	Embedding vector.
SearchRequest.FacetSpec	A facet specification to perform faceted search.
SearchRequest.FacetSpec.Builder	A facet specification to perform faceted search.
SearchRequest.FacetSpec.FacetKey	Specifies how a facet is computed.
SearchRequest.FacetSpec.FacetKey.Builder	Specifies how a facet is computed.
SearchRequest.ImageQuery	Specifies the image query input.
SearchRequest.ImageQuery.Builder	Specifies the image query input.
SearchRequest.QueryExpansionSpec	Specification to determine under which conditions query expansion should occur.
SearchRequest.QueryExpansionSpec.Builder	Specification to determine under which conditions query expansion should occur.
SearchRequest.SpellCorrectionSpec	The specification for query spell correction.
SearchRequest.SpellCorrectionSpec.Builder	The specification for query spell correction.
SearchResponse	Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
SearchResponse.Builder	Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
SearchResponse.Facet	A facet result.
SearchResponse.Facet.Builder	A facet result.
SearchResponse.Facet.FacetValue	A facet value which contains value names and their count.
SearchResponse.Facet.FacetValue.Builder	A facet value which contains value names and their count.
SearchResponse.GuidedSearchResult	Guided search result.
SearchResponse.GuidedSearchResult.Builder	Guided search result.
SearchResponse.GuidedSearchResult.RefinementAttribute	Useful attribute for search result refinements.
SearchResponse.GuidedSearchResult.RefinementAttribute.Builder	Useful attribute for search result refinements.
SearchResponse.QueryExpansionInfo	Information describing query expansion including whether expansion has occurred.
SearchResponse.QueryExpansionInfo.Builder	Information describing query expansion including whether expansion has occurred.
SearchResponse.SearchResult	Represents the search results.
SearchResponse.SearchResult.Builder	Represents the search results.
SearchResponse.Summary	Summary of the top N search result specified by the summary spec.
SearchResponse.Summary.Builder	Summary of the top N search result specified by the summary spec.
SearchResponse.Summary.SafetyAttributes	Safety Attribute categories and their associated confidence scores.
SearchResponse.Summary.SafetyAttributes.Builder	Safety Attribute categories and their associated confidence scores.
SearchServiceProto
ServingConfigName
ServingConfigName.Builder	Builder for projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}.
ServingConfigName.ProjectLocationCollectionDataStoreServingConfigBuilder	Builder for projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}.
TextInput	Defines text input.
TextInput.Builder	Defines text input.
TransactionInfo	A transaction represents the entire purchase transaction.
TransactionInfo.Builder	A transaction represents the entire purchase transaction.
UpdateConversationRequest	Request for UpdateConversation method.
UpdateConversationRequest.Builder	Request for UpdateConversation method.
UpdateDocumentRequest	Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] method.
UpdateDocumentRequest.Builder	Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] method.
UpdateSchemaMetadata	Metadata for UpdateSchema LRO.
UpdateSchemaMetadata.Builder	Metadata for UpdateSchema LRO.
UpdateSchemaRequest	Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] method.
UpdateSchemaRequest.Builder	Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] method.
UserEvent	UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
UserEvent.Builder	UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
UserEventProto
UserEventServiceProto
UserInfo	Information of an end user.
UserInfo.Builder	Information of an end user.
WriteUserEventRequest	Request message for WriteUserEvent method.
WriteUserEventRequest.Builder	Request message for WriteUserEvent method.

Enum Summary

Enum	Description
BigQuerySource.PartitionCase
Conversation.State	Enumeration of the state of the conversation.
ConversationMessage.MessageCase
Document.Content.ContentCase
Document.DataCase
DocumentInfo.DocumentDescriptorCase
ImportDocumentsRequest.ReconciliationMode	Indicates how imported documents are reconciled with the existing documents created or imported before.
ImportDocumentsRequest.SourceCase
ImportErrorConfig.DestinationCase
ImportUserEventsRequest.SourceCase
Interval.MaxCase
Interval.MinCase
Schema.SchemaCase
SearchRequest.ImageQuery.ImageCase
SearchRequest.QueryExpansionSpec.Condition	Enum describing under which condition query expansion should occur.
SearchRequest.SpellCorrectionSpec.Mode	Enum describing under which mode spell correction should occur.
SearchResponse.Facet.FacetValue.FacetValueCase
SearchResponse.Summary.SummarySkippedReason	An Enum for summary-skipped reasons.