google-cloud-contact_center_insights-v1 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +167 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google-cloud-contact_center_insights-v1.rb +21 -0
  7. data/lib/google/cloud/contact_center_insights/v1.rb +38 -0
  8. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights.rb +50 -0
  9. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/client.rb +2506 -0
  10. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/credentials.rb +47 -0
  11. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/operations.rb +664 -0
  12. data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb +211 -0
  13. data/lib/google/cloud/contact_center_insights/v1/version.rb +28 -0
  14. data/lib/google/cloud/contactcenterinsights/v1/contact_center_insights_pb.rb +273 -0
  15. data/lib/google/cloud/contactcenterinsights/v1/contact_center_insights_services_pb.rb +102 -0
  16. data/lib/google/cloud/contactcenterinsights/v1/resources_pb.rb +408 -0
  17. data/proto_docs/README.md +4 -0
  18. data/proto_docs/google/api/field_behavior.rb +71 -0
  19. data/proto_docs/google/api/resource.rb +283 -0
  20. data/proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb +685 -0
  21. data/proto_docs/google/cloud/contactcenterinsights/v1/resources.rb +1213 -0
  22. data/proto_docs/google/longrunning/operations.rb +164 -0
  23. data/proto_docs/google/protobuf/any.rb +141 -0
  24. data/proto_docs/google/protobuf/duration.rb +98 -0
  25. data/proto_docs/google/protobuf/empty.rb +36 -0
  26. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  27. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  28. data/proto_docs/google/rpc/status.rb +46 -0
  29. metadata +220 -0
