- 4.60.0 (latest)
- 4.59.0
- 4.58.0
- 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 SessionsClient implements BackgroundResource
Service Description: A service used for session interactions.
For more information, see the API interactions guide.
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (SessionsClient sessionsClient = SessionsClient.create()) {
SessionName session = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
QueryInput queryInput = QueryInput.newBuilder().build();
DetectIntentResponse response = sessionsClient.detectIntent(session, queryInput);
}
Note: close() needs to be called on the SessionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of SessionsSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SessionsSettings sessionsSettings =
SessionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SessionsSettings sessionsSettings =
SessionsSettings.newBuilder().setEndpoint(myEndpoint).build();
SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SessionsSettings sessionsSettings =
SessionsSettings.newBuilder()
.setTransportChannelProvider(
SessionsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final SessionsClient create()
Constructs an instance of SessionsClient with default settings.
Type | Description |
SessionsClient |
Type | Description |
IOException |
create(SessionsSettings settings)
public static final SessionsClient create(SessionsSettings settings)
Constructs an instance of SessionsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | SessionsSettings |
Type | Description |
SessionsClient |
Type | Description |
IOException |
create(SessionsStub stub)
public static final SessionsClient create(SessionsStub stub)
Constructs an instance of SessionsClient, using the given stub for making calls. This is for advanced usage - prefer using create(SessionsSettings).
Name | Description |
stub | SessionsStub |
Type | Description |
SessionsClient |
Constructors
SessionsClient(SessionsSettings settings)
protected SessionsClient(SessionsSettings settings)
Constructs an instance of SessionsClient, 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.
Name | Description |
settings | SessionsSettings |
SessionsClient(SessionsStub stub)
protected SessionsClient(SessionsStub stub)
Name | Description |
stub | SessionsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
detectIntent(DetectIntentRequest request)
public final DetectIntentResponse detectIntent(DetectIntentRequest request)
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
If you might use Agent Assist or other CCAI
products now or in the future, consider using
AnalyzeContent instead of
DetectIntent
. AnalyzeContent
has additional functionality for Agent Assist and other CCAI
products.
Note: Always use agent versions for production traffic. See Versions and environments.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SessionsClient sessionsClient = SessionsClient.create()) {
DetectIntentRequest request =
DetectIntentRequest.newBuilder()
.setSession(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.setQueryParams(QueryParameters.newBuilder().build())
.setQueryInput(QueryInput.newBuilder().build())
.setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
.setOutputAudioConfigMask(FieldMask.newBuilder().build())
.setInputAudio(ByteString.EMPTY)
.build();
DetectIntentResponse response = sessionsClient.detectIntent(request);
}
Name | Description |
request | DetectIntentRequest The request object containing all of the parameters for the API call. |
Type | Description |
DetectIntentResponse |
detectIntent(SessionName session, QueryInput queryInput)
public final DetectIntentResponse detectIntent(SessionName session, QueryInput queryInput)
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
If you might use Agent Assist or other CCAI
products now or in the future, consider using
AnalyzeContent instead of
DetectIntent
. AnalyzeContent
has additional functionality for Agent Assist and other CCAI
products.
Note: Always use agent versions for production traffic. See Versions and environments.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SessionsClient sessionsClient = SessionsClient.create()) {
SessionName session = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
QueryInput queryInput = QueryInput.newBuilder().build();
DetectIntentResponse response = sessionsClient.detectIntent(session, queryInput);
}
Name | Description |
session | SessionName Required. The name of the session this query is sent to. Supported formats: -
Note: Always use agent versions for production traffic. See Versions and environments. |
queryInput | QueryInput Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger. |
Type | Description |
DetectIntentResponse |
detectIntent(String session, QueryInput queryInput)
public final DetectIntentResponse detectIntent(String session, QueryInput queryInput)
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
If you might use Agent Assist or other CCAI
products now or in the future, consider using
AnalyzeContent instead of
DetectIntent
. AnalyzeContent
has additional functionality for Agent Assist and other CCAI
products.
Note: Always use agent versions for production traffic. See Versions and environments.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SessionsClient sessionsClient = SessionsClient.create()) {
String session = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
QueryInput queryInput = QueryInput.newBuilder().build();
DetectIntentResponse response = sessionsClient.detectIntent(session, queryInput);
}
Name | Description |
session | String Required. The name of the session this query is sent to. Supported formats: -
Note: Always use agent versions for production traffic. See Versions and environments. |
queryInput | QueryInput Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger. |
Type | Description |
DetectIntentResponse |
detectIntentCallable()
public final UnaryCallable<DetectIntentRequest,DetectIntentResponse> detectIntentCallable()
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
If you might use Agent Assist or other CCAI
products now or in the future, consider using
AnalyzeContent instead of
DetectIntent
. AnalyzeContent
has additional functionality for Agent Assist and other CCAI
products.
Note: Always use agent versions for production traffic. See Versions and environments.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SessionsClient sessionsClient = SessionsClient.create()) {
DetectIntentRequest request =
DetectIntentRequest.newBuilder()
.setSession(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.setQueryParams(QueryParameters.newBuilder().build())
.setQueryInput(QueryInput.newBuilder().build())
.setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
.setOutputAudioConfigMask(FieldMask.newBuilder().build())
.setInputAudio(ByteString.EMPTY)
.build();
ApiFuture<DetectIntentResponse> future =
sessionsClient.detectIntentCallable().futureCall(request);
// Do something.
DetectIntentResponse response = future.get();
}
Type | Description |
UnaryCallable<DetectIntentRequest,DetectIntentResponse> |
getSettings()
public final SessionsSettings getSettings()
Type | Description |
SessionsSettings |
getStub()
public SessionsStub getStub()
Type | Description |
SessionsStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
streamingDetectIntentCallable()
public final BidiStreamingCallable<StreamingDetectIntentRequest,StreamingDetectIntentResponse> streamingDetectIntentCallable()
Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
If you might use Agent Assist or other CCAI
products now or in the future, consider using
StreamingAnalyzeContent
instead of StreamingDetectIntent
. StreamingAnalyzeContent
has additional functionality for
Agent Assist and other CCAI products.
Note: Always use agent versions for production traffic. See Versions and environments.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SessionsClient sessionsClient = SessionsClient.create()) {
BidiStream<StreamingDetectIntentRequest, StreamingDetectIntentResponse> bidiStream =
sessionsClient.streamingDetectIntentCallable().call();
StreamingDetectIntentRequest request =
StreamingDetectIntentRequest.newBuilder()
.setSession(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.setQueryParams(QueryParameters.newBuilder().build())
.setQueryInput(QueryInput.newBuilder().build())
.setSingleUtterance(true)
.setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
.setOutputAudioConfigMask(FieldMask.newBuilder().build())
.setInputAudio(ByteString.EMPTY)
.build();
bidiStream.send(request);
for (StreamingDetectIntentResponse response : bidiStream) {
// Do something when a response is received.
}
}
Type | Description |
BidiStreamingCallable<StreamingDetectIntentRequest,StreamingDetectIntentResponse> |