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

A client to Discovery Engine API

The interfaces provided are listed below, along with usage samples.

CompletionServiceClient

Service Description: Service for Auto-Completion.

Sample for CompletionServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
   CompleteQueryRequest request =
       CompleteQueryRequest.newBuilder()
           .setDataStore(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setQuery("query107944136")
           .setQueryModel("queryModel-184930495")
           .setUserPseudoId("userPseudoId-1155274652")
           .build();
   CompleteQueryResponse response = completionServiceClient.completeQuery(request);
 }

DocumentServiceClient

Service Description: Service for ingesting Document information of the customer's website.

Sample for DocumentServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DocumentName name =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
   Document response = documentServiceClient.getDocument(name);
 }

RecommendationServiceClient

Service Description: Service for making recommendations.

Sample for RecommendationServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create()) {
   RecommendRequest request =
       RecommendRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .setPageSize(883849137)
           .setFilter("filter-1274492040")
           .setValidateOnly(true)
           .putAllParams(new HashMap<String, Value>())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   RecommendResponse response = recommendationServiceClient.recommend(request);
 }

SchemaServiceClient

Service Description: Service for managing Schemas.

Sample for SchemaServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name =
       SchemaName.ofProjectLocationDataStoreSchemaName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]");
   Schema response = schemaServiceClient.getSchema(name);
 }

SearchServiceClient

Service Description: Service for search.

