google-apis-contactcenterinsights_v1 0.41.0 → 0.42.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -22,6 +22,193 @@ module Google
22
22
  module Apis
23
23
  module ContactcenterinsightsV1
24
24
 
25
+ # Agent Coaching instructions that customer can configure.
26
+ class GoogleCloudContactcenterinsightsV1AgentCoachingInstruction
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Optional. The action that human agent should take. For example, "apologize for
30
+ # the slow shipping". If the users only want to use agent coaching for intent
31
+ # detection, agent_action can be empty
32
+ # Corresponds to the JSON property `agentAction`
33
+ # @return [String]
34
+ attr_accessor :agent_action
35
+
36
+ # Optional. The condition of the instruction. For example, "the customer wants
37
+ # to cancel an order". If the users want the instruction to be triggered
38
+ # unconditionally, the condition can be empty.
39
+ # Corresponds to the JSON property `condition`
40
+ # @return [String]
41
+ attr_accessor :condition
42
+
43
+ # Optional. The detailed description of this instruction.
44
+ # Corresponds to the JSON property `description`
45
+ # @return [String]
46
+ attr_accessor :description
47
+
48
+ # Optional. Display name for the instruction.
49
+ # Corresponds to the JSON property `displayName`
50
+ # @return [String]
51
+ attr_accessor :display_name
52
+
53
+ # Optional. Additional information attached to this instruction.
54
+ # Corresponds to the JSON property `metadata`
55
+ # @return [Hash<String,String>]
56
+ attr_accessor :metadata
57
+
58
+ # Optional. The action that system should take. For example, "call GetOrderTime
59
+ # with order_number=`order number provided by the customer`". If the users don't
60
+ # have plugins or don't want to trigger plugins, the system_action can be empty
61
+ # Corresponds to the JSON property `systemAction`
62
+ # @return [String]
63
+ attr_accessor :system_action
64
+
65
+ def initialize(**args)
66
+ update!(**args)
67
+ end
68
+
69
+ # Update properties of this object
70
+ def update!(**args)
71
+ @agent_action = args[:agent_action] if args.key?(:agent_action)
72
+ @condition = args[:condition] if args.key?(:condition)
73
+ @description = args[:description] if args.key?(:description)
74
+ @display_name = args[:display_name] if args.key?(:display_name)
75
+ @metadata = args[:metadata] if args.key?(:metadata)
76
+ @system_action = args[:system_action] if args.key?(:system_action)
77
+ end
78
+ end
79
+
80
+ # Suggestion for coaching agents.
81
+ class GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion
82
+ include Google::Apis::Core::Hashable
83
+
84
+ # Optional. Suggested actions for the agent to take.
85
+ # Corresponds to the JSON property `agentActionSuggestions`
86
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion>]
87
+ attr_accessor :agent_action_suggestions
88
+
89
+ # Optional. Instructions applicable based on the current context.
90
+ # Corresponds to the JSON property `applicableInstructions`
91
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1AgentCoachingInstruction>]
92
+ attr_accessor :applicable_instructions
93
+
94
+ # Optional. Sample response for the Agent.
95
+ # Corresponds to the JSON property `sampleResponses`
96
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse>]
97
+ attr_accessor :sample_responses
98
+
99
+ # Self evaluations of the suggestion.
100
+ # Corresponds to the JSON property `suggestionEval`
101
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval]
102
+ attr_accessor :suggestion_eval
103
+
104
+ # Reasoning for the suggestion.
105
+ # Corresponds to the JSON property `suggestionReasoning`
106
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning]
107
+ attr_accessor :suggestion_reasoning
108
+
109
+ def initialize(**args)
110
+ update!(**args)
111
+ end
112
+
113
+ # Update properties of this object
114
+ def update!(**args)
115
+ @agent_action_suggestions = args[:agent_action_suggestions] if args.key?(:agent_action_suggestions)
116
+ @applicable_instructions = args[:applicable_instructions] if args.key?(:applicable_instructions)
117
+ @sample_responses = args[:sample_responses] if args.key?(:sample_responses)
118
+ @suggestion_eval = args[:suggestion_eval] if args.key?(:suggestion_eval)
119
+ @suggestion_reasoning = args[:suggestion_reasoning] if args.key?(:suggestion_reasoning)
120
+ end
121
+ end
122
+
123
+ # Actions suggested for the agent. This is based on applicable instructions.
124
+ class GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion
125
+ include Google::Apis::Core::Hashable
126
+
127
+ # Optional. The suggested action for the agent.
128
+ # Corresponds to the JSON property `agentAction`
129
+ # @return [String]
130
+ attr_accessor :agent_action
131
+
132
+ def initialize(**args)
133
+ update!(**args)
134
+ end
135
+
136
+ # Update properties of this object
137
+ def update!(**args)
138
+ @agent_action = args[:agent_action] if args.key?(:agent_action)
139
+ end
140
+ end
141
+
142
+ # Self evaluations of the suggestion.
143
+ class GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval
144
+ include Google::Apis::Core::Hashable
145
+
146
+ # Optional. Eval for Agent action suggestion.
147
+ # Corresponds to the JSON property `actionActionSuggestionEval`
148
+ # @return [String]
149
+ attr_accessor :action_action_suggestion_eval
150
+
151
+ # Optional. Eval for sample response.
152
+ # Corresponds to the JSON property `sampleResponseEval`
153
+ # @return [String]
154
+ attr_accessor :sample_response_eval
155
+
156
+ def initialize(**args)
157
+ update!(**args)
158
+ end
159
+
160
+ # Update properties of this object
161
+ def update!(**args)
162
+ @action_action_suggestion_eval = args[:action_action_suggestion_eval] if args.key?(:action_action_suggestion_eval)
163
+ @sample_response_eval = args[:sample_response_eval] if args.key?(:sample_response_eval)
164
+ end
165
+ end
166
+
167
+ # Reasoning for the suggestion.
168
+ class GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning
169
+ include Google::Apis::Core::Hashable
170
+
171
+ # Optional. The actions that the agent has taken already.
172
+ # Corresponds to the JSON property `agentActionTaken`
173
+ # @return [String]
174
+ attr_accessor :agent_action_taken
175
+
176
+ # Optional. Summary of the issue.
177
+ # Corresponds to the JSON property `issueSummary`
178
+ # @return [String]
179
+ attr_accessor :issue_summary
180
+
181
+ def initialize(**args)
182
+ update!(**args)
183
+ end
184
+
185
+ # Update properties of this object
186
+ def update!(**args)
187
+ @agent_action_taken = args[:agent_action_taken] if args.key?(:agent_action_taken)
188
+ @issue_summary = args[:issue_summary] if args.key?(:issue_summary)
189
+ end
190
+ end
191
+
192
+ # Sample response that the agent can use. This could be based on applicable
193
+ # instructions and ingested data from other systems.
194
+ class GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse
195
+ include Google::Apis::Core::Hashable
196
+
197
+ # Optional. Sample response for Agent in text.
198
+ # Corresponds to the JSON property `responseText`
199
+ # @return [String]
200
+ attr_accessor :response_text
201
+
202
+ def initialize(**args)
203
+ update!(**args)
204
+ end
205
+
206
+ # Update properties of this object
207
+ def update!(**args)
208
+ @response_text = args[:response_text] if args.key?(:response_text)
209
+ end
210
+ end
211
+
25
212
  # The analysis resource.
26
213
  class GoogleCloudContactcenterinsightsV1Analysis
27
214
  include Google::Apis::Core::Hashable
@@ -2017,6 +2204,31 @@ module Google
2017
2204
  end
2018
2205
  end
2019
2206
 
2207
+ # Suggestion generated using free form generator.
2208
+ class GoogleCloudContactcenterinsightsV1FreeFormSuggestion
2209
+ include Google::Apis::Core::Hashable
2210
+
2211
+ # Optional. Labels for the generator.
2212
+ # Corresponds to the JSON property `labels`
2213
+ # @return [Array<String>]
2214
+ attr_accessor :labels
2215
+
2216
+ # Required. Free form suggestion.
2217
+ # Corresponds to the JSON property `response`
2218
+ # @return [String]
2219
+ attr_accessor :response
2220
+
2221
+ def initialize(**args)
2222
+ update!(**args)
2223
+ end
2224
+
2225
+ # Update properties of this object
2226
+ def update!(**args)
2227
+ @labels = args[:labels] if args.key?(:labels)
2228
+ @response = args[:response] if args.key?(:response)
2229
+ end
2230
+ end
2231
+
2020
2232
  # A Cloud Storage source of conversation data.
2021
2233
  class GoogleCloudContactcenterinsightsV1GcsSource
2022
2234
  include Google::Apis::Core::Hashable
@@ -2043,37 +2255,45 @@ module Google
2043
2255
  end
2044
2256
  end
2045
2257
 
2046
- # The data for a hold annotation.
2047
- class GoogleCloudContactcenterinsightsV1HoldData
2258
+ # Suggestion generated using a Generator.
2259
+ class GoogleCloudContactcenterinsightsV1GeneratorSuggestion
2048
2260
  include Google::Apis::Core::Hashable
2049
2261
 
2262
+ # Suggestion for coaching agents.
2263
+ # Corresponds to the JSON property `agentCoachingSuggestion`
2264
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion]
2265
+ attr_accessor :agent_coaching_suggestion
2266
+
2267
+ # Suggestion generated using free form generator.
2268
+ # Corresponds to the JSON property `freeFormSuggestion`
2269
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1FreeFormSuggestion]
2270
+ attr_accessor :free_form_suggestion
2271
+
2272
+ # Suggested summary of the conversation.
2273
+ # Corresponds to the JSON property `summarySuggestion`
2274
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1SummarySuggestion]
2275
+ attr_accessor :summary_suggestion
2276
+
2050
2277
  def initialize(**args)
2051
2278
  update!(**args)
2052
2279
  end
2053
2280
 
2054
2281
  # Update properties of this object
2055
2282
  def update!(**args)
