google-cloud-dialogflow-v2 0.12.0 → 0.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/lib/google/cloud/dialogflow/v2/agents/client.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/document_pb.rb +13 -0
- data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +10 -0
- data/lib/google/cloud/dialogflow/v2/documents/client.rb +149 -2
- data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/gcs_pb.rb +4 -0
- data/lib/google/cloud/dialogflow/v2/intents/client.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/knowledge_base_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +28 -1
- data/lib/google/cloud/dialogflow/v2/participant_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/participants/client.rb +2 -3
- data/lib/google/cloud/dialogflow/v2/session_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +4 -1
- data/proto_docs/google/cloud/dialogflow/v2/document.rb +53 -0
- data/proto_docs/google/cloud/dialogflow/v2/gcs.rb +39 -0
- data/proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb +28 -0
- data/proto_docs/google/cloud/dialogflow/v2/participant.rb +35 -59
- metadata +4 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 62888f52211fe153212450eeea4fb0887edae78c58f11e7faae2ddda20948def
|
4
|
+
data.tar.gz: 681defd6a49675b731528529fb2e4340236a4b4e313bbd34a68923f5cc51d198
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 236925d5030cf45bbb34938cd7565e5d5db0d9b6758393a58a1ea16c96a86a7d7feaa3bab6f2320ef7a38ece5acc0708f9ac01474c4b127a295252739605c9ec
|
7
|
+
data.tar.gz: e07664eaf7f723c31473c70e094584438699761be72ebc4679ddb6d5ce0016c075f0b0d00dbfafdc33a1a8eeb630d89300d45a2cbb57ca9ffe83e93209102285
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
@@ -120,15 +120,6 @@ To configure your system for this, simply:
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
121
121
|
*should* only be used during development.
|
122
122
|
|
123
|
-
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
|
124
|
-
[dev-console]: https://console.cloud.google.com/project
|
125
|
-
|
126
|
-
[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
|
127
|
-
|
128
|
-
[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
|
129
|
-
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
|
130
|
-
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
|
131
|
-
|
132
123
|
## Creating a Service Account
|
133
124
|
|
134
125
|
Google Cloud requires **Service Account Credentials** to
|
@@ -139,31 +130,22 @@ If you are not running this client within
|
|
139
130
|
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
140
131
|
need a Google Developers service account.
|
141
132
|
|
142
|
-
1. Visit the [Google
|
133
|
+
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
143
134
|
2. Create a new project or click on an existing project.
|
144
|
-
3. Activate the
|
135
|
+
3. Activate the menu in the upper left and select **APIs & Services**. From
|
145
136
|
here, you will enable the APIs that your application requires.
|
146
137
|
|
147
|
-
![Enable the APIs that your application requires][enable-apis]
|
148
|
-
|
149
138
|
*Note: You may need to enable billing in order to use these services.*
|
150
139
|
|
151
140
|
4. Select **Credentials** from the side navigation.
|
152
141
|
|
153
|
-
|
154
|
-
|
155
|
-
![Create a new service account][create-new-service-account]
|
156
|
-
|
157
|
-
![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
|
158
|
-
|
159
|
-
Find the "Add credentials" drop down and select "Service account" to be
|
160
|
-
guided through downloading a new JSON key file.
|
142
|
+
Find the "Create credentials" drop down near the top of the page, and select
|
143
|
+
"Service account" to be guided through downloading a new JSON key file.
|
161
144
|
|
162
145
|
If you want to re-use an existing service account, you can easily generate a
|
163
|
-
new key file. Just select the account you wish to re-use,
|
164
|
-
|
165
|
-
|
166
|
-
![Re-use an existing service account][reuse-service-account]
|
146
|
+
new key file. Just select the account you wish to re-use, click the pencil
|
147
|
+
tool on the right side to edit the service account, select the **Keys** tab,
|
148
|
+
and then select **Add Key**.
|
167
149
|
|
168
150
|
The key file you download will be used by this library to authenticate API
|
169
151
|
requests and should be stored in a secure location.
|
@@ -8,6 +8,7 @@ require 'google/api/resource_pb'
|
|
8
8
|
require 'google/cloud/dialogflow/v2/audio_config_pb'
|
9
9
|
require 'google/cloud/dialogflow/v2/participant_pb'
|
10
10
|
require 'google/longrunning/operations_pb'
|
11
|
+
require 'google/protobuf/duration_pb'
|
11
12
|
require 'google/protobuf/empty_pb'
|
12
13
|
require 'google/protobuf/field_mask_pb'
|
13
14
|
require 'google/protobuf/timestamp_pb'
|
@@ -5,6 +5,7 @@ require 'google/api/annotations_pb'
|
|
5
5
|
require 'google/api/client_pb'
|
6
6
|
require 'google/api/field_behavior_pb'
|
7
7
|
require 'google/api/resource_pb'
|
8
|
+
require 'google/cloud/dialogflow/v2/gcs_pb'
|
8
9
|
require 'google/longrunning/operations_pb'
|
9
10
|
require 'google/protobuf/field_mask_pb'
|
10
11
|
require 'google/protobuf/timestamp_pb'
|
@@ -43,6 +44,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
43
44
|
optional :parent, :string, 1
|
44
45
|
optional :page_size, :int32, 2
|
45
46
|
optional :page_token, :string, 3
|
47
|
+
optional :filter, :string, 4
|
46
48
|
end
|
47
49
|
add_message "google.cloud.dialogflow.v2.ListDocumentsResponse" do
|
48
50
|
repeated :documents, :message, 1, "google.cloud.dialogflow.v2.Document"
|
@@ -61,10 +63,20 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
61
63
|
end
|
62
64
|
add_message "google.cloud.dialogflow.v2.ReloadDocumentRequest" do
|
63
65
|
optional :name, :string, 1
|
66
|
+
optional :import_gcs_custom_metadata, :bool, 4
|
67
|
+
optional :smart_messaging_partial_update, :bool, 5
|
64
68
|
oneof :source do
|
65
69
|
optional :content_uri, :string, 3
|
66
70
|
end
|
67
71
|
end
|
72
|
+
add_message "google.cloud.dialogflow.v2.ExportDocumentRequest" do
|
73
|
+
optional :name, :string, 1
|
74
|
+
optional :export_full_content, :bool, 3
|
75
|
+
optional :smart_messaging_partial_update, :bool, 5
|
76
|
+
oneof :destination do
|
77
|
+
optional :gcs_destination, :message, 2, "google.cloud.dialogflow.v2.GcsDestination"
|
78
|
+
end
|
79
|
+
end
|
68
80
|
add_message "google.cloud.dialogflow.v2.KnowledgeOperationMetadata" do
|
69
81
|
optional :state, :enum, 1, "google.cloud.dialogflow.v2.KnowledgeOperationMetadata.State"
|
70
82
|
end
|
@@ -91,6 +103,7 @@ module Google
|
|
91
103
|
DeleteDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.DeleteDocumentRequest").msgclass
|
92
104
|
UpdateDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.UpdateDocumentRequest").msgclass
|
93
105
|
ReloadDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.ReloadDocumentRequest").msgclass
|
106
|
+
ExportDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.ExportDocumentRequest").msgclass
|
94
107
|
KnowledgeOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.KnowledgeOperationMetadata").msgclass
|
95
108
|
KnowledgeOperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.KnowledgeOperationMetadata.State").enummodule
|
96
109
|
end
|
@@ -80,6 +80,16 @@ module Google
|
|
80
80
|
# Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
81
81
|
# only use `projects.knowledgeBases.documents`.
|
82
82
|
rpc :ReloadDocument, ::Google::Cloud::Dialogflow::V2::ReloadDocumentRequest, ::Google::Longrunning::Operation
|
83
|
+
# Exports a smart messaging candidate document into the specified
|
84
|
+
# destination.
|
85
|
+
#
|
86
|
+
# This method is a [long-running
|
87
|
+
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
88
|
+
# The returned `Operation` type has the following method-specific fields:
|
89
|
+
#
|
90
|
+
# - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
|
91
|
+
# - `response`: [Document][google.cloud.dialogflow.v2.Document]
|
92
|
+
rpc :ExportDocument, ::Google::Cloud::Dialogflow::V2::ExportDocumentRequest, ::Google::Longrunning::Operation
|
83
93
|
end
|
84
94
|
|
85
95
|
Stub = Service.rpc_stub_class
|
@@ -140,6 +140,7 @@ module Google
|
|
140
140
|
|
141
141
|
@operations_client = Operations.new do |config|
|
142
142
|
config.credentials = credentials
|
143
|
+
config.quota_project = @quota_project_id
|
143
144
|
config.endpoint = @config.endpoint
|
144
145
|
end
|
145
146
|
|
@@ -174,7 +175,7 @@ module Google
|
|
174
175
|
# @param options [::Gapic::CallOptions, ::Hash]
|
175
176
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
176
177
|
#
|
177
|
-
# @overload list_documents(parent: nil, page_size: nil, page_token: nil)
|
178
|
+
# @overload list_documents(parent: nil, page_size: nil, page_token: nil, filter: nil)
|
178
179
|
# Pass arguments to `list_documents` via keyword arguments. Note that at
|
179
180
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
180
181
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -188,6 +189,28 @@ module Google
|
|
188
189
|
# default 10 and at most 100.
|
189
190
|
# @param page_token [::String]
|
190
191
|
# The next_page_token value returned from a previous list request.
|
192
|
+
# @param filter [::String]
|
193
|
+
# The filter expression used to filter documents returned by the list method.
|
194
|
+
# The expression has the following syntax:
|
195
|
+
#
|
196
|
+
# <field> <operator> <value> [AND <field> <operator> <value>] ...
|
197
|
+
#
|
198
|
+
# The following fields and operators are supported:
|
199
|
+
#
|
200
|
+
# * knowledge_types with has(:) operator
|
201
|
+
# * display_name with has(:) operator
|
202
|
+
# * state with equals(=) operator
|
203
|
+
#
|
204
|
+
# Examples:
|
205
|
+
#
|
206
|
+
# * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
|
207
|
+
# * "display_name:customer" matches documents whose display name contains
|
208
|
+
# "customer".
|
209
|
+
# * "state=ACTIVE" matches documents with ACTIVE state.
|
210
|
+
# * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
|
211
|
+
#
|
212
|
+
# For more information about filtering, see
|
213
|
+
# [API Filtering](https://aip.dev/160).
|
191
214
|
#
|
192
215
|
# @yield [response, operation] Access the result along with the RPC operation
|
193
216
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Document>]
|
@@ -684,7 +707,7 @@ module Google
|
|
684
707
|
# @param options [::Gapic::CallOptions, ::Hash]
|
685
708
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
686
709
|
#
|
687
|
-
# @overload reload_document(name: nil, content_uri: nil)
|
710
|
+
# @overload reload_document(name: nil, content_uri: nil, import_gcs_custom_metadata: nil, smart_messaging_partial_update: nil)
|
688
711
|
# Pass arguments to `reload_document` via keyword arguments. Note that at
|
689
712
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
690
713
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -699,6 +722,12 @@ module Google
|
|
699
722
|
#
|
700
723
|
# For documents stored in Google Cloud Storage, these URIs must have
|
701
724
|
# the form `gs://<bucket-name>/<object-name>`.
|
725
|
+
# @param import_gcs_custom_metadata [::Boolean]
|
726
|
+
# Optional. Whether to import custom metadata from Google Cloud Storage.
|
727
|
+
# Only valid when the document source is Google Cloud Storage URI.
|
728
|
+
# @param smart_messaging_partial_update [::Boolean]
|
729
|
+
# Optional. When enabled, the reload request is to apply partial update to the smart
|
730
|
+
# messaging allowlist.
|
702
731
|
#
|
703
732
|
# @yield [response, operation] Access the result along with the RPC operation
|
704
733
|
# @yieldparam response [::Gapic::Operation]
|
@@ -772,6 +801,117 @@ module Google
|
|
772
801
|
raise ::Google::Cloud::Error.from_error(e)
|
773
802
|
end
|
774
803
|
|
804
|
+
##
|
805
|
+
# Exports a smart messaging candidate document into the specified
|
806
|
+
# destination.
|
807
|
+
#
|
808
|
+
# This method is a [long-running
|
809
|
+
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
810
|
+
# The returned `Operation` type has the following method-specific fields:
|
811
|
+
#
|
812
|
+
# - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
|
813
|
+
# - `response`: {::Google::Cloud::Dialogflow::V2::Document Document}
|
814
|
+
#
|
815
|
+
# @overload export_document(request, options = nil)
|
816
|
+
# Pass arguments to `export_document` via a request object, either of type
|
817
|
+
# {::Google::Cloud::Dialogflow::V2::ExportDocumentRequest} or an equivalent Hash.
|
818
|
+
#
|
819
|
+
# @param request [::Google::Cloud::Dialogflow::V2::ExportDocumentRequest, ::Hash]
|
820
|
+
# A request object representing the call parameters. Required. To specify no
|
821
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
822
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
823
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
824
|
+
#
|
825
|
+
# @overload export_document(name: nil, gcs_destination: nil, export_full_content: nil, smart_messaging_partial_update: nil)
|
826
|
+
# Pass arguments to `export_document` via keyword arguments. Note that at
|
827
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
828
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
829
|
+
#
|
830
|
+
# @param name [::String]
|
831
|
+
# Required. The name of the document to export.
|
832
|
+
# Format: `projects/<Project ID>/locations/<Location
|
833
|
+
# ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
|
834
|
+
# @param gcs_destination [::Google::Cloud::Dialogflow::V2::GcsDestination, ::Hash]
|
835
|
+
# Cloud Storage file path to export the document.
|
836
|
+
# @param export_full_content [::Boolean]
|
837
|
+
# When enabled, export the full content of the document including empirical
|
838
|
+
# probability.
|
839
|
+
# @param smart_messaging_partial_update [::Boolean]
|
840
|
+
# When enabled, export the smart messaging allowlist document for partial
|
841
|
+
# update.
|
842
|
+
#
|
843
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
844
|
+
# @yieldparam response [::Gapic::Operation]
|
845
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
846
|
+
#
|
847
|
+
# @return [::Gapic::Operation]
|
848
|
+
#
|
849
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
850
|
+
#
|
851
|
+
# @example Basic example
|
852
|
+
# require "google/cloud/dialogflow/v2"
|
853
|
+
#
|
854
|
+
# # Create a client object. The client can be reused for multiple calls.
|
855
|
+
# client = Google::Cloud::Dialogflow::V2::Documents::Client.new
|
856
|
+
#
|
857
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
858
|
+
# request = Google::Cloud::Dialogflow::V2::ExportDocumentRequest.new
|
859
|
+
#
|
860
|
+
# # Call the export_document method.
|
861
|
+
# result = client.export_document request
|
862
|
+
#
|
863
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
864
|
+
# # object to check the status of an operation, cancel it, or wait
|
865
|
+
# # for results. Here is how to block until completion:
|
866
|
+
# result.wait_until_done! timeout: 60
|
867
|
+
# if result.response?
|
868
|
+
# p result.response
|
869
|
+
# else
|
870
|
+
# puts "Error!"
|
871
|
+
# end
|
872
|
+
#
|
873
|
+
def export_document request, options = nil
|
874
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
875
|
+
|
876
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ExportDocumentRequest
|
877
|
+
|
878
|
+
# Converts hash and nil to an options object
|
879
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
880
|
+
|
881
|
+
# Customize the options with defaults
|
882
|
+
metadata = @config.rpcs.export_document.metadata.to_h
|
883
|
+
|
884
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
885
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
886
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
887
|
+
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
|
888
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
889
|
+
|
890
|
+
header_params = {}
|
891
|
+
if request.name
|
892
|
+
header_params["name"] = request.name
|
893
|
+
end
|
894
|
+
|
895
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
896
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
897
|
+
|
898
|
+
options.apply_defaults timeout: @config.rpcs.export_document.timeout,
|
899
|
+
metadata: metadata,
|
900
|
+
retry_policy: @config.rpcs.export_document.retry_policy
|
901
|
+
|
902
|
+
options.apply_defaults timeout: @config.timeout,
|
903
|
+
metadata: @config.metadata,
|
904
|
+
retry_policy: @config.retry_policy
|
905
|
+
|
906
|
+
@documents_stub.call_rpc :export_document, request, options: options do |response, operation|
|
907
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
908
|
+
yield response, operation if block_given?
|
909
|
+
return response
|
910
|
+
end
|
911
|
+
rescue ::GRPC::BadStatus => e
|
912
|
+
raise ::Google::Cloud::Error.from_error(e)
|
913
|
+
end
|
914
|
+
|
775
915
|
##
|
776
916
|
# Configuration class for the Documents API.
|
777
917
|
#
|
@@ -937,6 +1077,11 @@ module Google
|
|
937
1077
|
# @return [::Gapic::Config::Method]
|
938
1078
|
#
|
939
1079
|
attr_reader :reload_document
|
1080
|
+
##
|
1081
|
+
# RPC-specific configuration for `export_document`
|
1082
|
+
# @return [::Gapic::Config::Method]
|
1083
|
+
#
|
1084
|
+
attr_reader :export_document
|
940
1085
|
|
941
1086
|
# @private
|
942
1087
|
def initialize parent_rpcs = nil
|
@@ -952,6 +1097,8 @@ module Google
|
|
952
1097
|
@update_document = ::Gapic::Config::Method.new update_document_config
|
953
1098
|
reload_document_config = parent_rpcs.reload_document if parent_rpcs.respond_to? :reload_document
|
954
1099
|
@reload_document = ::Gapic::Config::Method.new reload_document_config
|
1100
|
+
export_document_config = parent_rpcs.export_document if parent_rpcs.respond_to? :export_document
|
1101
|
+
@export_document = ::Gapic::Config::Method.new export_document_config
|
955
1102
|
|
956
1103
|
yield self if block_given?
|
957
1104
|
end
|
@@ -7,6 +7,9 @@ require 'google/protobuf'
|
|
7
7
|
|
8
8
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
9
9
|
add_file("google/cloud/dialogflow/v2/gcs.proto", :syntax => :proto3) do
|
10
|
+
add_message "google.cloud.dialogflow.v2.GcsDestination" do
|
11
|
+
optional :uri, :string, 1
|
12
|
+
end
|
10
13
|
end
|
11
14
|
end
|
12
15
|
|
@@ -14,6 +17,7 @@ module Google
|
|
14
17
|
module Cloud
|
15
18
|
module Dialogflow
|
16
19
|
module V2
|
20
|
+
GcsDestination = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.GcsDestination").msgclass
|
17
21
|
end
|
18
22
|
end
|
19
23
|
end
|
@@ -20,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
20
20
|
optional :parent, :string, 1
|
21
21
|
optional :page_size, :int32, 2
|
22
22
|
optional :page_token, :string, 3
|
23
|
+
optional :filter, :string, 4
|
23
24
|
end
|
24
25
|
add_message "google.cloud.dialogflow.v2.ListKnowledgeBasesResponse" do
|
25
26
|
repeated :knowledge_bases, :message, 1, "google.cloud.dialogflow.v2.KnowledgeBase"
|
@@ -162,7 +162,7 @@ module Google
|
|
162
162
|
# @param options [::Gapic::CallOptions, ::Hash]
|
163
163
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
164
164
|
#
|
165
|
-
# @overload list_knowledge_bases(parent: nil, page_size: nil, page_token: nil)
|
165
|
+
# @overload list_knowledge_bases(parent: nil, page_size: nil, page_token: nil, filter: nil)
|
166
166
|
# Pass arguments to `list_knowledge_bases` via keyword arguments. Note that at
|
167
167
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
168
168
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -175,6 +175,33 @@ module Google
|
|
175
175
|
# default 10 and at most 100.
|
176
176
|
# @param page_token [::String]
|
177
177
|
# The next_page_token value returned from a previous list request.
|
178
|
+
# @param filter [::String]
|
179
|
+
# The filter expression used to filter knowledge bases returned by the list
|
180
|
+
# method. The expression has the following syntax:
|
181
|
+
#
|
182
|
+
# <field> <operator> <value> [AND <field> <operator> <value>] ...
|
183
|
+
#
|
184
|
+
# The following fields and operators are supported:
|
185
|
+
#
|
186
|
+
# * display_name with has(:) operator
|
187
|
+
# * language_code with equals(=) operator
|
188
|
+
#
|
189
|
+
# Examples:
|
190
|
+
#
|
191
|
+
# * 'language_code=en-us' matches knowledge bases with en-us language code.
|
192
|
+
# * 'display_name:articles' matches knowledge bases whose display name
|
193
|
+
# contains "articles".
|
194
|
+
# * 'display_name:"Best Articles"' matches knowledge bases whose display
|
195
|
+
# name contains "Best Articles".
|
196
|
+
# * 'language_code=en-gb AND display_name=articles' matches all knowledge
|
197
|
+
# bases whose display name contains "articles" and whose language code is
|
198
|
+
# "en-gb".
|
199
|
+
#
|
200
|
+
# Note: An empty filter string (i.e. "") is a no-op and will result in no
|
201
|
+
# filtering.
|
202
|
+
#
|
203
|
+
# For more information about filtering, see
|
204
|
+
# [API Filtering](https://aip.dev/160).
|
178
205
|
#
|
179
206
|
# @yield [response, operation] Access the result along with the RPC operation
|
180
207
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::KnowledgeBase>]
|
@@ -6,6 +6,7 @@ require 'google/api/client_pb'
|
|
6
6
|
require 'google/api/field_behavior_pb'
|
7
7
|
require 'google/api/resource_pb'
|
8
8
|
require 'google/cloud/dialogflow/v2/audio_config_pb'
|
9
|
+
require 'google/cloud/dialogflow/v2/gcs_pb'
|
9
10
|
require 'google/cloud/dialogflow/v2/session_pb'
|
10
11
|
require 'google/protobuf/any_pb'
|
11
12
|
require 'google/protobuf/duration_pb'
|
@@ -657,9 +657,8 @@ module Google
|
|
657
657
|
# ID>/conversations/<Conversation ID>/messages/<Message ID>`.
|
658
658
|
# @param context_size [::Integer]
|
659
659
|
# Max number of messages prior to and including
|
660
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message}
|
661
|
-
#
|
662
|
-
# most 50.
|
660
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message} to use as context
|
661
|
+
# when compiling the suggestion. By default 20 and at most 50.
|
663
662
|
# @param assist_query_params [::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash]
|
664
663
|
# Parameters for a human assist query.
|
665
664
|
#
|
@@ -7,6 +7,7 @@ require 'google/api/field_behavior_pb'
|
|
7
7
|
require 'google/api/resource_pb'
|
8
8
|
require 'google/cloud/dialogflow/v2/audio_config_pb'
|
9
9
|
require 'google/cloud/dialogflow/v2/context_pb'
|
10
|
+
require 'google/cloud/dialogflow/v2/gcs_pb'
|
10
11
|
require 'google/cloud/dialogflow/v2/intent_pb'
|
11
12
|
require 'google/cloud/dialogflow/v2/session_entity_type_pb'
|
12
13
|
require 'google/protobuf/duration_pb'
|
@@ -33,11 +33,7 @@ module Google
|
|
33
33
|
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
34
|
# option (google.api.resource) = {
|
35
35
|
# type: "pubsub.googleapis.com/Topic"
|
36
|
-
#
|
37
|
-
# pattern: "projects/{project}/topics/{topic}"
|
38
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
-
# parent_name_extractor: "projects/{project}"
|
40
|
-
# }
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
41
37
|
# };
|
42
38
|
# }
|
43
39
|
#
|
@@ -45,10 +41,7 @@ module Google
|
|
45
41
|
#
|
46
42
|
# resources:
|
47
43
|
# - type: "pubsub.googleapis.com/Topic"
|
48
|
-
#
|
49
|
-
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
-
# parent_name_extractor: "projects/{project}"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
52
45
|
#
|
53
46
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
47
|
# live under multiple parents.
|
@@ -58,26 +51,10 @@ module Google
|
|
58
51
|
# message LogEntry {
|
59
52
|
# option (google.api.resource) = {
|
60
53
|
# type: "logging.googleapis.com/LogEntry"
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
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
|
-
# }
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
81
58
|
# };
|
82
59
|
# }
|
83
60
|
#
|
@@ -85,48 +62,10 @@ module Google
|
|
85
62
|
#
|
86
63
|
# resources:
|
87
64
|
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
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"
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
130
69
|
# @!attribute [rw] type
|
131
70
|
# @return [::String]
|
132
71
|
# The resource type. It must be in the format of
|
@@ -241,10 +241,13 @@ module Google
|
|
241
241
|
# Configures speech transcription for {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile}.
|
242
242
|
# @!attribute [rw] speech_model_variant
|
243
243
|
# @return [::Google::Cloud::Dialogflow::V2::SpeechModelVariant]
|
244
|
-
#
|
244
|
+
# The speech model used in speech to text.
|
245
245
|
# `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as
|
246
246
|
# `USE_ENHANCED`. It can be overridden in {::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest AnalyzeContentRequest} and
|
247
247
|
# [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest] request.
|
248
|
+
# If enhanced model variant is specified and an enhanced
|
249
|
+
# version of the specified model for the language does not exist, then it
|
250
|
+
# would emit an error.
|
248
251
|
class SpeechToTextConfig
|
249
252
|
include ::Google::Protobuf::MessageExts
|
250
253
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -163,6 +163,29 @@ module Google
|
|
163
163
|
# @!attribute [rw] page_token
|
164
164
|
# @return [::String]
|
165
165
|
# The next_page_token value returned from a previous list request.
|
166
|
+
# @!attribute [rw] filter
|
167
|
+
# @return [::String]
|
168
|
+
# The filter expression used to filter documents returned by the list method.
|
169
|
+
# The expression has the following syntax:
|
170
|
+
#
|
171
|
+
# <field> <operator> <value> [AND <field> <operator> <value>] ...
|
172
|
+
#
|
173
|
+
# The following fields and operators are supported:
|
174
|
+
#
|
175
|
+
# * knowledge_types with has(:) operator
|
176
|
+
# * display_name with has(:) operator
|
177
|
+
# * state with equals(=) operator
|
178
|
+
#
|
179
|
+
# Examples:
|
180
|
+
#
|
181
|
+
# * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
|
182
|
+
# * "display_name:customer" matches documents whose display name contains
|
183
|
+
# "customer".
|
184
|
+
# * "state=ACTIVE" matches documents with ACTIVE state.
|
185
|
+
# * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
|
186
|
+
#
|
187
|
+
# For more information about filtering, see
|
188
|
+
# [API Filtering](https://aip.dev/160).
|
166
189
|
class ListDocumentsRequest
|
167
190
|
include ::Google::Protobuf::MessageExts
|
168
191
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -233,11 +256,41 @@ module Google
|
|
233
256
|
#
|
234
257
|
# For documents stored in Google Cloud Storage, these URIs must have
|
235
258
|
# the form `gs://<bucket-name>/<object-name>`.
|
259
|
+
# @!attribute [rw] import_gcs_custom_metadata
|
260
|
+
# @return [::Boolean]
|
261
|
+
# Optional. Whether to import custom metadata from Google Cloud Storage.
|
262
|
+
# Only valid when the document source is Google Cloud Storage URI.
|
263
|
+
# @!attribute [rw] smart_messaging_partial_update
|
264
|
+
# @return [::Boolean]
|
265
|
+
# Optional. When enabled, the reload request is to apply partial update to the smart
|
266
|
+
# messaging allowlist.
|
236
267
|
class ReloadDocumentRequest
|
237
268
|
include ::Google::Protobuf::MessageExts
|
238
269
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
239
270
|
end
|
240
271
|
|
272
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#export_document Documents.ExportDocument}.
|
273
|
+
# @!attribute [rw] name
|
274
|
+
# @return [::String]
|
275
|
+
# Required. The name of the document to export.
|
276
|
+
# Format: `projects/<Project ID>/locations/<Location
|
277
|
+
# ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
|
278
|
+
# @!attribute [rw] gcs_destination
|
279
|
+
# @return [::Google::Cloud::Dialogflow::V2::GcsDestination]
|
280
|
+
# Cloud Storage file path to export the document.
|
281
|
+
# @!attribute [rw] export_full_content
|
282
|
+
# @return [::Boolean]
|
283
|
+
# When enabled, export the full content of the document including empirical
|
284
|
+
# probability.
|
285
|
+
# @!attribute [rw] smart_messaging_partial_update
|
286
|
+
# @return [::Boolean]
|
287
|
+
# When enabled, export the smart messaging allowlist document for partial
|
288
|
+
# update.
|
289
|
+
class ExportDocumentRequest
|
290
|
+
include ::Google::Protobuf::MessageExts
|
291
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
292
|
+
end
|
293
|
+
|
241
294
|
# Metadata in google::longrunning::Operation for Knowledge operations.
|
242
295
|
# @!attribute [r] state
|
243
296
|
# @return [::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata::State]
|
@@ -0,0 +1,39 @@
|
|
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 Dialogflow
|
23
|
+
module V2
|
24
|
+
# Google Cloud Storage location for the output.
|
25
|
+
# @!attribute [rw] uri
|
26
|
+
# @return [::String]
|
27
|
+
# The Google Cloud Storage URIs for the output. A URI is of the
|
28
|
+
# form:
|
29
|
+
# gs://bucket/object-prefix-or-name
|
30
|
+
# Whether a prefix or name is used depends on the use case. The requesting
|
31
|
+
# user must have "write-permission" to the bucket.
|
32
|
+
class GcsDestination
|
33
|
+
include ::Google::Protobuf::MessageExts
|
34
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -63,6 +63,34 @@ module Google
|
|
63
63
|
# @!attribute [rw] page_token
|
64
64
|
# @return [::String]
|
65
65
|
# The next_page_token value returned from a previous list request.
|
66
|
+
# @!attribute [rw] filter
|
67
|
+
# @return [::String]
|
68
|
+
# The filter expression used to filter knowledge bases returned by the list
|
69
|
+
# method. The expression has the following syntax:
|
70
|
+
#
|
71
|
+
# <field> <operator> <value> [AND <field> <operator> <value>] ...
|
72
|
+
#
|
73
|
+
# The following fields and operators are supported:
|
74
|
+
#
|
75
|
+
# * display_name with has(:) operator
|
76
|
+
# * language_code with equals(=) operator
|
77
|
+
#
|
78
|
+
# Examples:
|
79
|
+
#
|
80
|
+
# * 'language_code=en-us' matches knowledge bases with en-us language code.
|
81
|
+
# * 'display_name:articles' matches knowledge bases whose display name
|
82
|
+
# contains "articles".
|
83
|
+
# * 'display_name:"Best Articles"' matches knowledge bases whose display
|
84
|
+
# name contains "Best Articles".
|
85
|
+
# * 'language_code=en-gb AND display_name=articles' matches all knowledge
|
86
|
+
# bases whose display name contains "articles" and whose language code is
|
87
|
+
# "en-gb".
|
88
|
+
#
|
89
|
+
# Note: An empty filter string (i.e. "") is a no-op and will result in no
|
90
|
+
# filtering.
|
91
|
+
#
|
92
|
+
# For more information about filtering, see
|
93
|
+
# [API Filtering](https://aip.dev/160).
|
66
94
|
class ListKnowledgeBasesRequest
|
67
95
|
include ::Google::Protobuf::MessageExts
|
68
96
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -29,8 +29,8 @@ module Google
|
|
29
29
|
# ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
|
30
30
|
# @!attribute [rw] role
|
31
31
|
# @return [::Google::Cloud::Dialogflow::V2::Participant::Role]
|
32
|
-
# Immutable. The role this participant plays in the conversation. This field
|
33
|
-
#
|
32
|
+
# Immutable. The role this participant plays in the conversation. This field must be set
|
33
|
+
# during participant creation and is then immutable.
|
34
34
|
# @!attribute [rw] sip_recording_media_label
|
35
35
|
# @return [::String]
|
36
36
|
# Optional. Label applied to streams representing this participant in SIPREC
|
@@ -38,10 +38,9 @@ module Google
|
|
38
38
|
# media stream to this participant. This field can be updated.
|
39
39
|
# @!attribute [rw] documents_metadata_filters
|
40
40
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
41
|
-
# Optional. Key-value filters on the metadata of documents returned by
|
42
|
-
#
|
43
|
-
# documents that match all filters in their
|
44
|
-
# {::Google::Cloud::Dialogflow::V2::Document#metadata Document.metadata}. Multiple
|
41
|
+
# Optional. Key-value filters on the metadata of documents returned by article
|
42
|
+
# suggestion. If specified, article suggestion only returns suggested
|
43
|
+
# documents that match all filters in their {::Google::Cloud::Dialogflow::V2::Document#metadata Document.metadata}. Multiple
|
45
44
|
# values for a metadata key should be concatenated by comma. For example,
|
46
45
|
# filters to match all documents that have 'US' or 'CA' in their market
|
47
46
|
# metadata values and 'agent' in their user metadata values will be
|
@@ -116,8 +115,7 @@ module Google
|
|
116
115
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
117
116
|
end
|
118
117
|
|
119
|
-
# The request message for
|
120
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#create_participant Participants.CreateParticipant}.
|
118
|
+
# The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#create_participant Participants.CreateParticipant}.
|
121
119
|
# @!attribute [rw] parent
|
122
120
|
# @return [::String]
|
123
121
|
# Required. Resource identifier of the conversation adding the participant.
|
@@ -131,8 +129,7 @@ module Google
|
|
131
129
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
132
130
|
end
|
133
131
|
|
134
|
-
# The request message for
|
135
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#get_participant Participants.GetParticipant}.
|
132
|
+
# The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#get_participant Participants.GetParticipant}.
|
136
133
|
# @!attribute [rw] name
|
137
134
|
# @return [::String]
|
138
135
|
# Required. The name of the participant. Format:
|
@@ -143,8 +140,7 @@ module Google
|
|
143
140
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
144
141
|
end
|
145
142
|
|
146
|
-
# The request message for
|
147
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#list_participants Participants.ListParticipants}.
|
143
|
+
# The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#list_participants Participants.ListParticipants}.
|
148
144
|
# @!attribute [rw] parent
|
149
145
|
# @return [::String]
|
150
146
|
# Required. The conversation to list all participants from.
|
@@ -162,8 +158,7 @@ module Google
|
|
162
158
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
163
159
|
end
|
164
160
|
|
165
|
-
# The response message for
|
166
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#list_participants Participants.ListParticipants}.
|
161
|
+
# The response message for {::Google::Cloud::Dialogflow::V2::Participants::Client#list_participants Participants.ListParticipants}.
|
167
162
|
# @!attribute [rw] participants
|
168
163
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::Participant>]
|
169
164
|
# The list of participants. There is a maximum number of items
|
@@ -177,8 +172,7 @@ module Google
|
|
177
172
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
178
173
|
end
|
179
174
|
|
180
|
-
# The request message for
|
181
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#update_participant Participants.UpdateParticipant}.
|
175
|
+
# The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#update_participant Participants.UpdateParticipant}.
|
182
176
|
# @!attribute [rw] participant
|
183
177
|
# @return [::Google::Cloud::Dialogflow::V2::Participant]
|
184
178
|
# Required. The participant to update.
|
@@ -190,8 +184,7 @@ module Google
|
|
190
184
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
191
185
|
end
|
192
186
|
|
193
|
-
# The request message for
|
194
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}.
|
187
|
+
# The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}.
|
195
188
|
# @!attribute [rw] participant
|
196
189
|
# @return [::String]
|
197
190
|
# Required. The name of the participant this text comes from.
|
@@ -235,8 +228,7 @@ module Google
|
|
235
228
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
236
229
|
end
|
237
230
|
|
238
|
-
# The response message for
|
239
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}.
|
231
|
+
# The response message for {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}.
|
240
232
|
# @!attribute [rw] reply_text
|
241
233
|
# @return [::String]
|
242
234
|
# The output text content.
|
@@ -260,23 +252,19 @@ module Google
|
|
260
252
|
# Only set if a Dialogflow automated agent has responded.
|
261
253
|
# Note that: [AutomatedAgentReply.detect_intent_response.output_audio][]
|
262
254
|
# and [AutomatedAgentReply.detect_intent_response.output_audio_config][]
|
263
|
-
# are always empty, use
|
264
|
-
# {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#reply_audio reply_audio}
|
265
|
-
# instead.
|
255
|
+
# are always empty, use {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#reply_audio reply_audio} instead.
|
266
256
|
# @!attribute [rw] message
|
267
257
|
# @return [::Google::Cloud::Dialogflow::V2::Message]
|
268
258
|
# Message analyzed by CCAI.
|
269
259
|
# @!attribute [rw] human_agent_suggestion_results
|
270
260
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
|
271
261
|
# The suggestions for most recent human agent. The order is the same as
|
272
|
-
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
273
|
-
# of
|
262
|
+
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs} of
|
274
263
|
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig#human_agent_suggestion_config HumanAgentAssistantConfig.human_agent_suggestion_config}.
|
275
264
|
# @!attribute [rw] end_user_suggestion_results
|
276
265
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
|
277
266
|
# The suggestions for end user. The order is the same as
|
278
|
-
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs}
|
279
|
-
# of
|
267
|
+
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig#feature_configs HumanAgentAssistantConfig.SuggestionConfig.feature_configs} of
|
280
268
|
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig#end_user_suggestion_config HumanAgentAssistantConfig.end_user_suggestion_config}.
|
281
269
|
# @!attribute [rw] dtmf_parameters
|
282
270
|
# @return [::Google::Cloud::Dialogflow::V2::DtmfParameters]
|
@@ -286,8 +274,7 @@ module Google
|
|
286
274
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
287
275
|
end
|
288
276
|
|
289
|
-
# The request message for
|
290
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_articles Participants.SuggestArticles}.
|
277
|
+
# The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_articles Participants.SuggestArticles}.
|
291
278
|
# @!attribute [rw] parent
|
292
279
|
# @return [::String]
|
293
280
|
# Required. The name of the participant to fetch suggestion for.
|
@@ -303,9 +290,8 @@ module Google
|
|
303
290
|
# @!attribute [rw] context_size
|
304
291
|
# @return [::Integer]
|
305
292
|
# Max number of messages prior to and including
|
306
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message}
|
307
|
-
#
|
308
|
-
# most 50.
|
293
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message} to use as context
|
294
|
+
# when compiling the suggestion. By default 20 and at most 50.
|
309
295
|
# @!attribute [rw] assist_query_params
|
310
296
|
# @return [::Google::Cloud::Dialogflow::V2::AssistQueryParameters]
|
311
297
|
# Parameters for a human assist query.
|
@@ -314,8 +300,7 @@ module Google
|
|
314
300
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
315
301
|
end
|
316
302
|
|
317
|
-
# The response message for
|
318
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_articles Participants.SuggestArticles}.
|
303
|
+
# The response message for {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_articles Participants.SuggestArticles}.
|
319
304
|
# @!attribute [rw] article_answers
|
320
305
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::ArticleAnswer>]
|
321
306
|
# Articles ordered by score in descending order.
|
@@ -329,18 +314,16 @@ module Google
|
|
329
314
|
# @!attribute [rw] context_size
|
330
315
|
# @return [::Integer]
|
331
316
|
# Number of messages prior to and including
|
332
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse#latest_message latest_message}
|
333
|
-
#
|
334
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#context_size SuggestArticlesRequest.context_size}
|
335
|
-
#
|
336
|
-
# conversation.
|
317
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse#latest_message latest_message} to compile the
|
318
|
+
# suggestion. It may be smaller than the
|
319
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#context_size SuggestArticlesRequest.context_size} field in the request if there
|
320
|
+
# aren't that many messages in the conversation.
|
337
321
|
class SuggestArticlesResponse
|
338
322
|
include ::Google::Protobuf::MessageExts
|
339
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
340
324
|
end
|
341
325
|
|
342
|
-
# The request message for
|
343
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_faq_answers Participants.SuggestFaqAnswers}.
|
326
|
+
# The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_faq_answers Participants.SuggestFaqAnswers}.
|
344
327
|
# @!attribute [rw] parent
|
345
328
|
# @return [::String]
|
346
329
|
# Required. The name of the participant to fetch suggestion for.
|
@@ -366,8 +349,7 @@ module Google
|
|
366
349
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
367
350
|
end
|
368
351
|
|
369
|
-
# The request message for
|
370
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_faq_answers Participants.SuggestFaqAnswers}.
|
352
|
+
# The request message for {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_faq_answers Participants.SuggestFaqAnswers}.
|
371
353
|
# @!attribute [rw] faq_answers
|
372
354
|
# @return [::Array<::Google::Cloud::Dialogflow::V2::FaqAnswer>]
|
373
355
|
# Answers extracted from FAQ documents.
|
@@ -381,11 +363,10 @@ module Google
|
|
381
363
|
# @!attribute [rw] context_size
|
382
364
|
# @return [::Integer]
|
383
365
|
# Number of messages prior to and including
|
384
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse#latest_message latest_message}
|
385
|
-
#
|
386
|
-
# {::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersRequest#context_size SuggestFaqAnswersRequest.context_size}
|
387
|
-
#
|
388
|
-
# conversation.
|
366
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse#latest_message latest_message} to compile the
|
367
|
+
# suggestion. It may be smaller than the
|
368
|
+
# {::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersRequest#context_size SuggestFaqAnswersRequest.context_size} field in the request if there
|
369
|
+
# aren't that many messages in the conversation.
|
389
370
|
class SuggestFaqAnswersResponse
|
390
371
|
include ::Google::Protobuf::MessageExts
|
391
372
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -407,9 +388,7 @@ module Google
|
|
407
388
|
# Represents a response from an automated agent.
|
408
389
|
# @!attribute [rw] detect_intent_response
|
409
390
|
# @return [::Google::Cloud::Dialogflow::V2::DetectIntentResponse]
|
410
|
-
# Response of the Dialogflow
|
411
|
-
# {::Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent Sessions.DetectIntent}
|
412
|
-
# call.
|
391
|
+
# Response of the Dialogflow {::Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent Sessions.DetectIntent} call.
|
413
392
|
# @!attribute [rw] automated_agent_reply_type
|
414
393
|
# @return [::Google::Cloud::Dialogflow::V2::AutomatedAgentReply::AutomatedAgentReplyType]
|
415
394
|
# AutomatedAgentReply type.
|
@@ -518,12 +497,8 @@ module Google
|
|
518
497
|
end
|
519
498
|
|
520
499
|
# One response of different type of suggestion response which is used in
|
521
|
-
# the response of
|
522
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
|
523
|
-
# and
|
524
|
-
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent},
|
525
|
-
# as well as
|
526
|
-
# {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantEvent HumanAgentAssistantEvent}.
|
500
|
+
# the response of {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent} and
|
501
|
+
# {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}, as well as {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantEvent HumanAgentAssistantEvent}.
|
527
502
|
# @!attribute [rw] error
|
528
503
|
# @return [::Google::Rpc::Status]
|
529
504
|
# Error status if the request failed.
|
@@ -586,11 +561,11 @@ module Google
|
|
586
561
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
587
562
|
# Key-value filters on the metadata of documents returned by article
|
588
563
|
# suggestion. If specified, article suggestion only returns suggested
|
589
|
-
# documents that match all filters in their
|
590
|
-
# {::Google::Cloud::Dialogflow::V2::Document#metadata Document.metadata}. Multiple
|
564
|
+
# documents that match all filters in their {::Google::Cloud::Dialogflow::V2::Document#metadata Document.metadata}. Multiple
|
591
565
|
# values for a metadata key should be concatenated by comma. For example,
|
592
566
|
# filters to match all documents that have 'US' or 'CA' in their market
|
593
567
|
# metadata values and 'agent' in their user metadata values will be
|
568
|
+
# ```
|
594
569
|
# documents_metadata_filters {
|
595
570
|
# key: "market"
|
596
571
|
# value: "US,CA"
|
@@ -599,6 +574,7 @@ module Google
|
|
599
574
|
# key: "user"
|
600
575
|
# value: "agent"
|
601
576
|
# }
|
577
|
+
# ```
|
602
578
|
class AssistQueryParameters
|
603
579
|
include ::Google::Protobuf::MessageExts
|
604
580
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-dialogflow-v2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.13.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: 2022-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -290,6 +290,7 @@ files:
|
|
290
290
|
- proto_docs/google/cloud/dialogflow/v2/entity_type.rb
|
291
291
|
- proto_docs/google/cloud/dialogflow/v2/environment.rb
|
292
292
|
- proto_docs/google/cloud/dialogflow/v2/fulfillment.rb
|
293
|
+
- proto_docs/google/cloud/dialogflow/v2/gcs.rb
|
293
294
|
- proto_docs/google/cloud/dialogflow/v2/human_agent_assistant_event.rb
|
294
295
|
- proto_docs/google/cloud/dialogflow/v2/intent.rb
|
295
296
|
- proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb
|
@@ -327,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
327
328
|
- !ruby/object:Gem::Version
|
328
329
|
version: '0'
|
329
330
|
requirements: []
|
330
|
-
rubygems_version: 3.
|
331
|
+
rubygems_version: 3.3.4
|
331
332
|
signing_key:
|
332
333
|
specification_version: 4
|
333
334
|
summary: API Client library for the Dialogflow V2 API
|