@@ -0,0 +1,4 @@
1
+ # Contact Center AI Insights V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # An indicator of the behavior of a given field (for example, that a field
23
+ # is required in requests, or given as output but ignored as input).
24
+ # This **does not** change the behavior in protocol buffers itself; it only
25
+ # denotes the behavior and may affect how API tooling handles the field.
26
+ #
27
+ # Note: This enum **may** receive new values in the future.
28
+ module FieldBehavior
29
+ # Conventional default for enums. Do not use this.
30
+ FIELD_BEHAVIOR_UNSPECIFIED = 0
31
+
32
+ # Specifically denotes a field as optional.
33
+ # While all fields in protocol buffers are optional, this may be specified
34
+ # for emphasis if appropriate.
35
+ OPTIONAL = 1
36
+
37
+ # Denotes a field as required.
38
+ # This indicates that the field **must** be provided as part of the request,
39
+ # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
40
+ REQUIRED = 2
41
+
42
+ # Denotes a field as output only.
43
+ # This indicates that the field is provided in responses, but including the
44
+ # field in a request does nothing (the server *must* ignore it and
45
+ # *must not* throw an error as a result of the field's presence).
46
+ OUTPUT_ONLY = 3
47
+
48
+ # Denotes a field as input only.
49
+ # This indicates that the field is provided in requests, and the
50
+ # corresponding field is not included in output.
51
+ INPUT_ONLY = 4
52
+
53
+ # Denotes a field as immutable.
54
+ # This indicates that the field may be set once in a request to create a
55
+ # resource, but may not be changed thereafter.
56
+ IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,283 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # name_descriptor: {
37
+ # pattern: "projects/{project}/topics/{topic}"
38
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
+ # parent_name_extractor: "projects/{project}"
40
+ # }
41
+ # };
42
+ # }
43
+ #
44
+ # The ResourceDescriptor Yaml config will look like:
45
+ #
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
+ #
53
+ # Sometimes, resources have multiple patterns, typically because they can
54
+ # live under multiple parents.
55
+ #
56
+ # Example:
57
+ #
58
+ # message LogEntry {
59
+ # option (google.api.resource) = {
60
+ # type: "logging.googleapis.com/LogEntry"
61
+ # name_descriptor: {
62
+ # pattern: "projects/{project}/logs/{log}"
63
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
+ # parent_name_extractor: "projects/{project}"
65
+ # }
66
+ # name_descriptor: {
67
+ # pattern: "folders/{folder}/logs/{log}"
68
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
+ # parent_name_extractor: "folders/{folder}"
70
+ # }
71
+ # name_descriptor: {
72
+ # pattern: "organizations/{organization}/logs/{log}"
73
+ # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
+ # parent_name_extractor: "organizations/{organization}"
75
+ # }
76
+ # name_descriptor: {
77
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
+ # parent_type: "billing.googleapis.com/BillingAccount"
79
+ # parent_name_extractor: "billingAccounts/{billing_account}"
80
+ # }
81
+ # };
82
+ # }
83
+ #
84
+ # The ResourceDescriptor Yaml config will look like:
85
+ #
86
+ # resources:
87
+ # - type: 'logging.googleapis.com/LogEntry'
88
+ # name_descriptor:
89
+ # - pattern: "projects/{project}/logs/{log}"
90
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
+ # parent_name_extractor: "projects/{project}"
92
+ # - pattern: "folders/{folder}/logs/{log}"
93
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
+ # parent_name_extractor: "folders/{folder}"
95
+ # - pattern: "organizations/{organization}/logs/{log}"
96
+ # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
+ # parent_name_extractor: "organizations/{organization}"
98
+ # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
+ # parent_type: "billing.googleapis.com/BillingAccount"
100
+ # parent_name_extractor: "billingAccounts/{billing_account}"
101
+ #
102
+ # For flexible resources, the resource name doesn't contain parent names, but
103
+ # the resource itself has parents for policy evaluation.
104
+ #
105
+ # Example:
106
+ #
107
+ # message Shelf {
108
+ # option (google.api.resource) = {
109
+ # type: "library.googleapis.com/Shelf"
110
+ # name_descriptor: {
111
+ # pattern: "shelves/{shelf}"
112
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
+ # }
114
+ # name_descriptor: {
115
+ # pattern: "shelves/{shelf}"
116
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
+ # }
118
+ # };
119
+ # }
120
+ #
121
+ # The ResourceDescriptor Yaml config will look like:
122
+ #
123
+ # resources:
124
+ # - type: 'library.googleapis.com/Shelf'
125
+ # name_descriptor:
126
+ # - pattern: "shelves/{shelf}"
127
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
+ # - pattern: "shelves/{shelf}"
129
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
130
+ # @!attribute [rw] type
131
+ # @return [::String]
132
+ # The resource type. It must be in the format of
133
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134
+ # singular and must not include version numbers.
135
+ #
136
+ # Example: `storage.googleapis.com/Bucket`
137
+ #
138
+ # The value of the resource_type_kind must follow the regular expression
139
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
140
+ # should use PascalCase (UpperCamelCase). The maximum number of
141
+ # characters allowed for the `resource_type_kind` is 100.
142
+ # @!attribute [rw] pattern
143
+ # @return [::Array<::String>]
144
+ # Optional. The relative resource name pattern associated with this resource
145
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
146
+ #
147
+ # The path pattern must follow the syntax, which aligns with HTTP binding
148
+ # syntax:
149
+ #
150
+ # Template = Segment { "/" Segment } ;
151
+ # Segment = LITERAL | Variable ;
152
+ # Variable = "{" LITERAL "}" ;
153
+ #
154
+ # Examples:
155
+ #
156
+ # - "projects/\\{project}/topics/\\{topic}"
157
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
158
+ #
159
+ # The components in braces correspond to the IDs for each resource in the
160
+ # hierarchy. It is expected that, if multiple patterns are provided,
161
+ # the same component name (e.g. "project") refers to IDs of the same
162
+ # type of resource.
163
+ # @!attribute [rw] name_field
164
+ # @return [::String]
165
+ # Optional. The field on the resource that designates the resource name
166
+ # field. If omitted, this is assumed to be "name".
167
+ # @!attribute [rw] history
168
+ # @return [::Google::Api::ResourceDescriptor::History]
169
+ # Optional. The historical or future-looking state of the resource pattern.
170
+ #
171
+ # Example:
172
+ #
173
+ # // The InspectTemplate message originally only supported resource
174
+ # // names with organization, and project was added later.
175
+ # message InspectTemplate {
176
+ # option (google.api.resource) = {
177
+ # type: "dlp.googleapis.com/InspectTemplate"
178
+ # pattern:
179
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
180
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
181
+ # history: ORIGINALLY_SINGLE_PATTERN
182
+ # };
183
+ # }
184
+ # @!attribute [rw] plural
185
+ # @return [::String]
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
190
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
194
+ # @!attribute [rw] singular
195
+ # @return [::String]
196
+ # The same concept of the `singular` field in k8s CRD spec
197
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
198
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
204
+ class ResourceDescriptor
205
+ include ::Google::Protobuf::MessageExts
206
+ extend ::Google::Protobuf::MessageExts::ClassMethods
207
+
208
+ # A description of the historical or future-looking state of the
209
+ # resource pattern.
210
+ module History
211
+ # The "unset" value.
212
+ HISTORY_UNSPECIFIED = 0
213
+
214
+ # The resource originally had one pattern and launched as such, and
215
+ # additional patterns were added later.
216
+ ORIGINALLY_SINGLE_PATTERN = 1
217
+
218
+ # The resource has one pattern, but the API owner expects to add more
219
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
220
+ # that from being necessary once there are multiple patterns.)
221
+ FUTURE_MULTI_PATTERN = 2
222
+ end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
239
+ end
240
+
241
+ # Defines a proto annotation that describes a string field that refers to
242
+ # an API resource.
243
+ # @!attribute [rw] type
244
+ # @return [::String]
245
+ # The resource type that the annotated field references.
246
+ #
247
+ # Example:
248
+ #
249
+ # message Subscription {
250
+ # string topic = 2 [(google.api.resource_reference) = {
251
+ # type: "pubsub.googleapis.com/Topic"
252
+ # }];
253
+ # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
265
+ # @!attribute [rw] child_type
266
+ # @return [::String]
267
+ # The resource type of a child collection that the annotated field
268
+ # references. This is useful for annotating the `parent` field that
269
+ # doesn't have a fixed resource type.
270
+ #
271
+ # Example:
272
+ #
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
278
+ class ResourceReference
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+ end
283
+ end
@@ -0,0 +1,685 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module ContactCenterInsights
23
+ module V1
24
+ # The request for calculating conversation statistics.
25
+ # @!attribute [rw] location
26
+ # @return [::String]
27
+ # Required. The location of the conversations.
28
+ # @!attribute [rw] filter
29
+ # @return [::String]
30
+ # A filter to reduce results to a specific subset. This field is useful for
31
+ # getting statistics about conversations with specific properties.
32
+ class CalculateStatsRequest
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+ end
36
+
37
+ # The response for calculating conversation statistics.
38
+ # @!attribute [rw] average_duration
39
+ # @return [::Google::Protobuf::Duration]
40
+ # The average duration of all conversations. The average is calculated using
41
+ # only conversations that have a time duration.
42
+ # @!attribute [rw] average_turn_count
43
+ # @return [::Integer]
44
+ # The average number of turns per conversation.
45
+ # @!attribute [rw] conversation_count
46
+ # @return [::Integer]
47
+ # The total number of conversations.
48
+ # @!attribute [rw] smart_highlighter_matches
49
+ # @return [::Google::Protobuf::Map{::String => ::Integer}]
50
+ # A map associating each smart highlighter display name with its respective
51
+ # number of matches in the set of conversations.
52
+ # @!attribute [rw] custom_highlighter_matches
53
+ # @return [::Google::Protobuf::Map{::String => ::Integer}]
54
+ # A map associating each custom highlighter resource name with its respective
55
+ # number of matches in the set of conversations.
56
+ # @!attribute [rw] issue_matches
57
+ # @return [::Google::Protobuf::Map{::String => ::Integer}]
58
+ # A map associating each issue resource name with its respective number of
59
+ # matches in the set of conversations. Key has the format:
60
+ # `projects/<Project ID>/locations/<Location ID>/issueModels/<Issue Model
61
+ # ID>/issues/<Issue ID>`
62
+ # @!attribute [rw] conversation_count_time_series
63
+ # @return [::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse::TimeSeries]
64
+ # A time series representing the count of conversations created over time
65
+ # that match that requested filter criteria.
66
+ class CalculateStatsResponse
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+
70
+ # A time series representing conversations over time.
71
+ # @!attribute [rw] interval_duration
72
+ # @return [::Google::Protobuf::Duration]
73
+ # The duration of each interval.
74
+ # @!attribute [rw] points
75
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::CalculateStatsResponse::TimeSeries::Interval>]
76
+ # An ordered list of intervals from earliest to latest, where each interval
77
+ # represents the number of conversations that transpired during the time
78
+ # window.
79
+ class TimeSeries
80
+ include ::Google::Protobuf::MessageExts
81
+ extend ::Google::Protobuf::MessageExts::ClassMethods
82
+
83
+ # A single interval in a time series.
84
+ # @!attribute [rw] start_time
85
+ # @return [::Google::Protobuf::Timestamp]
86
+ # The start time of this interval.
87
+ # @!attribute [rw] conversation_count
88
+ # @return [::Integer]
89
+ # The number of conversations created in this interval.
90
+ class Interval
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
+ end
94
+ end
95
+
96
+ # @!attribute [rw] key
97
+ # @return [::String]
98
+ # @!attribute [rw] value
99
+ # @return [::Integer]
100
+ class SmartHighlighterMatchesEntry
101
+ include ::Google::Protobuf::MessageExts
102
+ extend ::Google::Protobuf::MessageExts::ClassMethods
103
+ end
104
+
105
+ # @!attribute [rw] key
106
+ # @return [::String]
107
+ # @!attribute [rw] value
108
+ # @return [::Integer]
109
+ class CustomHighlighterMatchesEntry
110
+ include ::Google::Protobuf::MessageExts
111
+ extend ::Google::Protobuf::MessageExts::ClassMethods
112
+ end
113
+
114
+ # @!attribute [rw] key
115
+ # @return [::String]
116
+ # @!attribute [rw] value
117
+ # @return [::Integer]
118
+ class IssueMatchesEntry
119
+ include ::Google::Protobuf::MessageExts
120
+ extend ::Google::Protobuf::MessageExts::ClassMethods
121
+ end
122
+ end
123
+
124
+ # Metadata for a create analysis operation.
125
+ # @!attribute [r] create_time
126
+ # @return [::Google::Protobuf::Timestamp]
127
+ # Output only. The time the operation was created.
128
+ # @!attribute [r] end_time
129
+ # @return [::Google::Protobuf::Timestamp]
130
+ # Output only. The time the operation finished running.
131
+ # @!attribute [r] conversation
132
+ # @return [::String]
133
+ # Output only. The Conversation that this Analysis Operation belongs to.
134
+ class CreateAnalysisOperationMetadata
135
+ include ::Google::Protobuf::MessageExts
136
+ extend ::Google::Protobuf::MessageExts::ClassMethods
137
+ end
138
+
139
+ # Request to create a conversation.
140
+ # @!attribute [rw] parent
141
+ # @return [::String]
142
+ # Required. The parent resource of the conversation.
143
+ # @!attribute [rw] conversation
144
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation]
145
+ # Required. The conversation resource to create.
146
+ # @!attribute [rw] conversation_id
147
+ # @return [::String]
148
+ # A unique ID for the new conversation. This ID will become the final
149
+ # component of the conversation's resource name. If no ID is specified, a
150
+ # server-generated ID will be used.
151
+ #
152
+ # This value should be 4-32 characters and must match the regular
153
+ # expression /^[a-z0-9-]\\{4,32}$/. Valid characters are /[a-z][0-9]-/
154
+ class CreateConversationRequest
155
+ include ::Google::Protobuf::MessageExts
156
+ extend ::Google::Protobuf::MessageExts::ClassMethods
157
+ end
158
+
159
+ # Request to list conversations.
160
+ # @!attribute [rw] parent
161
+ # @return [::String]
162
+ # Required. The parent resource of the conversation.
163
+ # @!attribute [rw] page_size
164
+ # @return [::Integer]
165
+ # The maximum number of conversations to return in the response. If this
166
+ # value is zero, the service will select a default size. A call might return
167
+ # fewer objects than requested. A non-empty `next_page_token` in the response
168
+ # indicates that more data is available.
169
+ # @!attribute [rw] page_token
170
+ # @return [::String]
171
+ # The value returned by the last `ListConversationsResponse`. This value
172
+ # indicates that this is a continuation of a prior `ListConversations` call
173
+ # and that the system should return the next page of data.
174
+ # @!attribute [rw] filter
175
+ # @return [::String]
176
+ # A filter to reduce results to a specific subset. Useful for querying
177
+ # conversations with specific properties.
178
+ # @!attribute [rw] view
179
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationView]
180
+ # The level of details of the conversation. Default is `BASIC`.
181
+ class ListConversationsRequest
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
+ end
185
+
186
+ # The response of listing conversations.
187
+ # @!attribute [rw] conversations
188
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Conversation>]
189
+ # The conversations that match the request.
190
+ # @!attribute [rw] next_page_token
191
+ # @return [::String]
192
+ # A token, which can be sent as `page_token` to retrieve the next page.
193
+ # If this field is omitted, there are no subsequent pages.
194
+ class ListConversationsResponse
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # The request to get a conversation.
200
+ # @!attribute [rw] name
201
+ # @return [::String]
202
+ # Required. The name of the conversation to get.
203
+ # @!attribute [rw] view
204
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ConversationView]
205
+ # The level of details of the conversation. Default is `FULL`.
206
+ class GetConversationRequest
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # The request to update a conversation.
212
+ # @!attribute [rw] conversation
213
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation]
214
+ # Required. The new values for the conversation.
215
+ # @!attribute [rw] update_mask
216
+ # @return [::Google::Protobuf::FieldMask]
217
+ # The list of fields to be updated.
218
+ class UpdateConversationRequest
219
+ include ::Google::Protobuf::MessageExts
220
+ extend ::Google::Protobuf::MessageExts::ClassMethods
221
+ end
222
+
223
+ # The request to delete a conversation.
224
+ # @!attribute [rw] name
225
+ # @return [::String]
226
+ # Required. The name of the conversation to delete.
227
+ # @!attribute [rw] force
228
+ # @return [::Boolean]
229
+ # If set to true, all of this conversation's analyses will also be deleted.
230
+ # Otherwise, the request will only succeed if the conversation has no
231
+ # analyses.
232
+ class DeleteConversationRequest
233
+ include ::Google::Protobuf::MessageExts
234
+ extend ::Google::Protobuf::MessageExts::ClassMethods
235
+ end
236
+
237
+ # The request to create an analysis.
238
+ # @!attribute [rw] parent
239
+ # @return [::String]
240
+ # Required. The parent resource of the analysis.
241
+ # @!attribute [rw] analysis
242
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Analysis]
243
+ # Required. The analysis to create.
244
+ class CreateAnalysisRequest
245
+ include ::Google::Protobuf::MessageExts
246
+ extend ::Google::Protobuf::MessageExts::ClassMethods
247
+ end
248
+
249
+ # The request to list analyses.
250
+ # @!attribute [rw] parent
251
+ # @return [::String]
252
+ # Required. The parent resource of the analyses.
253
+ # @!attribute [rw] page_size
254
+ # @return [::Integer]
255
+ # The maximum number of analyses to return in the response. If this
256
+ # value is zero, the service will select a default size. A call might return
257
+ # fewer objects than requested. A non-empty `next_page_token` in the response
258
+ # indicates that more data is available.
259
+ # @!attribute [rw] page_token
260
+ # @return [::String]
261
+ # The value returned by the last `ListAnalysesResponse`; indicates
262
+ # that this is a continuation of a prior `ListAnalyses` call and
263
+ # the system should return the next page of data.
264
+ # @!attribute [rw] filter
265
+ # @return [::String]
266
+ # A filter to reduce results to a specific subset. Useful for querying
267
+ # conversations with specific properties.
268
+ class ListAnalysesRequest
269
+ include ::Google::Protobuf::MessageExts
270
+ extend ::Google::Protobuf::MessageExts::ClassMethods
271
+ end
272
+
273
+ # The response to list analyses.
274
+ # @!attribute [rw] analyses
275
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Analysis>]
276
+ # The analyses that match the request.
277
+ # @!attribute [rw] next_page_token
278
+ # @return [::String]
279
+ # A token, which can be sent as `page_token` to retrieve the next page.
280
+ # If this field is omitted, there are no subsequent pages.
281
+ class ListAnalysesResponse
282
+ include ::Google::Protobuf::MessageExts
283
+ extend ::Google::Protobuf::MessageExts::ClassMethods
284
+ end
285
+
286
+ # The request to get an analysis.
287
+ # @!attribute [rw] name
288
+ # @return [::String]
289
+ # Required. The name of the analysis to get.
290
+ class GetAnalysisRequest
291
+ include ::Google::Protobuf::MessageExts
292
+ extend ::Google::Protobuf::MessageExts::ClassMethods
293
+ end
294
+
295
+ # The request to delete an analysis.
296
+ # @!attribute [rw] name
297
+ # @return [::String]
298
+ # Required. The name of the analysis to delete.
299
+ class DeleteAnalysisRequest
300
+ include ::Google::Protobuf::MessageExts
301
+ extend ::Google::Protobuf::MessageExts::ClassMethods
302
+ end
303
+
304
+ # The request to export insights.
305
+ # @!attribute [rw] big_query_destination
306
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest::BigQueryDestination]
307
+ # Specified if sink is a BigQuery table.
308
+ # @!attribute [rw] parent
309
+ # @return [::String]
310
+ # Required. The parent resource to export data from.
311
+ # @!attribute [rw] filter
312
+ # @return [::String]
313
+ # A filter to reduce results to a specific subset. Useful for exporting
314
+ # conversations with specific properties.
315
+ # @!attribute [rw] kms_key
316
+ # @return [::String]
317
+ # A fully qualified KMS key name for BigQuery tables protected by CMEK.
318
+ # Format:
319
+ # projects/\\{project}/locations/\\{location}/keyRings/\\{keyring}/cryptoKeys/\\{key}/cryptoKeyVersions/\\{version}
320
+ class ExportInsightsDataRequest
321
+ include ::Google::Protobuf::MessageExts
322
+ extend ::Google::Protobuf::MessageExts::ClassMethods
323
+
324
+ # A BigQuery Table Reference.
325
+ # @!attribute [rw] project_id
326
+ # @return [::String]
327
+ # A project ID or number. If specified, then export will attempt to
328
+ # write data to this project instead of the resource project. Otherwise,
329
+ # the resource project will be used.
330
+ # @!attribute [rw] dataset
331
+ # @return [::String]
332
+ # Required. The name of the BigQuery dataset that the snapshot result should be
333
+ # exported to. If this dataset does not exist, the export call returns an
334
+ # INVALID_ARGUMENT error.
335
+ # @!attribute [rw] table
336
+ # @return [::String]
337
+ # The BigQuery table name to which the insights data should be written.
338
+ # If this table does not exist, the export call returns an INVALID_ARGUMENT
339
+ # error.
340
+ class BigQueryDestination
341
+ include ::Google::Protobuf::MessageExts
342
+ extend ::Google::Protobuf::MessageExts::ClassMethods
343
+ end
344
+ end
345
+
346
+ # Metadata for an export insights operation.
347
+ # @!attribute [r] create_time
348
+ # @return [::Google::Protobuf::Timestamp]
349
+ # Output only. The time the operation was created.
350
+ # @!attribute [r] end_time
351
+ # @return [::Google::Protobuf::Timestamp]
352
+ # Output only. The time the operation finished running.
353
+ # @!attribute [rw] request
354
+ # @return [::Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest]
355
+ # The original request for export.
356
+ # @!attribute [rw] partial_errors
357
+ # @return [::Array<::Google::Rpc::Status>]
358
+ # Partial errors during export operation that might cause the operation
359
+ # output to be incomplete.
360
+ class ExportInsightsDataMetadata
361
+ include ::Google::Protobuf::MessageExts
362
+ extend ::Google::Protobuf::MessageExts::ClassMethods
363
+ end
364
+
365
+ # Response for an export insights operation.
366
+ class ExportInsightsDataResponse
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
+ end
370
+
371
+ # The request to create an issue model.
372
+ # @!attribute [rw] parent
373
+ # @return [::String]
374
+ # Required. The parent resource of the issue model.
375
+ # @!attribute [rw] issue_model
376
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModel]
377
+ # Required. The issue model to create.
378
+ class CreateIssueModelRequest
379
+ include ::Google::Protobuf::MessageExts
380
+ extend ::Google::Protobuf::MessageExts::ClassMethods
381
+ end
382
+
383
+ # Metadata for creating an issue model.
384
+ # @!attribute [r] create_time
385
+ # @return [::Google::Protobuf::Timestamp]
386
+ # Output only. The time the operation was created.
387
+ # @!attribute [r] end_time
388
+ # @return [::Google::Protobuf::Timestamp]
389
+ # Output only. The time the operation finished running.
390
+ # @!attribute [rw] request
391
+ # @return [::Google::Cloud::ContactCenterInsights::V1::CreateIssueModelRequest]
392
+ # The original request for creation.
393
+ class CreateIssueModelMetadata
394
+ include ::Google::Protobuf::MessageExts
395
+ extend ::Google::Protobuf::MessageExts::ClassMethods
396
+ end
397
+
398
+ # The request to update an issue model.
399
+ # @!attribute [rw] issue_model
400
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModel]
401
+ # Required. The new values for the issue model.
402
+ # @!attribute [rw] update_mask
403
+ # @return [::Google::Protobuf::FieldMask]
404
+ # The list of fields to be updated.
405
+ class UpdateIssueModelRequest
406
+ include ::Google::Protobuf::MessageExts
407
+ extend ::Google::Protobuf::MessageExts::ClassMethods
408
+ end
409
+
410
+ # Request to list issue models.
411
+ # @!attribute [rw] parent
412
+ # @return [::String]
413
+ # Required. The parent resource of the issue model.
414
+ class ListIssueModelsRequest
415
+ include ::Google::Protobuf::MessageExts
416
+ extend ::Google::Protobuf::MessageExts::ClassMethods
417
+ end
418
+
419
+ # The response of listing issue models.
420
+ # @!attribute [rw] issue_models
421
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::IssueModel>]
422
+ # The issue models that match the request.
423
+ class ListIssueModelsResponse
424
+ include ::Google::Protobuf::MessageExts
425
+ extend ::Google::Protobuf::MessageExts::ClassMethods
426
+ end
427
+
428
+ # The request to get an issue model.
429
+ # @!attribute [rw] name
430
+ # @return [::String]
431
+ # Required. The name of the issue model to get.
432
+ class GetIssueModelRequest
433
+ include ::Google::Protobuf::MessageExts
434
+ extend ::Google::Protobuf::MessageExts::ClassMethods
435
+ end
436
+
437
+ # The request to delete an issue model.
438
+ # @!attribute [rw] name
439
+ # @return [::String]
440
+ # Required. The name of the issue model to delete.
441
+ class DeleteIssueModelRequest
442
+ include ::Google::Protobuf::MessageExts
443
+ extend ::Google::Protobuf::MessageExts::ClassMethods
444
+ end
445
+
446
+ # Metadata for deleting an issue model.
447
+ # @!attribute [r] create_time
448
+ # @return [::Google::Protobuf::Timestamp]
449
+ # Output only. The time the operation was created.
450
+ # @!attribute [r] end_time
451
+ # @return [::Google::Protobuf::Timestamp]
452
+ # Output only. The time the operation finished running.
453
+ # @!attribute [rw] request
454
+ # @return [::Google::Cloud::ContactCenterInsights::V1::DeleteIssueModelRequest]
455
+ # The original request for deletion.
456
+ class DeleteIssueModelMetadata
457
+ include ::Google::Protobuf::MessageExts
458
+ extend ::Google::Protobuf::MessageExts::ClassMethods
459
+ end
460
+
461
+ # The request to deploy an issue model.
462
+ # @!attribute [rw] name
463
+ # @return [::String]
464
+ # Required. The issue model to deploy.
465
+ class DeployIssueModelRequest
466
+ include ::Google::Protobuf::MessageExts
467
+ extend ::Google::Protobuf::MessageExts::ClassMethods
468
+ end
469
+
470
+ # The response to deploy an issue model.
471
+ class DeployIssueModelResponse
472
+ include ::Google::Protobuf::MessageExts
473
+ extend ::Google::Protobuf::MessageExts::ClassMethods
474
+ end
475
+
476
+ # Metadata for deploying an issue model.
477
+ # @!attribute [r] create_time
478
+ # @return [::Google::Protobuf::Timestamp]
479
+ # Output only. The time the operation was created.
480
+ # @!attribute [r] end_time
481
+ # @return [::Google::Protobuf::Timestamp]
482
+ # Output only. The time the operation finished running.
483
+ # @!attribute [rw] request
484
+ # @return [::Google::Cloud::ContactCenterInsights::V1::DeployIssueModelRequest]
485
+ # The original request for deployment.
486
+ class DeployIssueModelMetadata
487
+ include ::Google::Protobuf::MessageExts
488
+ extend ::Google::Protobuf::MessageExts::ClassMethods
489
+ end
490
+
491
+ # The request to undeploy an issue model.
492
+ # @!attribute [rw] name
493
+ # @return [::String]
494
+ # Required. The issue model to undeploy.
495
+ class UndeployIssueModelRequest
496
+ include ::Google::Protobuf::MessageExts
497
+ extend ::Google::Protobuf::MessageExts::ClassMethods
498
+ end
499
+
500
+ # The response to undeploy an issue model.
501
+ class UndeployIssueModelResponse
502
+ include ::Google::Protobuf::MessageExts
503
+ extend ::Google::Protobuf::MessageExts::ClassMethods
504
+ end
505
+
506
+ # Metadata for undeploying an issue model.
507
+ # @!attribute [r] create_time
508
+ # @return [::Google::Protobuf::Timestamp]
509
+ # Output only. The time the operation was created.
510
+ # @!attribute [r] end_time
511
+ # @return [::Google::Protobuf::Timestamp]
512
+ # Output only. The time the operation finished running.
513
+ # @!attribute [rw] request
514
+ # @return [::Google::Cloud::ContactCenterInsights::V1::UndeployIssueModelRequest]
515
+ # The original request for undeployment.
516
+ class UndeployIssueModelMetadata
517
+ include ::Google::Protobuf::MessageExts
518
+ extend ::Google::Protobuf::MessageExts::ClassMethods
519
+ end
520
+
521
+ # The request to get an issue.
522
+ # @!attribute [rw] name
523
+ # @return [::String]
524
+ # Required. The name of the issue to get.
525
+ class GetIssueRequest
526
+ include ::Google::Protobuf::MessageExts
527
+ extend ::Google::Protobuf::MessageExts::ClassMethods
528
+ end
529
+
530
+ # Request to list issues.
531
+ # @!attribute [rw] parent
532
+ # @return [::String]
533
+ # Required. The parent resource of the issue.
534
+ class ListIssuesRequest
535
+ include ::Google::Protobuf::MessageExts
536
+ extend ::Google::Protobuf::MessageExts::ClassMethods
537
+ end
538
+
539
+ # The response of listing issues.
540
+ # @!attribute [rw] issues
541
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Issue>]
542
+ # The issues that match the request.
543
+ class ListIssuesResponse
544
+ include ::Google::Protobuf::MessageExts
545
+ extend ::Google::Protobuf::MessageExts::ClassMethods
546
+ end
547
+
548
+ # The request to update an issue.
549
+ # @!attribute [rw] issue
550
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Issue]
551
+ # Required. The new values for the issue.
552
+ # @!attribute [rw] update_mask
553
+ # @return [::Google::Protobuf::FieldMask]
554
+ # The list of fields to be updated.
555
+ class UpdateIssueRequest
556
+ include ::Google::Protobuf::MessageExts
557
+ extend ::Google::Protobuf::MessageExts::ClassMethods
558
+ end
559
+
560
+ # Request to get statistics of an issue model.
561
+ # @!attribute [rw] issue_model
562
+ # @return [::String]
563
+ # Required. The resource name of the issue model to query against.
564
+ class CalculateIssueModelStatsRequest
565
+ include ::Google::Protobuf::MessageExts
566
+ extend ::Google::Protobuf::MessageExts::ClassMethods
567
+ end
568
+
569
+ # Response of querying an issue model's statistics.
570
+ # @!attribute [rw] current_stats
571
+ # @return [::Google::Cloud::ContactCenterInsights::V1::IssueModelLabelStats]
572
+ # The latest label statistics for the queried issue model. Includes results
573
+ # on both training data and data labeled after deployment.
574
+ class CalculateIssueModelStatsResponse
575
+ include ::Google::Protobuf::MessageExts
576
+ extend ::Google::Protobuf::MessageExts::ClassMethods
577
+ end
578
+
579
+ # Request to create a phrase matcher.
580
+ # @!attribute [rw] parent
581
+ # @return [::String]
582
+ # Required. The parent resource of the phrase matcher. Required. The location to create
583
+ # a phrase matcher for.
584
+ # Format: `projects/<Project ID>/locations/<Location ID>` or
585
+ # `projects/<Project Number>/locations/<Location ID>`
586
+ # @!attribute [rw] phrase_matcher
587
+ # @return [::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher]
588
+ # Required. The phrase matcher resource to create.
589
+ class CreatePhraseMatcherRequest
590
+ include ::Google::Protobuf::MessageExts
591
+ extend ::Google::Protobuf::MessageExts::ClassMethods
592
+ end
593
+
594
+ # Request to list phrase matchers.
595
+ # @!attribute [rw] parent
596
+ # @return [::String]
597
+ # Required. The parent resource of the phrase matcher.
598
+ # @!attribute [rw] page_size
599
+ # @return [::Integer]
600
+ # The maximum number of phrase matchers to return in the response. If this
601
+ # value is zero, the service will select a default size. A call might return
602
+ # fewer objects than requested. A non-empty `next_page_token` in the response
603
+ # indicates that more data is available.
604
+ # @!attribute [rw] page_token
605
+ # @return [::String]
606
+ # The value returned by the last `ListPhraseMatchersResponse`. This value
607
+ # indicates that this is a continuation of a prior `ListPhraseMatchers` call
608
+ # and that the system should return the next page of data.
609
+ # @!attribute [rw] filter
610
+ # @return [::String]
611
+ # A filter to reduce results to a specific subset. Useful for querying
612
+ # phrase matchers with specific properties.
613
+ class ListPhraseMatchersRequest
614
+ include ::Google::Protobuf::MessageExts
615
+ extend ::Google::Protobuf::MessageExts::ClassMethods
616
+ end
617
+
618
+ # The response of listing phrase matchers.
619
+ # @!attribute [rw] phrase_matchers
620
+ # @return [::Array<::Google::Cloud::ContactCenterInsights::V1::PhraseMatcher>]
621
+ # The phrase matchers that match the request.
622
+ # @!attribute [rw] next_page_token
623
+ # @return [::String]
624
+ # A token, which can be sent as `page_token` to retrieve the next page.
625
+ # If this field is omitted, there are no subsequent pages.
626
+ class ListPhraseMatchersResponse
627
+ include ::Google::Protobuf::MessageExts
628
+ extend ::Google::Protobuf::MessageExts::ClassMethods
629
+ end
630
+
631
+ # The request to get a a phrase matcher.
632
+ # @!attribute [rw] name
633
+ # @return [::String]
634
+ # Required. The name of the phrase matcher to get.
635
+ class GetPhraseMatcherRequest
636
+ include ::Google::Protobuf::MessageExts
637
+ extend ::Google::Protobuf::MessageExts::ClassMethods
638
+ end
639
+
640
+ # The request to delete a phrase matcher.
641
+ # @!attribute [rw] name
642
+ # @return [::String]
643
+ # Required. The name of the phrase matcher to delete.
644
+ class DeletePhraseMatcherRequest
645
+ include ::Google::Protobuf::MessageExts
646
+ extend ::Google::Protobuf::MessageExts::ClassMethods
647
+ end
648
+
649
+ # The request to get project-level settings.
650
+ # @!attribute [rw] name
651
+ # @return [::String]
652
+ # Required. The name of the settings resource to get.
653
+ class GetSettingsRequest
654
+ include ::Google::Protobuf::MessageExts
655
+ extend ::Google::Protobuf::MessageExts::ClassMethods
656
+ end
657
+
658
+ # The request to update project-level settings.
659
+ # @!attribute [rw] settings
660
+ # @return [::Google::Cloud::ContactCenterInsights::V1::Settings]
661
+ # Required. The new values for the conversation.
662
+ # @!attribute [rw] update_mask
663
+ # @return [::Google::Protobuf::FieldMask]
664
+ # Required. The list of fields to be updated.
665
+ class UpdateSettingsRequest
666
+ include ::Google::Protobuf::MessageExts
667
+ extend ::Google::Protobuf::MessageExts::ClassMethods
668
+ end
669
+
670
+ # Represents the options for views of a conversation.
671
+ module ConversationView
672
+ # Not specified. Defaults to FULL on GetConversationRequest and BASIC for
673
+ # ListConversationsRequest.
674
+ CONVERSATION_VIEW_UNSPECIFIED = 0
675
+
676
+ # Transcript field is not populated in the response.
677
+ BASIC = 1
678
+
679
+ # All fields are populated.
680
+ FULL = 2
681
+ end
682
+ end
683
+ end
684
+ end
685
+ end