2283
+ @agent_coaching_suggestion = args[:agent_coaching_suggestion] if args.key?(:agent_coaching_suggestion)
2284
+ @free_form_suggestion = args[:free_form_suggestion] if args.key?(:free_form_suggestion)
2285
+ @summary_suggestion = args[:summary_suggestion] if args.key?(:summary_suggestion)
2056
2286
  end
2057
2287
  end
2058
2288
 
2059
- # Metadata used for import issue model.
2060
- class GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata
2289
+ # Represents response from generators.
2290
+ class GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse
2061
2291
  include Google::Apis::Core::Hashable
2062
2292
 
2063
- # The time the operation was created.
2064
- # Corresponds to the JSON property `createTime`
2065
- # @return [String]
2066
- attr_accessor :create_time
2067
-
2068
- # The time the operation finished running.
2069
- # Corresponds to the JSON property `endTime`
2070
- # @return [String]
2071
- attr_accessor :end_time
2072
-
2073
- # Request to import an issue model.
2074
- # Corresponds to the JSON property `request`
2075
- # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ImportIssueModelRequest]
2076
- attr_accessor :request
2293
+ # Suggestion generated using a Generator.
2294
+ # Corresponds to the JSON property `generatorSuggestion`
2295
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GeneratorSuggestion]
2296
+ attr_accessor :generator_suggestion
2077
2297
 
2078
2298
  def initialize(**args)
2079
2299
  update!(**args)
@@ -2081,33 +2301,25 @@ module Google
2081
2301
 
2082
2302
  # Update properties of this object
2083
2303
  def update!(**args)
2084
- @create_time = args[:create_time] if args.key?(:create_time)
2085
- @end_time = args[:end_time] if args.key?(:end_time)
2086
- @request = args[:request] if args.key?(:request)
2304
+ @generator_suggestion = args[:generator_suggestion] if args.key?(:generator_suggestion)
2087
2305
  end
2088
2306
  end
2089
2307
 
2090
- # Request to import an issue model.
2091
- class GoogleCloudContactcenterinsightsV1ImportIssueModelRequest
2308
+ # Response for Knowledge Assist. Contains suggested query and optionally
2309
+ # includes an answer for the query.
2310
+ class GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse
2092
2311
  include Google::Apis::Core::Hashable
2093
2312
 
2094
- # Optional. If set to true, will create a new issue model from the imported file
2095
- # with randomly generated IDs for the issue model and corresponding issues.
2096
- # Otherwise, replaces an existing model with the same ID as the file.
2097
- # Corresponds to the JSON property `createNewModel`
2098
- # @return [Boolean]
2099
- attr_accessor :create_new_model
2100
- alias_method :create_new_model?, :create_new_model
2101
-
2102
- # Google Cloud Storage Object URI to get the issue model file from.
2103
- # Corresponds to the JSON property `gcsSource`
2104
- # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource]
2105
- attr_accessor :gcs_source
2313
+ # Represents a suggested query.
2314
+ # Corresponds to the JSON property `suggestedQuery`
2315
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery]
2316
+ attr_accessor :suggested_query
2106
2317
 
2107
- # Required. The parent resource of the issue model.
2108
- # Corresponds to the JSON property `parent`
2109
- # @return [String]
2110
- attr_accessor :parent
2318
+ # Represents an answer from Knowledge. Cuurently supports FAQ and Generative
2319
+ # answers.
2320
+ # Corresponds to the JSON property `suggestedQueryAnswer`
2321
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer]
2322
+ attr_accessor :suggested_query_answer
2111
2323
 
2112
2324
  def initialize(**args)
2113
2325
  update!(**args)
@@ -2115,20 +2327,42 @@ module Google
2115
2327
 
2116
2328
  # Update properties of this object
2117
2329
  def update!(**args)
2118
- @create_new_model = args[:create_new_model] if args.key?(:create_new_model)
2119
- @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
2120
- @parent = args[:parent] if args.key?(:parent)
2330
+ @suggested_query = args[:suggested_query] if args.key?(:suggested_query)
2331
+ @suggested_query_answer = args[:suggested_query_answer] if args.key?(:suggested_query_answer)
2121
2332
  end
2122
2333
  end
2123
2334
 
2124
- # Google Cloud Storage Object URI to get the issue model file from.
2125
- class GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource
2335
+ # Represents an answer from Knowledge. Cuurently supports FAQ and Generative
2336
+ # answers.
2337
+ class GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer
2126
2338
  include Google::Apis::Core::Hashable
2127
2339
 
2128
- # Required. Format: `gs:///`
2129
- # Corresponds to the JSON property `objectUri`
2340
+ # The piece of text from the `source` that answers this suggested query.
2341
+ # Corresponds to the JSON property `answerText`
2130
2342
  # @return [String]
2131
- attr_accessor :object_uri
2343
+ attr_accessor :answer_text
2344
+
2345
+ # Details about source of FAQ answer.
2346
+ # Corresponds to the JSON property `faqSource`
2347
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource]
2348
+ attr_accessor :faq_source
2349
+
2350
+ # Details about source of Generative answer.
2351
+ # Corresponds to the JSON property `generativeSource`
2352
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource]
2353
+ attr_accessor :generative_source
2354
+
2355
+ # Details about source of Intent Matching answer.
2356
+ # Corresponds to the JSON property `intentMatchingSource`
2357
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource]
2358
+ attr_accessor :intent_matching_source
2359
+
2360
+ # The system's confidence score that this answer is a good match for this
2361
+ # conversational query. The range is from 0.0 (completely uncertain) to 1.0 (
2362
+ # completely certain).
2363
+ # Corresponds to the JSON property `matchConfidence`
2364
+ # @return [Float]
2365
+ attr_accessor :match_confidence
2132
2366
 
2133
2367
  def initialize(**args)
2134
2368
  update!(**args)
@@ -2136,52 +2370,49 @@ module Google
2136
2370
 
2137
2371
  # Update properties of this object
2138
2372
  def update!(**args)
2139
- @object_uri = args[:object_uri] if args.key?(:object_uri)
2373
+ @answer_text = args[:answer_text] if args.key?(:answer_text)
2374
+ @faq_source = args[:faq_source] if args.key?(:faq_source)
2375
+ @generative_source = args[:generative_source] if args.key?(:generative_source)
2376
+ @intent_matching_source = args[:intent_matching_source] if args.key?(:intent_matching_source)
2377
+ @match_confidence = args[:match_confidence] if args.key?(:match_confidence)
2140
2378
  end
2141
2379
  end
2142
2380
 
2143
- # Response from import issue model
2144
- class GoogleCloudContactcenterinsightsV1ImportIssueModelResponse
2381
+ # Details about source of FAQ answer.
2382
+ class GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource
2145
2383
  include Google::Apis::Core::Hashable
2146
2384
 
2385
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
2386
+ # projects//knowledgeBases//documents/`.
2387
+ # Corresponds to the JSON property `document`
2388
+ # @return [String]
2389
+ attr_accessor :document
2390
+
2391
+ # The corresponding FAQ question.
2392
+ # Corresponds to the JSON property `question`
2393
+ # @return [String]
2394
+ attr_accessor :question
2395
+
2147
2396
  def initialize(**args)
2148
2397
  update!(**args)
2149
2398
  end
2150
2399
 
2151
2400
  # Update properties of this object
2152
2401
  def update!(**args)
2402
+ @document = args[:document] if args.key?(:document)
2403
+ @question = args[:question] if args.key?(:question)
2153
2404
  end
2154
2405
  end
2155
2406
 
2156
- # The metadata for an IngestConversations operation.
2157
- class GoogleCloudContactcenterinsightsV1IngestConversationsMetadata
2407
+ # Details about source of Generative answer.
2408
+ class GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource
2158
2409
  include Google::Apis::Core::Hashable
2159
2410
 
2160
- # Output only. The time the operation was created.
2161
- # Corresponds to the JSON property `createTime`
2162
- # @return [String]
2163
- attr_accessor :create_time
2164
-
2165
- # Output only. The time the operation finished running.
2166
- # Corresponds to the JSON property `endTime`
2167
- # @return [String]
2168
- attr_accessor :end_time
2169
-
2170
- # Statistics for IngestConversations operation.
2171
- # Corresponds to the JSON property `ingestConversationsStats`
2172
- # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats]
2173
- attr_accessor :ingest_conversations_stats
2174
-
2175
- # Output only. Partial errors during ingest operation that might cause the
2176
- # operation output to be incomplete.
2177
- # Corresponds to the JSON property `partialErrors`
2178
- # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleRpcStatus>]
2179
- attr_accessor :partial_errors
2180
-
2181
- # The request to ingest conversations.
2182
- # Corresponds to the JSON property `request`
2183
- # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IngestConversationsRequest]
2184
- attr_accessor :request
2411
+ # All snippets used for this Generative Prediction, with their source URI and
2412
+ # data.
2413
+ # Corresponds to the JSON property `snippets`
2414
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet>]
2415
+ attr_accessor :snippets
2185
2416
 
2186
2417
  def initialize(**args)
2187
2418
  update!(**args)
@@ -2189,40 +2420,34 @@ module Google
2189
2420
 
2190
2421
  # Update properties of this object
2191
2422
  def update!(**args)
2192
- @create_time = args[:create_time] if args.key?(:create_time)
2193
- @end_time = args[:end_time] if args.key?(:end_time)
2194
- @ingest_conversations_stats = args[:ingest_conversations_stats] if args.key?(:ingest_conversations_stats)
2195
- @partial_errors = args[:partial_errors] if args.key?(:partial_errors)
2196
- @request = args[:request] if args.key?(:request)
2423
+ @snippets = args[:snippets] if args.key?(:snippets)
2197
2424
  end
2198
2425
  end
2199
2426
 
2200
- # Statistics for IngestConversations operation.
2201
- class GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats
2427
+ # Snippet Source for a Generative Prediction.
2428
+ class GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet
2202
2429
  include Google::Apis::Core::Hashable
2203
2430
 
2204
- # Output only. The number of objects skipped because another conversation with
2205
- # the same transcript uri had already been ingested.
2206
- # Corresponds to the JSON property `duplicatesSkippedCount`
2207
- # @return [Fixnum]
2208
- attr_accessor :duplicates_skipped_count
2431
+ # Indicates which Knowledge Document this snippet was extracted from. Format: `
2432
+ # projects//knowledgeBases//documents/`.
2433
+ # Corresponds to the JSON property `document`
2434
+ # @return [String]
2435
+ attr_accessor :document
2209
2436
 
2210
- # Output only. The number of objects which were unable to be ingested due to
2211
- # errors. The errors are populated in the partial_errors field.
2212
- # Corresponds to the JSON property `failedIngestCount`
2213
- # @return [Fixnum]
2214
- attr_accessor :failed_ingest_count
2437
+ # text taken from that URI.
2438
+ # Corresponds to the JSON property `text`
2439
+ # @return [String]
2440
+ attr_accessor :text
2215
2441
 
2216
- # Output only. The number of objects processed during the ingest operation.
2217
- # Corresponds to the JSON property `processedObjectCount`
2218
- # @return [Fixnum]
2219
- attr_accessor :processed_object_count
2442
+ # Title of the document.
2443
+ # Corresponds to the JSON property `title`
2444
+ # @return [String]
2445
+ attr_accessor :title
2220
2446
 
2221
- # Output only. The number of new conversations added during this ingest
2222
- # operation.
2223
- # Corresponds to the JSON property `successfulIngestCount`
2224
- # @return [Fixnum]
2225
- attr_accessor :successful_ingest_count
2447
+ # URI the data is sourced from.
2448
+ # Corresponds to the JSON property `uri`
2449
+ # @return [String]
2450
+ attr_accessor :uri
2226
2451
 
2227
2452
  def initialize(**args)
2228
2453
  update!(**args)
@@ -2230,9 +2455,253 @@ module Google
2230
2455
 
2231
2456
  # Update properties of this object
2232
2457
  def update!(**args)
2233
- @duplicates_skipped_count = args[:duplicates_skipped_count] if args.key?(:duplicates_skipped_count)
2234
- @failed_ingest_count = args[:failed_ingest_count] if args.key?(:failed_ingest_count)
2235
- @processed_object_count = args[:processed_object_count] if args.key?(:processed_object_count)
2458
+ @document = args[:document] if args.key?(:document)
2459
+ @text = args[:text] if args.key?(:text)
2460
+ @title = args[:title] if args.key?(:title)
2461
+ @uri = args[:uri] if args.key?(:uri)
2462
+ end
2463
+ end
2464
+
2465
+ # Details about source of Intent Matching answer.
2466
+ class GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource
2467
+ include Google::Apis::Core::Hashable
2468
+
2469
+ # Title of the document.
2470
+ # Corresponds to the JSON property `title`
2471
+ # @return [String]
2472
+ attr_accessor :title
2473
+
2474
+ # URI the data is sourced from.
2475
+ # Corresponds to the JSON property `uri`
2476
+ # @return [String]
2477
+ attr_accessor :uri
2478
+
2479
+ def initialize(**args)
2480
+ update!(**args)
2481
+ end
2482
+
2483
+ # Update properties of this object
2484
+ def update!(**args)
2485
+ @title = args[:title] if args.key?(:title)
2486
+ @uri = args[:uri] if args.key?(:uri)
2487
+ end
2488
+ end
2489
+
2490
+ # Represents a suggested query.
2491
+ class GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery
2492
+ include Google::Apis::Core::Hashable
2493
+
2494
+ # Suggested query text.
2495
+ # Corresponds to the JSON property `queryText`
2496
+ # @return [String]
2497
+ attr_accessor :query_text
2498
+
2499
+ # Suggested query score.
2500
+ # Corresponds to the JSON property `score`
2501
+ # @return [Float]
2502
+ attr_accessor :score
2503
+
2504
+ def initialize(**args)
2505
+ update!(**args)
2506
+ end
2507
+
2508
+ # Update properties of this object
2509
+ def update!(**args)
2510
+ @query_text = args[:query_text] if args.key?(:query_text)
2511
+ @score = args[:score] if args.key?(:score)
2512
+ end
2513
+ end
2514
+
2515
+ # The data for a hold annotation.
2516
+ class GoogleCloudContactcenterinsightsV1HoldData
2517
+ include Google::Apis::Core::Hashable
2518
+
2519
+ def initialize(**args)
2520
+ update!(**args)
2521
+ end
2522
+
2523
+ # Update properties of this object
2524
+ def update!(**args)
2525
+ end
2526
+ end
2527
+
2528
+ # Metadata used for import issue model.
2529
+ class GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata
2530
+ include Google::Apis::Core::Hashable
2531
+
2532
+ # The time the operation was created.
2533
+ # Corresponds to the JSON property `createTime`
2534
+ # @return [String]
2535
+ attr_accessor :create_time
2536
+
2537
+ # The time the operation finished running.
2538
+ # Corresponds to the JSON property `endTime`
2539
+ # @return [String]
2540
+ attr_accessor :end_time
2541
+
2542
+ # Request to import an issue model.
2543
+ # Corresponds to the JSON property `request`
2544
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ImportIssueModelRequest]
2545
+ attr_accessor :request
2546
+
2547
+ def initialize(**args)
2548
+ update!(**args)
2549
+ end
2550
+
2551
+ # Update properties of this object
2552
+ def update!(**args)
2553
+ @create_time = args[:create_time] if args.key?(:create_time)
2554
+ @end_time = args[:end_time] if args.key?(:end_time)
2555
+ @request = args[:request] if args.key?(:request)
2556
+ end
2557
+ end
2558
+
2559
+ # Request to import an issue model.
2560
+ class GoogleCloudContactcenterinsightsV1ImportIssueModelRequest
2561
+ include Google::Apis::Core::Hashable
2562
+
2563
+ # Optional. If set to true, will create a new issue model from the imported file
2564
+ # with randomly generated IDs for the issue model and corresponding issues.
2565
+ # Otherwise, replaces an existing model with the same ID as the file.
2566
+ # Corresponds to the JSON property `createNewModel`
2567
+ # @return [Boolean]
2568
+ attr_accessor :create_new_model
2569
+ alias_method :create_new_model?, :create_new_model
2570
+
2571
+ # Google Cloud Storage Object URI to get the issue model file from.
2572
+ # Corresponds to the JSON property `gcsSource`
2573
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource]
2574
+ attr_accessor :gcs_source
2575
+
2576
+ # Required. The parent resource of the issue model.
2577
+ # Corresponds to the JSON property `parent`
2578
+ # @return [String]
2579
+ attr_accessor :parent
2580
+
2581
+ def initialize(**args)
2582
+ update!(**args)
2583
+ end
2584
+
2585
+ # Update properties of this object
2586
+ def update!(**args)
2587
+ @create_new_model = args[:create_new_model] if args.key?(:create_new_model)
2588
+ @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
2589
+ @parent = args[:parent] if args.key?(:parent)
2590
+ end
2591
+ end
2592
+
2593
+ # Google Cloud Storage Object URI to get the issue model file from.
2594
+ class GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource
2595
+ include Google::Apis::Core::Hashable
2596
+
2597
+ # Required. Format: `gs:///`
2598
+ # Corresponds to the JSON property `objectUri`
2599
+ # @return [String]
2600
+ attr_accessor :object_uri
2601
+
2602
+ def initialize(**args)
2603
+ update!(**args)
2604
+ end
2605
+
2606
+ # Update properties of this object
2607
+ def update!(**args)
2608
+ @object_uri = args[:object_uri] if args.key?(:object_uri)
2609
+ end
2610
+ end
2611
+
2612
+ # Response from import issue model
2613
+ class GoogleCloudContactcenterinsightsV1ImportIssueModelResponse
2614
+ include Google::Apis::Core::Hashable
2615
+
2616
+ def initialize(**args)
2617
+ update!(**args)
2618
+ end
2619
+
2620
+ # Update properties of this object
2621
+ def update!(**args)
2622
+ end
2623
+ end
2624
+
2625
+ # The metadata for an IngestConversations operation.
2626
+ class GoogleCloudContactcenterinsightsV1IngestConversationsMetadata
2627
+ include Google::Apis::Core::Hashable
2628
+
2629
+ # Output only. The time the operation was created.
2630
+ # Corresponds to the JSON property `createTime`
2631
+ # @return [String]
2632
+ attr_accessor :create_time
2633
+
2634
+ # Output only. The time the operation finished running.
2635
+ # Corresponds to the JSON property `endTime`
2636
+ # @return [String]
2637
+ attr_accessor :end_time
2638
+
2639
+ # Statistics for IngestConversations operation.
2640
+ # Corresponds to the JSON property `ingestConversationsStats`
2641
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats]
2642
+ attr_accessor :ingest_conversations_stats
2643
+
2644
+ # Output only. Partial errors during ingest operation that might cause the
2645
+ # operation output to be incomplete.
2646
+ # Corresponds to the JSON property `partialErrors`
2647
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleRpcStatus>]
2648
+ attr_accessor :partial_errors
2649
+
2650
+ # The request to ingest conversations.
2651
+ # Corresponds to the JSON property `request`
2652
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IngestConversationsRequest]
2653
+ attr_accessor :request
2654
+
2655
+ def initialize(**args)
2656
+ update!(**args)
2657
+ end
2658
+
2659
+ # Update properties of this object
2660
+ def update!(**args)
2661
+ @create_time = args[:create_time] if args.key?(:create_time)
2662
+ @end_time = args[:end_time] if args.key?(:end_time)
2663
+ @ingest_conversations_stats = args[:ingest_conversations_stats] if args.key?(:ingest_conversations_stats)
2664
+ @partial_errors = args[:partial_errors] if args.key?(:partial_errors)
2665
+ @request = args[:request] if args.key?(:request)
2666
+ end
2667
+ end
2668
+
2669
+ # Statistics for IngestConversations operation.
2670
+ class GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats
2671
+ include Google::Apis::Core::Hashable
2672
+
2673
+ # Output only. The number of objects skipped because another conversation with
2674
+ # the same transcript uri had already been ingested.
2675
+ # Corresponds to the JSON property `duplicatesSkippedCount`
2676
+ # @return [Fixnum]
2677
+ attr_accessor :duplicates_skipped_count
2678
+
2679
+ # Output only. The number of objects which were unable to be ingested due to
2680
+ # errors. The errors are populated in the partial_errors field.
2681
+ # Corresponds to the JSON property `failedIngestCount`
2682
+ # @return [Fixnum]
2683
+ attr_accessor :failed_ingest_count
2684
+
2685
+ # Output only. The number of objects processed during the ingest operation.
2686
+ # Corresponds to the JSON property `processedObjectCount`
2687
+ # @return [Fixnum]
2688
+ attr_accessor :processed_object_count
2689
+
2690
+ # Output only. The number of new conversations added during this ingest
2691
+ # operation.
2692
+ # Corresponds to the JSON property `successfulIngestCount`
2693
+ # @return [Fixnum]
2694
+ attr_accessor :successful_ingest_count
2695
+
2696
+ def initialize(**args)
2697
+ update!(**args)
2698
+ end
2699
+
2700
+ # Update properties of this object
2701
+ def update!(**args)
2702
+ @duplicates_skipped_count = args[:duplicates_skipped_count] if args.key?(:duplicates_skipped_count)
2703
+ @failed_ingest_count = args[:failed_ingest_count] if args.key?(:failed_ingest_count)
2704
+ @processed_object_count = args[:processed_object_count] if args.key?(:processed_object_count)
2236
2705
  @successful_ingest_count = args[:successful_ingest_count] if args.key?(:successful_ingest_count)
2237
2706
  end
2238
2707
  end
@@ -3157,6 +3626,22 @@ module Google
3157
3626
  # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1FaqAnswerData]
3158
3627
  attr_accessor :faq_answer
3159
3628
 
3629
+ # Represents response from generators.
3630
+ # Corresponds to the JSON property `generatorSuggestionResult`
3631
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse]
3632
+ attr_accessor :generator_suggestion_result
3633
+
3634
+ # Response for Knowledge Assist. Contains suggested query and optionally
3635
+ # includes an answer for the query.
3636
+ # Corresponds to the JSON property `knowledgeAssistResult`
3637
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse]
3638
+ attr_accessor :knowledge_assist_result
3639
+
3640
+ # Represents a SearchKnowledge answer.
3641
+ # Corresponds to the JSON property `knowledgeSearchResult`
3642
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer]
3643
+ attr_accessor :knowledge_search_result
3644
+
3160
3645
  # Agent Assist Smart Compose suggestion data.
3161
3646
  # Corresponds to the JSON property `smartComposeSuggestion`
3162
3647
  # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData]
@@ -3186,12 +3671,97 @@ module Google
3186
3671
  @dialogflow_interaction = args[:dialogflow_interaction] if args.key?(:dialogflow_interaction)
3187
3672
  @end_boundary = args[:end_boundary] if args.key?(:end_boundary)
3188
3673
  @faq_answer = args[:faq_answer] if args.key?(:faq_answer)
3674
+ @generator_suggestion_result = args[:generator_suggestion_result] if args.key?(:generator_suggestion_result)
3675
+ @knowledge_assist_result = args[:knowledge_assist_result] if args.key?(:knowledge_assist_result)
3676
+ @knowledge_search_result = args[:knowledge_search_result] if args.key?(:knowledge_search_result)
3189
3677
  @smart_compose_suggestion = args[:smart_compose_suggestion] if args.key?(:smart_compose_suggestion)
3190
3678
  @smart_reply = args[:smart_reply] if args.key?(:smart_reply)
3191
3679
  @start_boundary = args[:start_boundary] if args.key?(:start_boundary)
3192
3680
  end
3193
3681
  end
3194
3682
 
3683
+ # Represents a SearchKnowledge answer.
3684
+ class GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer
3685
+ include Google::Apis::Core::Hashable
3686
+
3687
+ # The piece of text from the knowledge base documents that answers the search
3688
+ # query
3689
+ # Corresponds to the JSON property `answer`
3690
+ # @return [String]
3691
+ attr_accessor :answer
3692
+
3693
+ # The name of the answer record. Format: `projects//locations//answer Records/`
3694
+ # Corresponds to the JSON property `answerRecord`
3695
+ # @return [String]
3696
+ attr_accessor :answer_record
3697
+
3698
+ # All sources used to generate the answer.
3699
+ # Corresponds to the JSON property `answerSources`
3700
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource>]
3701
+ attr_accessor :answer_sources
3702
+
3703
+ # The type of the answer.
3704
+ # Corresponds to the JSON property `answerType`
3705
+ # @return [String]
3706
+ attr_accessor :answer_type
3707
+
3708
+ # The confidence score in [0.0, 1.0] range.
3709
+ # Corresponds to the JSON property `confidenceScore`
3710
+ # @return [Float]
3711
+ attr_accessor :confidence_score
3712
+
3713
+ def initialize(**args)
3714
+ update!(**args)
3715
+ end
3716
+
3717
+ # Update properties of this object
3718
+ def update!(**args)
3719
+ @answer = args[:answer] if args.key?(:answer)
3720
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
3721
+ @answer_sources = args[:answer_sources] if args.key?(:answer_sources)
3722
+ @answer_type = args[:answer_type] if args.key?(:answer_type)
3723
+ @confidence_score = args[:confidence_score] if args.key?(:confidence_score)
3724
+ end
3725
+ end
3726
+
3727
+ # The sources of the answers.
3728
+ class GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource
3729
+ include Google::Apis::Core::Hashable
3730
+
3731
+ # The document from which the snippet was extracted. Format: `projects//
3732
+ # knowledgeBases//documents/`
3733
+ # Corresponds to the JSON property `document`
3734
+ # @return [String]
3735
+ attr_accessor :document
3736
+
3737
+ # The relevant snippet of the article.
3738
+ # Corresponds to the JSON property `snippet`
3739
+ # @return [String]
3740
+ attr_accessor :snippet
3741
+
3742
+ # The title of the article.
3743
+ # Corresponds to the JSON property `title`
3744
+ # @return [String]
3745
+ attr_accessor :title
3746
+
3747
+ # The URI of the article.
3748
+ # Corresponds to the JSON property `uri`
3749
+ # @return [String]
3750
+ attr_accessor :uri
3751
+
3752
+ def initialize(**args)
3753
+ update!(**args)
3754
+ end
3755
+
3756
+ # Update properties of this object
3757
+ def update!(**args)
3758
+ @document = args[:document] if args.key?(:document)
3759
+ @snippet = args[:snippet] if args.key?(:snippet)
3760
+ @title = args[:title] if args.key?(:title)
3761
+ @uri = args[:uri] if args.key?(:uri)
3762
+ end
3763
+ end
3764
+
3195
3765
  # The data for a sentiment annotation.
3196
3766
  class GoogleCloudContactcenterinsightsV1SentimentData
3197
3767
  include Google::Apis::Core::Hashable
@@ -3449,6 +4019,50 @@ module Google
3449
4019
  end
3450
4020
  end
3451
4021
 
4022
+ # Suggested summary of the conversation.
4023
+ class GoogleCloudContactcenterinsightsV1SummarySuggestion
4024
+ include Google::Apis::Core::Hashable
4025
+
4026
+ # Required. All the parts of generated summary.
4027
+ # Corresponds to the JSON property `summarySections`
4028
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection>]
4029
+ attr_accessor :summary_sections
4030
+
4031
+ def initialize(**args)
4032
+ update!(**args)
4033
+ end
4034
+
4035
+ # Update properties of this object
4036
+ def update!(**args)
4037
+ @summary_sections = args[:summary_sections] if args.key?(:summary_sections)
4038
+ end
4039
+ end
4040
+
4041
+ # A component of the generated summary.
4042
+ class GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection
4043
+ include Google::Apis::Core::Hashable
4044
+
4045
+ # Required. Name of the section.
4046
+ # Corresponds to the JSON property `section`
4047
+ # @return [String]
4048
+ attr_accessor :section
4049
+
4050
+ # Required. Summary text for the section.
4051
+ # Corresponds to the JSON property `summary`
4052
+ # @return [String]
4053
+ attr_accessor :summary
4054
+
4055
+ def initialize(**args)
4056
+ update!(**args)
4057
+ end
4058
+
4059
+ # Update properties of this object
4060
+ def update!(**args)
4061
+ @section = args[:section] if args.key?(:section)
4062
+ @summary = args[:summary] if args.key?(:summary)
4063
+ end
4064
+ end
4065
+
3452
4066
  # Metadata for undeploying an issue model.
3453
4067
  class GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata
3454
4068
  include Google::Apis::Core::Hashable
@@ -3622,15 +4236,206 @@ module Google
3622
4236
  # @return [String]
3623
4237
  attr_accessor :name
3624
4238
 
