Class ParticipantsClient (4.3.1)

Version 4.3.1

• 4.58.0 (latest)
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public class ParticipantsClient implements BackgroundResource

Service Description: Service for managing Participants.

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:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ConversationName parent =
       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]");
   Participant participant = Participant.newBuilder().build();
   Participant response = participantsClient.createParticipant(parent, participant);
 }
 

Note: close() needs to be called on the ParticipantsClient 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:

1. 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.
2. 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.
3. 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 ParticipantsSettings to create(). For example:

To customize credentials:

 ParticipantsSettings participantsSettings =
     ParticipantsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
 

To customize the endpoint:

 ParticipantsSettings participantsSettings =
     ParticipantsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
 

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

Inheritance

java.lang.Object > ParticipantsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

ParticipantsClient(ParticipantsSettings settings)

protected ParticipantsClient(ParticipantsSettings settings)

Constructs an instance of ParticipantsClient, 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	ParticipantsSettings

ParticipantsClient(ParticipantsStub stub)

protected ParticipantsClient(ParticipantsStub stub)

Parameter

Name	Description
stub	ParticipantsStub

Methods

analyzeContent(AnalyzeContentRequest request)

public final AnalyzeContentResponse analyzeContent(AnalyzeContentRequest request)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   AnalyzeContentRequest request =
       AnalyzeContentRequest.newBuilder()
           .setParticipant(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .setReplyAudioConfig(OutputAudioConfig.newBuilder().build())
           .setQueryParams(QueryParameters.newBuilder().build())
           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
           .setMessageSendTime(Timestamp.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   AnalyzeContentResponse response = participantsClient.analyzeContent(request);
 }
 

Parameter

Name	Description
request	AnalyzeContentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
AnalyzeContentResponse

analyzeContent(ParticipantName participant, EventInput eventInput)

public final AnalyzeContentResponse analyzeContent(ParticipantName participant, EventInput eventInput)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ParticipantName participant =
       ParticipantName.ofProjectConversationParticipantName(
           "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
   EventInput eventInput = EventInput.newBuilder().build();
   AnalyzeContentResponse response = participantsClient.analyzeContent(participant, eventInput);
 }
 

Parameters

Name	Description
participant	ParticipantName Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.
eventInput	EventInput An input event to send to Dialogflow.

Returns

Type	Description
AnalyzeContentResponse

analyzeContent(ParticipantName participant, TextInput textInput)

public final AnalyzeContentResponse analyzeContent(ParticipantName participant, TextInput textInput)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ParticipantName participant =
       ParticipantName.ofProjectConversationParticipantName(
           "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
   TextInput textInput = TextInput.newBuilder().build();
   AnalyzeContentResponse response = participantsClient.analyzeContent(participant, textInput);
 }
 

Parameters

Name	Description
participant	ParticipantName Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.
textInput	TextInput The natural language text to be processed.

Returns

Type	Description
AnalyzeContentResponse

analyzeContent(String participant, EventInput eventInput)

public final AnalyzeContentResponse analyzeContent(String participant, EventInput eventInput)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   String participant =
       ParticipantName.ofProjectConversationParticipantName(
               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
           .toString();
   EventInput eventInput = EventInput.newBuilder().build();
   AnalyzeContentResponse response = participantsClient.analyzeContent(participant, eventInput);
 }
 

Parameters

Name	Description
participant	String Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.
eventInput	EventInput An input event to send to Dialogflow.

Returns

Type	Description
AnalyzeContentResponse

analyzeContent(String participant, TextInput textInput)

public final AnalyzeContentResponse analyzeContent(String participant, TextInput textInput)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   String participant =
       ParticipantName.ofProjectConversationParticipantName(
               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
           .toString();
   TextInput textInput = TextInput.newBuilder().build();
   AnalyzeContentResponse response = participantsClient.analyzeContent(participant, textInput);
 }
 

Parameters

Name	Description
participant	String Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.
textInput	TextInput The natural language text to be processed.

Returns

Type	Description
AnalyzeContentResponse

analyzeContentCallable()

public final UnaryCallable<AnalyzeContentRequest,AnalyzeContentResponse> analyzeContentCallable()

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   AnalyzeContentRequest request =
       AnalyzeContentRequest.newBuilder()
           .setParticipant(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .setReplyAudioConfig(OutputAudioConfig.newBuilder().build())
           .setQueryParams(QueryParameters.newBuilder().build())
           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
           .setMessageSendTime(Timestamp.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<AnalyzeContentRequest,AnalyzeContentResponse>

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

compileSuggestion(CompileSuggestionRequest request) (deprecated)

public final CompileSuggestionResponse compileSuggestion(CompileSuggestionRequest request)

(deprecated) This method is deprecated and will be removed in the next major version update.

Deprecated. use SuggestArticles and SuggestFaqAnswers instead.

Gets suggestions for a participant based on specific historical messages.

Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   CompileSuggestionRequest request =
       CompileSuggestionRequest.newBuilder()
           .setParent("parent-995424086")
           .setLatestMessage("latestMessage-1424305536")
           .setContextSize(1116903569)
           .build();
   CompileSuggestionResponse response = participantsClient.compileSuggestion(request);
 }
 

Parameter

Name	Description
request	CompileSuggestionRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CompileSuggestionResponse

compileSuggestionCallable() (deprecated)

public final UnaryCallable<CompileSuggestionRequest,CompileSuggestionResponse> compileSuggestionCallable()

(deprecated) This method is deprecated and will be removed in the next major version update.

Deprecated. use SuggestArticles and SuggestFaqAnswers instead.

Gets suggestions for a participant based on specific historical messages.

Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   CompileSuggestionRequest request =
       CompileSuggestionRequest.newBuilder()
           .setParent("parent-995424086")
           .setLatestMessage("latestMessage-1424305536")
           .setContextSize(1116903569)
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CompileSuggestionRequest,CompileSuggestionResponse>

create()

public static final ParticipantsClient create()

Constructs an instance of ParticipantsClient with default settings.

Returns

Type	Description
ParticipantsClient

Exceptions

Type	Description
IOException

create(ParticipantsSettings settings)

public static final ParticipantsClient create(ParticipantsSettings settings)

Constructs an instance of ParticipantsClient, 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	ParticipantsSettings

Returns

Type	Description
ParticipantsClient

Exceptions

Type	Description
IOException

create(ParticipantsStub stub)

public static final ParticipantsClient create(ParticipantsStub stub)

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

Parameter

Name	Description
stub	ParticipantsStub

Returns

Type	Description
ParticipantsClient

createParticipant(ConversationName parent, Participant participant)

public final Participant createParticipant(ConversationName parent, Participant participant)

Creates a new participant in a conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ConversationName parent =
       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]");
   Participant participant = Participant.newBuilder().build();
   Participant response = participantsClient.createParticipant(parent, participant);
 }
 