Sample for SearchServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setBranch(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setUserInfo(UserInfo.newBuilder().build())
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .putAllParams(new HashMap<String, Value>())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setUserPseudoId("userPseudoId-1155274652")
           .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
           .setSafeSearch(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

UserEventServiceClient

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

Sample for UserEventServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   WriteUserEventRequest request =
       WriteUserEventRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .build();
   UserEvent response = userEventServiceClient.writeUserEvent(request);
 }

Classes

BigQuerySource

BigQuery source import data from.

Protobuf type google.cloud.discoveryengine.v1beta.BigQuerySource

BigQuerySource.Builder

BigQuery source import data from.

Protobuf type google.cloud.discoveryengine.v1beta.BigQuerySource

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.

Protobuf type google.cloud.discoveryengine.v1beta.CollectUserEventRequest

CollectUserEventRequest.Builder

Request message for CollectUserEvent method.

Protobuf type google.cloud.discoveryengine.v1beta.CollectUserEventRequest

CompleteQueryRequest

Request message for CompletionService.CompleteQuery method.

Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryRequest

CompleteQueryRequest.Builder

Request message for CompletionService.CompleteQuery method.

Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryRequest

CompleteQueryResponse

Response message for CompletionService.CompleteQuery method.

Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryResponse

CompleteQueryResponse.Builder

Response message for CompletionService.CompleteQuery method.

Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryResponse

CompleteQueryResponse.QuerySuggestion

Suggestions as search queries.

Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestion

CompleteQueryResponse.QuerySuggestion.Builder

Suggestions as search queries.

Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestion

CompletionInfo

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

Protobuf type google.cloud.discoveryengine.v1beta.CompletionInfo

CompletionInfo.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.CompletionInfo

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
   CompleteQueryRequest request =
       CompleteQueryRequest.newBuilder()
           .setDataStore(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setQuery("query107944136")
           .setQueryModel("queryModel-184930495")
           .setUserPseudoId("userPseudoId-1155274652")
           .build();
   CompleteQueryResponse response = completionServiceClient.completeQuery(request);
 }

Note: close() needs to be called on the CompletionServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CompletionServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CompletionServiceSettings completionServiceSettings =
     CompletionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CompletionServiceClient completionServiceClient =
     CompletionServiceClient.create(completionServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CompletionServiceSettings completionServiceSettings =
     CompletionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CompletionServiceClient completionServiceClient =
     CompletionServiceClient.create(completionServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CompletionServiceSettings completionServiceSettings =
     CompletionServiceSettings.newHttpJsonBuilder().build();
 CompletionServiceClient completionServiceClient =
     CompletionServiceClient.create(completionServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

CompletionServiceGrpc

Service for Auto-Completion.

CompletionServiceGrpc.CompletionServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service CompletionService.

Service for Auto-Completion.

CompletionServiceGrpc.CompletionServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service CompletionService.

Service for Auto-Completion.

CompletionServiceGrpc.CompletionServiceImplBase

Base class for the server implementation of the service CompletionService.

Service for Auto-Completion.

CompletionServiceGrpc.CompletionServiceStub

A stub to allow clients to do asynchronous rpc calls to service CompletionService.

Service for Auto-Completion.

CompletionServiceProto

CompletionServiceSettings

Settings class to configure an instance of CompletionServiceClient.

The default instance has everything set to sensible defaults:

The default service address (discoveryengine.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of completeQuery to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CompletionServiceSettings.Builder completionServiceSettingsBuilder =
     CompletionServiceSettings.newBuilder();
 completionServiceSettingsBuilder
     .completeQuerySettings()
     .setRetrySettings(
         completionServiceSettingsBuilder
             .completeQuerySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CompletionServiceSettings completionServiceSettings = completionServiceSettingsBuilder.build();

CompletionServiceSettings.Builder

Builder for CompletionServiceSettings.

CreateDocumentRequest

Request message for DocumentService.CreateDocument method.

Protobuf type google.cloud.discoveryengine.v1beta.CreateDocumentRequest

CreateDocumentRequest.Builder

Request message for DocumentService.CreateDocument method.

Protobuf type google.cloud.discoveryengine.v1beta.CreateDocumentRequest

CreateSchemaMetadata

Metadata for Create Schema LRO.

Protobuf type google.cloud.discoveryengine.v1beta.CreateSchemaMetadata

CreateSchemaMetadata.Builder

Metadata for Create Schema LRO.

Protobuf type google.cloud.discoveryengine.v1beta.CreateSchemaMetadata

CreateSchemaRequest

Request message for SchemaService.CreateSchema method.

Protobuf type google.cloud.discoveryengine.v1beta.CreateSchemaRequest

CreateSchemaRequest.Builder

Request message for SchemaService.CreateSchema method.

Protobuf type google.cloud.discoveryengine.v1beta.CreateSchemaRequest

CustomAttribute

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

Protobuf type google.cloud.discoveryengine.v1beta.CustomAttribute

CustomAttribute.Builder

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

Protobuf type google.cloud.discoveryengine.v1beta.CustomAttribute

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

DeleteDocumentRequest

Request message for DocumentService.DeleteDocument method.

Protobuf type google.cloud.discoveryengine.v1beta.DeleteDocumentRequest

DeleteDocumentRequest.Builder

Request message for DocumentService.DeleteDocument method.

Protobuf type google.cloud.discoveryengine.v1beta.DeleteDocumentRequest

DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

Protobuf type google.cloud.discoveryengine.v1beta.DeleteSchemaMetadata

DeleteSchemaMetadata.Builder

Metadata for DeleteSchema LRO.

Protobuf type google.cloud.discoveryengine.v1beta.DeleteSchemaMetadata

DeleteSchemaRequest

Request message for SchemaService.DeleteSchema method.

Protobuf type google.cloud.discoveryengine.v1beta.DeleteSchemaRequest

DeleteSchemaRequest.Builder

Request message for SchemaService.DeleteSchema method.

Protobuf type google.cloud.discoveryengine.v1beta.DeleteSchemaRequest

Document

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

Protobuf type google.cloud.discoveryengine.v1beta.Document

Document.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.Document

Document.Content

Unstructured data linked to this document.

Protobuf type google.cloud.discoveryengine.v1beta.Document.Content

Document.Content.Builder

Unstructured data linked to this document.

Protobuf type google.cloud.discoveryengine.v1beta.Document.Content

DocumentInfo

Detailed document information associated with a user event.

Protobuf type google.cloud.discoveryengine.v1beta.DocumentInfo

DocumentInfo.Builder

Detailed document information associated with a user event.

Protobuf type google.cloud.discoveryengine.v1beta.DocumentInfo

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

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 calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DocumentName name =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
   Document response = documentServiceClient.getDocument(name);
 }

Note: close() needs to be called on the DocumentServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of DocumentServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newHttpJsonBuilder().build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DocumentServiceClient.ListDocumentsFixedSizeCollection

DocumentServiceClient.ListDocumentsPage

DocumentServiceClient.ListDocumentsPagedResponse

DocumentServiceGrpc

Service for ingesting Document information of the customer's website.

DocumentServiceGrpc.DocumentServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service DocumentService.

Service for ingesting Document information of the customer's website.

DocumentServiceGrpc.DocumentServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service DocumentService.

Service for ingesting Document information of the customer's website.

DocumentServiceGrpc.DocumentServiceImplBase

Base class for the server implementation of the service DocumentService.

Service for ingesting Document information of the customer's website.

DocumentServiceGrpc.DocumentServiceStub

A stub to allow clients to do asynchronous rpc calls to service DocumentService.

Service for ingesting Document information of the customer's website.

DocumentServiceProto

DocumentServiceSettings

Settings class to configure an instance of DocumentServiceClient.

The default instance has everything set to sensible defaults:

The default service address (discoveryengine.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getDocument to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentServiceSettings.Builder documentServiceSettingsBuilder =
     DocumentServiceSettings.newBuilder();
 documentServiceSettingsBuilder
     .getDocumentSettings()
     .setRetrySettings(
         documentServiceSettingsBuilder
             .getDocumentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DocumentServiceSettings documentServiceSettings = documentServiceSettingsBuilder.build();

DocumentServiceSettings.Builder

Builder for DocumentServiceSettings.

GcsSource

Cloud Storage location for input content.

Protobuf type google.cloud.discoveryengine.v1beta.GcsSource

GcsSource.Builder

Cloud Storage location for input content.

Protobuf type google.cloud.discoveryengine.v1beta.GcsSource

GetDocumentRequest

Request message for DocumentService.GetDocument method.

Protobuf type google.cloud.discoveryengine.v1beta.GetDocumentRequest

GetDocumentRequest.Builder

Request message for DocumentService.GetDocument method.

Protobuf type google.cloud.discoveryengine.v1beta.GetDocumentRequest

GetSchemaRequest

Request message for SchemaService.GetSchema method.

Protobuf type google.cloud.discoveryengine.v1beta.GetSchemaRequest

GetSchemaRequest.Builder

Request message for SchemaService.GetSchema method.

Protobuf type google.cloud.discoveryengine.v1beta.GetSchemaRequest

ImportConfigProto

ImportDocumentsMetadata

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

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata

ImportDocumentsMetadata.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata

ImportDocumentsRequest

Request message for Import methods.

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsRequest

ImportDocumentsRequest.Builder

Request message for Import methods.

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsRequest

ImportDocumentsRequest.InlineSource

The inline source for the input config for ImportDocuments method.

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource

ImportDocumentsRequest.InlineSource.Builder

The inline source for the input config for ImportDocuments method.

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource

ImportDocumentsResponse

Response of the 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.

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsResponse

ImportDocumentsResponse.Builder

Response of the 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.

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsResponse

ImportErrorConfig

Configuration of destination for Import related errors.

Protobuf type google.cloud.discoveryengine.v1beta.ImportErrorConfig

ImportErrorConfig.Builder

Configuration of destination for Import related errors.

Protobuf type google.cloud.discoveryengine.v1beta.ImportErrorConfig

ImportUserEventsMetadata

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

Protobuf type google.cloud.discoveryengine.v1beta.ImportUserEventsMetadata

ImportUserEventsMetadata.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.ImportUserEventsMetadata

ImportUserEventsRequest

Request message for the ImportUserEvents request.

Protobuf type google.cloud.discoveryengine.v1beta.ImportUserEventsRequest

ImportUserEventsRequest.Builder

Request message for the ImportUserEvents request.

Protobuf type google.cloud.discoveryengine.v1beta.ImportUserEventsRequest

ImportUserEventsRequest.InlineSource

The inline source for the input config for ImportUserEvents method.

Protobuf type google.cloud.discoveryengine.v1beta.ImportUserEventsRequest.InlineSource

ImportUserEventsRequest.InlineSource.Builder

The inline source for the input config for ImportUserEvents method.

Protobuf type google.cloud.discoveryengine.v1beta.ImportUserEventsRequest.InlineSource

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.

Protobuf type google.cloud.discoveryengine.v1beta.ImportUserEventsResponse

ImportUserEventsResponse.Builder

Protobuf type google.cloud.discoveryengine.v1beta.ImportUserEventsResponse

Interval

A floating point interval.

Protobuf type google.cloud.discoveryengine.v1beta.Interval

Interval.Builder

A floating point interval.

Protobuf type google.cloud.discoveryengine.v1beta.Interval

ListDocumentsRequest

Request message for DocumentService.ListDocuments method.

Protobuf type google.cloud.discoveryengine.v1beta.ListDocumentsRequest

ListDocumentsRequest.Builder

Request message for DocumentService.ListDocuments method.

Protobuf type google.cloud.discoveryengine.v1beta.ListDocumentsRequest

ListDocumentsResponse

Response message for DocumentService.ListDocuments method.

Protobuf type google.cloud.discoveryengine.v1beta.ListDocumentsResponse

ListDocumentsResponse.Builder

Response message for DocumentService.ListDocuments method.

Protobuf type google.cloud.discoveryengine.v1beta.ListDocumentsResponse

ListSchemasRequest

Request message for SchemaService.ListSchemas method.

Protobuf type google.cloud.discoveryengine.v1beta.ListSchemasRequest

ListSchemasRequest.Builder

Request message for SchemaService.ListSchemas method.

Protobuf type google.cloud.discoveryengine.v1beta.ListSchemasRequest

ListSchemasResponse

Response message for SchemaService.ListSchemas method.

Protobuf type google.cloud.discoveryengine.v1beta.ListSchemasResponse

ListSchemasResponse.Builder

Response message for SchemaService.ListSchemas method.

Protobuf type google.cloud.discoveryengine.v1beta.ListSchemasResponse

MediaInfo

Media-specific user event information.

Protobuf type google.cloud.discoveryengine.v1beta.MediaInfo

MediaInfo.Builder

Media-specific user event information.

Protobuf type google.cloud.discoveryengine.v1beta.MediaInfo

PageInfo

Detailed page information.

Protobuf type google.cloud.discoveryengine.v1beta.PageInfo

PageInfo.Builder

Detailed page information.

Protobuf type google.cloud.discoveryengine.v1beta.PageInfo

PanelInfo

Detailed panel information associated with a user event.

Protobuf type google.cloud.discoveryengine.v1beta.PanelInfo

PanelInfo.Builder

Detailed panel information associated with a user event.

Protobuf type google.cloud.discoveryengine.v1beta.PanelInfo

PurgeConfigProto

PurgeDocumentsMetadata

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

Protobuf type google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata

PurgeDocumentsMetadata.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata

PurgeDocumentsRequest

Request message for DocumentService.PurgeDocuments method.

Protobuf type google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest

PurgeDocumentsRequest.Builder

Request message for DocumentService.PurgeDocuments method.

Protobuf type google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest

PurgeDocumentsResponse

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

Protobuf type google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse

PurgeDocumentsResponse.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse

RecommendRequest

Request message for Recommend method.

Protobuf type google.cloud.discoveryengine.v1beta.RecommendRequest

RecommendRequest.Builder

Request message for Recommend method.

Protobuf type google.cloud.discoveryengine.v1beta.RecommendRequest

RecommendResponse

Response message for Recommend method.

Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse

RecommendResponse.Builder

Response message for Recommend method.

Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse

RecommendResponse.RecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult

RecommendResponse.RecommendationResult.Builder

RecommendationResult represents a generic recommendation result with associated metadata.

Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create()) {
   RecommendRequest request =
       RecommendRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .setPageSize(883849137)
           .setFilter("filter-1274492040")
           .setValidateOnly(true)
           .putAllParams(new HashMap<String, Value>())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   RecommendResponse response = recommendationServiceClient.recommend(request);
 }

Note: close() needs to be called on the RecommendationServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of RecommendationServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RecommendationServiceSettings recommendationServiceSettings =
     RecommendationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create(recommendationServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RecommendationServiceSettings recommendationServiceSettings =
     RecommendationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create(recommendationServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RecommendationServiceSettings recommendationServiceSettings =
     RecommendationServiceSettings.newHttpJsonBuilder().build();
 RecommendationServiceClient recommendationServiceClient =
     RecommendationServiceClient.create(recommendationServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

RecommendationServiceGrpc

Service for making recommendations.

RecommendationServiceGrpc.RecommendationServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service RecommendationService.

Service for making recommendations.

RecommendationServiceGrpc.RecommendationServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service RecommendationService.

Service for making recommendations.

RecommendationServiceGrpc.RecommendationServiceImplBase

Base class for the server implementation of the service RecommendationService.

Service for making recommendations.

RecommendationServiceGrpc.RecommendationServiceStub

A stub to allow clients to do asynchronous rpc calls to service RecommendationService.

Service for making recommendations.

RecommendationServiceProto

RecommendationServiceSettings

Settings class to configure an instance of RecommendationServiceClient.

The default instance has everything set to sensible defaults:

The default service address (discoveryengine.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of recommend to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RecommendationServiceSettings.Builder recommendationServiceSettingsBuilder =
     RecommendationServiceSettings.newBuilder();
 recommendationServiceSettingsBuilder
     .recommendSettings()
     .setRetrySettings(
         recommendationServiceSettingsBuilder
             .recommendSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RecommendationServiceSettings recommendationServiceSettings =
     recommendationServiceSettingsBuilder.build();

RecommendationServiceSettings.Builder

Builder for RecommendationServiceSettings.

Schema

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

Protobuf type google.cloud.discoveryengine.v1beta.Schema

Schema.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.Schema

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

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name =
       SchemaName.ofProjectLocationDataStoreSchemaName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]");
   Schema response = schemaServiceClient.getSchema(name);
 }

Note: close() needs to be called on the SchemaServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of SchemaServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SchemaServiceClient schemaServiceClient = SchemaServiceClient.create(schemaServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SchemaServiceClient schemaServiceClient = SchemaServiceClient.create(schemaServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newHttpJsonBuilder().build();
 SchemaServiceClient schemaServiceClient = SchemaServiceClient.create(schemaServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

SchemaServiceClient.ListSchemasFixedSizeCollection

SchemaServiceClient.ListSchemasPage

SchemaServiceClient.ListSchemasPagedResponse

SchemaServiceGrpc

Service for managing Schemas.

SchemaServiceGrpc.SchemaServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service SchemaService.

Service for managing Schemas.

SchemaServiceGrpc.SchemaServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service SchemaService.

Service for managing Schemas.

SchemaServiceGrpc.SchemaServiceImplBase

Base class for the server implementation of the service SchemaService.

Service for managing Schemas.

SchemaServiceGrpc.SchemaServiceStub

A stub to allow clients to do asynchronous rpc calls to service SchemaService.

Service for managing Schemas.

SchemaServiceProto

SchemaServiceSettings

Settings class to configure an instance of SchemaServiceClient.

The default instance has everything set to sensible defaults:

The default service address (discoveryengine.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getSchema to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SchemaServiceSettings.Builder schemaServiceSettingsBuilder = SchemaServiceSettings.newBuilder();
 schemaServiceSettingsBuilder
     .getSchemaSettings()
     .setRetrySettings(
         schemaServiceSettingsBuilder
             .getSchemaSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SchemaServiceSettings schemaServiceSettings = schemaServiceSettingsBuilder.build();

SchemaServiceSettings.Builder

Builder for SchemaServiceSettings.

SearchInfo

Detailed search information.

Protobuf type google.cloud.discoveryengine.v1beta.SearchInfo

SearchInfo.Builder

Detailed search information.

Protobuf type google.cloud.discoveryengine.v1beta.SearchInfo

SearchRequest

Request message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest

SearchRequest.BoostSpec

Boost specification to boost certain documents.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec

SearchRequest.BoostSpec.Builder

Boost specification to boost certain documents.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec

SearchRequest.BoostSpec.ConditionBoostSpec

Boost applies to documents which match a condition.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec

SearchRequest.BoostSpec.ConditionBoostSpec.Builder

Boost applies to documents which match a condition.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec

SearchRequest.Builder

Request message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest

SearchRequest.ContentSearchSpec

The specification that configs the desired behavior of the UCS content search.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec

SearchRequest.ContentSearchSpec.Builder

The specification that configs the desired behavior of the UCS content search.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec

SearchRequest.ContentSearchSpec.SnippetSpec

The specification that configs the snippet in the search results.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec

SearchRequest.ContentSearchSpec.SnippetSpec.Builder

The specification that configs the snippet in the search results.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec

SearchRequest.ContentSearchSpec.SummarySpec

The specification that configs the summary in the search response.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec

SearchRequest.ContentSearchSpec.SummarySpec.Builder

The specification that configs the summary in the search response.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec

SearchRequest.FacetSpec

A facet specification to perform faceted search.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec

SearchRequest.FacetSpec.Builder

A facet specification to perform faceted search.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec

SearchRequest.FacetSpec.FacetKey

Specifies how a facet is computed.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey

SearchRequest.FacetSpec.FacetKey.Builder

Specifies how a facet is computed.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey

SearchRequest.QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec

SearchRequest.QueryExpansionSpec.Builder

Specification to determine under which conditions query expansion should occur.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec

SearchRequest.SpellCorrectionSpec

The specification for query spell correction.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec

SearchRequest.SpellCorrectionSpec.Builder

The specification for query spell correction.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec

SearchResponse

Response message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse

SearchResponse.Builder

Response message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse

A facet result.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.Facet

A facet result.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.Facet

A facet value which contains value names and their count.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue

A facet value which contains value names and their count.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue

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.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult

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.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult

SearchResponse.GuidedSearchResult.RefinementAttribute

Useful attribute for search result refinements.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute

SearchResponse.GuidedSearchResult.RefinementAttribute.Builder

Useful attribute for search result refinements.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute

SearchResponse.SearchResult

Represents the search results.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult

SearchResponse.SearchResult.Builder

Represents the search results.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult

SearchResponse.Summary

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

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.Summary

SearchResponse.Summary.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.Summary

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setServingConfig(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .setBranch(
               BranchName.ofProjectLocationDataStoreBranchName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
                   .toString())
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOffset(-1019779949)
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setUserInfo(UserInfo.newBuilder().build())
           .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
           .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
           .putAllParams(new HashMap<String, Value>())
           .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
           .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
           .setUserPseudoId("userPseudoId-1155274652")
           .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
           .setSafeSearch(true)
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the SearchServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of SearchServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SearchServiceSettings searchServiceSettings =
     SearchServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SearchServiceSettings searchServiceSettings =
     SearchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SearchServiceSettings searchServiceSettings =
     SearchServiceSettings.newHttpJsonBuilder().build();
 SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

SearchServiceClient.SearchFixedSizeCollection

SearchServiceClient.SearchPage

SearchServiceClient.SearchPagedResponse

SearchServiceGrpc

Service for search.

SearchServiceGrpc.SearchServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service SearchService.

Service for search.

SearchServiceGrpc.SearchServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service SearchService.

Service for search.

SearchServiceGrpc.SearchServiceImplBase

Base class for the server implementation of the service SearchService.

Service for search.

SearchServiceGrpc.SearchServiceStub

A stub to allow clients to do asynchronous rpc calls to service SearchService.

Service for search.

SearchServiceProto

SearchServiceSettings

Settings class to configure an instance of SearchServiceClient.

The default instance has everything set to sensible defaults:

The default service address (discoveryengine.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of search to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SearchServiceSettings.Builder searchServiceSettingsBuilder = SearchServiceSettings.newBuilder();
 searchServiceSettingsBuilder
     .searchSettings()
     .setRetrySettings(
         searchServiceSettingsBuilder
             .searchSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SearchServiceSettings searchServiceSettings = searchServiceSettingsBuilder.build();

SearchServiceSettings.Builder

Builder for SearchServiceSettings.

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

TransactionInfo

A transaction represents the entire purchase transaction.

Protobuf type google.cloud.discoveryengine.v1beta.TransactionInfo

TransactionInfo.Builder

A transaction represents the entire purchase transaction.

Protobuf type google.cloud.discoveryengine.v1beta.TransactionInfo

UpdateDocumentRequest

Request message for DocumentService.UpdateDocument method.

Protobuf type google.cloud.discoveryengine.v1beta.UpdateDocumentRequest

UpdateDocumentRequest.Builder

Request message for DocumentService.UpdateDocument method.

Protobuf type google.cloud.discoveryengine.v1beta.UpdateDocumentRequest

UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

Protobuf type google.cloud.discoveryengine.v1beta.UpdateSchemaMetadata

UpdateSchemaMetadata.Builder

Metadata for UpdateSchema LRO.

Protobuf type google.cloud.discoveryengine.v1beta.UpdateSchemaMetadata

UpdateSchemaRequest

Request message for SchemaService.UpdateSchema method.

Protobuf type google.cloud.discoveryengine.v1beta.UpdateSchemaRequest

UpdateSchemaRequest.Builder

Request message for SchemaService.UpdateSchema method.

Protobuf type google.cloud.discoveryengine.v1beta.UpdateSchemaRequest

UserEvent

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

Protobuf type google.cloud.discoveryengine.v1beta.UserEvent

UserEvent.Builder

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

Protobuf type google.cloud.discoveryengine.v1beta.UserEvent

UserEventProto

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
   WriteUserEventRequest request =
       WriteUserEventRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setUserEvent(UserEvent.newBuilder().build())
           .build();
   UserEvent response = userEventServiceClient.writeUserEvent(request);
 }

Note: close() needs to be called on the UserEventServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of UserEventServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 UserEventServiceSettings userEventServiceSettings =
     UserEventServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UserEventServiceClient userEventServiceClient =
     UserEventServiceClient.create(userEventServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 UserEventServiceSettings userEventServiceSettings =
     UserEventServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 UserEventServiceClient userEventServiceClient =
     UserEventServiceClient.create(userEventServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 UserEventServiceSettings userEventServiceSettings =
     UserEventServiceSettings.newHttpJsonBuilder().build();
 UserEventServiceClient userEventServiceClient =
     UserEventServiceClient.create(userEventServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

UserEventServiceGrpc

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

UserEventServiceGrpc.UserEventServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service UserEventService.

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

UserEventServiceGrpc.UserEventServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service UserEventService.

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

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.

UserEventServiceGrpc.UserEventServiceStub

A stub to allow clients to do asynchronous rpc calls to service UserEventService.

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

UserEventServiceProto

UserEventServiceSettings

Settings class to configure an instance of UserEventServiceClient.

The default instance has everything set to sensible defaults:

The default service address (discoveryengine.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of writeUserEvent to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 UserEventServiceSettings.Builder userEventServiceSettingsBuilder =
     UserEventServiceSettings.newBuilder();
 userEventServiceSettingsBuilder
     .writeUserEventSettings()
     .setRetrySettings(
         userEventServiceSettingsBuilder
             .writeUserEventSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 UserEventServiceSettings userEventServiceSettings = userEventServiceSettingsBuilder.build();