google-cloud-dialogflow-v2 0.6.4 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +188 -190
- data/README.md +66 -2
- data/lib/google/cloud/dialogflow/v2.rb +11 -2
- data/lib/google/cloud/dialogflow/v2/agent_services_pb.rb +9 -9
- data/lib/google/cloud/dialogflow/v2/agents/client.rb +24 -18
- data/lib/google/cloud/dialogflow/v2/agents/operations.rb +96 -11
- data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +100 -0
- data/lib/google/cloud/dialogflow/v2/answer_record_services_pb.rb +49 -0
- data/lib/google/cloud/dialogflow/v2/answer_records.rb +50 -0
- data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +479 -0
- data/lib/google/cloud/dialogflow/v2/answer_records/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/answer_records/paths.rb +105 -0
- data/lib/google/cloud/dialogflow/v2/audio_config_pb.rb +7 -0
- data/lib/google/cloud/dialogflow/v2/context_services_pb.rb +7 -24
- data/lib/google/cloud/dialogflow/v2/contexts.rb +1 -18
- data/lib/google/cloud/dialogflow/v2/contexts/client.rb +22 -33
- data/lib/google/cloud/dialogflow/v2/contexts/paths.rb +2 -2
- data/lib/google/cloud/dialogflow/v2/conversation_event_pb.rb +39 -0
- data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +89 -0
- data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +182 -0
- data/lib/google/cloud/dialogflow/v2/conversation_profile_services_pb.rb +61 -0
- data/lib/google/cloud/dialogflow/v2/conversation_profiles.rb +49 -0
- data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +699 -0
- data/lib/google/cloud/dialogflow/v2/conversation_profiles/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/conversation_profiles/paths.rb +205 -0
- data/lib/google/cloud/dialogflow/v2/conversation_services_pb.rb +75 -0
- data/lib/google/cloud/dialogflow/v2/conversations.rb +49 -0
- data/lib/google/cloud/dialogflow/v2/conversations/client.rb +757 -0
- data/lib/google/cloud/dialogflow/v2/conversations/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/conversations/paths.rb +146 -0
- data/lib/google/cloud/dialogflow/v2/document_pb.rb +99 -0
- data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +73 -0
- data/lib/google/cloud/dialogflow/v2/documents.rb +50 -0
- data/lib/google/cloud/dialogflow/v2/documents/client.rb +810 -0
- data/lib/google/cloud/dialogflow/v2/documents/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/documents/operations.rb +655 -0
- data/lib/google/cloud/dialogflow/v2/documents/paths.rb +119 -0
- data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb +11 -38
- data/lib/google/cloud/dialogflow/v2/entity_types.rb +1 -28
- data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +26 -47
- data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +96 -11
- data/lib/google/cloud/dialogflow/v2/environment_services_pb.rb +2 -2
- data/lib/google/cloud/dialogflow/v2/environments.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/environments/client.rb +17 -11
- data/lib/google/cloud/dialogflow/v2/gcs_pb.rb +20 -0
- data/lib/google/cloud/dialogflow/v2/human_agent_assistant_event_pb.rb +26 -0
- data/lib/google/cloud/dialogflow/v2/intent_pb.rb +2 -0
- data/lib/google/cloud/dialogflow/v2/intent_services_pb.rb +8 -39
- data/lib/google/cloud/dialogflow/v2/intents.rb +1 -32
- data/lib/google/cloud/dialogflow/v2/intents/client.rb +23 -48
- data/lib/google/cloud/dialogflow/v2/intents/operations.rb +96 -11
- data/lib/google/cloud/dialogflow/v2/intents/paths.rb +1 -1
- data/lib/google/cloud/dialogflow/v2/knowledge_base_pb.rb +60 -0
- data/lib/google/cloud/dialogflow/v2/knowledge_base_services_pb.rb +53 -0
- data/lib/google/cloud/dialogflow/v2/knowledge_bases.rb +49 -0
- data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +696 -0
- data/lib/google/cloud/dialogflow/v2/knowledge_bases/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/knowledge_bases/paths.rb +105 -0
- data/lib/google/cloud/dialogflow/v2/participant_pb.rb +172 -0
- data/lib/google/cloud/dialogflow/v2/participant_services_pb.rb +64 -0
- data/lib/google/cloud/dialogflow/v2/participants.rb +49 -0
- data/lib/google/cloud/dialogflow/v2/participants/client.rb +894 -0
- data/lib/google/cloud/dialogflow/v2/participants/credentials.rb +52 -0
- data/lib/google/cloud/dialogflow/v2/participants/paths.rb +258 -0
- data/lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb +6 -22
- data/lib/google/cloud/dialogflow/v2/session_entity_types.rb +1 -17
- data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +21 -31
- data/lib/google/cloud/dialogflow/v2/session_entity_types/paths.rb +2 -2
- data/lib/google/cloud/dialogflow/v2/session_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/v2/session_services_pb.rb +14 -6
- data/lib/google/cloud/dialogflow/v2/sessions.rb +4 -4
- data/lib/google/cloud/dialogflow/v2/sessions/client.rb +43 -21
- data/lib/google/cloud/dialogflow/v2/sessions/paths.rb +3 -3
- data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/api/resource.rb +50 -14
- data/proto_docs/google/cloud/dialogflow/v2/agent.rb +1 -2
- data/proto_docs/google/cloud/dialogflow/v2/answer_record.rb +259 -0
- data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +25 -0
- data/proto_docs/google/cloud/dialogflow/v2/context.rb +17 -2
- data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +253 -0
- data/proto_docs/google/cloud/dialogflow/v2/conversation_event.rb +83 -0
- data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +510 -0
- data/proto_docs/google/cloud/dialogflow/v2/document.rb +267 -0
- data/proto_docs/google/cloud/dialogflow/v2/entity_type.rb +12 -3
- data/proto_docs/google/cloud/dialogflow/v2/environment.rb +18 -1
- data/proto_docs/google/cloud/dialogflow/v2/human_agent_assistant_event.rb +45 -0
- data/proto_docs/google/cloud/dialogflow/v2/intent.rb +20 -3
- data/proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb +139 -0
- data/proto_docs/google/cloud/dialogflow/v2/participant.rb +503 -0
- data/proto_docs/google/cloud/dialogflow/v2/session.rb +52 -7
- data/proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb +7 -6
- data/proto_docs/google/cloud/dialogflow/v2/validation_result.rb +1 -1
- data/proto_docs/google/cloud/dialogflow/v2/webhook.rb +2 -2
- data/proto_docs/google/longrunning/operations.rb +17 -3
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- data/proto_docs/google/type/latlng.rb +2 -2
- metadata +59 -9
@@ -0,0 +1,267 @@
|
|
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
|
+
# A knowledge document to be used by a {::Google::Cloud::Dialogflow::V2::KnowledgeBase KnowledgeBase}.
|
25
|
+
#
|
26
|
+
# For more information, see the [knowledge base
|
27
|
+
# guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
|
28
|
+
#
|
29
|
+
# Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
30
|
+
# only use `projects.knowledgeBases.documents`.
|
31
|
+
# @!attribute [rw] name
|
32
|
+
# @return [::String]
|
33
|
+
# Optional. The document resource name.
|
34
|
+
# The name must be empty when creating a document.
|
35
|
+
# Format: `projects/<Project ID>/locations/<Location
|
36
|
+
# ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
|
37
|
+
# @!attribute [rw] display_name
|
38
|
+
# @return [::String]
|
39
|
+
# Required. The display name of the document. The name must be 1024 bytes or
|
40
|
+
# less; otherwise, the creation request fails.
|
41
|
+
# @!attribute [rw] mime_type
|
42
|
+
# @return [::String]
|
43
|
+
# Required. The MIME type of this document.
|
44
|
+
# @!attribute [rw] knowledge_types
|
45
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::Document::KnowledgeType>]
|
46
|
+
# Required. The knowledge type of document content.
|
47
|
+
# @!attribute [rw] content_uri
|
48
|
+
# @return [::String]
|
49
|
+
# The URI where the file content is located.
|
50
|
+
#
|
51
|
+
# For documents stored in Google Cloud Storage, these URIs must have
|
52
|
+
# the form `gs://<bucket-name>/<object-name>`.
|
53
|
+
#
|
54
|
+
# NOTE: External URLs must correspond to public webpages, i.e., they must
|
55
|
+
# be indexed by Google Search. In particular, URLs for showing documents in
|
56
|
+
# Google Cloud Storage (i.e. the URL in your browser) are not supported.
|
57
|
+
# Instead use the `gs://` format URI described above.
|
58
|
+
# @!attribute [rw] raw_content
|
59
|
+
# @return [::String]
|
60
|
+
# The raw content of the document. This field is only permitted for
|
61
|
+
# EXTRACTIVE_QA and FAQ knowledge types.
|
62
|
+
# @!attribute [rw] enable_auto_reload
|
63
|
+
# @return [::Boolean]
|
64
|
+
# Optional. If true, we try to automatically reload the document every day
|
65
|
+
# (at a time picked by the system). If false or unspecified, we don't try
|
66
|
+
# to automatically reload the document.
|
67
|
+
#
|
68
|
+
# Currently you can only enable automatic reload for documents sourced from
|
69
|
+
# a public url, see `source` field for the source types.
|
70
|
+
#
|
71
|
+
# Reload status can be tracked in `latest_reload_status`. If a reload
|
72
|
+
# fails, we will keep the document unchanged.
|
73
|
+
#
|
74
|
+
# If a reload fails with internal errors, the system will try to reload the
|
75
|
+
# document on the next day.
|
76
|
+
# If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
|
77
|
+
# system will not try to reload the document anymore. You need to manually
|
78
|
+
# reload the document successfully by calling `ReloadDocument` and clear the
|
79
|
+
# errors.
|
80
|
+
# @!attribute [r] latest_reload_status
|
81
|
+
# @return [::Google::Cloud::Dialogflow::V2::Document::ReloadStatus]
|
82
|
+
# Output only. The time and status of the latest reload.
|
83
|
+
# This reload may have been triggered automatically or manually
|
84
|
+
# and may not have succeeded.
|
85
|
+
# @!attribute [rw] metadata
|
86
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
87
|
+
# Optional. Metadata for the document. The metadata supports arbitrary
|
88
|
+
# key-value pairs. Suggested use cases include storing a document's title,
|
89
|
+
# an external URL distinct from the document's content_uri, etc.
|
90
|
+
# The max size of a `key` or a `value` of the metadata is 1024 bytes.
|
91
|
+
class Document
|
92
|
+
include ::Google::Protobuf::MessageExts
|
93
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
94
|
+
|
95
|
+
# The status of a reload attempt.
|
96
|
+
# @!attribute [rw] time
|
97
|
+
# @return [::Google::Protobuf::Timestamp]
|
98
|
+
# The time of a reload attempt.
|
99
|
+
# This reload may have been triggered automatically or manually and may
|
100
|
+
# not have succeeded.
|
101
|
+
# @!attribute [rw] status
|
102
|
+
# @return [::Google::Rpc::Status]
|
103
|
+
# The status of a reload attempt or the initial load.
|
104
|
+
class ReloadStatus
|
105
|
+
include ::Google::Protobuf::MessageExts
|
106
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
107
|
+
end
|
108
|
+
|
109
|
+
# @!attribute [rw] key
|
110
|
+
# @return [::String]
|
111
|
+
# @!attribute [rw] value
|
112
|
+
# @return [::String]
|
113
|
+
class MetadataEntry
|
114
|
+
include ::Google::Protobuf::MessageExts
|
115
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
116
|
+
end
|
117
|
+
|
118
|
+
# The knowledge type of document content.
|
119
|
+
module KnowledgeType
|
120
|
+
# The type is unspecified or arbitrary.
|
121
|
+
KNOWLEDGE_TYPE_UNSPECIFIED = 0
|
122
|
+
|
123
|
+
# The document content contains question and answer pairs as either HTML or
|
124
|
+
# CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats
|
125
|
+
# may fail to be parsed.
|
126
|
+
#
|
127
|
+
# CSV must have questions in the first column and answers in the second,
|
128
|
+
# with no header. Because of this explicit format, they are always parsed
|
129
|
+
# accurately.
|
130
|
+
FAQ = 1
|
131
|
+
|
132
|
+
# Documents for which unstructured text is extracted and used for
|
133
|
+
# question answering.
|
134
|
+
EXTRACTIVE_QA = 2
|
135
|
+
|
136
|
+
# The entire document content as a whole can be used for query results.
|
137
|
+
# Only for Contact Center Solutions on Dialogflow.
|
138
|
+
ARTICLE_SUGGESTION = 3
|
139
|
+
end
|
140
|
+
end
|
141
|
+
|
142
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#get_document Documents.GetDocument}.
|
143
|
+
# @!attribute [rw] name
|
144
|
+
# @return [::String]
|
145
|
+
# Required. The name of the document to retrieve.
|
146
|
+
# Format `projects/<Project ID>/locations/<Location
|
147
|
+
# ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
|
148
|
+
class GetDocumentRequest
|
149
|
+
include ::Google::Protobuf::MessageExts
|
150
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
151
|
+
end
|
152
|
+
|
153
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#list_documents Documents.ListDocuments}.
|
154
|
+
# @!attribute [rw] parent
|
155
|
+
# @return [::String]
|
156
|
+
# Required. The knowledge base to list all documents for.
|
157
|
+
# Format: `projects/<Project ID>/locations/<Location
|
158
|
+
# ID>/knowledgeBases/<Knowledge Base ID>`.
|
159
|
+
# @!attribute [rw] page_size
|
160
|
+
# @return [::Integer]
|
161
|
+
# The maximum number of items to return in a single page. By
|
162
|
+
# default 10 and at most 100.
|
163
|
+
# @!attribute [rw] page_token
|
164
|
+
# @return [::String]
|
165
|
+
# The next_page_token value returned from a previous list request.
|
166
|
+
class ListDocumentsRequest
|
167
|
+
include ::Google::Protobuf::MessageExts
|
168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
169
|
+
end
|
170
|
+
|
171
|
+
# Response message for {::Google::Cloud::Dialogflow::V2::Documents::Client#list_documents Documents.ListDocuments}.
|
172
|
+
# @!attribute [rw] documents
|
173
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::Document>]
|
174
|
+
# The list of documents.
|
175
|
+
# @!attribute [rw] next_page_token
|
176
|
+
# @return [::String]
|
177
|
+
# Token to retrieve the next page of results, or empty if there are no
|
178
|
+
# more results in the list.
|
179
|
+
class ListDocumentsResponse
|
180
|
+
include ::Google::Protobuf::MessageExts
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
|
+
end
|
183
|
+
|
184
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#create_document Documents.CreateDocument}.
|
185
|
+
# @!attribute [rw] parent
|
186
|
+
# @return [::String]
|
187
|
+
# Required. The knowledge base to create a document for.
|
188
|
+
# Format: `projects/<Project ID>/locations/<Location
|
189
|
+
# ID>/knowledgeBases/<Knowledge Base ID>`.
|
190
|
+
# @!attribute [rw] document
|
191
|
+
# @return [::Google::Cloud::Dialogflow::V2::Document]
|
192
|
+
# Required. The document to create.
|
193
|
+
class CreateDocumentRequest
|
194
|
+
include ::Google::Protobuf::MessageExts
|
195
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
end
|
197
|
+
|
198
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#delete_document Documents.DeleteDocument}.
|
199
|
+
# @!attribute [rw] name
|
200
|
+
# @return [::String]
|
201
|
+
# Required. The name of the document to delete.
|
202
|
+
# Format: `projects/<Project ID>/locations/<Location
|
203
|
+
# ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
|
204
|
+
class DeleteDocumentRequest
|
205
|
+
include ::Google::Protobuf::MessageExts
|
206
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
207
|
+
end
|
208
|
+
|
209
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#update_document Documents.UpdateDocument}.
|
210
|
+
# @!attribute [rw] document
|
211
|
+
# @return [::Google::Cloud::Dialogflow::V2::Document]
|
212
|
+
# Required. The document to update.
|
213
|
+
# @!attribute [rw] update_mask
|
214
|
+
# @return [::Google::Protobuf::FieldMask]
|
215
|
+
# Optional. Not specified means `update all`.
|
216
|
+
# Currently, only `display_name` can be updated, an InvalidArgument will be
|
217
|
+
# returned for attempting to update other fields.
|
218
|
+
class UpdateDocumentRequest
|
219
|
+
include ::Google::Protobuf::MessageExts
|
220
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
221
|
+
end
|
222
|
+
|
223
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#reload_document Documents.ReloadDocument}.
|
224
|
+
# @!attribute [rw] name
|
225
|
+
# @return [::String]
|
226
|
+
# Required. The name of the document to reload.
|
227
|
+
# Format: `projects/<Project ID>/locations/<Location
|
228
|
+
# ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
|
229
|
+
# @!attribute [rw] content_uri
|
230
|
+
# @return [::String]
|
231
|
+
# Optional. The path of gcs source file for reloading document content. For now,
|
232
|
+
# only gcs uri is supported.
|
233
|
+
#
|
234
|
+
# For documents stored in Google Cloud Storage, these URIs must have
|
235
|
+
# the form `gs://<bucket-name>/<object-name>`.
|
236
|
+
class ReloadDocumentRequest
|
237
|
+
include ::Google::Protobuf::MessageExts
|
238
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
239
|
+
end
|
240
|
+
|
241
|
+
# Metadata in google::longrunning::Operation for Knowledge operations.
|
242
|
+
# @!attribute [r] state
|
243
|
+
# @return [::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata::State]
|
244
|
+
# Output only. The current state of this operation.
|
245
|
+
class KnowledgeOperationMetadata
|
246
|
+
include ::Google::Protobuf::MessageExts
|
247
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
248
|
+
|
249
|
+
# States of the operation.
|
250
|
+
module State
|
251
|
+
# State unspecified.
|
252
|
+
STATE_UNSPECIFIED = 0
|
253
|
+
|
254
|
+
# The operation has been created.
|
255
|
+
PENDING = 1
|
256
|
+
|
257
|
+
# The operation is currently running.
|
258
|
+
RUNNING = 2
|
259
|
+
|
260
|
+
# The operation is done, either cancelled or completed.
|
261
|
+
DONE = 3
|
262
|
+
end
|
263
|
+
end
|
264
|
+
end
|
265
|
+
end
|
266
|
+
end
|
267
|
+
end
|
@@ -21,9 +21,18 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Dialogflow
|
23
23
|
module V2
|
24
|
-
#
|
25
|
-
#
|
26
|
-
#
|
24
|
+
# Each intent parameter has a type, called the entity type, which dictates
|
25
|
+
# exactly how data from an end-user expression is extracted.
|
26
|
+
#
|
27
|
+
# Dialogflow provides predefined system entities that can match many common
|
28
|
+
# types of data. For example, there are system entities for matching dates,
|
29
|
+
# times, colors, email addresses, and so on. You can also create your own
|
30
|
+
# custom entities for matching custom data. For example, you could define a
|
31
|
+
# vegetable entity that can match the types of vegetables available for
|
32
|
+
# purchase with a grocery store agent.
|
33
|
+
#
|
34
|
+
# For more information, see the
|
35
|
+
# [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).
|
27
36
|
# @!attribute [rw] name
|
28
37
|
# @return [::String]
|
29
38
|
# The unique identifier of the entity type.
|
@@ -21,7 +21,24 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Dialogflow
|
23
23
|
module V2
|
24
|
-
#
|
24
|
+
# You can create multiple versions of your agent and publish them to separate
|
25
|
+
# environments.
|
26
|
+
#
|
27
|
+
# When you edit an agent, you are editing the draft agent. At any point, you
|
28
|
+
# can save the draft agent as an agent version, which is an immutable snapshot
|
29
|
+
# of your agent.
|
30
|
+
#
|
31
|
+
# When you save the draft agent, it is published to the default environment.
|
32
|
+
# When you create agent versions, you can publish them to custom environments.
|
33
|
+
# You can create a variety of custom environments for:
|
34
|
+
#
|
35
|
+
# - testing
|
36
|
+
# - development
|
37
|
+
# - production
|
38
|
+
# - etc.
|
39
|
+
#
|
40
|
+
# For more information, see the [versions and environments
|
41
|
+
# guide](https://cloud.google.com/dialogflow/docs/agents-versions).
|
25
42
|
# @!attribute [r] name
|
26
43
|
# @return [::String]
|
27
44
|
# Output only. The unique identifier of this agent environment.
|
@@ -0,0 +1,45 @@
|
|
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
|
+
# Represents a notification sent to Cloud Pub/Sub subscribers for
|
25
|
+
# human agent assistant events in a specific conversation.
|
26
|
+
# @!attribute [rw] conversation
|
27
|
+
# @return [::String]
|
28
|
+
# The conversation this notification refers to.
|
29
|
+
# Format: `projects/<Project ID>/conversations/<Conversation ID>`.
|
30
|
+
# @!attribute [rw] participant
|
31
|
+
# @return [::String]
|
32
|
+
# The participant that the suggestion is compiled for.
|
33
|
+
# Format: `projects/<Project ID>/conversations/<Conversation
|
34
|
+
# ID>/participants/<Participant ID>`. It will not be set in legacy workflow.
|
35
|
+
# @!attribute [rw] suggestion_results
|
36
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::SuggestionResult>]
|
37
|
+
# The suggestion results payload that this notification refers to.
|
38
|
+
class HumanAgentAssistantEvent
|
39
|
+
include ::Google::Protobuf::MessageExts
|
40
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -21,9 +21,15 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Dialogflow
|
23
23
|
module V2
|
24
|
-
#
|
25
|
-
#
|
26
|
-
#
|
24
|
+
# An intent categorizes an end-user's intention for one conversation turn. For
|
25
|
+
# each agent, you define many intents, where your combined intents can handle a
|
26
|
+
# complete conversation. When an end-user writes or says something, referred to
|
27
|
+
# as an end-user expression or end-user input, Dialogflow matches the end-user
|
28
|
+
# input to the best intent in your agent. Matching an intent is also known as
|
29
|
+
# intent classification.
|
30
|
+
#
|
31
|
+
# For more information, see the [intent
|
32
|
+
# guide](https://cloud.google.com/dialogflow/docs/intents-overview).
|
27
33
|
# @!attribute [rw] name
|
28
34
|
# @return [::String]
|
29
35
|
# Optional. The unique identifier of this intent.
|
@@ -55,6 +61,17 @@ module Google
|
|
55
61
|
# Note: If `ml_disabled` setting is set to true, then this intent is not
|
56
62
|
# taken into account during inference in `ML ONLY` match mode. Also,
|
57
63
|
# auto-markup in the UI is turned off.
|
64
|
+
# @!attribute [rw] live_agent_handoff
|
65
|
+
# @return [::Boolean]
|
66
|
+
# Optional. Indicates that a live agent should be brought in to handle the
|
67
|
+
# interaction with the user. In most cases, when you set this flag to true,
|
68
|
+
# you would also want to set end_interaction to true as well. Default is
|
69
|
+
# false.
|
70
|
+
# @!attribute [rw] end_interaction
|
71
|
+
# @return [::Boolean]
|
72
|
+
# Optional. Indicates that this intent ends an interaction. Some integrations
|
73
|
+
# (e.g., Actions on Google or Dialogflow phone gateway) use this information
|
74
|
+
# to close interaction with an end user. Default is false.
|
58
75
|
# @!attribute [rw] input_context_names
|
59
76
|
# @return [::Array<::String>]
|
60
77
|
# Optional. The list of context names required for this intent to be
|
@@ -0,0 +1,139 @@
|
|
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
|
+
# A knowledge base represents a collection of knowledge documents that you
|
25
|
+
# provide to Dialogflow. Your knowledge documents contain information that may
|
26
|
+
# be useful during conversations with end-users. Some Dialogflow features use
|
27
|
+
# knowledge bases when looking for a response to an end-user input.
|
28
|
+
#
|
29
|
+
# For more information, see the [knowledge base
|
30
|
+
# guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
|
31
|
+
#
|
32
|
+
# Note: The `projects.agent.knowledgeBases` resource is deprecated;
|
33
|
+
# only use `projects.knowledgeBases`.
|
34
|
+
# @!attribute [rw] name
|
35
|
+
# @return [::String]
|
36
|
+
# The knowledge base resource name.
|
37
|
+
# The name must be empty when creating a knowledge base.
|
38
|
+
# Format: `projects/<Project ID>/locations/<Location
|
39
|
+
# ID>/knowledgeBases/<Knowledge Base ID>`.
|
40
|
+
# @!attribute [rw] display_name
|
41
|
+
# @return [::String]
|
42
|
+
# Required. The display name of the knowledge base. The name must be 1024
|
43
|
+
# bytes or less; otherwise, the creation request fails.
|
44
|
+
# @!attribute [rw] language_code
|
45
|
+
# @return [::String]
|
46
|
+
# Language which represents the KnowledgeBase. When the KnowledgeBase is
|
47
|
+
# created/updated, expect this to be present for non en-us languages. When
|
48
|
+
# unspecified, the default language code en-us applies.
|
49
|
+
class KnowledgeBase
|
50
|
+
include ::Google::Protobuf::MessageExts
|
51
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
52
|
+
end
|
53
|
+
|
54
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::KnowledgeBases::Client#list_knowledge_bases KnowledgeBases.ListKnowledgeBases}.
|
55
|
+
# @!attribute [rw] parent
|
56
|
+
# @return [::String]
|
57
|
+
# Required. The project to list of knowledge bases for.
|
58
|
+
# Format: `projects/<Project ID>/locations/<Location ID>`.
|
59
|
+
# @!attribute [rw] page_size
|
60
|
+
# @return [::Integer]
|
61
|
+
# The maximum number of items to return in a single page. By
|
62
|
+
# default 10 and at most 100.
|
63
|
+
# @!attribute [rw] page_token
|
64
|
+
# @return [::String]
|
65
|
+
# The next_page_token value returned from a previous list request.
|
66
|
+
class ListKnowledgeBasesRequest
|
67
|
+
include ::Google::Protobuf::MessageExts
|
68
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
69
|
+
end
|
70
|
+
|
71
|
+
# Response message for {::Google::Cloud::Dialogflow::V2::KnowledgeBases::Client#list_knowledge_bases KnowledgeBases.ListKnowledgeBases}.
|
72
|
+
# @!attribute [rw] knowledge_bases
|
73
|
+
# @return [::Array<::Google::Cloud::Dialogflow::V2::KnowledgeBase>]
|
74
|
+
# The list of knowledge bases.
|
75
|
+
# @!attribute [rw] next_page_token
|
76
|
+
# @return [::String]
|
77
|
+
# Token to retrieve the next page of results, or empty if there are no
|
78
|
+
# more results in the list.
|
79
|
+
class ListKnowledgeBasesResponse
|
80
|
+
include ::Google::Protobuf::MessageExts
|
81
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
82
|
+
end
|
83
|
+
|
84
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::KnowledgeBases::Client#get_knowledge_base KnowledgeBases.GetKnowledgeBase}.
|
85
|
+
# @!attribute [rw] name
|
86
|
+
# @return [::String]
|
87
|
+
# Required. The name of the knowledge base to retrieve.
|
88
|
+
# Format `projects/<Project ID>/locations/<Location
|
89
|
+
# ID>/knowledgeBases/<Knowledge Base ID>`.
|
90
|
+
class GetKnowledgeBaseRequest
|
91
|
+
include ::Google::Protobuf::MessageExts
|
92
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
93
|
+
end
|
94
|
+
|
95
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::KnowledgeBases::Client#create_knowledge_base KnowledgeBases.CreateKnowledgeBase}.
|
96
|
+
# @!attribute [rw] parent
|
97
|
+
# @return [::String]
|
98
|
+
# Required. The project to create a knowledge base for.
|
99
|
+
# Format: `projects/<Project ID>/locations/<Location ID>`.
|
100
|
+
# @!attribute [rw] knowledge_base
|
101
|
+
# @return [::Google::Cloud::Dialogflow::V2::KnowledgeBase]
|
102
|
+
# Required. The knowledge base to create.
|
103
|
+
class CreateKnowledgeBaseRequest
|
104
|
+
include ::Google::Protobuf::MessageExts
|
105
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
106
|
+
end
|
107
|
+
|
108
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::KnowledgeBases::Client#delete_knowledge_base KnowledgeBases.DeleteKnowledgeBase}.
|
109
|
+
# @!attribute [rw] name
|
110
|
+
# @return [::String]
|
111
|
+
# Required. The name of the knowledge base to delete.
|
112
|
+
# Format: `projects/<Project ID>/locations/<Location
|
113
|
+
# ID>/knowledgeBases/<Knowledge Base ID>`.
|
114
|
+
# @!attribute [rw] force
|
115
|
+
# @return [::Boolean]
|
116
|
+
# Optional. Force deletes the knowledge base. When set to true, any documents
|
117
|
+
# in the knowledge base are also deleted.
|
118
|
+
class DeleteKnowledgeBaseRequest
|
119
|
+
include ::Google::Protobuf::MessageExts
|
120
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
121
|
+
end
|
122
|
+
|
123
|
+
# Request message for {::Google::Cloud::Dialogflow::V2::KnowledgeBases::Client#update_knowledge_base KnowledgeBases.UpdateKnowledgeBase}.
|
124
|
+
# @!attribute [rw] knowledge_base
|
125
|
+
# @return [::Google::Cloud::Dialogflow::V2::KnowledgeBase]
|
126
|
+
# Required. The knowledge base to update.
|
127
|
+
# @!attribute [rw] update_mask
|
128
|
+
# @return [::Google::Protobuf::FieldMask]
|
129
|
+
# Optional. Not specified means `update all`.
|
130
|
+
# Currently, only `display_name` can be updated, an InvalidArgument will be
|
131
|
+
# returned for attempting to update other fields.
|
132
|
+
class UpdateKnowledgeBaseRequest
|
133
|
+
include ::Google::Protobuf::MessageExts
|
134
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
135
|
+
end
|
136
|
+
end
|
137
|
+
end
|
138
|
+
end
|
139
|
+
end
|