Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client (v0.20.0)

Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.

REST client for the ContactCenterInsights service.

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

Inherits

Object

Includes

Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ContactCenterInsights Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all ContactCenterInsights clients
::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#bulk_analyze_conversations

def bulk_analyze_conversations(request, options = nil) -> ::Gapic::Operation
def bulk_analyze_conversations(parent: nil, filter: nil, analysis_percentage: nil, annotator_selector: nil) -> ::Gapic::Operation

Analyzes multiple conversations in a single request.

Overloads

def bulk_analyze_conversations(request, options = nil) -> ::Gapic::Operation

Pass arguments to bulk_analyze_conversations via a request object, either of type BulkAnalyzeConversationsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::BulkAnalyzeConversationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def bulk_analyze_conversations(parent: nil, filter: nil, analysis_percentage: nil, annotator_selector: nil) -> ::Gapic::Operation

Pass arguments to bulk_analyze_conversations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource to create analyses in.
filter (::String) — Required. Filter used to select the subset of conversations to analyze.
analysis_percentage (::Float) — Required. Percentage of selected conversation to analyze, between [0, 100].
annotator_selector (::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector, ::Hash) — To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::BulkAnalyzeConversationsRequest.new

# Call the bulk_analyze_conversations method.
result = client.bulk_analyze_conversations request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#bulk_delete_conversations

def bulk_delete_conversations(request, options = nil) -> ::Gapic::Operation
def bulk_delete_conversations(parent: nil, filter: nil, max_delete_count: nil, force: nil) -> ::Gapic::Operation

Deletes multiple conversations in a single request.

Overloads

def bulk_delete_conversations(request, options = nil) -> ::Gapic::Operation

Pass arguments to bulk_delete_conversations via a request object, either of type BulkDeleteConversationsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::BulkDeleteConversationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def bulk_delete_conversations(parent: nil, filter: nil, max_delete_count: nil, force: nil) -> ::Gapic::Operation

Pass arguments to bulk_delete_conversations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}
filter (::String) — Filter used to select the subset of conversations to delete.
max_delete_count (::Integer) — Maximum number of conversations to delete.
force (::Boolean) — If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::BulkDeleteConversationsRequest.new

# Call the bulk_delete_conversations method.
result = client.bulk_delete_conversations request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#calculate_issue_model_stats