Parameters

Name	Description
parent	ConversationName Required. Resource identifier of the conversation adding the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.
participant	Participant Required. The participant to create.

Returns

Type	Description
Participant

createParticipant(CreateParticipantRequest request)

public final Participant createParticipant(CreateParticipantRequest request)

Creates a new participant in a conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   CreateParticipantRequest request =
       CreateParticipantRequest.newBuilder()
           .setParent(
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                   .toString())
           .setParticipant(Participant.newBuilder().build())
           .build();
   Participant response = participantsClient.createParticipant(request);
 }
 

Parameter

Name	Description
request	CreateParticipantRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Participant

createParticipant(String parent, Participant participant)

public final Participant createParticipant(String parent, Participant participant)

Creates a new participant in a conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   String parent =
       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]").toString();
   Participant participant = Participant.newBuilder().build();
   Participant response = participantsClient.createParticipant(parent, participant);
 }
 

Parameters

Name	Description
parent	String Required. Resource identifier of the conversation adding the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.
participant	Participant Required. The participant to create.

Returns

Type	Description
Participant

createParticipantCallable()

public final UnaryCallable<CreateParticipantRequest,Participant> createParticipantCallable()

Creates a new participant in a conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   CreateParticipantRequest request =
       CreateParticipantRequest.newBuilder()
           .setParent(
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                   .toString())
           .setParticipant(Participant.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateParticipantRequest,Participant>

getParticipant(GetParticipantRequest request)

public final Participant getParticipant(GetParticipantRequest request)

Retrieves a conversation participant.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   GetParticipantRequest request =
       GetParticipantRequest.newBuilder()
           .setName(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .build();
   Participant response = participantsClient.getParticipant(request);
 }
 

Parameter

Name	Description
request	GetParticipantRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Participant

getParticipant(ParticipantName name)

public final Participant getParticipant(ParticipantName name)

Retrieves a conversation participant.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ParticipantName name =
       ParticipantName.ofProjectConversationParticipantName(
           "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
   Participant response = participantsClient.getParticipant(name);
 }
 

Parameter

Name	Description
name	ParticipantName Required. The name of the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns

Type	Description
Participant

getParticipant(String name)

public final Participant getParticipant(String name)

Retrieves a conversation participant.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   String name =
       ParticipantName.ofProjectConversationParticipantName(
               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
           .toString();
   Participant response = participantsClient.getParticipant(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns

Type	Description
Participant

getParticipantCallable()

public final UnaryCallable<GetParticipantRequest,Participant> getParticipantCallable()

Retrieves a conversation participant.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   GetParticipantRequest request =
       GetParticipantRequest.newBuilder()
           .setName(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetParticipantRequest,Participant>

getSettings()

public final ParticipantsSettings getSettings()

Returns

Type	Description
ParticipantsSettings

getStub()

public ParticipantsStub getStub()

Returns

Type	Description
ParticipantsStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listParticipants(ConversationName parent)

public final ParticipantsClient.ListParticipantsPagedResponse listParticipants(ConversationName parent)

Returns the list of all participants in the specified conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ConversationName parent =
       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]");
   for (Participant element : participantsClient.listParticipants(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	ConversationName Required. The conversation to list all participants from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

Returns

Type	Description
ParticipantsClient.ListParticipantsPagedResponse

listParticipants(ListParticipantsRequest request)

public final ParticipantsClient.ListParticipantsPagedResponse listParticipants(ListParticipantsRequest request)

Returns the list of all participants in the specified conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ListParticipantsRequest request =
       ListParticipantsRequest.newBuilder()
           .setParent(
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Participant element : participantsClient.listParticipants(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListParticipantsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ParticipantsClient.ListParticipantsPagedResponse

listParticipants(String parent)

public final ParticipantsClient.ListParticipantsPagedResponse listParticipants(String parent)

Returns the list of all participants in the specified conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   String parent =
       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]").toString();
   for (Participant element : participantsClient.listParticipants(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The conversation to list all participants from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

Returns

Type	Description
ParticipantsClient.ListParticipantsPagedResponse

listParticipantsCallable()

public final UnaryCallable<ListParticipantsRequest,ListParticipantsResponse> listParticipantsCallable()

Returns the list of all participants in the specified conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ListParticipantsRequest request =
       ListParticipantsRequest.newBuilder()
           .setParent(
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListParticipantsResponse response =
         participantsClient.listParticipantsCallable().call(request);
     for (Participant element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListParticipantsRequest,ListParticipantsResponse>

listParticipantsPagedCallable()

public final UnaryCallable<ListParticipantsRequest,ParticipantsClient.ListParticipantsPagedResponse> listParticipantsPagedCallable()

Returns the list of all participants in the specified conversation.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ListParticipantsRequest request =
       ListParticipantsRequest.newBuilder()
           .setParent(
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListParticipantsRequest,ListParticipantsPagedResponse>

listSuggestions(ListSuggestionsRequest request) (deprecated)

public final ParticipantsClient.ListSuggestionsPagedResponse listSuggestions(ListSuggestionsRequest request)

(deprecated) This method is deprecated and will be removed in the next major version update.

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01.

Retrieves suggestions for live agents.

This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ListSuggestionsRequest request =
       ListSuggestionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Suggestion element : participantsClient.listSuggestions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListSuggestionsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ParticipantsClient.ListSuggestionsPagedResponse

listSuggestionsCallable() (deprecated)

public final UnaryCallable<ListSuggestionsRequest,ListSuggestionsResponse> listSuggestionsCallable()

(deprecated) This method is deprecated and will be removed in the next major version update.

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01.

Retrieves suggestions for live agents.

This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ListSuggestionsRequest request =
       ListSuggestionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListSuggestionsResponse response =
         participantsClient.listSuggestionsCallable().call(request);
     for (Suggestion element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListSuggestionsRequest,ListSuggestionsResponse>

listSuggestionsPagedCallable() (deprecated)

public final UnaryCallable<ListSuggestionsRequest,ParticipantsClient.ListSuggestionsPagedResponse> listSuggestionsPagedCallable()

(deprecated) This method is deprecated and will be removed in the next major version update.

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01.

Retrieves suggestions for live agents.

This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ListSuggestionsRequest request =
       ListSuggestionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListSuggestionsRequest,ListSuggestionsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

suggestArticles(ParticipantName parent)

public final SuggestArticlesResponse suggestArticles(ParticipantName parent)

Gets suggested articles for a participant based on specific historical messages.

Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ParticipantName parent =
       ParticipantName.ofProjectConversationParticipantName(
           "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
   SuggestArticlesResponse response = participantsClient.suggestArticles(parent);
 }
 

Parameter

Name	Description
parent	ParticipantName Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns

Type	Description
SuggestArticlesResponse

suggestArticles(SuggestArticlesRequest request)

public final SuggestArticlesResponse suggestArticles(SuggestArticlesRequest request)

Gets suggested articles for a participant based on specific historical messages.

Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   SuggestArticlesRequest request =
       SuggestArticlesRequest.newBuilder()
           .setParent(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .setLatestMessage(
               MessageName.ofProjectConversationMessageName(
                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                   .toString())
           .setContextSize(1116903569)
           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
           .build();
   SuggestArticlesResponse response = participantsClient.suggestArticles(request);
 }
 

Parameter

Name	Description
request	SuggestArticlesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
SuggestArticlesResponse

suggestArticles(String parent)

public final SuggestArticlesResponse suggestArticles(String parent)

Gets suggested articles for a participant based on specific historical messages.

Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   String parent =
       ParticipantName.ofProjectConversationParticipantName(
               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
           .toString();
   SuggestArticlesResponse response = participantsClient.suggestArticles(parent);
 }
 

Parameter

Name	Description
parent	String Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns

Type	Description
SuggestArticlesResponse

suggestArticlesCallable()

public final UnaryCallable<SuggestArticlesRequest,SuggestArticlesResponse> suggestArticlesCallable()

Gets suggested articles for a participant based on specific historical messages.

Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   SuggestArticlesRequest request =
       SuggestArticlesRequest.newBuilder()
           .setParent(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .setLatestMessage(
               MessageName.ofProjectConversationMessageName(
                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                   .toString())
           .setContextSize(1116903569)
           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<SuggestArticlesRequest,SuggestArticlesResponse>

suggestFaqAnswers(ParticipantName parent)

public final SuggestFaqAnswersResponse suggestFaqAnswers(ParticipantName parent)

Gets suggested faq answers for a participant based on specific historical messages.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ParticipantName parent =
       ParticipantName.ofProjectConversationParticipantName(
           "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
   SuggestFaqAnswersResponse response = participantsClient.suggestFaqAnswers(parent);
 }
 

Parameter

Name	Description
parent	ParticipantName Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns

Type	Description
SuggestFaqAnswersResponse

suggestFaqAnswers(SuggestFaqAnswersRequest request)

public final SuggestFaqAnswersResponse suggestFaqAnswers(SuggestFaqAnswersRequest request)

Gets suggested faq answers for a participant based on specific historical messages.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   SuggestFaqAnswersRequest request =
       SuggestFaqAnswersRequest.newBuilder()
           .setParent(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .setLatestMessage(
               MessageName.ofProjectConversationMessageName(
                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                   .toString())
           .setContextSize(1116903569)
           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
           .build();
   SuggestFaqAnswersResponse response = participantsClient.suggestFaqAnswers(request);
 }
 

Parameter

Name	Description
request	SuggestFaqAnswersRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
SuggestFaqAnswersResponse

suggestFaqAnswers(String parent)

public final SuggestFaqAnswersResponse suggestFaqAnswers(String parent)

Gets suggested faq answers for a participant based on specific historical messages.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   String parent =
       ParticipantName.ofProjectConversationParticipantName(
               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
           .toString();
   SuggestFaqAnswersResponse response = participantsClient.suggestFaqAnswers(parent);
 }
 

Parameter

Name	Description
parent	String Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns

Type	Description
SuggestFaqAnswersResponse

suggestFaqAnswersCallable()

public final UnaryCallable<SuggestFaqAnswersRequest,SuggestFaqAnswersResponse> suggestFaqAnswersCallable()

Gets suggested faq answers for a participant based on specific historical messages.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   SuggestFaqAnswersRequest request =
       SuggestFaqAnswersRequest.newBuilder()
           .setParent(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .setLatestMessage(
               MessageName.ofProjectConversationMessageName(
                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                   .toString())
           .setContextSize(1116903569)
           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<SuggestFaqAnswersRequest,SuggestFaqAnswersResponse>

suggestSmartReplies(ParticipantName parent)

public final SuggestSmartRepliesResponse suggestSmartReplies(ParticipantName parent)

Gets smart replies for a participant based on specific historical messages.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   ParticipantName parent =
       ParticipantName.ofProjectConversationParticipantName(
           "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
   SuggestSmartRepliesResponse response = participantsClient.suggestSmartReplies(parent);
 }
 

Parameter

Name	Description
parent	ParticipantName Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns

Type	Description
SuggestSmartRepliesResponse

suggestSmartReplies(SuggestSmartRepliesRequest request)

public final SuggestSmartRepliesResponse suggestSmartReplies(SuggestSmartRepliesRequest request)

Gets smart replies for a participant based on specific historical messages.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   SuggestSmartRepliesRequest request =
       SuggestSmartRepliesRequest.newBuilder()
           .setParent(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .setCurrentTextInput(TextInput.newBuilder().build())
           .setLatestMessage(
               MessageName.ofProjectConversationMessageName(
                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                   .toString())
           .setContextSize(1116903569)
           .build();
   SuggestSmartRepliesResponse response = participantsClient.suggestSmartReplies(request);
 }
 

Parameter

Name	Description
request	SuggestSmartRepliesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
SuggestSmartRepliesResponse

suggestSmartReplies(String parent)

public final SuggestSmartRepliesResponse suggestSmartReplies(String parent)

Gets smart replies for a participant based on specific historical messages.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   String parent =
       ParticipantName.ofProjectConversationParticipantName(
               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
           .toString();
   SuggestSmartRepliesResponse response = participantsClient.suggestSmartReplies(parent);
 }
 

Parameter

Name	Description
parent	String Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns

Type	Description
SuggestSmartRepliesResponse

suggestSmartRepliesCallable()

public final UnaryCallable<SuggestSmartRepliesRequest,SuggestSmartRepliesResponse> suggestSmartRepliesCallable()

Gets smart replies for a participant based on specific historical messages.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   SuggestSmartRepliesRequest request =
       SuggestSmartRepliesRequest.newBuilder()
           .setParent(
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString())
           .setCurrentTextInput(TextInput.newBuilder().build())
           .setLatestMessage(
               MessageName.ofProjectConversationMessageName(
                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                   .toString())
           .setContextSize(1116903569)
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<SuggestSmartRepliesRequest,SuggestSmartRepliesResponse>

updateParticipant(Participant participant, FieldMask updateMask)

public final Participant updateParticipant(Participant participant, FieldMask updateMask)

Updates the specified participant.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   Participant participant = Participant.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Participant response = participantsClient.updateParticipant(participant, updateMask);
 }
 

Parameters

Name	Description
participant	Participant Required. The participant to update.
updateMask	FieldMask Required. The mask to specify which fields to update.

Returns

Type	Description
Participant

updateParticipant(UpdateParticipantRequest request)

public final Participant updateParticipant(UpdateParticipantRequest request)

Updates the specified participant.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   UpdateParticipantRequest request =
       UpdateParticipantRequest.newBuilder()
           .setParticipant(Participant.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Participant response = participantsClient.updateParticipant(request);
 }
 

Parameter

Name	Description
request	UpdateParticipantRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Participant

updateParticipantCallable()

public final UnaryCallable<UpdateParticipantRequest,Participant> updateParticipantCallable()

Updates the specified participant.

Sample code:

 try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
   UpdateParticipantRequest request =
       UpdateParticipantRequest.newBuilder()
           .setParticipant(Participant.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateParticipantRequest,Participant>