3625
- # Output only. The most recent time at which the view was updated.
3626
- # Corresponds to the JSON property `updateTime`
3627
- # @return [String]
3628
- attr_accessor :update_time
4239
+ # Output only. The most recent time at which the view was updated.
4240
+ # Corresponds to the JSON property `updateTime`
4241
+ # @return [String]
4242
+ attr_accessor :update_time
4243
+
4244
+ # String with specific view properties, must be non-empty.
4245
+ # Corresponds to the JSON property `value`
4246
+ # @return [String]
4247
+ attr_accessor :value
4248
+
4249
+ def initialize(**args)
4250
+ update!(**args)
4251
+ end
4252
+
4253
+ # Update properties of this object
4254
+ def update!(**args)
4255
+ @create_time = args[:create_time] if args.key?(:create_time)
4256
+ @display_name = args[:display_name] if args.key?(:display_name)
4257
+ @name = args[:name] if args.key?(:name)
4258
+ @update_time = args[:update_time] if args.key?(:update_time)
4259
+ @value = args[:value] if args.key?(:value)
4260
+ end
4261
+ end
4262
+
4263
+ # Agent Coaching instructions that customer can configure.
4264
+ class GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction
4265
+ include Google::Apis::Core::Hashable
4266
+
4267
+ # Optional. The action that human agent should take. For example, "apologize for
4268
+ # the slow shipping". If the users only want to use agent coaching for intent
4269
+ # detection, agent_action can be empty
4270
+ # Corresponds to the JSON property `agentAction`
4271
+ # @return [String]
4272
+ attr_accessor :agent_action
4273
+
4274
+ # Optional. The condition of the instruction. For example, "the customer wants
4275
+ # to cancel an order". If the users want the instruction to be triggered
4276
+ # unconditionally, the condition can be empty.
4277
+ # Corresponds to the JSON property `condition`
4278
+ # @return [String]
4279
+ attr_accessor :condition
4280
+
4281
+ # Optional. The detailed description of this instruction.
4282
+ # Corresponds to the JSON property `description`
4283
+ # @return [String]
4284
+ attr_accessor :description
4285
+
4286
+ # Optional. Display name for the instruction.
4287
+ # Corresponds to the JSON property `displayName`
4288
+ # @return [String]
4289
+ attr_accessor :display_name
4290
+
4291
+ # Optional. Additional information attached to this instruction.
4292
+ # Corresponds to the JSON property `metadata`
4293
+ # @return [Hash<String,String>]
4294
+ attr_accessor :metadata
4295
+
4296
+ # Optional. The action that system should take. For example, "call GetOrderTime
4297
+ # with order_number=`order number provided by the customer`". If the users don't
4298
+ # have plugins or don't want to trigger plugins, the system_action can be empty
4299
+ # Corresponds to the JSON property `systemAction`
4300
+ # @return [String]
4301
+ attr_accessor :system_action
4302
+
4303
+ def initialize(**args)
4304
+ update!(**args)
4305
+ end
4306
+
4307
+ # Update properties of this object
4308
+ def update!(**args)
4309
+ @agent_action = args[:agent_action] if args.key?(:agent_action)
4310
+ @condition = args[:condition] if args.key?(:condition)
4311
+ @description = args[:description] if args.key?(:description)
4312
+ @display_name = args[:display_name] if args.key?(:display_name)
4313
+ @metadata = args[:metadata] if args.key?(:metadata)
4314
+ @system_action = args[:system_action] if args.key?(:system_action)
4315
+ end
4316
+ end
4317
+
4318
+ # Suggestion for coaching agents.
4319
+ class GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion
4320
+ include Google::Apis::Core::Hashable
4321
+
4322
+ # Optional. Suggested actions for the agent to take.
4323
+ # Corresponds to the JSON property `agentActionSuggestions`
4324
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion>]
4325
+ attr_accessor :agent_action_suggestions
4326
+
4327
+ # Optional. Instructions applicable based on the current context.
4328
+ # Corresponds to the JSON property `applicableInstructions`
4329
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction>]
4330
+ attr_accessor :applicable_instructions
4331
+
4332
+ # Optional. Sample response for the Agent.
4333
+ # Corresponds to the JSON property `sampleResponses`
4334
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse>]
4335
+ attr_accessor :sample_responses
4336
+
4337
+ # Self evaluations of the suggestion.
4338
+ # Corresponds to the JSON property `suggestionEval`
4339
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval]
4340
+ attr_accessor :suggestion_eval
4341
+
4342
+ # Reasoning for the suggestion.
4343
+ # Corresponds to the JSON property `suggestionReasoning`
4344
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning]
4345
+ attr_accessor :suggestion_reasoning
4346
+
4347
+ def initialize(**args)
4348
+ update!(**args)
4349
+ end
4350
+
4351
+ # Update properties of this object
4352
+ def update!(**args)
4353
+ @agent_action_suggestions = args[:agent_action_suggestions] if args.key?(:agent_action_suggestions)
4354
+ @applicable_instructions = args[:applicable_instructions] if args.key?(:applicable_instructions)
4355
+ @sample_responses = args[:sample_responses] if args.key?(:sample_responses)
4356
+ @suggestion_eval = args[:suggestion_eval] if args.key?(:suggestion_eval)
4357
+ @suggestion_reasoning = args[:suggestion_reasoning] if args.key?(:suggestion_reasoning)
4358
+ end
4359
+ end
4360
+
4361
+ # Actions suggested for the agent. This is based on applicable instructions.
4362
+ class GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion
4363
+ include Google::Apis::Core::Hashable
4364
+
4365
+ # Optional. The suggested action for the agent.
4366
+ # Corresponds to the JSON property `agentAction`
4367
+ # @return [String]
4368
+ attr_accessor :agent_action
4369
+
4370
+ def initialize(**args)
4371
+ update!(**args)
4372
+ end
4373
+
4374
+ # Update properties of this object
4375
+ def update!(**args)
4376
+ @agent_action = args[:agent_action] if args.key?(:agent_action)
4377
+ end
4378
+ end
4379
+
4380
+ # Self evaluations of the suggestion.
4381
+ class GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval
4382
+ include Google::Apis::Core::Hashable
4383
+
4384
+ # Optional. Eval for Agent action suggestion.
4385
+ # Corresponds to the JSON property `actionActionSuggestionEval`
4386
+ # @return [String]
4387
+ attr_accessor :action_action_suggestion_eval
4388
+
4389
+ # Optional. Eval for sample response.
4390
+ # Corresponds to the JSON property `sampleResponseEval`
4391
+ # @return [String]
4392
+ attr_accessor :sample_response_eval
4393
+
4394
+ def initialize(**args)
4395
+ update!(**args)
4396
+ end
4397
+
4398
+ # Update properties of this object
4399
+ def update!(**args)
4400
+ @action_action_suggestion_eval = args[:action_action_suggestion_eval] if args.key?(:action_action_suggestion_eval)
4401
+ @sample_response_eval = args[:sample_response_eval] if args.key?(:sample_response_eval)
4402
+ end
4403
+ end
4404
+
4405
+ # Reasoning for the suggestion.
4406
+ class GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning
4407
+ include Google::Apis::Core::Hashable
4408
+
4409
+ # Optional. The actions that the agent has taken already.
4410
+ # Corresponds to the JSON property `agentActionTaken`
4411
+ # @return [String]
4412
+ attr_accessor :agent_action_taken
4413
+
4414
+ # Optional. Summary of the issue.
4415
+ # Corresponds to the JSON property `issueSummary`
4416
+ # @return [String]
4417
+ attr_accessor :issue_summary
4418
+
4419
+ def initialize(**args)
4420
+ update!(**args)
4421
+ end
4422
+
4423
+ # Update properties of this object
4424
+ def update!(**args)
4425
+ @agent_action_taken = args[:agent_action_taken] if args.key?(:agent_action_taken)
4426
+ @issue_summary = args[:issue_summary] if args.key?(:issue_summary)
4427
+ end
4428
+ end
3629
4429
 
3630
- # String with specific view properties, must be non-empty.
3631
- # Corresponds to the JSON property `value`
4430
+ # Sample response that the agent can use. This could be based on applicable
4431
+ # instructions and ingested data from other systems.
4432
+ class GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse
4433
+ include Google::Apis::Core::Hashable
4434
+
4435
+ # Optional. Sample response for Agent in text.
4436
+ # Corresponds to the JSON property `responseText`
3632
4437
  # @return [String]
3633
- attr_accessor :value
4438
+ attr_accessor :response_text
3634
4439
 
3635
4440
  def initialize(**args)
3636
4441
  update!(**args)
@@ -3638,11 +4443,7 @@ module Google
3638
4443
 
3639
4444
  # Update properties of this object
3640
4445
  def update!(**args)
3641
- @create_time = args[:create_time] if args.key?(:create_time)
3642
- @display_name = args[:display_name] if args.key?(:display_name)
3643
- @name = args[:name] if args.key?(:name)
3644
- @update_time = args[:update_time] if args.key?(:update_time)
3645
- @value = args[:value] if args.key?(:value)
4446
+ @response_text = args[:response_text] if args.key?(:response_text)
3646
4447
  end
3647
4448
  end
3648
4449
 
@@ -5271,12 +6072,257 @@ module Google
5271
6072
  # Required. The parent resource to export data from.
5272
6073
  # Corresponds to the JSON property `parent`
5273
6074
  # @return [String]
5274
- attr_accessor :parent
6075
+ attr_accessor :parent
6076
+
6077
+ # Options for what to do if the destination table already exists.
6078
+ # Corresponds to the JSON property `writeDisposition`
6079
+ # @return [String]
6080
+ attr_accessor :write_disposition
6081
+
6082
+ def initialize(**args)
6083
+ update!(**args)
6084
+ end
6085
+
6086
+ # Update properties of this object
6087
+ def update!(**args)
6088
+ @big_query_destination = args[:big_query_destination] if args.key?(:big_query_destination)
6089
+ @filter = args[:filter] if args.key?(:filter)
6090
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
6091
+ @parent = args[:parent] if args.key?(:parent)
6092
+ @write_disposition = args[:write_disposition] if args.key?(:write_disposition)
6093
+ end
6094
+ end
6095
+
6096
+ # A BigQuery Table Reference.
6097
+ class GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination
6098
+ include Google::Apis::Core::Hashable
6099
+
6100
+ # Required. The name of the BigQuery dataset that the snapshot result should be
6101
+ # exported to. If this dataset does not exist, the export call returns an
6102
+ # INVALID_ARGUMENT error.
6103
+ # Corresponds to the JSON property `dataset`
6104
+ # @return [String]
6105
+ attr_accessor :dataset
6106
+
6107
+ # A project ID or number. If specified, then export will attempt to write data
6108
+ # to this project instead of the resource project. Otherwise, the resource
6109
+ # project will be used.
6110
+ # Corresponds to the JSON property `projectId`
6111
+ # @return [String]
6112
+ attr_accessor :project_id
6113
+
6114
+ # The BigQuery table name to which the insights data should be written. If this
6115
+ # table does not exist, the export call returns an INVALID_ARGUMENT error.
6116
+ # Corresponds to the JSON property `table`
6117
+ # @return [String]
6118
+ attr_accessor :table
6119
+
6120
+ def initialize(**args)
6121
+ update!(**args)
6122
+ end
6123
+
6124
+ # Update properties of this object
6125
+ def update!(**args)
6126
+ @dataset = args[:dataset] if args.key?(:dataset)
6127
+ @project_id = args[:project_id] if args.key?(:project_id)
6128
+ @table = args[:table] if args.key?(:table)
6129
+ end
6130
+ end
6131
+
6132
+ # Response for an export insights operation.
6133
+ class GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse
6134
+ include Google::Apis::Core::Hashable
6135
+
6136
+ def initialize(**args)
6137
+ update!(**args)
6138
+ end
6139
+
6140
+ # Update properties of this object
6141
+ def update!(**args)
6142
+ end
6143
+ end
6144
+
6145
+ # Metadata used for export issue model.
6146
+ class GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata
6147
+ include Google::Apis::Core::Hashable
6148
+
6149
+ # The time the operation was created.
6150
+ # Corresponds to the JSON property `createTime`
6151
+ # @return [String]
6152
+ attr_accessor :create_time
6153
+
6154
+ # The time the operation finished running.
6155
+ # Corresponds to the JSON property `endTime`
6156
+ # @return [String]
6157
+ attr_accessor :end_time
6158
+
6159
+ # Request to export an issue model.
6160
+ # Corresponds to the JSON property `request`
6161
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest]
6162
+ attr_accessor :request
6163
+
6164
+ def initialize(**args)
6165
+ update!(**args)
6166
+ end
6167
+
6168
+ # Update properties of this object
6169
+ def update!(**args)
6170
+ @create_time = args[:create_time] if args.key?(:create_time)
6171
+ @end_time = args[:end_time] if args.key?(:end_time)
6172
+ @request = args[:request] if args.key?(:request)
6173
+ end
6174
+ end
6175
+
6176
+ # Request to export an issue model.
6177
+ class GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest
6178
+ include Google::Apis::Core::Hashable
6179
+
6180
+ # Google Cloud Storage Object URI to save the issue model to.
6181
+ # Corresponds to the JSON property `gcsDestination`
6182
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination]
6183
+ attr_accessor :gcs_destination
6184
+
6185
+ # Required. The issue model to export
6186
+ # Corresponds to the JSON property `name`
6187
+ # @return [String]
6188
+ attr_accessor :name
6189
+
6190
+ def initialize(**args)
6191
+ update!(**args)
6192
+ end
6193
+
6194
+ # Update properties of this object
6195
+ def update!(**args)
6196
+ @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
6197
+ @name = args[:name] if args.key?(:name)
6198
+ end
6199
+ end
6200
+
6201
+ # Google Cloud Storage Object URI to save the issue model to.
6202
+ class GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination
6203
+ include Google::Apis::Core::Hashable
6204
+
6205
+ # Required. Format: `gs:///`
6206
+ # Corresponds to the JSON property `objectUri`
6207
+ # @return [String]
6208
+ attr_accessor :object_uri
6209
+
6210
+ def initialize(**args)
6211
+ update!(**args)
6212
+ end
6213
+
6214
+ # Update properties of this object
6215
+ def update!(**args)
6216
+ @object_uri = args[:object_uri] if args.key?(:object_uri)
6217
+ end
6218
+ end
6219
+
6220
+ # Response from export issue model
6221
+ class GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse
6222
+ include Google::Apis::Core::Hashable
6223
+
6224
+ def initialize(**args)
6225
+ update!(**args)
6226
+ end
6227
+
6228
+ # Update properties of this object
6229
+ def update!(**args)
6230
+ end
6231
+ end
6232
+
6233
+ # Agent Assist frequently-asked-question answer data.
6234
+ class GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData
6235
+ include Google::Apis::Core::Hashable
6236
+
6237
+ # The piece of text from the `source` knowledge base document.
6238
+ # Corresponds to the JSON property `answer`
6239
+ # @return [String]
6240
+ attr_accessor :answer
6241
+
6242
+ # The system's confidence score that this answer is a good match for this
6243
+ # conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
6244
+ # certain).
6245
+ # Corresponds to the JSON property `confidenceScore`
6246
+ # @return [Float]
6247
+ attr_accessor :confidence_score
6248
+
6249
+ # Map that contains metadata about the FAQ answer and the document that it
6250
+ # originates from.
6251
+ # Corresponds to the JSON property `metadata`
6252
+ # @return [Hash<String,String>]
6253
+ attr_accessor :metadata
6254
+
6255
+ # The name of the answer record. Format: projects/`project`/locations/`location`/
6256
+ # answerRecords/`answer_record`
6257
+ # Corresponds to the JSON property `queryRecord`
6258
+ # @return [String]
6259
+ attr_accessor :query_record
6260
+
6261
+ # The corresponding FAQ question.
6262
+ # Corresponds to the JSON property `question`
6263
+ # @return [String]
6264
+ attr_accessor :question
6265
+
6266
+ # The knowledge document that this answer was extracted from. Format: projects/`
6267
+ # project`/knowledgeBases/`knowledge_base`/documents/`document`.
6268
+ # Corresponds to the JSON property `source`
6269
+ # @return [String]
6270
+ attr_accessor :source
6271
+
6272
+ def initialize(**args)
6273
+ update!(**args)
6274
+ end
6275
+
6276
+ # Update properties of this object
6277
+ def update!(**args)
6278
+ @answer = args[:answer] if args.key?(:answer)
6279
+ @confidence_score = args[:confidence_score] if args.key?(:confidence_score)
6280
+ @metadata = args[:metadata] if args.key?(:metadata)
6281
+ @query_record = args[:query_record] if args.key?(:query_record)
6282
+ @question = args[:question] if args.key?(:question)
6283
+ @source = args[:source] if args.key?(:source)
6284
+ end
6285
+ end
6286
+
6287
+ # Suggestion generated using free form generator.
6288
+ class GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion
6289
+ include Google::Apis::Core::Hashable
6290
+
6291
+ # Optional. Labels for the generator.
6292
+ # Corresponds to the JSON property `labels`
6293
+ # @return [Array<String>]
6294
+ attr_accessor :labels
6295
+
6296
+ # Required. Free form suggestion.
6297
+ # Corresponds to the JSON property `response`
6298
+ # @return [String]
6299
+ attr_accessor :response
6300
+
6301
+ def initialize(**args)
6302
+ update!(**args)
6303
+ end
6304
+
6305
+ # Update properties of this object
6306
+ def update!(**args)
6307
+ @labels = args[:labels] if args.key?(:labels)
6308
+ @response = args[:response] if args.key?(:response)
6309
+ end
6310
+ end
6311
+
6312
+ # A Cloud Storage source of conversation data.
6313
+ class GoogleCloudContactcenterinsightsV1alpha1GcsSource
6314
+ include Google::Apis::Core::Hashable
6315
+
6316
+ # Cloud Storage URI that points to a file that contains the conversation audio.
6317
+ # Corresponds to the JSON property `audioUri`
6318
+ # @return [String]
6319
+ attr_accessor :audio_uri
5275
6320
 
5276
- # Options for what to do if the destination table already exists.
5277
- # Corresponds to the JSON property `writeDisposition`
6321
+ # Immutable. Cloud Storage URI that points to a file that contains the
6322
+ # conversation transcript.
6323
+ # Corresponds to the JSON property `transcriptUri`
5278
6324
  # @return [String]
5279
- attr_accessor :write_disposition
6325
+ attr_accessor :transcript_uri
5280
6326
 
5281
6327
  def initialize(**args)
5282
6328
  update!(**args)
@@ -5284,37 +6330,29 @@ module Google
5284
6330
 
5285
6331
  # Update properties of this object
5286
6332
  def update!(**args)
5287
- @big_query_destination = args[:big_query_destination] if args.key?(:big_query_destination)
5288
- @filter = args[:filter] if args.key?(:filter)
5289
- @kms_key = args[:kms_key] if args.key?(:kms_key)
5290
- @parent = args[:parent] if args.key?(:parent)
5291
- @write_disposition = args[:write_disposition] if args.key?(:write_disposition)
6333
+ @audio_uri = args[:audio_uri] if args.key?(:audio_uri)
6334
+ @transcript_uri = args[:transcript_uri] if args.key?(:transcript_uri)
5292
6335
  end
5293
6336
  end
5294
6337
 
5295
- # A BigQuery Table Reference.
5296
- class GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination
6338
+ # Suggestion generated using a Generator.
6339
+ class GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion
5297
6340
  include Google::Apis::Core::Hashable
5298
6341
 
5299
- # Required. The name of the BigQuery dataset that the snapshot result should be
5300
- # exported to. If this dataset does not exist, the export call returns an
5301
- # INVALID_ARGUMENT error.
5302
- # Corresponds to the JSON property `dataset`
5303
- # @return [String]
5304
- attr_accessor :dataset
6342
+ # Suggestion for coaching agents.
6343
+ # Corresponds to the JSON property `agentCoachingSuggestion`
6344
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion]
6345
+ attr_accessor :agent_coaching_suggestion
5305
6346
 
5306
- # A project ID or number. If specified, then export will attempt to write data
5307
- # to this project instead of the resource project. Otherwise, the resource
5308
- # project will be used.
5309
- # Corresponds to the JSON property `projectId`
5310
- # @return [String]
5311
- attr_accessor :project_id
6347
+ # Suggestion generated using free form generator.
6348
+ # Corresponds to the JSON property `freeFormSuggestion`
6349
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion]
6350
+ attr_accessor :free_form_suggestion
5312
6351
 
5313
- # The BigQuery table name to which the insights data should be written. If this
5314
- # table does not exist, the export call returns an INVALID_ARGUMENT error.
5315
- # Corresponds to the JSON property `table`
5316
- # @return [String]
5317
- attr_accessor :table
6352
+ # Suggested summary of the conversation.
6353
+ # Corresponds to the JSON property `summarySuggestion`
6354
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion]
6355
+ attr_accessor :summary_suggestion
5318
6356
 
5319
6357
  def initialize(**args)
5320
6358
  update!(**args)
@@ -5322,43 +6360,46 @@ module Google
5322
6360
 
5323
6361
  # Update properties of this object
5324
6362
  def update!(**args)
5325
- @dataset = args[:dataset] if args.key?(:dataset)
5326
- @project_id = args[:project_id] if args.key?(:project_id)
5327
- @table = args[:table] if args.key?(:table)
6363
+ @agent_coaching_suggestion = args[:agent_coaching_suggestion] if args.key?(:agent_coaching_suggestion)
6364
+ @free_form_suggestion = args[:free_form_suggestion] if args.key?(:free_form_suggestion)
6365
+ @summary_suggestion = args[:summary_suggestion] if args.key?(:summary_suggestion)
5328
6366
  end
5329
6367
  end
5330
6368
 
5331
- # Response for an export insights operation.
5332
- class GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse
6369
+ # Represents response from generators.
6370
+ class GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse
5333
6371
  include Google::Apis::Core::Hashable
5334
6372
 
6373
+ # Suggestion generated using a Generator.
6374
+ # Corresponds to the JSON property `generatorSuggestion`
6375
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion]
6376
+ attr_accessor :generator_suggestion
6377
+
5335
6378
  def initialize(**args)
5336
6379
  update!(**args)
5337
6380
  end
5338
6381
 
5339
6382
  # Update properties of this object
5340
6383
  def update!(**args)
6384
+ @generator_suggestion = args[:generator_suggestion] if args.key?(:generator_suggestion)
5341
6385
  end
5342
6386
  end
5343
6387
 
5344
- # Metadata used for export issue model.
5345
- class GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata
6388
+ # Response for Knowledge Assist. Contains suggested query and optionally
6389
+ # includes an answer for the query.
6390
+ class GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse
5346
6391
  include Google::Apis::Core::Hashable
5347
6392
 
5348
- # The time the operation was created.
5349
- # Corresponds to the JSON property `createTime`
5350
- # @return [String]
5351
- attr_accessor :create_time
5352
-
5353
- # The time the operation finished running.
5354
- # Corresponds to the JSON property `endTime`
5355
- # @return [String]
5356
- attr_accessor :end_time
6393
+ # Represents a suggested query.
6394
+ # Corresponds to the JSON property `suggestedQuery`
6395
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery]
6396
+ attr_accessor :suggested_query
5357
6397
 
5358
- # Request to export an issue model.
5359
- # Corresponds to the JSON property `request`
5360
- # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest]
5361
- attr_accessor :request
6398
+ # Represents an answer from Knowledge. Cuurently supports FAQ and Generative
6399
+ # answers.
6400
+ # Corresponds to the JSON property `suggestedQueryAnswer`
6401
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer]
6402
+ attr_accessor :suggested_query_answer
5362
6403
 
5363
6404
  def initialize(**args)
5364
6405
  update!(**args)
@@ -5366,25 +6407,42 @@ module Google
5366
6407
 
5367
6408
  # Update properties of this object
5368
6409
  def update!(**args)
5369
- @create_time = args[:create_time] if args.key?(:create_time)
5370
- @end_time = args[:end_time] if args.key?(:end_time)
5371
- @request = args[:request] if args.key?(:request)
6410
+ @suggested_query = args[:suggested_query] if args.key?(:suggested_query)
6411
+ @suggested_query_answer = args[:suggested_query_answer] if args.key?(:suggested_query_answer)
5372
6412
  end
5373
6413
  end
5374
6414
 
5375
- # Request to export an issue model.
5376
- class GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest
6415
+ # Represents an answer from Knowledge. Cuurently supports FAQ and Generative
6416
+ # answers.
6417
+ class GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer
5377
6418
  include Google::Apis::Core::Hashable
5378
6419
 
5379
- # Google Cloud Storage Object URI to save the issue model to.
5380
- # Corresponds to the JSON property `gcsDestination`
5381
- # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination]
5382
- attr_accessor :gcs_destination
5383
-
5384
- # Required. The issue model to export
5385
- # Corresponds to the JSON property `name`
6420
+ # The piece of text from the `source` that answers this suggested query.
6421
+ # Corresponds to the JSON property `answerText`
5386
6422
  # @return [String]
5387
- attr_accessor :name
6423
+ attr_accessor :answer_text
6424
+
6425
+ # Details about source of FAQ answer.
6426
+ # Corresponds to the JSON property `faqSource`
6427
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource]
6428
+ attr_accessor :faq_source
6429
+
6430
+ # Details about source of Generative answer.
6431
+ # Corresponds to the JSON property `generativeSource`
6432
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource]
6433
+ attr_accessor :generative_source
6434
+
6435
+ # Details about source of Intent Matching answer.
6436
+ # Corresponds to the JSON property `intentMatchingSource`
6437
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource]
6438
+ attr_accessor :intent_matching_source
6439
+
6440
+ # The system's confidence score that this answer is a good match for this
6441
+ # conversational query. The range is from 0.0 (completely uncertain) to 1.0 (
6442
+ # completely certain).
6443
+ # Corresponds to the JSON property `matchConfidence`
6444
+ # @return [Float]
6445
+ attr_accessor :match_confidence
5388
6446
 
5389
6447
  def initialize(**args)
5390
6448
  update!(**args)
@@ -5392,19 +6450,28 @@ module Google
5392
6450
 
5393
6451
  # Update properties of this object
5394
6452
  def update!(**args)
5395
- @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
5396
- @name = args[:name] if args.key?(:name)
6453
+ @answer_text = args[:answer_text] if args.key?(:answer_text)
6454
+ @faq_source = args[:faq_source] if args.key?(:faq_source)
6455
+ @generative_source = args[:generative_source] if args.key?(:generative_source)
6456
+ @intent_matching_source = args[:intent_matching_source] if args.key?(:intent_matching_source)
6457
+ @match_confidence = args[:match_confidence] if args.key?(:match_confidence)
5397
6458
  end
5398
6459
  end
5399
6460
 
5400
- # Google Cloud Storage Object URI to save the issue model to.
5401
- class GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination
6461
+ # Details about source of FAQ answer.
6462
+ class GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource
5402
6463
  include Google::Apis::Core::Hashable
5403
6464
 
5404
- # Required. Format: `gs:///`
5405
- # Corresponds to the JSON property `objectUri`
6465
+ # Indicates which Knowledge Document this answer was extracted from. Format: `
6466
+ # projects//knowledgeBases//documents/`.
6467
+ # Corresponds to the JSON property `document`
5406
6468
  # @return [String]
5407
- attr_accessor :object_uri
6469
+ attr_accessor :document
6470
+
6471
+ # The corresponding FAQ question.
6472
+ # Corresponds to the JSON property `question`
6473
+ # @return [String]
6474
+ attr_accessor :question
5408
6475
 
5409
6476
  def initialize(**args)
5410
6477
  update!(**args)
@@ -5412,61 +6479,82 @@ module Google
5412
6479
 
5413
6480
  # Update properties of this object
5414
6481
  def update!(**args)
5415
- @object_uri = args[:object_uri] if args.key?(:object_uri)
6482
+ @document = args[:document] if args.key?(:document)
6483
+ @question = args[:question] if args.key?(:question)
5416
6484
  end
5417
6485
  end
5418
6486
 
5419
- # Response from export issue model
5420
- class GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse
6487
+ # Details about source of Generative answer.
6488
+ class GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource
5421
6489
  include Google::Apis::Core::Hashable
5422
6490
 
6491
+ # All snippets used for this Generative Prediction, with their source URI and
6492
+ # data.
6493
+ # Corresponds to the JSON property `snippets`
6494
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet>]
6495
+ attr_accessor :snippets
6496
+
5423
6497
  def initialize(**args)
5424
6498
  update!(**args)
5425
6499
  end
5426
6500
 
5427
6501
  # Update properties of this object
5428
6502
  def update!(**args)
6503
+ @snippets = args[:snippets] if args.key?(:snippets)
5429
6504
  end
5430
6505
  end
5431
6506
 
5432
- # Agent Assist frequently-asked-question answer data.
5433
- class GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData
6507
+ # Snippet Source for a Generative Prediction.
6508
+ class GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet
5434
6509
  include Google::Apis::Core::Hashable
5435
6510
 
5436
- # The piece of text from the `source` knowledge base document.
5437
- # Corresponds to the JSON property `answer`
6511
+ # Indicates which Knowledge Document this snippet was extracted from. Format: `
6512
+ # projects//knowledgeBases//documents/`.
6513
+ # Corresponds to the JSON property `document`
5438
6514
  # @return [String]
5439
- attr_accessor :answer
6515
+ attr_accessor :document
5440
6516
 
5441
- # The system's confidence score that this answer is a good match for this
5442
- # conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
5443
- # certain).
5444
- # Corresponds to the JSON property `confidenceScore`
5445
- # @return [Float]
5446
- attr_accessor :confidence_score
6517
+ # text taken from that URI.
6518
+ # Corresponds to the JSON property `text`
6519
+ # @return [String]
6520
+ attr_accessor :text
5447
6521
 
5448
- # Map that contains metadata about the FAQ answer and the document that it
5449
- # originates from.
5450
- # Corresponds to the JSON property `metadata`
5451
- # @return [Hash<String,String>]
5452
- attr_accessor :metadata
6522
+ # Title of the document.
6523
+ # Corresponds to the JSON property `title`
6524
+ # @return [String]
6525
+ attr_accessor :title
5453
6526
 
5454
- # The name of the answer record. Format: projects/`project`/locations/`location`/
5455
- # answerRecords/`answer_record`
5456
- # Corresponds to the JSON property `queryRecord`
6527
+ # URI the data is sourced from.
6528
+ # Corresponds to the JSON property `uri`
5457
6529
  # @return [String]
5458
- attr_accessor :query_record
6530
+ attr_accessor :uri
5459
6531
 
5460
- # The corresponding FAQ question.
5461
- # Corresponds to the JSON property `question`
6532
+ def initialize(**args)
6533
+ update!(**args)
6534
+ end
6535
+
6536
+ # Update properties of this object
6537
+ def update!(**args)
6538
+ @document = args[:document] if args.key?(:document)
6539
+ @text = args[:text] if args.key?(:text)
6540
+ @title = args[:title] if args.key?(:title)
6541
+ @uri = args[:uri] if args.key?(:uri)
6542
+ end
6543
+ end
6544
+
6545
+ # Details about source of Intent Matching answer.
6546
+ class GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource
6547
+ include Google::Apis::Core::Hashable
6548
+
6549
+ # Title of the document.
6550
+ # Corresponds to the JSON property `title`
5462
6551
  # @return [String]
5463
- attr_accessor :question
6552
+ attr_accessor :title
5464
6553
 
5465
- # The knowledge document that this answer was extracted from. Format: projects/`
5466
- # project`/knowledgeBases/`knowledge_base`/documents/`document`.
5467
- # Corresponds to the JSON property `source`
6554
+ # URI the data is sourced from.
6555
+ # Corresponds to the JSON property `uri`
5468
6556
  # @return [String]
5469
- attr_accessor :source
6557
+ attr_accessor :uri
5470
6558
 
5471
6559
  def initialize(**args)
5472
6560
  update!(**args)
@@ -5474,29 +6562,24 @@ module Google
5474
6562
 
5475
6563
  # Update properties of this object
5476
6564
  def update!(**args)
5477
- @answer = args[:answer] if args.key?(:answer)
5478
- @confidence_score = args[:confidence_score] if args.key?(:confidence_score)
5479
- @metadata = args[:metadata] if args.key?(:metadata)
5480
- @query_record = args[:query_record] if args.key?(:query_record)
5481
- @question = args[:question] if args.key?(:question)
5482
- @source = args[:source] if args.key?(:source)
6565
+ @title = args[:title] if args.key?(:title)
6566
+ @uri = args[:uri] if args.key?(:uri)
5483
6567
  end
5484
6568
  end
5485
6569
 
5486
- # A Cloud Storage source of conversation data.
5487
- class GoogleCloudContactcenterinsightsV1alpha1GcsSource
6570
+ # Represents a suggested query.
6571
+ class GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery
5488
6572
  include Google::Apis::Core::Hashable
5489
6573
 
5490
- # Cloud Storage URI that points to a file that contains the conversation audio.
5491
- # Corresponds to the JSON property `audioUri`
6574
+ # Suggested query text.
6575
+ # Corresponds to the JSON property `queryText`
5492
6576
  # @return [String]
5493
- attr_accessor :audio_uri
6577
+ attr_accessor :query_text
5494
6578
 
5495
- # Immutable. Cloud Storage URI that points to a file that contains the
5496
- # conversation transcript.
5497
- # Corresponds to the JSON property `transcriptUri`
5498
- # @return [String]
5499
- attr_accessor :transcript_uri
6579
+ # Suggested query score.
6580
+ # Corresponds to the JSON property `score`
6581
+ # @return [Float]
6582
+ attr_accessor :score
5500
6583
 
5501
6584
  def initialize(**args)
5502
6585
  update!(**args)
@@ -5504,8 +6587,8 @@ module Google
5504
6587
 
5505
6588
  # Update properties of this object
5506
6589
  def update!(**args)
5507
- @audio_uri = args[:audio_uri] if args.key?(:audio_uri)
5508
- @transcript_uri = args[:transcript_uri] if args.key?(:transcript_uri)
6590
+ @query_text = args[:query_text] if args.key?(:query_text)
6591
+ @score = args[:score] if args.key?(:score)
5509
6592
  end
5510
6593
  end
5511
6594
 
@@ -6270,6 +7353,22 @@ module Google
6270
7353
  # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData]
6271
7354
  attr_accessor :faq_answer
6272
7355
 
7356
+ # Represents response from generators.
7357
+ # Corresponds to the JSON property `generatorSuggestionResult`
7358
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse]
7359
+ attr_accessor :generator_suggestion_result
7360
+
7361
+ # Response for Knowledge Assist. Contains suggested query and optionally
7362
+ # includes an answer for the query.
7363
+ # Corresponds to the JSON property `knowledgeAssistResult`
7364
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse]
7365
+ attr_accessor :knowledge_assist_result
7366
+
7367
+ # Represents a SearchKnowledge answer.
7368
+ # Corresponds to the JSON property `knowledgeSearchResult`
7369
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer]
7370
+ attr_accessor :knowledge_search_result
7371
+
6273
7372
  # Agent Assist Smart Compose suggestion data.
6274
7373
  # Corresponds to the JSON property `smartComposeSuggestion`
6275
7374
  # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData]
@@ -6299,12 +7398,97 @@ module Google
6299
7398
  @dialogflow_interaction = args[:dialogflow_interaction] if args.key?(:dialogflow_interaction)
6300
7399
  @end_boundary = args[:end_boundary] if args.key?(:end_boundary)
6301
7400
  @faq_answer = args[:faq_answer] if args.key?(:faq_answer)
7401
+ @generator_suggestion_result = args[:generator_suggestion_result] if args.key?(:generator_suggestion_result)
7402
+ @knowledge_assist_result = args[:knowledge_assist_result] if args.key?(:knowledge_assist_result)
7403
+ @knowledge_search_result = args[:knowledge_search_result] if args.key?(:knowledge_search_result)
6302
7404
  @smart_compose_suggestion = args[:smart_compose_suggestion] if args.key?(:smart_compose_suggestion)
6303
7405
  @smart_reply = args[:smart_reply] if args.key?(:smart_reply)
6304
7406
  @start_boundary = args[:start_boundary] if args.key?(:start_boundary)
6305
7407
  end
6306
7408
  end
6307
7409
 
7410
+ # Represents a SearchKnowledge answer.
7411
+ class GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer
7412
+ include Google::Apis::Core::Hashable
7413
+
7414
+ # The piece of text from the knowledge base documents that answers the search
7415
+ # query
7416
+ # Corresponds to the JSON property `answer`
7417
+ # @return [String]
7418
+ attr_accessor :answer
7419
+
7420
+ # The name of the answer record. Format: `projects//locations//answer Records/`
7421
+ # Corresponds to the JSON property `answerRecord`
7422
+ # @return [String]
7423
+ attr_accessor :answer_record
7424
+
7425
+ # All sources used to generate the answer.
7426
+ # Corresponds to the JSON property `answerSources`
7427
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource>]
7428
+ attr_accessor :answer_sources
7429
+
7430
+ # The type of the answer.
7431
+ # Corresponds to the JSON property `answerType`
7432
+ # @return [String]
7433
+ attr_accessor :answer_type
7434
+
7435
+ # The confidence score in [0.0, 1.0] range.
7436
+ # Corresponds to the JSON property `confidenceScore`
7437
+ # @return [Float]
7438
+ attr_accessor :confidence_score
7439
+
7440
+ def initialize(**args)
7441
+ update!(**args)
7442
+ end
7443
+
7444
+ # Update properties of this object
7445
+ def update!(**args)
7446
+ @answer = args[:answer] if args.key?(:answer)
7447
+ @answer_record = args[:answer_record] if args.key?(:answer_record)
7448
+ @answer_sources = args[:answer_sources] if args.key?(:answer_sources)
7449
+ @answer_type = args[:answer_type] if args.key?(:answer_type)
7450
+ @confidence_score = args[:confidence_score] if args.key?(:confidence_score)
7451
+ end
7452
+ end
7453
+
7454
+ # The sources of the answers.
7455
+ class GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource
7456
+ include Google::Apis::Core::Hashable
7457
+
7458
+ # The document from which the snippet was extracted. Format: `projects//
7459
+ # knowledgeBases//documents/`
7460
+ # Corresponds to the JSON property `document`
7461
+ # @return [String]
7462
+ attr_accessor :document
7463
+
7464
+ # The relevant snippet of the article.
7465
+ # Corresponds to the JSON property `snippet`
7466
+ # @return [String]
7467
+ attr_accessor :snippet
7468
+
7469
+ # The title of the article.
7470
+ # Corresponds to the JSON property `title`
7471
+ # @return [String]
7472
+ attr_accessor :title
7473
+
7474
+ # The URI of the article.
7475
+ # Corresponds to the JSON property `uri`
7476
+ # @return [String]
7477
+ attr_accessor :uri
7478
+
7479
+ def initialize(**args)
7480
+ update!(**args)
7481
+ end
7482
+
7483
+ # Update properties of this object
7484
+ def update!(**args)
7485
+ @document = args[:document] if args.key?(:document)
7486
+ @snippet = args[:snippet] if args.key?(:snippet)
7487
+ @title = args[:title] if args.key?(:title)
7488
+ @uri = args[:uri] if args.key?(:uri)
7489
+ end
7490
+ end
7491
+
6308
7492
  # The data for a sentiment annotation.
6309
7493
  class GoogleCloudContactcenterinsightsV1alpha1SentimentData
6310
7494
  include Google::Apis::Core::Hashable
@@ -6446,6 +7630,50 @@ module Google
6446
7630
  end
6447
7631
  end
6448
7632
 
7633
+ # Suggested summary of the conversation.
7634
+ class GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion
7635
+ include Google::Apis::Core::Hashable
7636
+
7637
+ # Required. All the parts of generated summary.
7638
+ # Corresponds to the JSON property `summarySections`
7639
+ # @return [Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection>]
7640
+ attr_accessor :summary_sections
7641
+
7642
+ def initialize(**args)
7643
+ update!(**args)
7644
+ end
7645
+
7646
+ # Update properties of this object
7647
+ def update!(**args)
7648
+ @summary_sections = args[:summary_sections] if args.key?(:summary_sections)
7649
+ end
7650
+ end
7651
+
7652
+ # A component of the generated summary.
7653
+ class GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection
7654
+ include Google::Apis::Core::Hashable
7655
+
7656
+ # Required. Name of the section.
7657
+ # Corresponds to the JSON property `section`
7658
+ # @return [String]
7659
+ attr_accessor :section
7660
+
7661
+ # Required. Summary text for the section.
7662
+ # Corresponds to the JSON property `summary`
7663
+ # @return [String]
7664
+ attr_accessor :summary
7665
+
7666
+ def initialize(**args)
7667
+ update!(**args)
7668
+ end
7669
+
7670
+ # Update properties of this object
7671
+ def update!(**args)
7672
+ @section = args[:section] if args.key?(:section)
7673
+ @summary = args[:summary] if args.key?(:summary)
7674
+ end
7675
+ end
7676
+
6449
7677
  # Metadata for undeploying an issue model.
6450
7678
  class GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata
6451
7679
  include Google::Apis::Core::Hashable