Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Client.
Client for the ContactCenterInsights service.
An API that lets users analyze and explore their business conversation data.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the ContactCenterInsights Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all ContactCenterInsights clients ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::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.
def bulk_analyze_conversations(request, options = nil) -> ::Gapic::Operation
bulk_analyze_conversations
via a request object, either of type
BulkAnalyzeConversationsRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def bulk_delete_conversations(request, options = nil) -> ::Gapic::Operation
bulk_delete_conversations
via a request object, either of type
BulkDeleteConversationsRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#bulk_download_feedback_labels
def bulk_download_feedback_labels(request, options = nil) -> ::Gapic::Operation
def bulk_download_feedback_labels(gcs_destination: nil, parent: nil, filter: nil, max_download_count: nil, feedback_label_type: nil, conversation_filter: nil, template_qa_scorecard_id: nil) -> ::Gapic::Operation
Download feedback labels in bulk.
def bulk_download_feedback_labels(request, options = nil) -> ::Gapic::Operation
bulk_download_feedback_labels
via a request object, either of type
BulkDownloadFeedbackLabelsRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest, ::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_download_feedback_labels(gcs_destination: nil, parent: nil, filter: nil, max_download_count: nil, feedback_label_type: nil, conversation_filter: nil, template_qa_scorecard_id: nil) -> ::Gapic::Operation
bulk_download_feedback_labels
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).
- gcs_destination (::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::GcsDestination, ::Hash) — A cloud storage bucket destination.
- parent (::String) — Required. The parent resource for new feedback labels.
-
filter (::String) —
Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND).
Supported fields:
issue_model_id
qa_question_id
qa_scorecard_id
min_create_time
max_create_time
min_update_time
max_update_time
feedback_label_type
: QUALITY_AI, TOPIC_MODELING
-
max_download_count (::Integer) — Optional. Limits the maximum number of feedback labels that will be
downloaded. The first
N
feedback labels will be downloaded. - feedback_label_type (::Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest::FeedbackLabelType) — Optional. The type of feedback labels that will be downloaded.
-
conversation_filter (::String) — Optional. Filter parent conversations to download feedback labels for.
When specified, the feedback labels will be downloaded for the
conversations that match the filter.
If
template_qa_scorecard_id
is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling. -
template_qa_scorecard_id (::Array<::String>) — Optional. If set, a template for labeling conversations and scorecard
questions will be created from the conversation_filter and the questions
under the scorecard(s). The feedback label
filter
will be ignored.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::BulkDownloadFeedbackLabelsRequest.new # Call the bulk_download_feedback_labels method. result = client.bulk_download_feedback_labels 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_upload_feedback_labels
def bulk_upload_feedback_labels(request, options = nil) -> ::Gapic::Operation
def bulk_upload_feedback_labels(gcs_source: nil, parent: nil, validate_only: nil) -> ::Gapic::Operation
Upload feedback labels in bulk.
def bulk_upload_feedback_labels(request, options = nil) -> ::Gapic::Operation
bulk_upload_feedback_labels
via a request object, either of type
BulkUploadFeedbackLabelsRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::BulkUploadFeedbackLabelsRequest, ::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_upload_feedback_labels(gcs_source: nil, parent: nil, validate_only: nil) -> ::Gapic::Operation
bulk_upload_feedback_labels
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).
- gcs_source (::Google::Cloud::ContactCenterInsights::V1::BulkUploadFeedbackLabelsRequest::GcsSource, ::Hash) — A cloud storage bucket source.
- parent (::String) — Required. The parent resource for new feedback labels.
- validate_only (::Boolean) — Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::BulkUploadFeedbackLabelsRequest.new # Call the bulk_upload_feedback_labels method. result = client.bulk_upload_feedback_labels 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.
def calculate_issue_model_stats(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse
calculate_issue_model_stats
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsRequest or an equivalent Hash.
- 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
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).
- issue_model (::String) — Required. The resource name of the issue model to query against.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::CalculateIssueModelStatsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def calculate_stats(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse
calculate_stats
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CalculateStatsRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
- (config) — Configure the Client client.
- config (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.
def create_analysis(request, options = nil) -> ::Gapic::Operation
create_analysis
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateAnalysisRequest or an equivalent Hash.
- 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
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).
- parent (::String) — Required. The parent resource of the analysis.
- analysis (::Google::Cloud::ContactCenterInsights::V1::Analysis, ::Hash) — Required. The analysis to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_analysis_rule
def create_analysis_rule(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
def create_analysis_rule(parent: nil, analysis_rule: nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
Creates a analysis rule.
def create_analysis_rule(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
create_analysis_rule
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateAnalysisRuleRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::CreateAnalysisRuleRequest, ::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_rule(parent: nil, analysis_rule: nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
create_analysis_rule
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).
-
parent (::String) — Required. The parent resource of the analysis rule. Required. The location
to create a analysis rule for. Format:
projects/<Project ID>/locations/<Location ID>
orprojects/<Project Number>/locations/<Location ID>
- analysis_rule (::Google::Cloud::ContactCenterInsights::V1::AnalysisRule, ::Hash) — Required. The analysis rule resource to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::AnalysisRule)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::CreateAnalysisRuleRequest.new # Call the create_analysis_rule method. result = client.create_analysis_rule request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::AnalysisRule. p result
#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.
Note that this method does not support audio transcription or redaction.
Use conversations.upload
instead.
def create_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation
create_conversation
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateConversationRequest or an equivalent Hash.
- 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
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).
- 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]-
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::Conversation)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_feedback_label
def create_feedback_label(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
def create_feedback_label(parent: nil, feedback_label_id: nil, feedback_label: nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
Create feedback label.
def create_feedback_label(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
create_feedback_label
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateFeedbackLabelRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::CreateFeedbackLabelRequest, ::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_feedback_label(parent: nil, feedback_label_id: nil, feedback_label: nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
create_feedback_label
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).
- parent (::String) — Required. The parent resource of the feedback label.
- feedback_label_id (::String) — Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.
- feedback_label (::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel, ::Hash) — Required. The feedback label to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::CreateFeedbackLabelRequest.new # Call the create_feedback_label method. result = client.create_feedback_label request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::FeedbackLabel. 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.
def create_issue_model(request, options = nil) -> ::Gapic::Operation
create_issue_model
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateIssueModelRequest or an equivalent Hash.
- 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
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).
- parent (::String) — Required. The parent resource of the issue model.
- issue_model (::Google::Cloud::ContactCenterInsights::V1::IssueModel, ::Hash) — Required. The issue model to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def create_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher
create_phrase_matcher
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreatePhraseMatcherRequest or an equivalent Hash.
- 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
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).
-
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>
orprojects/<Project Number>/locations/<Location ID>
- phrase_matcher (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher, ::Hash) — Required. The phrase matcher resource to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_qa_question
def create_qa_question(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
def create_qa_question(parent: nil, qa_question: nil, qa_question_id: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
Create a QaQuestion.
def create_qa_question(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
create_qa_question
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateQaQuestionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::CreateQaQuestionRequest, ::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_qa_question(parent: nil, qa_question: nil, qa_question_id: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
create_qa_question
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).
- parent (::String) — Required. The parent resource of the QaQuestion.
- qa_question (::Google::Cloud::ContactCenterInsights::V1::QaQuestion, ::Hash) — Required. The QaQuestion to create.
-
qa_question_id (::String) — Optional. A unique ID for the new question. This ID will become the final
component of the question'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]-
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaQuestion)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::CreateQaQuestionRequest.new # Call the create_qa_question method. result = client.create_qa_question request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaQuestion. p result
#create_qa_scorecard
def create_qa_scorecard(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
def create_qa_scorecard(parent: nil, qa_scorecard: nil, qa_scorecard_id: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
Create a QaScorecard.
def create_qa_scorecard(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
create_qa_scorecard
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateQaScorecardRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::CreateQaScorecardRequest, ::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_qa_scorecard(parent: nil, qa_scorecard: nil, qa_scorecard_id: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
create_qa_scorecard
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).
- parent (::String) — Required. The parent resource of the QaScorecard.
- qa_scorecard (::Google::Cloud::ContactCenterInsights::V1::QaScorecard, ::Hash) — Required. The QaScorecard to create.
-
qa_scorecard_id (::String) — Optional. A unique ID for the new QaScorecard. This ID will become the
final component of the QaScorecard'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]-
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaScorecard)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::CreateQaScorecardRequest.new # Call the create_qa_scorecard method. result = client.create_qa_scorecard request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaScorecard. p result
#create_qa_scorecard_revision
def create_qa_scorecard_revision(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
def create_qa_scorecard_revision(parent: nil, qa_scorecard_revision: nil, qa_scorecard_revision_id: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
Creates a QaScorecardRevision.
def create_qa_scorecard_revision(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
create_qa_scorecard_revision
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateQaScorecardRevisionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::CreateQaScorecardRevisionRequest, ::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_qa_scorecard_revision(parent: nil, qa_scorecard_revision: nil, qa_scorecard_revision_id: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
create_qa_scorecard_revision
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).
- parent (::String) — Required. The parent resource of the QaScorecardRevision.
- qa_scorecard_revision (::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision, ::Hash) — Required. The QaScorecardRevision to create.
-
qa_scorecard_revision_id (::String) — Optional. A unique ID for the new QaScorecardRevision. This ID will become
the final component of the QaScorecardRevision'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]-
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::CreateQaScorecardRevisionRequest.new # Call the create_qa_scorecard_revision method. result = client.create_qa_scorecard_revision request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision. 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.
def create_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View
create_view
via a request object, either of type
Google::Cloud::ContactCenterInsights::V1::CreateViewRequest or an equivalent Hash.
- 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
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).
-
parent (::String) — Required. The parent resource of the view. Required. The location to create
a view for.
Format:
projects/<Project ID>/locations/<Location ID>
orprojects/<Project Number>/locations/<Location ID>
- view (::Google::Cloud::ContactCenterInsights::V1::View, ::Hash) — Required. The view resource to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::View)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def delete_analysis(request, options = nil) -> ::Google::Protobuf::Empty
delete_analysis
via a request object, either of type
DeleteAnalysisRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the analysis to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_analysis_rule
def delete_analysis_rule(request, options = nil) -> ::Google::Protobuf::Empty
def delete_analysis_rule(name: nil) -> ::Google::Protobuf::Empty
Deletes a analysis rule.
def delete_analysis_rule(request, options = nil) -> ::Google::Protobuf::Empty
delete_analysis_rule
via a request object, either of type
DeleteAnalysisRuleRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::DeleteAnalysisRuleRequest, ::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_rule(name: nil) -> ::Google::Protobuf::Empty
delete_analysis_rule
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).
- name (::String) — Required. The name of the analysis rule to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::DeleteAnalysisRuleRequest.new # Call the delete_analysis_rule method. result = client.delete_analysis_rule 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.
def delete_conversation(request, options = nil) -> ::Google::Protobuf::Empty
delete_conversation
via a request object, either of type
DeleteConversationRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_feedback_label
def delete_feedback_label(request, options = nil) -> ::Google::Protobuf::Empty
def delete_feedback_label(name: nil) -> ::Google::Protobuf::Empty
Delete feedback label.
def delete_feedback_label(request, options = nil) -> ::Google::Protobuf::Empty
delete_feedback_label
via a request object, either of type
DeleteFeedbackLabelRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::DeleteFeedbackLabelRequest, ::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_feedback_label(name: nil) -> ::Google::Protobuf::Empty
delete_feedback_label
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).
- name (::String) — Required. The name of the feedback label to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::DeleteFeedbackLabelRequest.new # Call the delete_feedback_label method. result = client.delete_feedback_label 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.
def delete_issue(request, options = nil) -> ::Google::Protobuf::Empty
delete_issue
via a request object, either of type
DeleteIssueRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the issue to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def delete_issue_model(request, options = nil) -> ::Gapic::Operation
delete_issue_model
via a request object, either of type
DeleteIssueModelRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the issue model to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def delete_phrase_matcher(request, options = nil) -> ::Google::Protobuf::Empty
delete_phrase_matcher
via a request object, either of type
DeletePhraseMatcherRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the phrase matcher to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_qa_question
def delete_qa_question(request, options = nil) -> ::Google::Protobuf::Empty
def delete_qa_question(name: nil) -> ::Google::Protobuf::Empty
Deletes a QaQuestion.
def delete_qa_question(request, options = nil) -> ::Google::Protobuf::Empty
delete_qa_question
via a request object, either of type
DeleteQaQuestionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::DeleteQaQuestionRequest, ::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_qa_question(name: nil) -> ::Google::Protobuf::Empty
delete_qa_question
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).
- name (::String) — Required. The name of the QaQuestion to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::DeleteQaQuestionRequest.new # Call the delete_qa_question method. result = client.delete_qa_question request # The returned object is of type Google::Protobuf::Empty. p result
#delete_qa_scorecard
def delete_qa_scorecard(request, options = nil) -> ::Google::Protobuf::Empty
def delete_qa_scorecard(name: nil, force: nil) -> ::Google::Protobuf::Empty
Deletes a QaScorecard.
def delete_qa_scorecard(request, options = nil) -> ::Google::Protobuf::Empty
delete_qa_scorecard
via a request object, either of type
DeleteQaScorecardRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::DeleteQaScorecardRequest, ::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_qa_scorecard(name: nil, force: nil) -> ::Google::Protobuf::Empty
delete_qa_scorecard
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).
- name (::String) — Required. The name of the QaScorecard to delete.
- force (::Boolean) — Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::DeleteQaScorecardRequest.new # Call the delete_qa_scorecard method. result = client.delete_qa_scorecard request # The returned object is of type Google::Protobuf::Empty. p result
#delete_qa_scorecard_revision
def delete_qa_scorecard_revision(request, options = nil) -> ::Google::Protobuf::Empty
def delete_qa_scorecard_revision(name: nil, force: nil) -> ::Google::Protobuf::Empty
Deletes a QaScorecardRevision.
def delete_qa_scorecard_revision(request, options = nil) -> ::Google::Protobuf::Empty
delete_qa_scorecard_revision
via a request object, either of type
DeleteQaScorecardRevisionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::DeleteQaScorecardRevisionRequest, ::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_qa_scorecard_revision(name: nil, force: nil) -> ::Google::Protobuf::Empty
delete_qa_scorecard_revision
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).
- name (::String) — Required. The name of the QaScorecardRevision to delete.
- force (::Boolean) — Optional. If set to true, all of this QaScorecardRevision's child resources will also be deleted. Otherwise, the request will only succeed if it has none.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::DeleteQaScorecardRevisionRequest.new # Call the delete_qa_scorecard_revision method. result = client.delete_qa_scorecard_revision 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.
def delete_view(request, options = nil) -> ::Google::Protobuf::Empty
delete_view
via a request object, either of type
DeleteViewRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the view to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def deploy_issue_model(request, options = nil) -> ::Gapic::Operation
deploy_issue_model
via a request object, either of type
DeployIssueModelRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The issue model to deploy.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#deploy_qa_scorecard_revision
def deploy_qa_scorecard_revision(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
def deploy_qa_scorecard_revision(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
Deploy a QaScorecardRevision.
def deploy_qa_scorecard_revision(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
deploy_qa_scorecard_revision
via a request object, either of type
DeployQaScorecardRevisionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::DeployQaScorecardRevisionRequest, ::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_qa_scorecard_revision(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
deploy_qa_scorecard_revision
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).
- name (::String) — Required. The name of the QaScorecardRevision to deploy.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::DeployQaScorecardRevisionRequest.new # Call the deploy_qa_scorecard_revision method. result = client.deploy_qa_scorecard_revision request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision. p result
#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.
def export_insights_data(request, options = nil) -> ::Gapic::Operation
export_insights_data
via a request object, either of type
ExportInsightsDataRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#export_issue_model
def export_issue_model(request, options = nil) -> ::Gapic::Operation
def export_issue_model(gcs_destination: nil, name: nil) -> ::Gapic::Operation
Exports an issue model to the provided destination.
def export_issue_model(request, options = nil) -> ::Gapic::Operation
export_issue_model
via a request object, either of type
ExportIssueModelRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::ExportIssueModelRequest, ::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_issue_model(gcs_destination: nil, name: nil) -> ::Gapic::Operation
export_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).
- gcs_destination (::Google::Cloud::ContactCenterInsights::V1::ExportIssueModelRequest::GcsDestination, ::Hash) — Google Cloud Storage URI to export the issue model to.
- name (::String) — Required. The issue model to export.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::ExportIssueModelRequest.new # Call the export_issue_model method. result = client.export_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
#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.
def get_analysis(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Analysis
get_analysis
via a request object, either of type
GetAnalysisRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the analysis to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::Analysis)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_analysis_rule
def get_analysis_rule(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
def get_analysis_rule(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
Get a analysis rule.
def get_analysis_rule(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
get_analysis_rule
via a request object, either of type
GetAnalysisRuleRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::GetAnalysisRuleRequest, ::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_rule(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
get_analysis_rule
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).
- name (::String) — Required. The name of the AnalysisRule to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::AnalysisRule)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::GetAnalysisRuleRequest.new # Call the get_analysis_rule method. result = client.get_analysis_rule request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::AnalysisRule. 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.
def get_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation
get_conversation
via a request object, either of type
GetConversationRequest or an equivalent Hash.
- 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
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).
- 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
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::Conversation)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_encryption_spec
def get_encryption_spec(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::EncryptionSpec
def get_encryption_spec(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::EncryptionSpec
Gets location-level encryption key specification.
def get_encryption_spec(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::EncryptionSpec
get_encryption_spec
via a request object, either of type
GetEncryptionSpecRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::GetEncryptionSpecRequest, ::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_encryption_spec(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::EncryptionSpec
get_encryption_spec
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).
- name (::String) — Required. The name of the encryption spec resource to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::EncryptionSpec)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::GetEncryptionSpecRequest.new # Call the get_encryption_spec method. result = client.get_encryption_spec request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::EncryptionSpec. p result
#get_feedback_label
def get_feedback_label(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
def get_feedback_label(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
Get feedback label.
def get_feedback_label(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
get_feedback_label
via a request object, either of type
GetFeedbackLabelRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::GetFeedbackLabelRequest, ::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_feedback_label(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
get_feedback_label
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).
- name (::String) — Required. The name of the feedback label to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::GetFeedbackLabelRequest.new # Call the get_feedback_label method. result = client.get_feedback_label request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::FeedbackLabel. 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.
def get_issue(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue
get_issue
via a request object, either of type
GetIssueRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the issue to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::Issue)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def get_issue_model(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel
get_issue_model
via a request object, either of type
GetIssueModelRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the issue model to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::IssueModel)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def get_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher
get_phrase_matcher
via a request object, either of type
GetPhraseMatcherRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the phrase matcher to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_qa_question
def get_qa_question(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
def get_qa_question(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
Gets a QaQuestion.
def get_qa_question(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
get_qa_question
via a request object, either of type
GetQaQuestionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::GetQaQuestionRequest, ::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_qa_question(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
get_qa_question
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).
- name (::String) — Required. The name of the QaQuestion to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaQuestion)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::GetQaQuestionRequest.new # Call the get_qa_question method. result = client.get_qa_question request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaQuestion. p result
#get_qa_scorecard
def get_qa_scorecard(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
def get_qa_scorecard(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
Gets a QaScorecard.
def get_qa_scorecard(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
get_qa_scorecard
via a request object, either of type
GetQaScorecardRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::GetQaScorecardRequest, ::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_qa_scorecard(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
get_qa_scorecard
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).
- name (::String) — Required. The name of the QaScorecard to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaScorecard)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::GetQaScorecardRequest.new # Call the get_qa_scorecard method. result = client.get_qa_scorecard request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaScorecard. p result
#get_qa_scorecard_revision
def get_qa_scorecard_revision(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
def get_qa_scorecard_revision(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
Gets a QaScorecardRevision.
def get_qa_scorecard_revision(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
get_qa_scorecard_revision
via a request object, either of type
GetQaScorecardRevisionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::GetQaScorecardRevisionRequest, ::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_qa_scorecard_revision(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
get_qa_scorecard_revision
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).
- name (::String) — Required. The name of the QaScorecardRevision to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::GetQaScorecardRevisionRequest.new # Call the get_qa_scorecard_revision method. result = client.get_qa_scorecard_revision request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision. 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.
def get_settings(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings
get_settings
via a request object, either of type
GetSettingsRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the settings resource to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::Settings)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def get_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View
get_view
via a request object, either of type
GetViewRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the view to get.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::View)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client
Get the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Client)
#import_issue_model
def import_issue_model(request, options = nil) -> ::Gapic::Operation
def import_issue_model(gcs_source: nil, parent: nil, create_new_model: nil) -> ::Gapic::Operation
Imports an issue model from a Cloud Storage bucket.
def import_issue_model(request, options = nil) -> ::Gapic::Operation
import_issue_model
via a request object, either of type
ImportIssueModelRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::ImportIssueModelRequest, ::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 import_issue_model(gcs_source: nil, parent: nil, create_new_model: nil) -> ::Gapic::Operation
import_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).
- gcs_source (::Google::Cloud::ContactCenterInsights::V1::ImportIssueModelRequest::GcsSource, ::Hash) — Google Cloud Storage source message.
- parent (::String) — Required. The parent resource of the issue model.
- create_new_model (::Boolean) — Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::ImportIssueModelRequest.new # Call the import_issue_model method. result = client.import_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
#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, sample_size: nil) -> ::Gapic::Operation
Imports conversations and processes them according to the user's configuration.
def ingest_conversations(request, options = nil) -> ::Gapic::Operation
ingest_conversations
via a request object, either of type
IngestConversationsRequest or an equivalent Hash.
- 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, sample_size: nil) -> ::Gapic::Operation
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).
- 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.
- sample_size (::Integer) — Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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 client object.
- (config) — Configure the ContactCenterInsights client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Client.new # Create a client using a custom configuration client = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Client.new do |config| config.timeout = 10.0 end
#initialize_encryption_spec
def initialize_encryption_spec(request, options = nil) -> ::Gapic::Operation
def initialize_encryption_spec(encryption_spec: nil) -> ::Gapic::Operation
Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
def initialize_encryption_spec(request, options = nil) -> ::Gapic::Operation
initialize_encryption_spec
via a request object, either of type
InitializeEncryptionSpecRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::InitializeEncryptionSpecRequest, ::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 initialize_encryption_spec(encryption_spec: nil) -> ::Gapic::Operation
initialize_encryption_spec
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).
-
encryption_spec (::Google::Cloud::ContactCenterInsights::V1::EncryptionSpec, ::Hash) — Required. The encryption spec used for CMEK encryption. It is required that
the kms key is in the same region as the endpoint. The same key will be
used for all provisioned resources, if encryption is available. If the
kms_key_name
field is left empty, no encryption will be enforced.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::InitializeEncryptionSpecRequest.new # Call the initialize_encryption_spec method. result = client.initialize_encryption_spec 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
#list_all_feedback_labels
def list_all_feedback_labels(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>
def list_all_feedback_labels(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>
List all feedback labels by project number.
def list_all_feedback_labels(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>
list_all_feedback_labels
via a request object, either of type
ListAllFeedbackLabelsRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::ListAllFeedbackLabelsRequest, ::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_all_feedback_labels(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>
list_all_feedback_labels
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).
- parent (::String) — Required. The parent resource of all feedback labels per project.
- page_size (::Integer) — Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,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) — Optional. The value returned by the last
ListAllFeedbackLabelsResponse
. This value indicates that this is a continuation of a priorListAllFeedbackLabels
call and that the system should return the next page of data. -
filter (::String) —
Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND).
Supported fields:
issue_model_id
qa_question_id
min_create_time
max_create_time
min_update_time
max_update_time
feedback_label_type
: QUALITY_AI, TOPIC_MODELING
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::ListAllFeedbackLabelsRequest.new # Call the list_all_feedback_labels method. result = client.list_all_feedback_labels 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::FeedbackLabel. p item end
#list_analyses
def list_analyses(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>
def list_analyses(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>
Lists analyses.
def list_analyses(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>
list_analyses
via a request object, either of type
ListAnalysesRequest or an equivalent Hash.
- 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::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>
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).
- 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 priorListAnalyses
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Analysis>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_analysis_rules
def list_analysis_rules(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::AnalysisRule>
def list_analysis_rules(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::AnalysisRule>
Lists analysis rules.
def list_analysis_rules(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::AnalysisRule>
list_analysis_rules
via a request object, either of type
ListAnalysisRulesRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::ListAnalysisRulesRequest, ::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_analysis_rules(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::AnalysisRule>
list_analysis_rules
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).
- parent (::String) — Required. The parent resource of the analysis rules.
-
page_size (::Integer) — Optional. The maximum number of analysis rule 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) — Optional. The value returned by the last
ListAnalysisRulesResponse
; indicates that this is a continuation of a priorListAnalysisRules
call and the system should return the next page of data.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::AnalysisRule>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::AnalysisRule>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::ListAnalysisRulesRequest.new # Call the list_analysis_rules method. result = client.list_analysis_rules 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::AnalysisRule. p item end
#list_conversations
def list_conversations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>
def list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>
Lists conversations.
def list_conversations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>
list_conversations
via a request object, either of type
ListConversationsRequest or an equivalent Hash.
- 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, order_by: nil, view: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>
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).
- 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 100,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 priorListConversations
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.
-
order_by (::String) — Optional. The attribute by which to order conversations in the response.
If empty, conversations will be ordered by descending creation time.
Supported values are one of the following:
- create_time
- customer_satisfaction_rating
- duration
- latest_analysis
- start_time
- turn_count
The default sort order is ascending. To specify order, append
asc
ordesc
(create_time desc
). For more details, see Google AIPs Ordering. -
view (::Google::Cloud::ContactCenterInsights::V1::ConversationView) — The level of details of the conversation. Default is
BASIC
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::Conversation>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_feedback_labels
def list_feedback_labels(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>
def list_feedback_labels(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>
List feedback labels.
def list_feedback_labels(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>
list_feedback_labels
via a request object, either of type
ListFeedbackLabelsRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::ListFeedbackLabelsRequest, ::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_feedback_labels(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>
list_feedback_labels
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).
- parent (::String) — Required. The parent resource of the feedback labels.
-
filter (::String) —
Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels.
Supported fields:
issue_model_id
qa_question_id
qa_scorecard_id
min_create_time
max_create_time
min_update_time
max_update_time
feedback_label_type
: QUALITY_AI, TOPIC_MODELING
- page_size (::Integer) — Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,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) — Optional. The value returned by the last
ListFeedbackLabelsResponse
. This value indicates that this is a continuation of a priorListFeedbackLabels
call and that the system should return the next page of data.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::ListFeedbackLabelsRequest.new # Call the list_feedback_labels method. result = client.list_feedback_labels 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::FeedbackLabel. 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.
def list_issue_models(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse
list_issue_models
via a request object, either of type
ListIssueModelsRequest or an equivalent Hash.
- 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
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).
- parent (::String) — Required. The parent resource of the issue model.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::ListIssueModelsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def list_issues(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse
list_issues
via a request object, either of type
ListIssuesRequest or an equivalent Hash.
- 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
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).
- parent (::String) — Required. The parent resource of the issue.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::ListIssuesResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>
def list_phrase_matchers(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>
Lists phrase matchers.
def list_phrase_matchers(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>
list_phrase_matchers
via a request object, either of type
ListPhraseMatchersRequest or an equivalent Hash.
- 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::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>
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).
- 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 priorListPhraseMatchers
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_qa_questions
def list_qa_questions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaQuestion>
def list_qa_questions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaQuestion>
Lists QaQuestions.
def list_qa_questions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaQuestion>
list_qa_questions
via a request object, either of type
ListQaQuestionsRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::ListQaQuestionsRequest, ::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_qa_questions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaQuestion>
list_qa_questions
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).
- parent (::String) — Required. The parent resource of the questions.
-
page_size (::Integer) — Optional. The maximum number of questions to return in the response. If the
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) — Optional. The value returned by the last
ListQaQuestionsResponse
. This value indicates that this is a continuation of a priorListQaQuestions
call and that the system should return the next page of data.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaQuestion>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaQuestion>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::ListQaQuestionsRequest.new # Call the list_qa_questions method. result = client.list_qa_questions 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::QaQuestion. p item end
#list_qa_scorecard_revisions
def list_qa_scorecard_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision>
def list_qa_scorecard_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision>
Lists all revisions under the parent QaScorecard.
def list_qa_scorecard_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision>
list_qa_scorecard_revisions
via a request object, either of type
ListQaScorecardRevisionsRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::ListQaScorecardRevisionsRequest, ::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_qa_scorecard_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision>
list_qa_scorecard_revisions
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).
- parent (::String) — Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character.
-
page_size (::Integer) — Optional. The maximum number of scorecard revisions to return in the
response. If the 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) — Optional. The value returned by the last
ListQaScorecardRevisionsResponse
. This value indicates that this is a continuation of a priorListQaScorecardRevisions
call and that the system should return the next page of data. - filter (::String) — Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::ListQaScorecardRevisionsRequest.new # Call the list_qa_scorecard_revisions method. result = client.list_qa_scorecard_revisions 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::QaScorecardRevision. p item end
#list_qa_scorecards
def list_qa_scorecards(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecard>
def list_qa_scorecards(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecard>
Lists QaScorecards.
def list_qa_scorecards(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecard>
list_qa_scorecards
via a request object, either of type
ListQaScorecardsRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::ListQaScorecardsRequest, ::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_qa_scorecards(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecard>
list_qa_scorecards
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).
- parent (::String) — Required. The parent resource of the scorecards.
-
page_size (::Integer) — Optional. The maximum number of scorecards to return in the response. If
the 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) — Optional. The value returned by the last
ListQaScorecardsResponse
. This value indicates that this is a continuation of a priorListQaScorecards
call and that the system should return the next page of data.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecard>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::QaScorecard>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::ListQaScorecardsRequest.new # Call the list_qa_scorecards method. result = client.list_qa_scorecards 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::QaScorecard. p item end
#list_views
def list_views(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>
def list_views(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>
Lists views.
def list_views(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>
list_views
via a request object, either of type
ListViewsRequest or an equivalent Hash.
- 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::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>
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).
- 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 priorListViews
call and the system should return the next page of data.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ContactCenterInsights::V1::View>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#operations_client
def operations_client() -> ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Operations
Get the associated client for long-running operations.
#query_metrics
def query_metrics(request, options = nil) -> ::Gapic::Operation
def query_metrics(location: nil, filter: nil, time_granularity: nil, dimensions: nil, measure_mask: nil) -> ::Gapic::Operation
Query metrics.
def query_metrics(request, options = nil) -> ::Gapic::Operation
query_metrics
via a request object, either of type
QueryMetricsRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest, ::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 query_metrics(location: nil, filter: nil, time_granularity: nil, dimensions: nil, measure_mask: nil) -> ::Gapic::Operation
query_metrics
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).
- location (::String) — Required. The location of the data. "projects/{project}/locations/{location}"
- filter (::String) — Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).
- time_granularity (::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest::TimeGranularity) — The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.
-
dimensions (::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension, ::Hash>) — The dimensions that determine the grouping key for the query. Defaults to
no dimension if this field is unspecified. If a dimension is specified,
its key must also be specified. Each dimension's key must be unique.
If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity.
Up to one dimension is supported for now.
-
measure_mask (::Google::Protobuf::FieldMask, ::Hash) — Measures to return. Defaults to all measures if this field is unspecified.
A valid mask should traverse from the
measure
field from the response. For example, a path from a measure mask to get the conversation count is "conversation_measure.count".
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest.new # Call the query_metrics method. result = client.query_metrics 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
#tune_qa_scorecard_revision
def tune_qa_scorecard_revision(request, options = nil) -> ::Gapic::Operation
def tune_qa_scorecard_revision(parent: nil, filter: nil, validate_only: nil) -> ::Gapic::Operation
Fine tune one or more QaModels.
def tune_qa_scorecard_revision(request, options = nil) -> ::Gapic::Operation
tune_qa_scorecard_revision
via a request object, either of type
TuneQaScorecardRevisionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::TuneQaScorecardRevisionRequest, ::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 tune_qa_scorecard_revision(parent: nil, filter: nil, validate_only: nil) -> ::Gapic::Operation
tune_qa_scorecard_revision
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).
- parent (::String) — Required. The parent resource for new fine tuning job instance.
- filter (::String) — Required. Filter for selecting the feedback labels that needs to be used for training. This filter can be used to limit the feedback labels used for tuning to a feedback labels created or updated for a specific time-window etc.
- validate_only (::Boolean) — Optional. Run in validate only mode, no fine tuning will actually run. Data quality validations like training data distributions will run. Even when set to false, the data quality validations will still run but once the validations complete we will proceed with the fine tune, if applicable.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::TuneQaScorecardRevisionRequest.new # Call the tune_qa_scorecard_revision method. result = client.tune_qa_scorecard_revision 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
#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.
def undeploy_issue_model(request, options = nil) -> ::Gapic::Operation
undeploy_issue_model
via a request object, either of type
UndeployIssueModelRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The issue model to undeploy.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#undeploy_qa_scorecard_revision
def undeploy_qa_scorecard_revision(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
def undeploy_qa_scorecard_revision(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
Undeploy a QaScorecardRevision.
def undeploy_qa_scorecard_revision(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
undeploy_qa_scorecard_revision
via a request object, either of type
UndeployQaScorecardRevisionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::UndeployQaScorecardRevisionRequest, ::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_qa_scorecard_revision(name: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision
undeploy_qa_scorecard_revision
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).
- name (::String) — Required. The name of the QaScorecardRevision to undeploy.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::UndeployQaScorecardRevisionRequest.new # Call the undeploy_qa_scorecard_revision method. result = client.undeploy_qa_scorecard_revision request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaScorecardRevision. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_analysis_rule
def update_analysis_rule(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
def update_analysis_rule(analysis_rule: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
Updates a analysis rule.
def update_analysis_rule(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
update_analysis_rule
via a request object, either of type
UpdateAnalysisRuleRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::UpdateAnalysisRuleRequest, ::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_analysis_rule(analysis_rule: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::AnalysisRule
update_analysis_rule
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).
- analysis_rule (::Google::Cloud::ContactCenterInsights::V1::AnalysisRule, ::Hash) — Required. The new analysis rule.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::AnalysisRule)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::UpdateAnalysisRuleRequest.new # Call the update_analysis_rule method. result = client.update_analysis_rule request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::AnalysisRule. p result
#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.
def update_conversation(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation
update_conversation
via a request object, either of type
UpdateConversationRequest or an equivalent Hash.
- 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
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).
- 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. All possible fields can be updated by passing
*
, or a subset of the following updateable fields can be provided:agent_id
language_code
labels
metadata
quality_metadata
call_metadata
start_time
expire_time
orttl
data_source.gcs_source.audio_uri
ordata_source.dialogflow_source.audio_uri
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::Conversation)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_feedback_label
def update_feedback_label(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
def update_feedback_label(feedback_label: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
Update feedback label.
def update_feedback_label(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
update_feedback_label
via a request object, either of type
UpdateFeedbackLabelRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::UpdateFeedbackLabelRequest, ::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_feedback_label(feedback_label: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel
update_feedback_label
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).
- feedback_label (::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel, ::Hash) — Required. The feedback label to update.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The list of fields to be updated.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::FeedbackLabel)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::UpdateFeedbackLabelRequest.new # Call the update_feedback_label method. result = client.update_feedback_label request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::FeedbackLabel. 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.
def update_issue(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Issue
update_issue
via a request object, either of type
UpdateIssueRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::Issue)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def update_issue_model(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::IssueModel
update_issue_model
via a request object, either of type
UpdateIssueModelRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::IssueModel)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def update_phrase_matcher(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher
update_phrase_matcher
via a request object, either of type
UpdatePhraseMatcherRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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_qa_question
def update_qa_question(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
def update_qa_question(qa_question: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
Updates a QaQuestion.
def update_qa_question(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
update_qa_question
via a request object, either of type
UpdateQaQuestionRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::UpdateQaQuestionRequest, ::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_qa_question(qa_question: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaQuestion
update_qa_question
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).
- qa_question (::Google::Cloud::ContactCenterInsights::V1::QaQuestion, ::Hash) — Required. The QaQuestion to update.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) —
Required. The list of fields to be updated. All possible fields can be updated by passing
*
, or a subset of the following updateable fields can be provided:abbreviation
answer_choices
answer_instructions
order
question_body
tags
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaQuestion)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::UpdateQaQuestionRequest.new # Call the update_qa_question method. result = client.update_qa_question request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaQuestion. p result
#update_qa_scorecard
def update_qa_scorecard(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
def update_qa_scorecard(qa_scorecard: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
Updates a QaScorecard.
def update_qa_scorecard(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
update_qa_scorecard
via a request object, either of type
UpdateQaScorecardRequest or an equivalent Hash.
- request (::Google::Cloud::ContactCenterInsights::V1::UpdateQaScorecardRequest, ::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_qa_scorecard(qa_scorecard: nil, update_mask: nil) -> ::Google::Cloud::ContactCenterInsights::V1::QaScorecard
update_qa_scorecard
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).
- qa_scorecard (::Google::Cloud::ContactCenterInsights::V1::QaScorecard, ::Hash) — Required. The QaScorecard to update.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) —
Required. The list of fields to be updated. All possible fields can be updated by passing
*
, or a subset of the following updateable fields can be provided:description
display_name
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::QaScorecard)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::ContactCenterInsights::V1::UpdateQaScorecardRequest.new # Call the update_qa_scorecard method. result = client.update_qa_scorecard request # The returned object is of type Google::Cloud::ContactCenterInsights::V1::QaScorecard. 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.
def update_settings(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::Settings
update_settings
via a request object, either of type
UpdateSettingsRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::Settings)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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.
def update_view(request, options = nil) -> ::Google::Cloud::ContactCenterInsights::V1::View
update_view
via a request object, either of type
UpdateViewRequest or an equivalent Hash.
- 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
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).
- view (::Google::Cloud::ContactCenterInsights::V1::View, ::Hash) — Required. The new view.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ContactCenterInsights::V1::View)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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 long-running conversation upload operation. This method differs
from CreateConversation
by allowing audio transcription and optional DLP
redaction.
def upload_conversation(request, options = nil) -> ::Gapic::Operation
upload_conversation
via a request object, either of type
UploadConversationRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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