- 4.53.0 (latest)
- 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
GitHub Repository | Product Reference |
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:
// 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 (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().
Method | Description | Method Variants |
---|---|---|
CreateParticipant |
Creates a new participant in a conversation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetParticipant |
Retrieves a conversation participant. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListParticipants |
Returns the list of all participants in the specified conversation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateParticipant |
Updates the specified participant. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
AnalyzeContent |
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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StreamingAnalyzeContent |
Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST). The top-level message sent to the client by the server is Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments. |
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SuggestArticles |
Gets suggested articles for a participant based on specific historical messages. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SuggestFaqAnswers |
Gets suggested faq answers for a participant based on specific historical messages. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SuggestSmartReplies |
Gets smart replies for a participant based on specific historical messages. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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:
// 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
ParticipantsSettings participantsSettings =
ParticipantsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
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
ParticipantsSettings participantsSettings =
ParticipantsSettings.newBuilder().setEndpoint(myEndpoint).build();
ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
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
ParticipantsSettings participantsSettings = ParticipantsSettings.newHttpJsonBuilder().build();
ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
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 |
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:
// 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 (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())
.setCxParameters(Struct.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:
// 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 (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:
|
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:
// 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 (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:
|
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:
// 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 (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:
|
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:
// 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 (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:
|
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:
// 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 (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())
.setCxParameters(Struct.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<AnalyzeContentResponse> future =
participantsClient.analyzeContentCallable().futureCall(request);
// Do something.
AnalyzeContentResponse response = future.get();
}
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()
createParticipant(ConversationName parent, Participant participant)
public final Participant createParticipant(ConversationName parent, Participant participant)
Creates a new participant in a conversation.
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 (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:
|
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:
// 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 (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:
// 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 (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:
|
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:
// 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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
CreateParticipantRequest request =
CreateParticipantRequest.newBuilder()
.setParent(
ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
.toString())
.setParticipant(Participant.newBuilder().build())
.build();
ApiFuture<Participant> future =
participantsClient.createParticipantCallable().futureCall(request);
// Do something.
Participant response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateParticipantRequest,Participant> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = participantsClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = participantsClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getParticipant(GetParticipantRequest request)
public final Participant getParticipant(GetParticipantRequest request)
Retrieves a conversation participant.
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 (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:
// 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 (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: |
Returns | |
---|---|
Type | Description |
Participant |
getParticipant(String name)
public final Participant getParticipant(String name)
Retrieves a conversation participant.
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 (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: |
Returns | |
---|---|
Type | Description |
Participant |
getParticipantCallable()
public final UnaryCallable<GetParticipantRequest,Participant> getParticipantCallable()
Retrieves a conversation participant.
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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
GetParticipantRequest request =
GetParticipantRequest.newBuilder()
.setName(
ParticipantName.ofProjectConversationParticipantName(
"[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
.toString())
.build();
ApiFuture<Participant> future =
participantsClient.getParticipantCallable().futureCall(request);
// Do something.
Participant response = future.get();
}
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 |
listLocations(ListLocationsRequest request)
public final ParticipantsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : participantsClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ParticipantsClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = participantsClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,ParticipantsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
participantsClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listParticipants(ConversationName parent)
public final ParticipantsClient.ListParticipantsPagedResponse listParticipants(ConversationName parent)
Returns the list of all participants in the specified conversation.
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 (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:
|
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:
// 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 (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:
// 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 (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:
|
Returns | |
---|---|
Type | Description |
ParticipantsClient.ListParticipantsPagedResponse |
listParticipantsCallable()
public final UnaryCallable<ListParticipantsRequest,ListParticipantsResponse> listParticipantsCallable()
Returns the list of all participants in the specified conversation.
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 (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.getParticipantsList()) {
// 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:
// 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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
ListParticipantsRequest request =
ListParticipantsRequest.newBuilder()
.setParent(
ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Participant> future =
participantsClient.listParticipantsPagedCallable().futureCall(request);
// Do something.
for (Participant element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListParticipantsRequest,ListParticipantsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
streamingAnalyzeContentCallable()
public final BidiStreamingCallable<StreamingAnalyzeContentRequest,StreamingAnalyzeContentResponse> streamingAnalyzeContentCallable()
Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST).
The top-level message sent to the client by the server is StreamingAnalyzeContentResponse
.
Multiple response messages can be returned in order. The first one or more messages contain the
recognition_result
field. Each result represents a more complete transcript of what the user
said. The next message contains the reply_text
field and potentially the reply_audio
field.
The message can also contain the automated_agent_reply
field.
Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.
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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
BidiStream<StreamingAnalyzeContentRequest, StreamingAnalyzeContentResponse> bidiStream =
participantsClient.streamingAnalyzeContentCallable().call();
StreamingAnalyzeContentRequest request =
StreamingAnalyzeContentRequest.newBuilder()
.setParticipant(
ParticipantName.ofProjectConversationParticipantName(
"[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
.toString())
.setReplyAudioConfig(OutputAudioConfig.newBuilder().build())
.setQueryParams(QueryParameters.newBuilder().build())
.setAssistQueryParams(AssistQueryParameters.newBuilder().build())
.setCxParameters(Struct.newBuilder().build())
.setEnableExtendedStreaming(true)
.setEnablePartialAutomatedAgentReply(true)
.setEnableDebuggingInfo(true)
.build();
bidiStream.send(request);
for (StreamingAnalyzeContentResponse response : bidiStream) {
// Do something when a response is received.
}
}
Returns | |
---|---|
Type | Description |
BidiStreamingCallable<StreamingAnalyzeContentRequest,StreamingAnalyzeContentResponse> |
suggestArticles(ParticipantName parent)
public final SuggestArticlesResponse suggestArticles(ParticipantName parent)
Gets suggested articles for a participant based on specific historical messages.
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 (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:
|
Returns | |
---|---|
Type | Description |
SuggestArticlesResponse |
suggestArticles(SuggestArticlesRequest request)
public final SuggestArticlesResponse suggestArticles(SuggestArticlesRequest request)
Gets suggested articles for a participant based on specific historical messages.
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 (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.
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 (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:
|
Returns | |
---|---|
Type | Description |
SuggestArticlesResponse |
suggestArticlesCallable()
public final UnaryCallable<SuggestArticlesRequest,SuggestArticlesResponse> suggestArticlesCallable()
Gets suggested articles for a participant based on specific historical messages.
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 (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<SuggestArticlesResponse> future =
participantsClient.suggestArticlesCallable().futureCall(request);
// Do something.
SuggestArticlesResponse response = future.get();
}
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:
// 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 (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:
|
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:
// 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 (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:
// 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 (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:
|
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:
// 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 (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<SuggestFaqAnswersResponse> future =
participantsClient.suggestFaqAnswersCallable().futureCall(request);
// Do something.
SuggestFaqAnswersResponse response = future.get();
}
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:
// 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 (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:
|
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:
// 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 (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:
// 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 (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:
|
Returns | |
---|---|
Type | Description |
SuggestSmartRepliesResponse |
suggestSmartRepliesCallable()
public final UnaryCallable<SuggestSmartRepliesRequest,SuggestSmartRepliesResponse> suggestSmartRepliesCallable()
Gets smart replies for a participant based on specific historical messages.
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 (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<SuggestSmartRepliesResponse> future =
participantsClient.suggestSmartRepliesCallable().futureCall(request);
// Do something.
SuggestSmartRepliesResponse response = future.get();
}
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:
// 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 (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:
// 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 (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:
// 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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
UpdateParticipantRequest request =
UpdateParticipantRequest.newBuilder()
.setParticipant(Participant.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Participant> future =
participantsClient.updateParticipantCallable().futureCall(request);
// Do something.
Participant response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateParticipantRequest,Participant> |