Package com.google.cloud.retail.v2alpha

Class ConversationalSearchServiceClient

java.lang.Object
com.google.cloud.retail.v2alpha.ConversationalSearchServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class ConversationalSearchServiceClient extends Object implements BackgroundResource
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())
           .putAllUserLabels(new HashMap<String, String>())
           .addAllSafetySettings(new ArrayList<SafetySetting>())
           .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.

  • Constructor Details

    • ConversationalSearchServiceClient

      protected ConversationalSearchServiceClient(ConversationalSearchServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • ConversationalSearchServiceClient

      protected ConversationalSearchServiceClient(ConversationalSearchServiceStub stub)

  • Method Details

    • create

      public static final ConversationalSearchServiceClient create() throws IOException
      Constructs an instance of ConversationalSearchServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final ConversationalSearchServiceClient create(ConversationalSearchServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final ConversationalSearchServiceSettings getSettings()

    • getStub

      public ConversationalSearchServiceStub getStub()

    • 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())
           .putAllUserLabels(new HashMap<String, String>())
           .addAllSafetySettings(new ArrayList<SafetySetting>())
           .build();
   ServerStream<ConversationalSearchResponse> stream =
       conversationalSearchServiceClient.conversationalSearchCallable().call(request);
   for (ConversationalSearchResponse response : stream) {
     // Do something when a response is received.
   }
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException