Contact Center AI Insights v1 API - Class ContactCenterInsights.ContactCenterInsightsBase (2.17.0)

Version 2.17.0

• 2.18.0 (latest)
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(ContactCenterInsights), "BindService")]
public abstract class ContactCenterInsights.ContactCenterInsightsBase

Reference documentation and code samples for the Contact Center AI Insights v1 API class ContactCenterInsights.ContactCenterInsightsBase.

Base class for server-side implementations of ContactCenterInsights

Inheritance

object > ContactCenterInsights.ContactCenterInsightsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Methods

BulkAnalyzeConversations(BulkAnalyzeConversationsRequest, ServerCallContext)

public virtual Task<Operation> BulkAnalyzeConversations(BulkAnalyzeConversationsRequest request, ServerCallContext context)

Analyzes multiple conversations in a single request.

Parameters
Name	Description
request	BulkAnalyzeConversationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

BulkDeleteConversations(BulkDeleteConversationsRequest, ServerCallContext)

public virtual Task<Operation> BulkDeleteConversations(BulkDeleteConversationsRequest request, ServerCallContext context)

Deletes multiple conversations in a single request.

Parameters
Name	Description
request	BulkDeleteConversationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CalculateIssueModelStats(CalculateIssueModelStatsRequest, ServerCallContext)

public virtual Task<CalculateIssueModelStatsResponse> CalculateIssueModelStats(CalculateIssueModelStatsRequest request, ServerCallContext context)

Gets an issue model's statistics.

Parameters
Name	Description
request	CalculateIssueModelStatsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCalculateIssueModelStatsResponse	The response to send back to the client (wrapped by a task).

CalculateStats(CalculateStatsRequest, ServerCallContext)

public virtual Task<CalculateStatsResponse> CalculateStats(CalculateStatsRequest request, ServerCallContext context)

Gets conversation statistics.

Parameters
Name	Description
request	CalculateStatsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCalculateStatsResponse	The response to send back to the client (wrapped by a task).

CreateAnalysis(CreateAnalysisRequest, ServerCallContext)

public virtual Task<Operation> CreateAnalysis(CreateAnalysisRequest request, ServerCallContext context)

Creates an analysis. The long running operation is done when the analysis has completed.

Parameters
Name	Description
request	CreateAnalysisRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateConversation(CreateConversationRequest, ServerCallContext)

public virtual Task<Conversation> CreateConversation(CreateConversationRequest request, ServerCallContext context)

Creates a conversation. Note that this method does not support audio transcription or redaction. Use conversations.upload instead.

Parameters
Name	Description
request	CreateConversationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConversation	The response to send back to the client (wrapped by a task).

CreateIssueModel(CreateIssueModelRequest, ServerCallContext)

public virtual Task<Operation> CreateIssueModel(CreateIssueModelRequest request, ServerCallContext context)

Creates an issue model.

Parameters
Name	Description
request	CreateIssueModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreatePhraseMatcher(CreatePhraseMatcherRequest, ServerCallContext)

public virtual Task<PhraseMatcher> CreatePhraseMatcher(CreatePhraseMatcherRequest request, ServerCallContext context)

Creates a phrase matcher.

Parameters
Name	Description
request	CreatePhraseMatcherRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPhraseMatcher	The response to send back to the client (wrapped by a task).

CreateView(CreateViewRequest, ServerCallContext)

public virtual Task<View> CreateView(CreateViewRequest request, ServerCallContext context)

Creates a view.

Parameters
Name	Description
request	CreateViewRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskView	The response to send back to the client (wrapped by a task).

DeleteAnalysis(DeleteAnalysisRequest, ServerCallContext)

public virtual Task<Empty> DeleteAnalysis(DeleteAnalysisRequest request, ServerCallContext context)

Deletes an analysis.

Parameters
Name	Description
request	DeleteAnalysisRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteConversation(DeleteConversationRequest, ServerCallContext)

public virtual Task<Empty> DeleteConversation(DeleteConversationRequest request, ServerCallContext context)

Deletes a conversation.

Parameters
Name	Description
request	DeleteConversationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteIssue(DeleteIssueRequest, ServerCallContext)

public virtual Task<Empty> DeleteIssue(DeleteIssueRequest request, ServerCallContext context)

Deletes an issue.

Parameters
Name	Description
request	DeleteIssueRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteIssueModel(DeleteIssueModelRequest, ServerCallContext)

public virtual Task<Operation> DeleteIssueModel(DeleteIssueModelRequest request, ServerCallContext context)

Deletes an issue model.

Parameters
Name	Description
request	DeleteIssueModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeletePhraseMatcher(DeletePhraseMatcherRequest, ServerCallContext)

public virtual Task<Empty> DeletePhraseMatcher(DeletePhraseMatcherRequest request, ServerCallContext context)

Deletes a phrase matcher.

Parameters
Name	Description
request	DeletePhraseMatcherRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteView(DeleteViewRequest, ServerCallContext)

public virtual Task<Empty> DeleteView(DeleteViewRequest request, ServerCallContext context)

Deletes a view.

Parameters
Name	Description
request	DeleteViewRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeployIssueModel(DeployIssueModelRequest, ServerCallContext)

public virtual Task<Operation> DeployIssueModel(DeployIssueModelRequest request, ServerCallContext context)

Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.

Parameters
Name	Description
request	DeployIssueModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportInsightsData(ExportInsightsDataRequest, ServerCallContext)

public virtual Task<Operation> ExportInsightsData(ExportInsightsDataRequest request, ServerCallContext context)

Export insights data to a destination defined in the request body.

Parameters
Name	Description
request	ExportInsightsDataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportIssueModel(ExportIssueModelRequest, ServerCallContext)

public virtual Task<Operation> ExportIssueModel(ExportIssueModelRequest request, ServerCallContext context)

Exports an issue model to the provided destination.

Parameters
Name	Description
request	ExportIssueModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetAnalysis(GetAnalysisRequest, ServerCallContext)

public virtual Task<Analysis> GetAnalysis(GetAnalysisRequest request, ServerCallContext context)

Gets an analysis.

Parameters
Name	Description
request	GetAnalysisRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnalysis	The response to send back to the client (wrapped by a task).

GetConversation(GetConversationRequest, ServerCallContext)

public virtual Task<Conversation> GetConversation(GetConversationRequest request, ServerCallContext context)

Gets a conversation.

Parameters
Name	Description
request	GetConversationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConversation	The response to send back to the client (wrapped by a task).

GetEncryptionSpec(GetEncryptionSpecRequest, ServerCallContext)

public virtual Task<EncryptionSpec> GetEncryptionSpec(GetEncryptionSpecRequest request, ServerCallContext context)

Gets location-level encryption key specification.

Parameters
Name	Description
request	GetEncryptionSpecRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEncryptionSpec	The response to send back to the client (wrapped by a task).

GetIssue(GetIssueRequest, ServerCallContext)

public virtual Task<Issue> GetIssue(GetIssueRequest request, ServerCallContext context)

Gets an issue.

Parameters
Name	Description
request	GetIssueRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskIssue	The response to send back to the client (wrapped by a task).

GetIssueModel(GetIssueModelRequest, ServerCallContext)

public virtual Task<IssueModel> GetIssueModel(GetIssueModelRequest request, ServerCallContext context)

Gets an issue model.

Parameters
Name	Description
request	GetIssueModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskIssueModel	The response to send back to the client (wrapped by a task).

GetPhraseMatcher(GetPhraseMatcherRequest, ServerCallContext)

public virtual Task<PhraseMatcher> GetPhraseMatcher(GetPhraseMatcherRequest request, ServerCallContext context)

Gets a phrase matcher.

Parameters
Name	Description
request	GetPhraseMatcherRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPhraseMatcher	The response to send back to the client (wrapped by a task).

GetSettings(GetSettingsRequest, ServerCallContext)

public virtual Task<Settings> GetSettings(GetSettingsRequest request, ServerCallContext context)

Gets project-level settings.

Parameters
Name	Description
request	GetSettingsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSettings	The response to send back to the client (wrapped by a task).

GetView(GetViewRequest, ServerCallContext)

public virtual Task<View> GetView(GetViewRequest request, ServerCallContext context)

Gets a view.

Parameters
Name	Description
request	GetViewRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskView	The response to send back to the client (wrapped by a task).

ImportIssueModel(ImportIssueModelRequest, ServerCallContext)

public virtual Task<Operation> ImportIssueModel(ImportIssueModelRequest request, ServerCallContext context)

Imports an issue model from a Cloud Storage bucket.

Parameters
Name	Description
request	ImportIssueModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

IngestConversations(IngestConversationsRequest, ServerCallContext)

public virtual Task<Operation> IngestConversations(IngestConversationsRequest request, ServerCallContext context)

Imports conversations and processes them according to the user's configuration.

Parameters
Name	Description
request	IngestConversationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

InitializeEncryptionSpec(InitializeEncryptionSpecRequest, ServerCallContext)

public virtual Task<Operation> InitializeEncryptionSpec(InitializeEncryptionSpecRequest request, ServerCallContext context)

Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

Parameters
Name	Description
request	InitializeEncryptionSpecRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListAnalyses(ListAnalysesRequest, ServerCallContext)

public virtual Task<ListAnalysesResponse> ListAnalyses(ListAnalysesRequest request, ServerCallContext context)

Lists analyses.

Parameters
Name	Description
request	ListAnalysesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAnalysesResponse	The response to send back to the client (wrapped by a task).

ListConversations(ListConversationsRequest, ServerCallContext)

public virtual Task<ListConversationsResponse> ListConversations(ListConversationsRequest request, ServerCallContext context)

Lists conversations.

Parameters
Name	Description
request	ListConversationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListConversationsResponse	The response to send back to the client (wrapped by a task).

ListIssueModels(ListIssueModelsRequest, ServerCallContext)

public virtual Task<ListIssueModelsResponse> ListIssueModels(ListIssueModelsRequest request, ServerCallContext context)

Lists issue models.

Parameters
Name	Description
request	ListIssueModelsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListIssueModelsResponse	The response to send back to the client (wrapped by a task).

ListIssues(ListIssuesRequest, ServerCallContext)

public virtual Task<ListIssuesResponse> ListIssues(ListIssuesRequest request, ServerCallContext context)

Lists issues.

Parameters
Name	Description
request	ListIssuesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListIssuesResponse	The response to send back to the client (wrapped by a task).

ListPhraseMatchers(ListPhraseMatchersRequest, ServerCallContext)

public virtual Task<ListPhraseMatchersResponse> ListPhraseMatchers(ListPhraseMatchersRequest request, ServerCallContext context)

Lists phrase matchers.

Parameters
Name	Description
request	ListPhraseMatchersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListPhraseMatchersResponse	The response to send back to the client (wrapped by a task).

ListViews(ListViewsRequest, ServerCallContext)

public virtual Task<ListViewsResponse> ListViews(ListViewsRequest request, ServerCallContext context)

Lists views.

Parameters
Name	Description
request	ListViewsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListViewsResponse	The response to send back to the client (wrapped by a task).

UndeployIssueModel(UndeployIssueModelRequest, ServerCallContext)

public virtual Task<Operation> UndeployIssueModel(UndeployIssueModelRequest request, ServerCallContext context)

Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.

Parameters
Name	Description
request	UndeployIssueModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateConversation(UpdateConversationRequest, ServerCallContext)

public virtual Task<Conversation> UpdateConversation(UpdateConversationRequest request, ServerCallContext context)

Updates a conversation.

Parameters
Name	Description
request	UpdateConversationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConversation	The response to send back to the client (wrapped by a task).

UpdateIssue(UpdateIssueRequest, ServerCallContext)

public virtual Task<Issue> UpdateIssue(UpdateIssueRequest request, ServerCallContext context)

Updates an issue.

Parameters
Name	Description
request	UpdateIssueRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskIssue	The response to send back to the client (wrapped by a task).

UpdateIssueModel(UpdateIssueModelRequest, ServerCallContext)

public virtual Task<IssueModel> UpdateIssueModel(UpdateIssueModelRequest request, ServerCallContext context)

Updates an issue model.

Parameters
Name	Description
request	UpdateIssueModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskIssueModel	The response to send back to the client (wrapped by a task).

UpdatePhraseMatcher(UpdatePhraseMatcherRequest, ServerCallContext)

public virtual Task<PhraseMatcher> UpdatePhraseMatcher(UpdatePhraseMatcherRequest request, ServerCallContext context)

Updates a phrase matcher.

Parameters
Name	Description
request	UpdatePhraseMatcherRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPhraseMatcher	The response to send back to the client (wrapped by a task).

UpdateSettings(UpdateSettingsRequest, ServerCallContext)

public virtual Task<Settings> UpdateSettings(UpdateSettingsRequest request, ServerCallContext context)

Updates project-level settings.

Parameters
Name	Description
request	UpdateSettingsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSettings	The response to send back to the client (wrapped by a task).

UpdateView(UpdateViewRequest, ServerCallContext)

public virtual Task<View> UpdateView(UpdateViewRequest request, ServerCallContext context)

Updates a view.

Parameters
Name	Description
request	UpdateViewRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskView	The response to send back to the client (wrapped by a task).

UploadConversation(UploadConversationRequest, ServerCallContext)

public virtual Task<Operation> UploadConversation(UploadConversationRequest request, ServerCallContext context)

Create a long-running conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction.

Parameters
Name	Description
request	UploadConversationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).