Package com.google.cloud.discoveryengine.v1beta (0.26.0)

GitHub Repository

This package is not the latest GA version!

For this library, we recommend using the package associated with API version v1 for new applications.

Prerelease Implications

This package is a prerelease version! Use with caution. Prerelease versions are considered unstable as they may be shut down. You can read more about Cloud API versioning strategy here. Each Cloud Java client library may contain multiple packages. Each package containing a version number in its name corresponds to a published version of the service. We recommend using the latest stable version for new production applications, which can be identified by the largest numeric version that does not contain a suffix. For example, if a client library has two packages: v1 and v2alpha, then the latest stable version is v1. If you use an unstable release, breaking changes may be introduced when upgrading.

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.discoveryengine.v1beta.CompletionServiceClient Service Description: Service for Auto-Completion.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.discoveryengine.v1beta.ConversationalSearchServiceClient Service Description: Service for conversational search.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.discoveryengine.v1beta.DocumentServiceClient Service Description: Service for ingesting Document information of the customer's website.

This class provides the ability to make remote calls to the backing service through method

com.google.cloud.discoveryengine.v1beta.RecommendationServiceClient Service Description: Service for making recommendations.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.discoveryengine.v1beta.SchemaServiceClient Service Description: Service for managing Schemas.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.discoveryengine.v1beta.SearchServiceClient Service Description: Service for search.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.discoveryengine.v1beta.UserEventServiceClient Service Description: Service for ingesting end user actions on a website to Discovery Engine API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.discoveryengine.v1beta.CompletionServiceSettings Settings class to configure an instance of CompletionServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.discoveryengine.v1beta.ConversationalSearchServiceSettings Settings class to configure an instance of ConversationalSearchServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.discoveryengine.v1beta.DocumentServiceSettings Settings class to configure an instance of DocumentServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.discoveryengine.v1beta.RecommendationServiceSettings Settings class to configure an instance of RecommendationServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.discoveryengine.v1beta.SchemaServiceSettings Settings class to configure an instance of SchemaServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.discoveryengine.v1beta.SearchServiceSettings Settings class to configure an instance of SearchServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.discoveryengine.v1beta.UserEventServiceSettings Settings class to configure an instance of UserEventServiceClient.

The default instance has everything set to sensible defaults:

Classes

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

Interfaces

Interface Description
com.google.cloud.discoveryengine.v1beta.BigQuerySourceOrBuilder
com.google.cloud.discoveryengine.v1beta.CollectUserEventRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.CompleteQueryRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestionOrBuilder
com.google.cloud.discoveryengine.v1beta.CompleteQueryResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.CompletionInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.CompletionServiceGrpc.AsyncService Service for Auto-Completion.
com.google.cloud.discoveryengine.v1beta.ConversationContextOrBuilder
com.google.cloud.discoveryengine.v1beta.ConversationMessageOrBuilder
com.google.cloud.discoveryengine.v1beta.ConversationOrBuilder
com.google.cloud.discoveryengine.v1beta.ConversationalSearchServiceGrpc.AsyncService Service for conversational search.
com.google.cloud.discoveryengine.v1beta.ConverseConversationRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.ConverseConversationResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.CreateConversationRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.CreateDocumentRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.CreateSchemaMetadataOrBuilder
com.google.cloud.discoveryengine.v1beta.CreateSchemaRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.CustomAttributeOrBuilder
com.google.cloud.discoveryengine.v1beta.DeleteConversationRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.DeleteDocumentRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.DeleteSchemaMetadataOrBuilder
com.google.cloud.discoveryengine.v1beta.DeleteSchemaRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.Document.ContentOrBuilder
com.google.cloud.discoveryengine.v1beta.DocumentInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.DocumentOrBuilder
com.google.cloud.discoveryengine.v1beta.DocumentServiceGrpc.AsyncService Service for ingesting Document information of the customer's website.
com.google.cloud.discoveryengine.v1beta.DoubleListOrBuilder
com.google.cloud.discoveryengine.v1beta.GcsSourceOrBuilder
com.google.cloud.discoveryengine.v1beta.GetConversationRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.GetDocumentRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.GetSchemaRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportDocumentsMetadataOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSourceOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportDocumentsRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportDocumentsResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportErrorConfigOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportUserEventsMetadataOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportUserEventsRequest.InlineSourceOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportUserEventsRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.ImportUserEventsResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.IntervalOrBuilder
com.google.cloud.discoveryengine.v1beta.ListConversationsRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.ListConversationsResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.ListDocumentsRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.ListDocumentsResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.ListSchemasRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.ListSchemasResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.MediaInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.PageInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.PanelInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadataOrBuilder
com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.RecommendRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResultOrBuilder
com.google.cloud.discoveryengine.v1beta.RecommendResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.RecommendationServiceGrpc.AsyncService Service for making recommendations.
com.google.cloud.discoveryengine.v1beta.Reply.ReferenceOrBuilder
com.google.cloud.discoveryengine.v1beta.ReplyOrBuilder
com.google.cloud.discoveryengine.v1beta.SchemaOrBuilder
com.google.cloud.discoveryengine.v1beta.SchemaServiceGrpc.AsyncService Service for managing Schemas.
com.google.cloud.discoveryengine.v1beta.SearchInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVectorOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKeyOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.ImageQueryOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpecOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValueOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponse.FacetOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttributeOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResultOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResultOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributesOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponse.SummaryOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchResponseOrBuilder
com.google.cloud.discoveryengine.v1beta.SearchServiceGrpc.AsyncService Service for search.
com.google.cloud.discoveryengine.v1beta.TextInputOrBuilder
com.google.cloud.discoveryengine.v1beta.TransactionInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.UpdateConversationRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.UpdateDocumentRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.UpdateSchemaMetadataOrBuilder
com.google.cloud.discoveryengine.v1beta.UpdateSchemaRequestOrBuilder
com.google.cloud.discoveryengine.v1beta.UserEventOrBuilder
com.google.cloud.discoveryengine.v1beta.UserEventServiceGrpc.AsyncService Service for ingesting end user actions on a website to Discovery Engine API.
com.google.cloud.discoveryengine.v1beta.UserInfoOrBuilder
com.google.cloud.discoveryengine.v1beta.WriteUserEventRequestOrBuilder

Enums

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