def calculate_issue_model_stats(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse
def calculate_issue_model_stats(issue_model: nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse

Gets an issue model's statistics.

Overloads

def calculate_issue_model_stats(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse

Pass arguments to calculate_issue_model_stats via a request object, either of type Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def calculate_issue_model_stats(issue_model: nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse

Pass arguments to calculate_issue_model_stats via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

issue_model (::String) — Required. The resource name of the issue model to query against.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsRequest.new

# Call the calculate_issue_model_stats method.
result = client.calculate_issue_model_stats request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse.
p result

#calculate_stats

def calculate_stats(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse
def calculate_stats(location: nil, filter: nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse

Gets conversation statistics.

Overloads

def calculate_stats(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse

Pass arguments to calculate_stats via a request object, either of type Google::Cloud::ContactCenterInsights::V1::CalculateStatsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::CalculateStatsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def calculate_stats(location: nil, filter: nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse

Pass arguments to calculate_stats via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

location (::String) — Required. The location of the conversations.
filter (::String) — A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::CalculateStatsRequest.new

# Call the calculate_stats method.
result = client.calculate_stats request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ContactCenterInsights Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_analysis

def create_analysis(request, options = nil) -> ::Gapic::Operation
def create_analysis(parent: nil, analysis: nil) -> ::Gapic::Operation

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

Overloads

def create_analysis(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_analysis via a request object, either of type Google::Cloud::ContactCenterInsights::V1::CreateAnalysisRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::CreateAnalysisRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_analysis(parent: nil, analysis: nil) -> ::Gapic::Operation

Pass arguments to create_analysis via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the analysis.
analysis (::Google::Cloud::ContactCenterInsights::V1::Analysis, ::Hash) — Required. The analysis to create.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::CreateAnalysisRequest.new

# Call the create_analysis method.
result = client.create_analysis request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_conversation

def create_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation
def create_conversation(parent: nil, conversation: nil, conversation_id: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Creates a conversation.

Overloads

def create_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Pass arguments to create_conversation via a request object, either of type Google::Cloud::ContactCenterInsights::V1::CreateConversationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::CreateConversationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_conversation(parent: nil, conversation: nil, conversation_id: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Pass arguments to create_conversation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the conversation.
conversation (::Google::Cloud::ContactCenterInsights::V1::Conversation, ::Hash) — Required. The conversation resource to create.
conversation_id (::String) — A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used.

This value should be 4-64 characters and must match the regular expression ^[a-z0-9-]{4,64}$. Valid characters are [a-z][0-9]-

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::Conversation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::Conversation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::CreateConversationRequest.new

# Call the create_conversation method.
result = client.create_conversation request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::Conversation.
p result

#create_issue_model

def create_issue_model(request, options = nil) -> ::Gapic::Operation
def create_issue_model(parent: nil, issue_model: nil) -> ::Gapic::Operation

Creates an issue model.

Overloads

def create_issue_model(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_issue_model via a request object, either of type Google::Cloud::ContactCenterInsights::V1::CreateIssueModelRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::CreateIssueModelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_issue_model(parent: nil, issue_model: nil) -> ::Gapic::Operation

Pass arguments to create_issue_model via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the issue model.
issue_model (::Google::Cloud::ContactCenterInsights::V1::IssueModel, ::Hash) — Required. The issue model to create.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::CreateIssueModelRequest.new

# Call the create_issue_model method.
result = client.create_issue_model request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_phrase_matcher

def create_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher
def create_phrase_matcher(parent: nil, phrase_matcher: nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Creates a phrase matcher.

Overloads

def create_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Pass arguments to create_phrase_matcher via a request object, either of type Google::Cloud::ContactCenterInsights::V1::CreatePhraseMatcherRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::CreatePhraseMatcherRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_phrase_matcher(parent: nil, phrase_matcher: nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Pass arguments to create_phrase_matcher via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: projects/<Project ID>/locations/<Location ID> or projects/<Project Number>/locations/<Location ID>
phrase_matcher (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher, ::Hash) — Required. The phrase matcher resource to create.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::CreatePhraseMatcherRequest.new

# Call the create_phrase_matcher method.
result = client.create_phrase_matcher request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::PhraseMatcher.
p result

#create_view

def create_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View
def create_view(parent: nil, view: nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Creates a view.

Overloads

def create_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Pass arguments to create_view via a request object, either of type Google::Cloud::ContactCenterInsights::V1::CreateViewRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::CreateViewRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_view(parent: nil, view: nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Pass arguments to create_view via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the view. Required. The location to create a view for. Format: projects/<Project ID>/locations/<Location ID> or projects/<Project Number>/locations/<Location ID>
view (::Google::Cloud::ContactCenterInsights::V1::View, ::Hash) — Required. The view resource to create.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::View)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::View)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::CreateViewRequest.new

# Call the create_view method.
result = client.create_view request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::View.
p result

#delete_analysis

def delete_analysis(request, options = nil) -> ::Google::Protobuf::Empty
def delete_analysis(name: nil) -> ::Google::Protobuf::Empty

Deletes an analysis.

Overloads

def delete_analysis(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_analysis via a request object, either of type DeleteAnalysisRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::DeleteAnalysisRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_analysis(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_analysis via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the analysis to delete.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::DeleteAnalysisRequest.new

# Call the delete_analysis method.
result = client.delete_analysis request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_conversation

def delete_conversation(request, options = nil) -> ::Google::Protobuf::Empty
def delete_conversation(name: nil, force: nil) -> ::Google::Protobuf::Empty

Deletes a conversation.

Overloads

def delete_conversation(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_conversation via a request object, either of type DeleteConversationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::DeleteConversationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_conversation(name: nil, force: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_conversation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the conversation to delete.
force (::Boolean) — If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::DeleteConversationRequest.new

# Call the delete_conversation method.
result = client.delete_conversation request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_issue

def delete_issue(request, options = nil) -> ::Google::Protobuf::Empty
def delete_issue(name: nil) -> ::Google::Protobuf::Empty

Deletes an issue.

Overloads

def delete_issue(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_issue via a request object, either of type DeleteIssueRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::DeleteIssueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_issue(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_issue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the issue to delete.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::DeleteIssueRequest.new

# Call the delete_issue method.
result = client.delete_issue request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_issue_model

def delete_issue_model(request, options = nil) -> ::Gapic::Operation
def delete_issue_model(name: nil) -> ::Gapic::Operation

Deletes an issue model.

Overloads

def delete_issue_model(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_issue_model via a request object, either of type DeleteIssueModelRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::DeleteIssueModelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_issue_model(name: nil) -> ::Gapic::Operation

Pass arguments to delete_issue_model via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the issue model to delete.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::DeleteIssueModelRequest.new

# Call the delete_issue_model method.
result = client.delete_issue_model request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_phrase_matcher

def delete_phrase_matcher(request, options = nil) -> ::Google::Protobuf::Empty
def delete_phrase_matcher(name: nil) -> ::Google::Protobuf::Empty

Deletes a phrase matcher.

Overloads

def delete_phrase_matcher(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_phrase_matcher via a request object, either of type DeletePhraseMatcherRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::DeletePhraseMatcherRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_phrase_matcher(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_phrase_matcher via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the phrase matcher to delete.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::DeletePhraseMatcherRequest.new

# Call the delete_phrase_matcher method.
result = client.delete_phrase_matcher request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_view

def delete_view(request, options = nil) -> ::Google::Protobuf::Empty
def delete_view(name: nil) -> ::Google::Protobuf::Empty

Deletes a view.

Overloads

def delete_view(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_view via a request object, either of type DeleteViewRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::DeleteViewRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_view(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_view via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the view to delete.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::DeleteViewRequest.new

# Call the delete_view method.
result = client.delete_view request

# The returned object is of type Google::Protobuf::Empty.
p result

#deploy_issue_model

def deploy_issue_model(request, options = nil) -> ::Gapic::Operation
def deploy_issue_model(name: nil) -> ::Gapic::Operation

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.

Overloads

def deploy_issue_model(request, options = nil) -> ::Gapic::Operation

Pass arguments to deploy_issue_model via a request object, either of type DeployIssueModelRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::DeployIssueModelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def deploy_issue_model(name: nil) -> ::Gapic::Operation

Pass arguments to deploy_issue_model via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The issue model to deploy.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::DeployIssueModelRequest.new

# Call the deploy_issue_model method.
result = client.deploy_issue_model request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#export_insights_data

def export_insights_data(request, options = nil) -> ::Gapic::Operation
def export_insights_data(big_query_destination: nil, parent: nil, filter: nil, kms_key: nil, write_disposition: nil) -> ::Gapic::Operation

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

Overloads

def export_insights_data(request, options = nil) -> ::Gapic::Operation

Pass arguments to export_insights_data via a request object, either of type ExportInsightsDataRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def export_insights_data(big_query_destination: nil, parent: nil, filter: nil, kms_key: nil, write_disposition: nil) -> ::Gapic::Operation

Pass arguments to export_insights_data via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

big_query_destination (::Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest::BigQueryDestination, ::Hash) — Specified if sink is a BigQuery table.
parent (::String) — Required. The parent resource to export data from.
filter (::String) — A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.
kms_key (::String) — A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}
write_disposition (::Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest::WriteDisposition) — Options for what to do if the destination table already exists.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest.new

# Call the export_insights_data method.
result = client.export_insights_data request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_analysis

def get_analysis(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Analysis
def get_analysis(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Analysis

Gets an analysis.

Overloads

def get_analysis(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Analysis

Pass arguments to get_analysis via a request object, either of type GetAnalysisRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::GetAnalysisRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_analysis(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Analysis

Pass arguments to get_analysis via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the analysis to get.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::Analysis)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::Analysis)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::GetAnalysisRequest.new

# Call the get_analysis method.
result = client.get_analysis request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::Analysis.
p result

#get_conversation

def get_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation
def get_conversation(name: nil, view: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Gets a conversation.

Overloads

def get_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Pass arguments to get_conversation via a request object, either of type GetConversationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::GetConversationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_conversation(name: nil, view: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Pass arguments to get_conversation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the conversation to get.
view (::Google::Cloud::ContactCenterInsights::V1::ConversationView) — The level of details of the conversation. Default is FULL.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::Conversation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::Conversation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::GetConversationRequest.new

# Call the get_conversation method.
result = client.get_conversation request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::Conversation.
p result

#get_issue

def get_issue(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue
def get_issue(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue

Gets an issue.

Overloads

def get_issue(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue

Pass arguments to get_issue via a request object, either of type GetIssueRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::GetIssueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_issue(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue

Pass arguments to get_issue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the issue to get.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::Issue)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::Issue)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::GetIssueRequest.new

# Call the get_issue method.
result = client.get_issue request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::Issue.
p result

#get_issue_model

def get_issue_model(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel
def get_issue_model(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel

Gets an issue model.

Overloads

def get_issue_model(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel

Pass arguments to get_issue_model via a request object, either of type GetIssueModelRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::GetIssueModelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_issue_model(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel

Pass arguments to get_issue_model via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the issue model to get.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::IssueModel)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::IssueModel)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::GetIssueModelRequest.new

# Call the get_issue_model method.
result = client.get_issue_model request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::IssueModel.
p result

#get_phrase_matcher

def get_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher
def get_phrase_matcher(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Gets a phrase matcher.

Overloads

def get_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Pass arguments to get_phrase_matcher via a request object, either of type GetPhraseMatcherRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::GetPhraseMatcherRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_phrase_matcher(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Pass arguments to get_phrase_matcher via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the phrase matcher to get.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::GetPhraseMatcherRequest.new

# Call the get_phrase_matcher method.
result = client.get_phrase_matcher request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::PhraseMatcher.
p result

#get_settings

def get_settings(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings
def get_settings(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings

Gets project-level settings.

Overloads

def get_settings(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings

Pass arguments to get_settings via a request object, either of type GetSettingsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::GetSettingsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_settings(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings

Pass arguments to get_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the settings resource to get.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::Settings)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::Settings)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::GetSettingsRequest.new

# Call the get_settings method.
result = client.get_settings request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::Settings.
p result

#get_view

def get_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View
def get_view(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Gets a view.

Overloads

def get_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Pass arguments to get_view via a request object, either of type GetViewRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::GetViewRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_view(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Pass arguments to get_view via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the view to get.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::View)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::View)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::GetViewRequest.new

# Call the get_view method.
result = client.get_view request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::View.
p result

#ingest_conversations

def ingest_conversations(request, options = nil) -> ::Gapic::Operation
def ingest_conversations(gcs_source: nil, transcript_object_config: nil, parent: nil, conversation_config: nil, redaction_config: nil, speech_config: nil) -> ::Gapic::Operation

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

Overloads

def ingest_conversations(request, options = nil) -> ::Gapic::Operation

Pass arguments to ingest_conversations via a request object, either of type IngestConversationsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def ingest_conversations(gcs_source: nil, transcript_object_config: nil, parent: nil, conversation_config: nil, redaction_config: nil, speech_config: nil) -> ::Gapic::Operation

Pass arguments to ingest_conversations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

gcs_source (::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource, ::Hash) — A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.
transcript_object_config (::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::TranscriptObjectConfig, ::Hash) — Configuration for when source contains conversation transcripts.
parent (::String) — Required. The parent resource for new conversations.
conversation_config (::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::ConversationConfig, ::Hash) — Configuration that applies to all conversations.
redaction_config (::Google::Cloud::ContactCenterInsights::V1::RedactionConfig, ::Hash) — Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.
speech_config (::Google::Cloud::ContactCenterInsights::V1::SpeechConfig, ::Hash) — Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest.new

# Call the ingest_conversations method.
result = client.ingest_conversations request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#initialize

def initialize() { |config| ... } -> Client

Create a new ContactCenterInsights REST client object.

Yields

(config) — Configure the ContactCenterInsights client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_analyses

def list_analyses(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>
def list_analyses(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>

Lists analyses.

Overloads

def list_analyses(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>

Pass arguments to list_analyses via a request object, either of type ListAnalysesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::ListAnalysesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_analyses(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>

Pass arguments to list_analyses via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the analyses.
page_size (::Integer) — The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.
page_token (::String) — The value returned by the last ListAnalysesResponse; indicates that this is a continuation of a prior ListAnalyses call and the system should return the next page of data.
filter (::String) — A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::ListAnalysesRequest.new

# Call the list_analyses method.
result = client.list_analyses request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ContactCenterInsights::V1::Analysis.
  p item
end

#list_conversations

def list_conversations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>
def list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>

Lists conversations.

Overloads

def list_conversations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>

Pass arguments to list_conversations via a request object, either of type ListConversationsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::ListConversationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>

Pass arguments to list_conversations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the conversation.
page_size (::Integer) — The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
page_token (::String) — The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.
filter (::String) — A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
view (::Google::Cloud::ContactCenterInsights::V1::ConversationView) — The level of details of the conversation. Default is BASIC.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::ListConversationsRequest.new

# Call the list_conversations method.
result = client.list_conversations request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ContactCenterInsights::V1::Conversation.
  p item
end

#list_issue_models

def list_issue_models(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse
def list_issue_models(parent: nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse

Lists issue models.

Overloads

def list_issue_models(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse

Pass arguments to list_issue_models via a request object, either of type ListIssueModelsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_issue_models(parent: nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse

Pass arguments to list_issue_models via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

parent (::String) — Required. The parent resource of the issue model.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::ListIssueModelsRequest.new

# Call the list_issue_models method.
result = client.list_issue_models request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse.
p result

#list_issues

def list_issues(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse
def list_issues(parent: nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse

Lists issues.

Overloads

def list_issues(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse

Pass arguments to list_issues via a request object, either of type ListIssuesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::ListIssuesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_issues(parent: nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse

Pass arguments to list_issues via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

parent (::String) — Required. The parent resource of the issue.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::ListIssuesRequest.new

# Call the list_issues method.
result = client.list_issues request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse.
p result

#list_phrase_matchers

def list_phrase_matchers(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>
def list_phrase_matchers(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>

Lists phrase matchers.

Overloads

def list_phrase_matchers(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>

Pass arguments to list_phrase_matchers via a request object, either of type ListPhraseMatchersRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::ListPhraseMatchersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_phrase_matchers(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>

Pass arguments to list_phrase_matchers via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the phrase matcher.
page_size (::Integer) — The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.
page_token (::String) — The value returned by the last ListPhraseMatchersResponse. This value indicates that this is a continuation of a prior ListPhraseMatchers call and that the system should return the next page of data.
filter (::String) — A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::ListPhraseMatchersRequest.new

# Call the list_phrase_matchers method.
result = client.list_phrase_matchers request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher.
  p item
end

#list_views

def list_views(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>
def list_views(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>

Lists views.

Overloads

def list_views(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>

Pass arguments to list_views via a request object, either of type ListViewsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::ListViewsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_views(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>

Pass arguments to list_views via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the views.
page_size (::Integer) — The maximum number of views to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.
page_token (::String) — The value returned by the last ListViewsResponse; indicates that this is a continuation of a prior ListViews call and the system should return the next page of data.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::ListViewsRequest.new

# Call the list_views method.
result = client.list_views request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ContactCenterInsights::V1::View.
  p item
end

#operations_client

def operations_client() -> ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Operations)

#undeploy_issue_model

def undeploy_issue_model(request, options = nil) -> ::Gapic::Operation
def undeploy_issue_model(name: nil) -> ::Gapic::Operation

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

Overloads

def undeploy_issue_model(request, options = nil) -> ::Gapic::Operation

Pass arguments to undeploy_issue_model via a request object, either of type UndeployIssueModelRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::UndeployIssueModelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def undeploy_issue_model(name: nil) -> ::Gapic::Operation

Pass arguments to undeploy_issue_model via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The issue model to undeploy.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::UndeployIssueModelRequest.new

# Call the undeploy_issue_model method.
result = client.undeploy_issue_model request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_conversation

def update_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation
def update_conversation(conversation: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Updates a conversation.

Overloads

def update_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Pass arguments to update_conversation via a request object, either of type UpdateConversationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::UpdateConversationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_conversation(conversation: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation

Pass arguments to update_conversation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

conversation (::Google::Cloud::ContactCenterInsights::V1::Conversation, ::Hash) — Required. The new values for the conversation.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::Conversation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::Conversation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::UpdateConversationRequest.new

# Call the update_conversation method.
result = client.update_conversation request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::Conversation.
p result

#update_issue

def update_issue(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue
def update_issue(issue: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue

Updates an issue.

Overloads

def update_issue(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue

Pass arguments to update_issue via a request object, either of type UpdateIssueRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::UpdateIssueRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_issue(issue: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue

Pass arguments to update_issue via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

issue (::Google::Cloud::ContactCenterInsights::V1::Issue, ::Hash) — Required. The new values for the issue.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::Issue)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::Issue)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::UpdateIssueRequest.new

# Call the update_issue method.
result = client.update_issue request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::Issue.
p result

#update_issue_model

def update_issue_model(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel
def update_issue_model(issue_model: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel

Updates an issue model.

Overloads

def update_issue_model(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel

Pass arguments to update_issue_model via a request object, either of type UpdateIssueModelRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::UpdateIssueModelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_issue_model(issue_model: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel

Pass arguments to update_issue_model via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

issue_model (::Google::Cloud::ContactCenterInsights::V1::IssueModel, ::Hash) — Required. The new values for the issue model.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::IssueModel)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::IssueModel)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::UpdateIssueModelRequest.new

# Call the update_issue_model method.
result = client.update_issue_model request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::IssueModel.
p result

#update_phrase_matcher

def update_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher
def update_phrase_matcher(phrase_matcher: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Updates a phrase matcher.

Overloads

def update_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Pass arguments to update_phrase_matcher via a request object, either of type UpdatePhraseMatcherRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::UpdatePhraseMatcherRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_phrase_matcher(phrase_matcher: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher

Pass arguments to update_phrase_matcher via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

phrase_matcher (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher, ::Hash) — Required. The new values for the phrase matcher.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::UpdatePhraseMatcherRequest.new

# Call the update_phrase_matcher method.
result = client.update_phrase_matcher request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::PhraseMatcher.
p result

#update_settings

def update_settings(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings
def update_settings(settings: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings

Updates project-level settings.

Overloads

def update_settings(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings

Pass arguments to update_settings via a request object, either of type UpdateSettingsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::UpdateSettingsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_settings(settings: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings

Pass arguments to update_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

settings (::Google::Cloud::ContactCenterInsights::V1::Settings, ::Hash) — Required. The new settings values.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The list of fields to be updated.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::Settings)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::Settings)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::UpdateSettingsRequest.new

# Call the update_settings method.
result = client.update_settings request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::Settings.
p result

#update_view

def update_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View
def update_view(view: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Updates a view.

Overloads

def update_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Pass arguments to update_view via a request object, either of type UpdateViewRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::UpdateViewRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_view(view: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::View

Pass arguments to update_view via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

view (::Google::Cloud::ContactCenterInsights::V1::View, ::Hash) — Required. The new view.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::ContactCenterInsights::V1::View)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::ContactCenterInsights::V1::View)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::UpdateViewRequest.new

# Call the update_view method.
result = client.update_view request

# The returned object is of type Google::Cloud::ContactCenterInsights::V1::View.
p result

#upload_conversation

def upload_conversation(request, options = nil) -> ::Gapic::Operation
def upload_conversation(parent: nil, conversation: nil, conversation_id: nil, redaction_config: nil, speech_config: nil) -> ::Gapic::Operation

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

Overloads

def upload_conversation(request, options = nil) -> ::Gapic::Operation

Pass arguments to upload_conversation via a request object, either of type UploadConversationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ContactCenterInsights::V1::UploadConversationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def upload_conversation(parent: nil, conversation: nil, conversation_id: nil, redaction_config: nil, speech_config: nil) -> ::Gapic::Operation

Pass arguments to upload_conversation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource of the conversation.
conversation (::Google::Cloud::ContactCenterInsights::V1::Conversation, ::Hash) — Required. The conversation resource to create.
conversation_id (::String) — Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used.

This value should be 4-64 characters and must match the regular expression ^[a-z0-9-]{4,64}$. Valid characters are [a-z][0-9]-
redaction_config (::Google::Cloud::ContactCenterInsights::V1::RedactionConfig, ::Hash) — Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.
speech_config (::Google::Cloud::ContactCenterInsights::V1::SpeechConfig, ::Hash) — Optional. Speech-to-Text configuration. Will default to the config specified in Settings.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/contact_center_insights/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ContactCenterInsights::V1::UploadConversationRequest.new

# Call the upload_conversation method.
result = client.upload_conversation request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end