google-cloud-contact_center_insights-v1 0.19.0 → 0.20.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.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/client.rb +39 -16
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/operations.rb +28 -6
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/rest/client.rb +41 -15
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/rest/operations.rb +33 -8
- data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/rest/service_stub.rb +14 -2
- data/lib/google/cloud/contact_center_insights/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb +10 -10
- data/proto_docs/google/cloud/contactcenterinsights/v1/resources.rb +2 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dffcd2af53f8249b198e6a89e76b0036e390cce86ff45a43e29cfb2369e32094
|
4
|
+
data.tar.gz: e395529c10af41e6a108824e1b60849f61e77a1398349f431d117bd776c8046a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 971cb7db50137dd1f68433825de15984c926a129b43297a93a34cf9d7541693570cc6233e5c7564bd0ba5d2216f2305f9c24b71e1c197f6c9cbed234576a0e1d
|
7
|
+
data.tar.gz: ef25d0f2b62c419681052c4734a066c23692ece89d7204fe880d829d32d40fc64c3ae0ba4e1926b908f5afb24296777ba371d3c9b1cffa618498e7c8d9aef9e2
|
data/AUTHENTICATION.md
CHANGED
@@ -1,149 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
7
|
-
credentials will be discovered automatically. When running on other
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
9
|
-
path to the
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
11
|
-
for the account (or the JSON itself) in
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
14
|
-
during development.
|
3
|
+
The recommended way to authenticate to the google-cloud-contact_center_insights-v1 library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
15
6
|
|
16
7
|
## Quickstart
|
17
8
|
|
18
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
26
14
|
|
27
|
-
|
28
|
-
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
29
17
|
|
30
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-cloud-contact_center_insights-v1 library aims to make authentication
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
38
|
-
|
39
|
-
**Credentials** are discovered in the following order:
|
40
|
-
|
41
|
-
1. Specify credentials in method arguments
|
42
|
-
2. Specify credentials in configuration
|
43
|
-
3. Discover credentials path in environment variables
|
44
|
-
4. Discover credentials JSON in environment variables
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
46
|
-
6. Discover GCP credentials
|
47
|
-
|
48
|
-
### Google Cloud Platform environments
|
22
|
+
3. Write code as if already authenticated.
|
49
23
|
|
50
|
-
|
51
|
-
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
54
26
|
|
55
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
63
|
-
containers where writing files is difficult or not encouraged.
|
29
|
+
The google-cloud-contact_center_insights-v1 library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
64
33
|
|
65
|
-
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
{::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Credentials}):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
72
41
|
|
73
|
-
|
74
|
-
require "google/cloud/contact_center_insights/v1"
|
75
|
-
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
77
43
|
|
78
|
-
client
|
79
|
-
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
80
49
|
|
81
|
-
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
82
53
|
|
83
|
-
|
84
|
-
it in an environment variable. Either on an individual client initialization:
|
54
|
+
To configure a credentials file for an individual client initialization:
|
85
55
|
|
86
56
|
```ruby
|
87
57
|
require "google/cloud/contact_center_insights/v1"
|
88
58
|
|
89
59
|
client = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Client.new do |config|
|
90
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
91
61
|
end
|
92
62
|
```
|
93
63
|
|
94
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
95
65
|
|
96
66
|
```ruby
|
97
67
|
require "google/cloud/contact_center_insights/v1"
|
98
68
|
|
99
69
|
::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Client.configure do |config|
|
100
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
101
71
|
end
|
102
72
|
|
103
73
|
client = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Client.new
|
104
74
|
```
|
105
75
|
|
106
|
-
###
|
76
|
+
### Environment Variables
|
107
77
|
|
108
|
-
|
109
|
-
|
110
|
-
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
111
82
|
|
112
|
-
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
113
87
|
|
114
|
-
|
115
|
-
|
116
|
-
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-cloud-contact_center_insights-v1
|
93
|
+
checks for credentials are:
|
117
94
|
|
118
|
-
|
119
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
120
97
|
|
121
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/contact_center_insights/v1"
|
122
100
|
|
123
|
-
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
125
|
-
connect to most services with google-cloud-contact_center_insights-v1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
126
102
|
|
127
|
-
|
128
|
-
|
129
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Client.new
|
104
|
+
```
|
130
105
|
|
131
|
-
|
132
|
-
2. Create a new project or click on an existing project.
|
133
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
134
|
-
here, you will enable the APIs that your application requires.
|
106
|
+
### Local ADC file
|
135
107
|
|
136
|
-
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
137
111
|
|
138
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
139
113
|
|
140
|
-
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
142
115
|
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
147
120
|
|
148
|
-
|
149
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
@@ -30,6 +30,9 @@ module Google
|
|
30
30
|
# An API that lets users analyze and explore their business conversation data.
|
31
31
|
#
|
32
32
|
class Client
|
33
|
+
# @private
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "contactcenterinsights.$UNIVERSE_DOMAIN$"
|
35
|
+
|
33
36
|
include Paths
|
34
37
|
|
35
38
|
# @private
|
@@ -95,6 +98,15 @@ module Google
|
|
95
98
|
@config
|
96
99
|
end
|
97
100
|
|
101
|
+
##
|
102
|
+
# The effective universe domain
|
103
|
+
#
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
def universe_domain
|
107
|
+
@contact_center_insights_stub.universe_domain
|
108
|
+
end
|
109
|
+
|
98
110
|
##
|
99
111
|
# Create a new ContactCenterInsights client object.
|
100
112
|
#
|
@@ -128,8 +140,9 @@ module Google
|
|
128
140
|
credentials = @config.credentials
|
129
141
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
130
142
|
# but only if the default endpoint does not have a region prefix.
|
131
|
-
enable_self_signed_jwt = @config.endpoint
|
132
|
-
|
143
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
144
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
145
|
+
!@config.endpoint.split(".").first.include?("-"))
|
133
146
|
credentials ||= Credentials.default scope: @config.scope,
|
134
147
|
enable_self_signed_jwt: enable_self_signed_jwt
|
135
148
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -142,12 +155,15 @@ module Google
|
|
142
155
|
config.credentials = credentials
|
143
156
|
config.quota_project = @quota_project_id
|
144
157
|
config.endpoint = @config.endpoint
|
158
|
+
config.universe_domain = @config.universe_domain
|
145
159
|
end
|
146
160
|
|
147
161
|
@contact_center_insights_stub = ::Gapic::ServiceStub.new(
|
148
162
|
::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Stub,
|
149
|
-
credentials:
|
150
|
-
endpoint:
|
163
|
+
credentials: credentials,
|
164
|
+
endpoint: @config.endpoint,
|
165
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
166
|
+
universe_domain: @config.universe_domain,
|
151
167
|
channel_args: @config.channel_args,
|
152
168
|
interceptors: @config.interceptors,
|
153
169
|
channel_pool_config: @config.channel_pool
|
@@ -289,11 +305,11 @@ module Google
|
|
289
305
|
# This value should be 4-64 characters and must match the regular
|
290
306
|
# expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
|
291
307
|
# @param redaction_config [::Google::Cloud::ContactCenterInsights::V1::RedactionConfig, ::Hash]
|
292
|
-
# Optional. DLP settings for transcript redaction.
|
293
|
-
#
|
308
|
+
# Optional. DLP settings for transcript redaction. Will default to the config
|
309
|
+
# specified in Settings.
|
294
310
|
# @param speech_config [::Google::Cloud::ContactCenterInsights::V1::SpeechConfig, ::Hash]
|
295
|
-
# Optional.
|
296
|
-
#
|
311
|
+
# Optional. Speech-to-Text configuration. Will default to the config
|
312
|
+
# specified in Settings.
|
297
313
|
#
|
298
314
|
# @yield [response, operation] Access the result along with the RPC operation
|
299
315
|
# @yieldparam response [::Gapic::Operation]
|
@@ -1222,14 +1238,13 @@ module Google
|
|
1222
1238
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1223
1239
|
#
|
1224
1240
|
# @param parent [::String]
|
1225
|
-
# Required. The parent resource to
|
1241
|
+
# Required. The parent resource to delete conversations from.
|
1226
1242
|
# Format:
|
1227
1243
|
# projects/\\{project}/locations/\\{location}
|
1228
1244
|
# @param filter [::String]
|
1229
|
-
# Filter used to select the subset of conversations to
|
1245
|
+
# Filter used to select the subset of conversations to delete.
|
1230
1246
|
# @param max_delete_count [::Integer]
|
1231
|
-
# Maximum number of conversations to delete.
|
1232
|
-
# changed by setting the `max_delete_count` field.
|
1247
|
+
# Maximum number of conversations to delete.
|
1233
1248
|
# @param force [::Boolean]
|
1234
1249
|
# If set to true, all of this conversation's analyses will also be deleted.
|
1235
1250
|
# Otherwise, the request will only succeed if the conversation has no
|
@@ -3763,9 +3778,9 @@ module Google
|
|
3763
3778
|
# end
|
3764
3779
|
#
|
3765
3780
|
# @!attribute [rw] endpoint
|
3766
|
-
#
|
3767
|
-
#
|
3768
|
-
# @return [::String]
|
3781
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
3782
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
3783
|
+
# @return [::String,nil]
|
3769
3784
|
# @!attribute [rw] credentials
|
3770
3785
|
# Credentials to send with calls. You may provide any of the following types:
|
3771
3786
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -3811,13 +3826,20 @@ module Google
|
|
3811
3826
|
# @!attribute [rw] quota_project
|
3812
3827
|
# A separate project against which to charge quota.
|
3813
3828
|
# @return [::String]
|
3829
|
+
# @!attribute [rw] universe_domain
|
3830
|
+
# The universe domain within which to make requests. This determines the
|
3831
|
+
# default endpoint URL. The default value of nil uses the environment
|
3832
|
+
# universe (usually the default "googleapis.com" universe).
|
3833
|
+
# @return [::String,nil]
|
3814
3834
|
#
|
3815
3835
|
class Configuration
|
3816
3836
|
extend ::Gapic::Config
|
3817
3837
|
|
3838
|
+
# @private
|
3839
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
3818
3840
|
DEFAULT_ENDPOINT = "contactcenterinsights.googleapis.com"
|
3819
3841
|
|
3820
|
-
config_attr :endpoint,
|
3842
|
+
config_attr :endpoint, nil, ::String, nil
|
3821
3843
|
config_attr :credentials, nil do |value|
|
3822
3844
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
3823
3845
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -3832,6 +3854,7 @@ module Google
|
|
3832
3854
|
config_attr :metadata, nil, ::Hash, nil
|
3833
3855
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
3834
3856
|
config_attr :quota_project, nil, ::String, nil
|
3857
|
+
config_attr :universe_domain, nil, ::String, nil
|
3835
3858
|
|
3836
3859
|
# @private
|
3837
3860
|
def initialize parent_config = nil
|
@@ -26,6 +26,9 @@ module Google
|
|
26
26
|
module ContactCenterInsights
|
27
27
|
# Service that implements Longrunning Operations API.
|
28
28
|
class Operations
|
29
|
+
# @private
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "contactcenterinsights.$UNIVERSE_DOMAIN$"
|
31
|
+
|
29
32
|
# @private
|
30
33
|
attr_reader :operations_stub
|
31
34
|
|
@@ -60,6 +63,15 @@ module Google
|
|
60
63
|
@config
|
61
64
|
end
|
62
65
|
|
66
|
+
##
|
67
|
+
# The effective universe domain
|
68
|
+
#
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
def universe_domain
|
72
|
+
@operations_stub.universe_domain
|
73
|
+
end
|
74
|
+
|
63
75
|
##
|
64
76
|
# Create a new Operations client object.
|
65
77
|
#
|
@@ -90,8 +102,10 @@ module Google
|
|
90
102
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
93
|
-
credentials:
|
94
|
-
endpoint:
|
105
|
+
credentials: credentials,
|
106
|
+
endpoint: @config.endpoint,
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
108
|
+
universe_domain: @config.universe_domain,
|
95
109
|
channel_args: @config.channel_args,
|
96
110
|
interceptors: @config.interceptors,
|
97
111
|
channel_pool_config: @config.channel_pool
|
@@ -613,9 +627,9 @@ module Google
|
|
613
627
|
# end
|
614
628
|
#
|
615
629
|
# @!attribute [rw] endpoint
|
616
|
-
#
|
617
|
-
#
|
618
|
-
# @return [::String]
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
632
|
+
# @return [::String,nil]
|
619
633
|
# @!attribute [rw] credentials
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -661,13 +675,20 @@ module Google
|
|
661
675
|
# @!attribute [rw] quota_project
|
662
676
|
# A separate project against which to charge quota.
|
663
677
|
# @return [::String]
|
678
|
+
# @!attribute [rw] universe_domain
|
679
|
+
# The universe domain within which to make requests. This determines the
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
682
|
+
# @return [::String,nil]
|
664
683
|
#
|
665
684
|
class Configuration
|
666
685
|
extend ::Gapic::Config
|
667
686
|
|
687
|
+
# @private
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
668
689
|
DEFAULT_ENDPOINT = "contactcenterinsights.googleapis.com"
|
669
690
|
|
670
|
-
config_attr :endpoint,
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
671
692
|
config_attr :credentials, nil do |value|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -682,6 +703,7 @@ module Google
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
685
707
|
|
686
708
|
# @private
|
687
709
|
def initialize parent_config = nil
|
@@ -32,6 +32,9 @@ module Google
|
|
32
32
|
# An API that lets users analyze and explore their business conversation data.
|
33
33
|
#
|
34
34
|
class Client
|
35
|
+
# @private
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "contactcenterinsights.$UNIVERSE_DOMAIN$"
|
37
|
+
|
35
38
|
include Paths
|
36
39
|
|
37
40
|
# @private
|
@@ -97,6 +100,15 @@ module Google
|
|
97
100
|
@config
|
98
101
|
end
|
99
102
|
|
103
|
+
##
|
104
|
+
# The effective universe domain
|
105
|
+
#
|
106
|
+
# @return [String]
|
107
|
+
#
|
108
|
+
def universe_domain
|
109
|
+
@contact_center_insights_stub.universe_domain
|
110
|
+
end
|
111
|
+
|
100
112
|
##
|
101
113
|
# Create a new ContactCenterInsights REST client object.
|
102
114
|
#
|
@@ -124,8 +136,9 @@ module Google
|
|
124
136
|
credentials = @config.credentials
|
125
137
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
126
138
|
# but only if the default endpoint does not have a region prefix.
|
127
|
-
enable_self_signed_jwt = @config.endpoint
|
128
|
-
|
139
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
140
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
141
|
+
!@config.endpoint.split(".").first.include?("-"))
|
129
142
|
credentials ||= Credentials.default scope: @config.scope,
|
130
143
|
enable_self_signed_jwt: enable_self_signed_jwt
|
131
144
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -139,9 +152,15 @@ module Google
|
|
139
152
|
config.credentials = credentials
|
140
153
|
config.quota_project = @quota_project_id
|
141
154
|
config.endpoint = @config.endpoint
|
155
|
+
config.universe_domain = @config.universe_domain
|
142
156
|
end
|
143
157
|
|
144
|
-
@contact_center_insights_stub = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::ServiceStub.new
|
158
|
+
@contact_center_insights_stub = ::Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Rest::ServiceStub.new(
|
159
|
+
endpoint: @config.endpoint,
|
160
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
161
|
+
universe_domain: @config.universe_domain,
|
162
|
+
credentials: credentials
|
163
|
+
)
|
145
164
|
end
|
146
165
|
|
147
166
|
##
|
@@ -272,11 +291,11 @@ module Google
|
|
272
291
|
# This value should be 4-64 characters and must match the regular
|
273
292
|
# expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
|
274
293
|
# @param redaction_config [::Google::Cloud::ContactCenterInsights::V1::RedactionConfig, ::Hash]
|
275
|
-
# Optional. DLP settings for transcript redaction.
|
276
|
-
#
|
294
|
+
# Optional. DLP settings for transcript redaction. Will default to the config
|
295
|
+
# specified in Settings.
|
277
296
|
# @param speech_config [::Google::Cloud::ContactCenterInsights::V1::SpeechConfig, ::Hash]
|
278
|
-
# Optional.
|
279
|
-
#
|
297
|
+
# Optional. Speech-to-Text configuration. Will default to the config
|
298
|
+
# specified in Settings.
|
280
299
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
281
300
|
# @yieldparam result [::Gapic::Operation]
|
282
301
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -1135,14 +1154,13 @@ module Google
|
|
1135
1154
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1136
1155
|
#
|
1137
1156
|
# @param parent [::String]
|
1138
|
-
# Required. The parent resource to
|
1157
|
+
# Required. The parent resource to delete conversations from.
|
1139
1158
|
# Format:
|
1140
1159
|
# projects/\\{project}/locations/\\{location}
|
1141
1160
|
# @param filter [::String]
|
1142
|
-
# Filter used to select the subset of conversations to
|
1161
|
+
# Filter used to select the subset of conversations to delete.
|
1143
1162
|
# @param max_delete_count [::Integer]
|
1144
|
-
# Maximum number of conversations to delete.
|
1145
|
-
# changed by setting the `max_delete_count` field.
|
1163
|
+
# Maximum number of conversations to delete.
|
1146
1164
|
# @param force [::Boolean]
|
1147
1165
|
# If set to true, all of this conversation's analyses will also be deleted.
|
1148
1166
|
# Otherwise, the request will only succeed if the conversation has no
|
@@ -3480,9 +3498,9 @@ module Google
|
|
3480
3498
|
# end
|
3481
3499
|
#
|
3482
3500
|
# @!attribute [rw] endpoint
|
3483
|
-
#
|
3484
|
-
#
|
3485
|
-
# @return [::String]
|
3501
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
3502
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
3503
|
+
# @return [::String,nil]
|
3486
3504
|
# @!attribute [rw] credentials
|
3487
3505
|
# Credentials to send with calls. You may provide any of the following types:
|
3488
3506
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -3519,13 +3537,20 @@ module Google
|
|
3519
3537
|
# @!attribute [rw] quota_project
|
3520
3538
|
# A separate project against which to charge quota.
|
3521
3539
|
# @return [::String]
|
3540
|
+
# @!attribute [rw] universe_domain
|
3541
|
+
# The universe domain within which to make requests. This determines the
|
3542
|
+
# default endpoint URL. The default value of nil uses the environment
|
3543
|
+
# universe (usually the default "googleapis.com" universe).
|
3544
|
+
# @return [::String,nil]
|
3522
3545
|
#
|
3523
3546
|
class Configuration
|
3524
3547
|
extend ::Gapic::Config
|
3525
3548
|
|
3549
|
+
# @private
|
3550
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
3526
3551
|
DEFAULT_ENDPOINT = "contactcenterinsights.googleapis.com"
|
3527
3552
|
|
3528
|
-
config_attr :endpoint,
|
3553
|
+
config_attr :endpoint, nil, ::String, nil
|
3529
3554
|
config_attr :credentials, nil do |value|
|
3530
3555
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
3531
3556
|
allowed.any? { |klass| klass === value }
|
@@ -3537,6 +3562,7 @@ module Google
|
|
3537
3562
|
config_attr :metadata, nil, ::Hash, nil
|
3538
3563
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
3539
3564
|
config_attr :quota_project, nil, ::String, nil
|
3565
|
+
config_attr :universe_domain, nil, ::String, nil
|
3540
3566
|
|
3541
3567
|
# @private
|
3542
3568
|
def initialize parent_config = nil
|
@@ -26,6 +26,9 @@ module Google
|
|
26
26
|
module Rest
|
27
27
|
# Service that implements Longrunning Operations API.
|
28
28
|
class Operations
|
29
|
+
# @private
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "contactcenterinsights.$UNIVERSE_DOMAIN$"
|
31
|
+
|
29
32
|
# @private
|
30
33
|
attr_reader :operations_stub
|
31
34
|
|
@@ -60,6 +63,15 @@ module Google
|
|
60
63
|
@config
|
61
64
|
end
|
62
65
|
|
66
|
+
##
|
67
|
+
# The effective universe domain
|
68
|
+
#
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
def universe_domain
|
72
|
+
@operations_stub.universe_domain
|
73
|
+
end
|
74
|
+
|
63
75
|
##
|
64
76
|
# Create a new Operations client object.
|
65
77
|
#
|
@@ -84,8 +96,10 @@ module Google
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
85
97
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
87
|
-
endpoint:
|
88
|
-
|
99
|
+
endpoint: @config.endpoint,
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
101
|
+
universe_domain: @config.universe_domain,
|
102
|
+
credentials: credentials
|
89
103
|
)
|
90
104
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
@@ -478,9 +492,9 @@ module Google
|
|
478
492
|
# end
|
479
493
|
#
|
480
494
|
# @!attribute [rw] endpoint
|
481
|
-
#
|
482
|
-
#
|
483
|
-
# @return [::String]
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
497
|
+
# @return [::String,nil]
|
484
498
|
# @!attribute [rw] credentials
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -517,13 +531,20 @@ module Google
|
|
517
531
|
# @!attribute [rw] quota_project
|
518
532
|
# A separate project against which to charge quota.
|
519
533
|
# @return [::String]
|
534
|
+
# @!attribute [rw] universe_domain
|
535
|
+
# The universe domain within which to make requests. This determines the
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
538
|
+
# @return [::String,nil]
|
520
539
|
#
|
521
540
|
class Configuration
|
522
541
|
extend ::Gapic::Config
|
523
542
|
|
543
|
+
# @private
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
524
545
|
DEFAULT_ENDPOINT = "contactcenterinsights.googleapis.com"
|
525
546
|
|
526
|
-
config_attr :endpoint,
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
527
548
|
config_attr :credentials, nil do |value|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
529
550
|
allowed.any? { |klass| klass === value }
|
@@ -535,6 +556,7 @@ module Google
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
538
560
|
|
539
561
|
# @private
|
540
562
|
def initialize parent_config = nil
|
@@ -617,12 +639,15 @@ module Google
|
|
617
639
|
# Service stub contains baseline method implementations
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
619
641
|
class OperationsServiceStub
|
620
|
-
def initialize endpoint:, credentials:
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
621
643
|
# These require statements are intentionally placed here to initialize
|
622
644
|
# the REST modules only when it's required.
|
623
645
|
require "gapic/rest"
|
624
646
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
648
|
+
endpoint_template: endpoint_template,
|
649
|
+
universe_domain: universe_domain,
|
650
|
+
credentials: credentials
|
626
651
|
end
|
627
652
|
|
628
653
|
##
|
data/lib/google/cloud/contact_center_insights/v1/contact_center_insights/rest/service_stub.rb
CHANGED
@@ -30,16 +30,28 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
def initialize endpoint:, credentials:
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
34
34
|
# These require statements are intentionally placed here to initialize
|
35
35
|
# the REST modules only when it's required.
|
36
36
|
require "gapic/rest"
|
37
37
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
endpoint_template: endpoint_template,
|
40
|
+
universe_domain: universe_domain,
|
41
|
+
credentials: credentials,
|
39
42
|
numeric_enums: true,
|
40
43
|
raise_faraday_errors: false
|
41
44
|
end
|
42
45
|
|
46
|
+
##
|
47
|
+
# The effective universe domain
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
def universe_domain
|
52
|
+
@client_stub.universe_domain
|
53
|
+
end
|
54
|
+
|
43
55
|
##
|
44
56
|
# Baseline implementation for the create_conversation REST call
|
45
57
|
#
|
@@ -21,6 +21,7 @@ module Google
|
|
21
21
|
module Api
|
22
22
|
# Required information for every language.
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
24
25
|
# @return [::String]
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
@@ -304,6 +305,19 @@ module Google
|
|
304
305
|
# seconds: 360 # 6 minutes
|
305
306
|
# total_poll_timeout:
|
306
307
|
# seconds: 54000 # 90 minutes
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
309
|
+
# @return [::Array<::String>]
|
310
|
+
# List of top-level fields of the request message, that should be
|
311
|
+
# automatically populated by the client libraries based on their
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
313
|
+
#
|
314
|
+
# Example of a YAML configuration:
|
315
|
+
#
|
316
|
+
# publishing:
|
317
|
+
# method_settings:
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
319
|
+
# auto_populated_fields:
|
320
|
+
# - request_id
|
307
321
|
class MethodSettings
|
308
322
|
include ::Google::Protobuf::MessageExts
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -54,6 +54,7 @@ module Google
|
|
54
54
|
# A map associating each custom highlighter resource name with its respective
|
55
55
|
# number of matches in the set of conversations.
|
56
56
|
# @!attribute [rw] issue_matches
|
57
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
57
58
|
# @return [::Google::Protobuf::Map{::String => ::Integer}]
|
58
59
|
# A map associating each issue resource name with its respective number of
|
59
60
|
# matches in the set of conversations. Key has the format:
|
@@ -190,12 +191,12 @@ module Google
|
|
190
191
|
# expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
|
191
192
|
# @!attribute [rw] redaction_config
|
192
193
|
# @return [::Google::Cloud::ContactCenterInsights::V1::RedactionConfig]
|
193
|
-
# Optional. DLP settings for transcript redaction.
|
194
|
-
#
|
194
|
+
# Optional. DLP settings for transcript redaction. Will default to the config
|
195
|
+
# specified in Settings.
|
195
196
|
# @!attribute [rw] speech_config
|
196
197
|
# @return [::Google::Cloud::ContactCenterInsights::V1::SpeechConfig]
|
197
|
-
# Optional.
|
198
|
-
#
|
198
|
+
# Optional. Speech-to-Text configuration. Will default to the config
|
199
|
+
# specified in Settings.
|
199
200
|
class UploadConversationRequest
|
200
201
|
include ::Google::Protobuf::MessageExts
|
201
202
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -340,7 +341,7 @@ module Google
|
|
340
341
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
341
342
|
|
342
343
|
module BucketObjectType
|
343
|
-
# The object type is unspecified and will default to TRANSCRIPT
|
344
|
+
# The object type is unspecified and will default to `TRANSCRIPT`.
|
344
345
|
BUCKET_OBJECT_TYPE_UNSPECIFIED = 0
|
345
346
|
|
346
347
|
# The object is a transcript.
|
@@ -561,16 +562,15 @@ module Google
|
|
561
562
|
# The request to delete conversations in bulk.
|
562
563
|
# @!attribute [rw] parent
|
563
564
|
# @return [::String]
|
564
|
-
# Required. The parent resource to
|
565
|
+
# Required. The parent resource to delete conversations from.
|
565
566
|
# Format:
|
566
567
|
# projects/\\{project}/locations/\\{location}
|
567
568
|
# @!attribute [rw] filter
|
568
569
|
# @return [::String]
|
569
|
-
# Filter used to select the subset of conversations to
|
570
|
+
# Filter used to select the subset of conversations to delete.
|
570
571
|
# @!attribute [rw] max_delete_count
|
571
572
|
# @return [::Integer]
|
572
|
-
# Maximum number of conversations to delete.
|
573
|
-
# changed by setting the `max_delete_count` field.
|
573
|
+
# Maximum number of conversations to delete.
|
574
574
|
# @!attribute [rw] force
|
575
575
|
# @return [::Boolean]
|
576
576
|
# If set to true, all of this conversation's analyses will also be deleted.
|
@@ -600,7 +600,7 @@ module Google
|
|
600
600
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
601
601
|
end
|
602
602
|
|
603
|
-
# The response for a bulk
|
603
|
+
# The response for a bulk delete conversations operation.
|
604
604
|
class BulkDeleteConversationsResponse
|
605
605
|
include ::Google::Protobuf::MessageExts
|
606
606
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -722,6 +722,7 @@ module Google
|
|
722
722
|
|
723
723
|
# Configs for the input data used to create the issue model.
|
724
724
|
# @!attribute [rw] medium
|
725
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
725
726
|
# @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium]
|
726
727
|
# Medium of conversations used in training data. This field is being
|
727
728
|
# deprecated. To specify the medium to be used in training a new issue
|
@@ -1360,6 +1361,7 @@ module Google
|
|
1360
1361
|
# @return [::String]
|
1361
1362
|
# A user-specified ID representing the participant.
|
1362
1363
|
# @!attribute [rw] dialogflow_participant
|
1364
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
1363
1365
|
# @return [::String]
|
1364
1366
|
# Deprecated. Use `dialogflow_participant_name` instead.
|
1365
1367
|
# The name of the Dialogflow participant. Format:
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-contact_center_insights-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.20.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.21.1
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.21.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
220
220
|
- !ruby/object:Gem::Version
|
221
221
|
version: '0'
|
222
222
|
requirements: []
|
223
|
-
rubygems_version: 3.
|
223
|
+
rubygems_version: 3.5.3
|
224
224
|
signing_key:
|
225
225
|
specification_version: 4
|
226
226
|
summary: API Client library for the Contact Center AI Insights V1 API
|