Class ConversationalSearchServiceClient (2.64.0)

GitHub RepositoryProduct Reference

Service Description: Service for retail conversational search.

This feature is only available for users who have Retail Conversational Search enabled. Enable Retail Conversational Search on Cloud Console before using this feature.

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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ConversationalSearchRequest request =
       ConversationalSearchRequest.newBuilder()
           .setPlacement("placement1792938725")
           .setBranch(
               BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
           .setQuery("query107944136")
           .addAllPageCategories(new ArrayList<String>())
           .setConversationId("conversationId-1676095234")
           .setSearchParams(ConversationalSearchRequest.SearchParams.newBuilder().build())
           .setVisitorId("visitorId1880545833")
           .setUserInfo(UserInfo.newBuilder().build())
           .setConversationalFilteringSpec(
               ConversationalSearchRequest.ConversationalFilteringSpec.newBuilder().build())
           .build();
   ServerStream<ConversationalSearchResponse> stream =
       conversationalSearchServiceClient.conversationalSearchCallable().call(request);
   for (ConversationalSearchResponse response : stream) {
     // Do something when a response is received.
   }
 }

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

Methods
Method Description Method Variants

ConversationalSearch

Performs a conversational search.

This feature is only available for users who have Conversational Search enabled.

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • conversationalSearchCallable()

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 ConversationalSearchServiceSettings 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
 ConversationalSearchServiceSettings conversationalSearchServiceSettings =
     ConversationalSearchServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create(conversationalSearchServiceSettings);

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
 ConversationalSearchServiceSettings conversationalSearchServiceSettings =
     ConversationalSearchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create(conversationalSearchServiceSettings);

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
 ConversationalSearchServiceSettings conversationalSearchServiceSettings =
     ConversationalSearchServiceSettings.newHttpJsonBuilder().build();
 ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create(conversationalSearchServiceSettings);

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

Inheritance

java.lang.Object > ConversationalSearchServiceClient

Static Methods

create()

public static final ConversationalSearchServiceClient create()

Constructs an instance of ConversationalSearchServiceClient with default settings.

Returns
Type Description
ConversationalSearchServiceClient
Exceptions
Type Description
IOException

create(ConversationalSearchServiceSettings settings)

public static final ConversationalSearchServiceClient create(ConversationalSearchServiceSettings settings)

Constructs an instance of ConversationalSearchServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings ConversationalSearchServiceSettings
Returns
Type Description
ConversationalSearchServiceClient
Exceptions
Type Description
IOException

create(ConversationalSearchServiceStub stub)

public static final ConversationalSearchServiceClient create(ConversationalSearchServiceStub stub)

Constructs an instance of ConversationalSearchServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConversationalSearchServiceSettings).

Parameter
Name Description
stub ConversationalSearchServiceStub
Returns
Type Description
ConversationalSearchServiceClient

Constructors

ConversationalSearchServiceClient(ConversationalSearchServiceSettings settings)

protected ConversationalSearchServiceClient(ConversationalSearchServiceSettings settings)

Constructs an instance of ConversationalSearchServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings ConversationalSearchServiceSettings

ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)

protected ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)
Parameter
Name Description
stub ConversationalSearchServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

conversationalSearchCallable()

public final ServerStreamingCallable<ConversationalSearchRequest,ConversationalSearchResponse> conversationalSearchCallable()

Performs a conversational search.

This feature is only available for users who have Conversational Search enabled.

Sample code:


 // 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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
     ConversationalSearchServiceClient.create()) {
   ConversationalSearchRequest request =
       ConversationalSearchRequest.newBuilder()
           .setPlacement("placement1792938725")
           .setBranch(
               BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
           .setQuery("query107944136")
           .addAllPageCategories(new ArrayList<String>())
           .setConversationId("conversationId-1676095234")
           .setSearchParams(ConversationalSearchRequest.SearchParams.newBuilder().build())
           .setVisitorId("visitorId1880545833")
           .setUserInfo(UserInfo.newBuilder().build())
           .setConversationalFilteringSpec(
               ConversationalSearchRequest.ConversationalFilteringSpec.newBuilder().build())
           .build();
   ServerStream<ConversationalSearchResponse> stream =
       conversationalSearchServiceClient.conversationalSearchCallable().call(request);
   for (ConversationalSearchResponse response : stream) {
     // Do something when a response is received.
   }
 }
Returns
Type Description
ServerStreamingCallable<ConversationalSearchRequest,ConversationalSearchResponse>

getSettings()

public final ConversationalSearchServiceSettings getSettings()
Returns
Type Description
ConversationalSearchServiceSettings

getStub()

public ConversationalSearchServiceStub getStub()
Returns
Type Description
ConversationalSearchServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()