Package com.google.cloud.contactcenterinsights.v1 (2.4.0)

The interfaces provided are listed below, along with usage samples.

ContactCenterInsightsClient

Service Description: An API that lets users analyze and explore their business conversation data.

Sample for ContactCenterInsightsClient:


 // 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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Conversation conversation = Conversation.newBuilder().build();
   String conversationId = "conversationId-1676095234";
   Conversation response =
       contactCenterInsightsClient.createConversation(parent, conversation, conversationId);
 }

Classes

Analysis

The analysis resource.

Protobuf type google.cloud.contactcenterinsights.v1.Analysis

Analysis.Builder

The analysis resource.

Protobuf type google.cloud.contactcenterinsights.v1.Analysis

AnalysisName.Builder

Builder for projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}.

AnalysisResult

The result of an analysis.

Protobuf type google.cloud.contactcenterinsights.v1.AnalysisResult

AnalysisResult.Builder

The result of an analysis.

Protobuf type google.cloud.contactcenterinsights.v1.AnalysisResult

AnalysisResult.CallAnalysisMetadata

Call-specific metadata created during analysis.

Protobuf type google.cloud.contactcenterinsights.v1.AnalysisResult.CallAnalysisMetadata

AnalysisResult.CallAnalysisMetadata.Builder

Call-specific metadata created during analysis.

Protobuf type google.cloud.contactcenterinsights.v1.AnalysisResult.CallAnalysisMetadata

AnnotationBoundary

A point in a conversation that marks the start or the end of an annotation.

Protobuf type google.cloud.contactcenterinsights.v1.AnnotationBoundary

AnnotationBoundary.Builder

A point in a conversation that marks the start or the end of an annotation.

Protobuf type google.cloud.contactcenterinsights.v1.AnnotationBoundary

AnswerFeedback

The feedback that the customer has about a certain answer in the conversation.

Protobuf type google.cloud.contactcenterinsights.v1.AnswerFeedback

AnswerFeedback.Builder

The feedback that the customer has about a certain answer in the conversation.

Protobuf type google.cloud.contactcenterinsights.v1.AnswerFeedback

ArticleSuggestionData

Agent Assist Article Suggestion data.

Protobuf type google.cloud.contactcenterinsights.v1.ArticleSuggestionData

ArticleSuggestionData.Builder

Agent Assist Article Suggestion data.

Protobuf type google.cloud.contactcenterinsights.v1.ArticleSuggestionData

CalculateIssueModelStatsRequest

Request to get statistics of an issue model.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateIssueModelStatsRequest

CalculateIssueModelStatsRequest.Builder

Request to get statistics of an issue model.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateIssueModelStatsRequest

CalculateIssueModelStatsResponse

Response of querying an issue model's statistics.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateIssueModelStatsResponse

CalculateIssueModelStatsResponse.Builder

Response of querying an issue model's statistics.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateIssueModelStatsResponse

CalculateStatsRequest

The request for calculating conversation statistics.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsRequest

CalculateStatsRequest.Builder

The request for calculating conversation statistics.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsRequest

CalculateStatsResponse

The response for calculating conversation statistics.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsResponse

CalculateStatsResponse.Builder

The response for calculating conversation statistics.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsResponse

CalculateStatsResponse.TimeSeries

A time series representing conversations over time.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsResponse.TimeSeries

CalculateStatsResponse.TimeSeries.Builder

A time series representing conversations over time.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsResponse.TimeSeries

CalculateStatsResponse.TimeSeries.Interval

A single interval in a time series.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsResponse.TimeSeries.Interval

CalculateStatsResponse.TimeSeries.Interval.Builder

A single interval in a time series.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsResponse.TimeSeries.Interval

CallAnnotation

A piece of metadata that applies to a window of a call.

Protobuf type google.cloud.contactcenterinsights.v1.CallAnnotation

CallAnnotation.Builder

A piece of metadata that applies to a window of a call.

Protobuf type google.cloud.contactcenterinsights.v1.CallAnnotation

ContactCenterInsightsClient

Service Description: An API that lets users analyze and explore their business conversation data.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Conversation conversation = Conversation.newBuilder().build();
   String conversationId = "conversationId-1676095234";
   Conversation response =
       contactCenterInsightsClient.createConversation(parent, conversation, conversationId);
 }

Note: close() needs to be called on the ContactCenterInsightsClient 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 ContactCenterInsightsSettings 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
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     ContactCenterInsightsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create(contactCenterInsightsSettings);

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
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     ContactCenterInsightsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create(contactCenterInsightsSettings);

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
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     ContactCenterInsightsSettings.newBuilder()
         .setTransportChannelProvider(
             ContactCenterInsightsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create(contactCenterInsightsSettings);

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

ContactCenterInsightsClient.ListAnalysesFixedSizeCollection

ContactCenterInsightsClient.ListAnalysesPage

ContactCenterInsightsClient.ListAnalysesPagedResponse

ContactCenterInsightsClient.ListConversationsFixedSizeCollection

ContactCenterInsightsClient.ListConversationsPage

ContactCenterInsightsClient.ListConversationsPagedResponse

ContactCenterInsightsClient.ListPhraseMatchersFixedSizeCollection

ContactCenterInsightsClient.ListPhraseMatchersPage

ContactCenterInsightsClient.ListPhraseMatchersPagedResponse