google-apis-dialogflow_v2 0.19.0 → 0.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/OVERVIEW.md +2 -2
- data/lib/google/apis/dialogflow_v2/classes.rb +421 -9
- data/lib/google/apis/dialogflow_v2/gem_version.rb +2 -2
- data/lib/google/apis/dialogflow_v2/representations.rb +186 -0
- data/lib/google/apis/dialogflow_v2/service.rb +332 -90
- data/lib/google/apis/dialogflow_v2.rb +1 -1
- metadata +5 -5
@@ -150,7 +150,12 @@ module Google
|
|
150
150
|
execute_or_queue_command(command, &block)
|
151
151
|
end
|
152
152
|
|
153
|
-
# Exports the specified agent to a ZIP file.
|
153
|
+
# Exports the specified agent to a ZIP file. This method is a [long-running
|
154
|
+
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
|
155
|
+
# operations). The returned `Operation` type has the following method-specific
|
156
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
157
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
|
158
|
+
# ExportAgentResponse
|
154
159
|
# @param [String] parent
|
155
160
|
# Required. The project that the agent to export is associated with. Format: `
|
156
161
|
# projects/`.
|
@@ -257,8 +262,13 @@ module Google
|
|
257
262
|
# the import, the imported draft agent will be trained automatically (unless
|
258
263
|
# disabled in agent settings). However, once the import is done, training may
|
259
264
|
# not be completed yet. Please call TrainAgent and wait for the operation it
|
260
|
-
# returns in order to train explicitly.
|
261
|
-
#
|
265
|
+
# returns in order to train explicitly. This method is a [long-running operation]
|
266
|
+
# (https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
|
267
|
+
# returned `Operation` type has the following method-specific fields: - `
|
268
|
+
# metadata`: An empty [Struct message](https://developers.google.com/protocol-
|
269
|
+
# buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message]
|
270
|
+
# (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
271
|
+
# empty) The operation only tracks when importing is complete, not when it is
|
262
272
|
# done training. Note: You should always train an agent prior to sending it
|
263
273
|
# queries. See the [training documentation](https://cloud.google.com/dialogflow/
|
264
274
|
# es/docs/training).
|
@@ -300,9 +310,14 @@ module Google
|
|
300
310
|
# are deleted. After the restore, the restored draft agent will be trained
|
301
311
|
# automatically (unless disabled in agent settings). However, once the restore
|
302
312
|
# is done, training may not be completed yet. Please call TrainAgent and wait
|
303
|
-
# for the operation it returns in order to train explicitly.
|
304
|
-
#
|
305
|
-
#
|
313
|
+
# for the operation it returns in order to train explicitly. This method is a [
|
314
|
+
# long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
|
315
|
+
# running-operations). The returned `Operation` type has the following method-
|
316
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
317
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
318
|
+
# : An [Empty message](https://developers.google.com/protocol-buffers/docs/
|
319
|
+
# reference/google.protobuf#empty) The operation only tracks when restoring is
|
320
|
+
# complete, not when it is done training. Note: You should always train an agent
|
306
321
|
# prior to sending it queries. See the [training documentation](https://cloud.
|
307
322
|
# google.com/dialogflow/es/docs/training).
|
308
323
|
# @param [String] parent
|
@@ -379,9 +394,14 @@ module Google
|
|
379
394
|
execute_or_queue_command(command, &block)
|
380
395
|
end
|
381
396
|
|
382
|
-
# Trains the specified agent.
|
383
|
-
#
|
384
|
-
#
|
397
|
+
# Trains the specified agent. This method is a [long-running operation](https://
|
398
|
+
# cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned
|
399
|
+
# `Operation` type has the following method-specific fields: - `metadata`: An
|
400
|
+
# empty [Struct message](https://developers.google.com/protocol-buffers/docs/
|
401
|
+
# reference/google.protobuf#struct) - `response`: An [Empty message](https://
|
402
|
+
# developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
|
403
|
+
# Note: You should always train an agent prior to sending it queries. See the [
|
404
|
+
# training documentation](https://cloud.google.com/dialogflow/es/docs/training).
|
385
405
|
# @param [String] parent
|
386
406
|
# Required. The project that the agent to train is associated with. Format: `
|
387
407
|
# projects/`.
|
@@ -454,9 +474,15 @@ module Google
|
|
454
474
|
execute_or_queue_command(command, &block)
|
455
475
|
end
|
456
476
|
|
457
|
-
# Deletes entity types in the specified agent.
|
458
|
-
#
|
459
|
-
#
|
477
|
+
# Deletes entity types in the specified agent. This method is a [long-running
|
478
|
+
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
|
479
|
+
# operations). The returned `Operation` type has the following method-specific
|
480
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
481
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
|
482
|
+
# Empty message](https://developers.google.com/protocol-buffers/docs/reference/
|
483
|
+
# google.protobuf#empty) Note: You should always train an agent prior to sending
|
484
|
+
# it queries. See the [training documentation](https://cloud.google.com/
|
485
|
+
# dialogflow/es/docs/training).
|
460
486
|
# @param [String] parent
|
461
487
|
# Required. The name of the agent to delete all entities types for. Format: `
|
462
488
|
# projects//agent`.
|
@@ -490,9 +516,14 @@ module Google
|
|
490
516
|
execute_or_queue_command(command, &block)
|
491
517
|
end
|
492
518
|
|
493
|
-
# Updates/Creates multiple entity types in the specified agent.
|
494
|
-
#
|
495
|
-
#
|
519
|
+
# Updates/Creates multiple entity types in the specified agent. This method is a
|
520
|
+
# [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
|
521
|
+
# running-operations). The returned `Operation` type has the following method-
|
522
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
523
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
524
|
+
# : BatchUpdateEntityTypesResponse Note: You should always train an agent prior
|
525
|
+
# to sending it queries. See the [training documentation](https://cloud.google.
|
526
|
+
# com/dialogflow/es/docs/training).
|
496
527
|
# @param [String] parent
|
497
528
|
# Required. The name of the agent to update or create entity types in. Format: `
|
498
529
|
# projects//agent`.
|
@@ -725,9 +756,15 @@ module Google
|
|
725
756
|
execute_or_queue_command(command, &block)
|
726
757
|
end
|
727
758
|
|
728
|
-
# Creates multiple new entities in the specified entity type.
|
729
|
-
#
|
730
|
-
#
|
759
|
+
# Creates multiple new entities in the specified entity type. This method is a [
|
760
|
+
# long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
|
761
|
+
# running-operations). The returned `Operation` type has the following method-
|
762
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
763
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
764
|
+
# : An [Empty message](https://developers.google.com/protocol-buffers/docs/
|
765
|
+
# reference/google.protobuf#empty) Note: You should always train an agent prior
|
766
|
+
# to sending it queries. See the [training documentation](https://cloud.google.
|
767
|
+
# com/dialogflow/es/docs/training).
|
731
768
|
# @param [String] parent
|
732
769
|
# Required. The name of the entity type to create entities in. Format: `projects/
|
733
770
|
# /agent/entityTypes/`.
|
@@ -761,9 +798,15 @@ module Google
|
|
761
798
|
execute_or_queue_command(command, &block)
|
762
799
|
end
|
763
800
|
|
764
|
-
# Deletes entities in the specified entity type.
|
765
|
-
#
|
766
|
-
#
|
801
|
+
# Deletes entities in the specified entity type. This method is a [long-running
|
802
|
+
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
|
803
|
+
# operations). The returned `Operation` type has the following method-specific
|
804
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
805
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
|
806
|
+
# Empty message](https://developers.google.com/protocol-buffers/docs/reference/
|
807
|
+
# google.protobuf#empty) Note: You should always train an agent prior to sending
|
808
|
+
# it queries. See the [training documentation](https://cloud.google.com/
|
809
|
+
# dialogflow/es/docs/training).
|
767
810
|
# @param [String] parent
|
768
811
|
# Required. The name of the entity type to delete entries for. Format: `projects/
|
769
812
|
# /agent/entityTypes/`.
|
@@ -799,9 +842,14 @@ module Google
|
|
799
842
|
|
800
843
|
# Updates or creates multiple entities in the specified entity type. This method
|
801
844
|
# does not affect entities in the entity type that aren't explicitly specified
|
802
|
-
# in the request.
|
803
|
-
#
|
804
|
-
#
|
845
|
+
# in the request. This method is a [long-running operation](https://cloud.google.
|
846
|
+
# com/dialogflow/es/docs/how/long-running-operations). The returned `Operation`
|
847
|
+
# type has the following method-specific fields: - `metadata`: An empty [Struct
|
848
|
+
# message](https://developers.google.com/protocol-buffers/docs/reference/google.
|
849
|
+
# protobuf#struct) - `response`: An [Empty message](https://developers.google.
|
850
|
+
# com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should
|
851
|
+
# always train an agent prior to sending it queries. See the [training
|
852
|
+
# documentation](https://cloud.google.com/dialogflow/es/docs/training).
|
805
853
|
# @param [String] parent
|
806
854
|
# Required. The name of the entity type to update or create entities in. Format:
|
807
855
|
# `projects//agent/entityTypes/`.
|
@@ -1152,9 +1200,12 @@ module Google
|
|
1152
1200
|
# Processes a natural language query and returns structured, actionable data as
|
1153
1201
|
# a result. This method is not idempotent, because it may cause contexts and
|
1154
1202
|
# session entity types to be updated, which in turn might affect results of
|
1155
|
-
# future queries.
|
1156
|
-
#
|
1157
|
-
#
|
1203
|
+
# future queries. If you might use [Agent Assist](https://cloud.google.com/
|
1204
|
+
# dialogflow/docs/#aa) or other CCAI products now or in the future, consider
|
1205
|
+
# using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has
|
1206
|
+
# additional functionality for Agent Assist and other CCAI products. Note:
|
1207
|
+
# Always use agent versions for production traffic. See [Versions and
|
1208
|
+
# environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
|
1158
1209
|
# @param [String] session
|
1159
1210
|
# Required. The name of the session this query is sent to. Format: `projects//
|
1160
1211
|
# agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `
|
@@ -1579,9 +1630,15 @@ module Google
|
|
1579
1630
|
execute_or_queue_command(command, &block)
|
1580
1631
|
end
|
1581
1632
|
|
1582
|
-
# Deletes intents in the specified agent.
|
1583
|
-
#
|
1584
|
-
#
|
1633
|
+
# Deletes intents in the specified agent. This method is a [long-running
|
1634
|
+
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
|
1635
|
+
# operations). The returned `Operation` type has the following method-specific
|
1636
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
1637
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
|
1638
|
+
# Empty message](https://developers.google.com/protocol-buffers/docs/reference/
|
1639
|
+
# google.protobuf#empty) Note: You should always train an agent prior to sending
|
1640
|
+
# it queries. See the [training documentation](https://cloud.google.com/
|
1641
|
+
# dialogflow/es/docs/training).
|
1585
1642
|
# @param [String] parent
|
1586
1643
|
# Required. The name of the agent to delete all entities types for. Format: `
|
1587
1644
|
# projects//agent`.
|
@@ -1615,9 +1672,14 @@ module Google
|
|
1615
1672
|
execute_or_queue_command(command, &block)
|
1616
1673
|
end
|
1617
1674
|
|
1618
|
-
# Updates/Creates multiple intents in the specified agent.
|
1619
|
-
#
|
1620
|
-
#
|
1675
|
+
# Updates/Creates multiple intents in the specified agent. This method is a [
|
1676
|
+
# long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
|
1677
|
+
# running-operations). The returned `Operation` type has the following method-
|
1678
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
1679
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
1680
|
+
# : BatchUpdateIntentsResponse Note: You should always train an agent prior to
|
1681
|
+
# sending it queries. See the [training documentation](https://cloud.google.com/
|
1682
|
+
# dialogflow/es/docs/training).
|
1621
1683
|
# @param [String] parent
|
1622
1684
|
# Required. The name of the agent to update or create intents in. Format: `
|
1623
1685
|
# projects//agent`.
|
@@ -2044,7 +2106,10 @@ module Google
|
|
2044
2106
|
execute_or_queue_command(command, &block)
|
2045
2107
|
end
|
2046
2108
|
|
2047
|
-
# Creates a new document.
|
2109
|
+
# Creates a new document. This method is a [long-running operation](https://
|
2110
|
+
# cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
|
2111
|
+
# Operation` type has the following method-specific fields: - `metadata`:
|
2112
|
+
# KnowledgeOperationMetadata - `response`: Document
|
2048
2113
|
# @param [String] parent
|
2049
2114
|
# Required. The knowledge base to create a document for. Format: `projects//
|
2050
2115
|
# locations//knowledgeBases/`.
|
@@ -2078,7 +2143,11 @@ module Google
|
|
2078
2143
|
execute_or_queue_command(command, &block)
|
2079
2144
|
end
|
2080
2145
|
|
2081
|
-
# Deletes the specified document.
|
2146
|
+
# Deletes the specified document. This method is a [long-running operation](
|
2147
|
+
# https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
2148
|
+
# returned `Operation` type has the following method-specific fields: - `
|
2149
|
+
# metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
|
2150
|
+
# developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
|
2082
2151
|
# @param [String] name
|
2083
2152
|
# Required. The name of the document to delete. Format: `projects//locations//
|
2084
2153
|
# knowledgeBases//documents/`.
|
@@ -2178,7 +2247,10 @@ module Google
|
|
2178
2247
|
execute_or_queue_command(command, &block)
|
2179
2248
|
end
|
2180
2249
|
|
2181
|
-
# Updates the specified document.
|
2250
|
+
# Updates the specified document. This method is a [long-running operation](
|
2251
|
+
# https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
2252
|
+
# returned `Operation` type has the following method-specific fields: - `
|
2253
|
+
# metadata`: KnowledgeOperationMetadata - `response`: Document
|
2182
2254
|
# @param [String] name
|
2183
2255
|
# Optional. The document resource name. The name must be empty when creating a
|
2184
2256
|
# document. Format: `projects//locations//knowledgeBases//documents/`.
|
@@ -2220,9 +2292,12 @@ module Google
|
|
2220
2292
|
# Reloads the specified document from its specified source, content_uri or
|
2221
2293
|
# content. The previously loaded content of the document will be deleted. Note:
|
2222
2294
|
# Even when the content of the document has not changed, there still may be side
|
2223
|
-
# effects because of internal implementation changes.
|
2224
|
-
#
|
2225
|
-
#
|
2295
|
+
# effects because of internal implementation changes. This method is a [long-
|
2296
|
+
# running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
|
2297
|
+
# running-operation). The returned `Operation` type has the following method-
|
2298
|
+
# specific fields: - `metadata`: KnowledgeOperationMetadata - `response`:
|
2299
|
+
# Document Note: The `projects.agent.knowledgeBases.documents` resource is
|
2300
|
+
# deprecated; only use `projects.knowledgeBases.documents`.
|
2226
2301
|
# @param [String] name
|
2227
2302
|
# Required. The name of the document to reload. Format: `projects//locations//
|
2228
2303
|
# knowledgeBases//documents/`
|
@@ -2292,9 +2367,12 @@ module Google
|
|
2292
2367
|
# Processes a natural language query and returns structured, actionable data as
|
2293
2368
|
# a result. This method is not idempotent, because it may cause contexts and
|
2294
2369
|
# session entity types to be updated, which in turn might affect results of
|
2295
|
-
# future queries.
|
2296
|
-
#
|
2297
|
-
#
|
2370
|
+
# future queries. If you might use [Agent Assist](https://cloud.google.com/
|
2371
|
+
# dialogflow/docs/#aa) or other CCAI products now or in the future, consider
|
2372
|
+
# using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has
|
2373
|
+
# additional functionality for Agent Assist and other CCAI products. Note:
|
2374
|
+
# Always use agent versions for production traffic. See [Versions and
|
2375
|
+
# environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
|
2298
2376
|
# @param [String] session
|
2299
2377
|
# Required. The name of the session this query is sent to. Format: `projects//
|
2300
2378
|
# agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `
|
@@ -3792,7 +3870,10 @@ module Google
|
|
3792
3870
|
execute_or_queue_command(command, &block)
|
3793
3871
|
end
|
3794
3872
|
|
3795
|
-
# Creates a new document.
|
3873
|
+
# Creates a new document. This method is a [long-running operation](https://
|
3874
|
+
# cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
|
3875
|
+
# Operation` type has the following method-specific fields: - `metadata`:
|
3876
|
+
# KnowledgeOperationMetadata - `response`: Document
|
3796
3877
|
# @param [String] parent
|
3797
3878
|
# Required. The knowledge base to create a document for. Format: `projects//
|
3798
3879
|
# locations//knowledgeBases/`.
|
@@ -3826,7 +3907,11 @@ module Google
|
|
3826
3907
|
execute_or_queue_command(command, &block)
|
3827
3908
|
end
|
3828
3909
|
|
3829
|
-
# Deletes the specified document.
|
3910
|
+
# Deletes the specified document. This method is a [long-running operation](
|
3911
|
+
# https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
3912
|
+
# returned `Operation` type has the following method-specific fields: - `
|
3913
|
+
# metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
|
3914
|
+
# developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
|
3830
3915
|
# @param [String] name
|
3831
3916
|
# Required. The name of the document to delete. Format: `projects//locations//
|
3832
3917
|
# knowledgeBases//documents/`.
|
@@ -3926,7 +4011,10 @@ module Google
|
|
3926
4011
|
execute_or_queue_command(command, &block)
|
3927
4012
|
end
|
3928
4013
|
|
3929
|
-
# Updates the specified document.
|
4014
|
+
# Updates the specified document. This method is a [long-running operation](
|
4015
|
+
# https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
4016
|
+
# returned `Operation` type has the following method-specific fields: - `
|
4017
|
+
# metadata`: KnowledgeOperationMetadata - `response`: Document
|
3930
4018
|
# @param [String] name
|
3931
4019
|
# Optional. The document resource name. The name must be empty when creating a
|
3932
4020
|
# document. Format: `projects//locations//knowledgeBases//documents/`.
|
@@ -3968,9 +4056,12 @@ module Google
|
|
3968
4056
|
# Reloads the specified document from its specified source, content_uri or
|
3969
4057
|
# content. The previously loaded content of the document will be deleted. Note:
|
3970
4058
|
# Even when the content of the document has not changed, there still may be side
|
3971
|
-
# effects because of internal implementation changes.
|
3972
|
-
#
|
3973
|
-
#
|
4059
|
+
# effects because of internal implementation changes. This method is a [long-
|
4060
|
+
# running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
|
4061
|
+
# running-operation). The returned `Operation` type has the following method-
|
4062
|
+
# specific fields: - `metadata`: KnowledgeOperationMetadata - `response`:
|
4063
|
+
# Document Note: The `projects.agent.knowledgeBases.documents` resource is
|
4064
|
+
# deprecated; only use `projects.knowledgeBases.documents`.
|
3974
4065
|
# @param [String] name
|
3975
4066
|
# Required. The name of the document to reload. Format: `projects//locations//
|
3976
4067
|
# knowledgeBases//documents/`
|
@@ -4035,6 +4126,36 @@ module Google
|
|
4035
4126
|
execute_or_queue_command(command, &block)
|
4036
4127
|
end
|
4037
4128
|
|
4129
|
+
# Gets information about a location.
|
4130
|
+
# @param [String] name
|
4131
|
+
# Resource name for the location.
|
4132
|
+
# @param [String] fields
|
4133
|
+
# Selector specifying which fields to include in a partial response.
|
4134
|
+
# @param [String] quota_user
|
4135
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4136
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4137
|
+
# @param [Google::Apis::RequestOptions] options
|
4138
|
+
# Request-specific options
|
4139
|
+
#
|
4140
|
+
# @yield [result, err] Result & error if block supplied
|
4141
|
+
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudLocationLocation] parsed result object
|
4142
|
+
# @yieldparam err [StandardError] error object if request failed
|
4143
|
+
#
|
4144
|
+
# @return [Google::Apis::DialogflowV2::GoogleCloudLocationLocation]
|
4145
|
+
#
|
4146
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4147
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4148
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4149
|
+
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
|
4150
|
+
command = make_simple_command(:get, 'v2/{+name}', options)
|
4151
|
+
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudLocationLocation::Representation
|
4152
|
+
command.response_class = Google::Apis::DialogflowV2::GoogleCloudLocationLocation
|
4153
|
+
command.params['name'] = name unless name.nil?
|
4154
|
+
command.query['fields'] = fields unless fields.nil?
|
4155
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4156
|
+
execute_or_queue_command(command, &block)
|
4157
|
+
end
|
4158
|
+
|
4038
4159
|
# Retrieves the specified agent.
|
4039
4160
|
# @param [String] parent
|
4040
4161
|
# Required. The project that the agent to fetch is associated with. Format: `
|
@@ -4066,6 +4187,49 @@ module Google
|
|
4066
4187
|
execute_or_queue_command(command, &block)
|
4067
4188
|
end
|
4068
4189
|
|
4190
|
+
# Lists information about the supported locations for this service.
|
4191
|
+
# @param [String] name
|
4192
|
+
# The resource that owns the locations collection, if applicable.
|
4193
|
+
# @param [String] filter
|
4194
|
+
# A filter to narrow down results to a preferred subset. The filtering language
|
4195
|
+
# accepts strings like "displayName=tokyo", and is documented in more detail in [
|
4196
|
+
# AIP-160](https://google.aip.dev/160).
|
4197
|
+
# @param [Fixnum] page_size
|
4198
|
+
# The maximum number of results to return. If not set, the service selects a
|
4199
|
+
# default.
|
4200
|
+
# @param [String] page_token
|
4201
|
+
# A page token received from the `next_page_token` field in the response. Send
|
4202
|
+
# that page token to receive the subsequent page.
|
4203
|
+
# @param [String] fields
|
4204
|
+
# Selector specifying which fields to include in a partial response.
|
4205
|
+
# @param [String] quota_user
|
4206
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4207
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4208
|
+
# @param [Google::Apis::RequestOptions] options
|
4209
|
+
# Request-specific options
|
4210
|
+
#
|
4211
|
+
# @yield [result, err] Result & error if block supplied
|
4212
|
+
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudLocationListLocationsResponse] parsed result object
|
4213
|
+
# @yieldparam err [StandardError] error object if request failed
|
4214
|
+
#
|
4215
|
+
# @return [Google::Apis::DialogflowV2::GoogleCloudLocationListLocationsResponse]
|
4216
|
+
#
|
4217
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4218
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4219
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4220
|
+
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4221
|
+
command = make_simple_command(:get, 'v2/{+name}/locations', options)
|
4222
|
+
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudLocationListLocationsResponse::Representation
|
4223
|
+
command.response_class = Google::Apis::DialogflowV2::GoogleCloudLocationListLocationsResponse
|
4224
|
+
command.params['name'] = name unless name.nil?
|
4225
|
+
command.query['filter'] = filter unless filter.nil?
|
4226
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
4227
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
4228
|
+
command.query['fields'] = fields unless fields.nil?
|
4229
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4230
|
+
execute_or_queue_command(command, &block)
|
4231
|
+
end
|
4232
|
+
|
4069
4233
|
# Creates/updates the specified agent. Note: You should always train an agent
|
4070
4234
|
# prior to sending it queries. See the [training documentation](https://cloud.
|
4071
4235
|
# google.com/dialogflow/es/docs/training).
|
@@ -4104,7 +4268,12 @@ module Google
|
|
4104
4268
|
execute_or_queue_command(command, &block)
|
4105
4269
|
end
|
4106
4270
|
|
4107
|
-
# Exports the specified agent to a ZIP file.
|
4271
|
+
# Exports the specified agent to a ZIP file. This method is a [long-running
|
4272
|
+
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
|
4273
|
+
# operations). The returned `Operation` type has the following method-specific
|
4274
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
4275
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
|
4276
|
+
# ExportAgentResponse
|
4108
4277
|
# @param [String] parent
|
4109
4278
|
# Required. The project that the agent to export is associated with. Format: `
|
4110
4279
|
# projects/`.
|
@@ -4211,8 +4380,13 @@ module Google
|
|
4211
4380
|
# the import, the imported draft agent will be trained automatically (unless
|
4212
4381
|
# disabled in agent settings). However, once the import is done, training may
|
4213
4382
|
# not be completed yet. Please call TrainAgent and wait for the operation it
|
4214
|
-
# returns in order to train explicitly.
|
4215
|
-
#
|
4383
|
+
# returns in order to train explicitly. This method is a [long-running operation]
|
4384
|
+
# (https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
|
4385
|
+
# returned `Operation` type has the following method-specific fields: - `
|
4386
|
+
# metadata`: An empty [Struct message](https://developers.google.com/protocol-
|
4387
|
+
# buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message]
|
4388
|
+
# (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
4389
|
+
# empty) The operation only tracks when importing is complete, not when it is
|
4216
4390
|
# done training. Note: You should always train an agent prior to sending it
|
4217
4391
|
# queries. See the [training documentation](https://cloud.google.com/dialogflow/
|
4218
4392
|
# es/docs/training).
|
@@ -4254,9 +4428,14 @@ module Google
|
|
4254
4428
|
# are deleted. After the restore, the restored draft agent will be trained
|
4255
4429
|
# automatically (unless disabled in agent settings). However, once the restore
|
4256
4430
|
# is done, training may not be completed yet. Please call TrainAgent and wait
|
4257
|
-
# for the operation it returns in order to train explicitly.
|
4258
|
-
#
|
4259
|
-
#
|
4431
|
+
# for the operation it returns in order to train explicitly. This method is a [
|
4432
|
+
# long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
|
4433
|
+
# running-operations). The returned `Operation` type has the following method-
|
4434
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
4435
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
4436
|
+
# : An [Empty message](https://developers.google.com/protocol-buffers/docs/
|
4437
|
+
# reference/google.protobuf#empty) The operation only tracks when restoring is
|
4438
|
+
# complete, not when it is done training. Note: You should always train an agent
|
4260
4439
|
# prior to sending it queries. See the [training documentation](https://cloud.
|
4261
4440
|
# google.com/dialogflow/es/docs/training).
|
4262
4441
|
# @param [String] parent
|
@@ -4333,9 +4512,14 @@ module Google
|
|
4333
4512
|
execute_or_queue_command(command, &block)
|
4334
4513
|
end
|
4335
4514
|
|
4336
|
-
# Trains the specified agent.
|
4337
|
-
#
|
4338
|
-
#
|
4515
|
+
# Trains the specified agent. This method is a [long-running operation](https://
|
4516
|
+
# cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned
|
4517
|
+
# `Operation` type has the following method-specific fields: - `metadata`: An
|
4518
|
+
# empty [Struct message](https://developers.google.com/protocol-buffers/docs/
|
4519
|
+
# reference/google.protobuf#struct) - `response`: An [Empty message](https://
|
4520
|
+
# developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
|
4521
|
+
# Note: You should always train an agent prior to sending it queries. See the [
|
4522
|
+
# training documentation](https://cloud.google.com/dialogflow/es/docs/training).
|
4339
4523
|
# @param [String] parent
|
4340
4524
|
# Required. The project that the agent to train is associated with. Format: `
|
4341
4525
|
# projects/`.
|
@@ -4408,9 +4592,15 @@ module Google
|
|
4408
4592
|
execute_or_queue_command(command, &block)
|
4409
4593
|
end
|
4410
4594
|
|
4411
|
-
# Deletes entity types in the specified agent.
|
4412
|
-
#
|
4413
|
-
#
|
4595
|
+
# Deletes entity types in the specified agent. This method is a [long-running
|
4596
|
+
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
|
4597
|
+
# operations). The returned `Operation` type has the following method-specific
|
4598
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
4599
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
|
4600
|
+
# Empty message](https://developers.google.com/protocol-buffers/docs/reference/
|
4601
|
+
# google.protobuf#empty) Note: You should always train an agent prior to sending
|
4602
|
+
# it queries. See the [training documentation](https://cloud.google.com/
|
4603
|
+
# dialogflow/es/docs/training).
|
4414
4604
|
# @param [String] parent
|
4415
4605
|
# Required. The name of the agent to delete all entities types for. Format: `
|
4416
4606
|
# projects//agent`.
|
@@ -4444,9 +4634,14 @@ module Google
|
|
4444
4634
|
execute_or_queue_command(command, &block)
|
4445
4635
|
end
|
4446
4636
|
|
4447
|
-
# Updates/Creates multiple entity types in the specified agent.
|
4448
|
-
#
|
4449
|
-
#
|
4637
|
+
# Updates/Creates multiple entity types in the specified agent. This method is a
|
4638
|
+
# [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
|
4639
|
+
# running-operations). The returned `Operation` type has the following method-
|
4640
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
4641
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
4642
|
+
# : BatchUpdateEntityTypesResponse Note: You should always train an agent prior
|
4643
|
+
# to sending it queries. See the [training documentation](https://cloud.google.
|
4644
|
+
# com/dialogflow/es/docs/training).
|
4450
4645
|
# @param [String] parent
|
4451
4646
|
# Required. The name of the agent to update or create entity types in. Format: `
|
4452
4647
|
# projects//agent`.
|
@@ -4679,9 +4874,15 @@ module Google
|
|
4679
4874
|
execute_or_queue_command(command, &block)
|
4680
4875
|
end
|
4681
4876
|
|
4682
|
-
# Creates multiple new entities in the specified entity type.
|
4683
|
-
#
|
4684
|
-
#
|
4877
|
+
# Creates multiple new entities in the specified entity type. This method is a [
|
4878
|
+
# long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
|
4879
|
+
# running-operations). The returned `Operation` type has the following method-
|
4880
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
4881
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
4882
|
+
# : An [Empty message](https://developers.google.com/protocol-buffers/docs/
|
4883
|
+
# reference/google.protobuf#empty) Note: You should always train an agent prior
|
4884
|
+
# to sending it queries. See the [training documentation](https://cloud.google.
|
4885
|
+
# com/dialogflow/es/docs/training).
|
4685
4886
|
# @param [String] parent
|
4686
4887
|
# Required. The name of the entity type to create entities in. Format: `projects/
|
4687
4888
|
# /agent/entityTypes/`.
|
@@ -4715,9 +4916,15 @@ module Google
|
|
4715
4916
|
execute_or_queue_command(command, &block)
|
4716
4917
|
end
|
4717
4918
|
|
4718
|
-
# Deletes entities in the specified entity type.
|
4719
|
-
#
|
4720
|
-
#
|
4919
|
+
# Deletes entities in the specified entity type. This method is a [long-running
|
4920
|
+
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
|
4921
|
+
# operations). The returned `Operation` type has the following method-specific
|
4922
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
4923
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
|
4924
|
+
# Empty message](https://developers.google.com/protocol-buffers/docs/reference/
|
4925
|
+
# google.protobuf#empty) Note: You should always train an agent prior to sending
|
4926
|
+
# it queries. See the [training documentation](https://cloud.google.com/
|
4927
|
+
# dialogflow/es/docs/training).
|
4721
4928
|
# @param [String] parent
|
4722
4929
|
# Required. The name of the entity type to delete entries for. Format: `projects/
|
4723
4930
|
# /agent/entityTypes/`.
|
@@ -4753,9 +4960,14 @@ module Google
|
|
4753
4960
|
|
4754
4961
|
# Updates or creates multiple entities in the specified entity type. This method
|
4755
4962
|
# does not affect entities in the entity type that aren't explicitly specified
|
4756
|
-
# in the request.
|
4757
|
-
#
|
4758
|
-
#
|
4963
|
+
# in the request. This method is a [long-running operation](https://cloud.google.
|
4964
|
+
# com/dialogflow/es/docs/how/long-running-operations). The returned `Operation`
|
4965
|
+
# type has the following method-specific fields: - `metadata`: An empty [Struct
|
4966
|
+
# message](https://developers.google.com/protocol-buffers/docs/reference/google.
|
4967
|
+
# protobuf#struct) - `response`: An [Empty message](https://developers.google.
|
4968
|
+
# com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should
|
4969
|
+
# always train an agent prior to sending it queries. See the [training
|
4970
|
+
# documentation](https://cloud.google.com/dialogflow/es/docs/training).
|
4759
4971
|
# @param [String] parent
|
4760
4972
|
# Required. The name of the entity type to update or create entities in. Format:
|
4761
4973
|
# `projects//agent/entityTypes/`.
|
@@ -5106,9 +5318,12 @@ module Google
|
|
5106
5318
|
# Processes a natural language query and returns structured, actionable data as
|
5107
5319
|
# a result. This method is not idempotent, because it may cause contexts and
|
5108
5320
|
# session entity types to be updated, which in turn might affect results of
|
5109
|
-
# future queries.
|
5110
|
-
#
|
5111
|
-
#
|
5321
|
+
# future queries. If you might use [Agent Assist](https://cloud.google.com/
|
5322
|
+
# dialogflow/docs/#aa) or other CCAI products now or in the future, consider
|
5323
|
+
# using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has
|
5324
|
+
# additional functionality for Agent Assist and other CCAI products. Note:
|
5325
|
+
# Always use agent versions for production traffic. See [Versions and
|
5326
|
+
# environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
|
5112
5327
|
# @param [String] session
|
5113
5328
|
# Required. The name of the session this query is sent to. Format: `projects//
|
5114
5329
|
# agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `
|
@@ -5533,9 +5748,15 @@ module Google
|
|
5533
5748
|
execute_or_queue_command(command, &block)
|
5534
5749
|
end
|
5535
5750
|
|
5536
|
-
# Deletes intents in the specified agent.
|
5537
|
-
#
|
5538
|
-
#
|
5751
|
+
# Deletes intents in the specified agent. This method is a [long-running
|
5752
|
+
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-
|
5753
|
+
# operations). The returned `Operation` type has the following method-specific
|
5754
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
5755
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [
|
5756
|
+
# Empty message](https://developers.google.com/protocol-buffers/docs/reference/
|
5757
|
+
# google.protobuf#empty) Note: You should always train an agent prior to sending
|
5758
|
+
# it queries. See the [training documentation](https://cloud.google.com/
|
5759
|
+
# dialogflow/es/docs/training).
|
5539
5760
|
# @param [String] parent
|
5540
5761
|
# Required. The name of the agent to delete all entities types for. Format: `
|
5541
5762
|
# projects//agent`.
|
@@ -5569,9 +5790,14 @@ module Google
|
|
5569
5790
|
execute_or_queue_command(command, &block)
|
5570
5791
|
end
|
5571
5792
|
|
5572
|
-
# Updates/Creates multiple intents in the specified agent.
|
5573
|
-
#
|
5574
|
-
#
|
5793
|
+
# Updates/Creates multiple intents in the specified agent. This method is a [
|
5794
|
+
# long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-
|
5795
|
+
# running-operations). The returned `Operation` type has the following method-
|
5796
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
5797
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
5798
|
+
# : BatchUpdateIntentsResponse Note: You should always train an agent prior to
|
5799
|
+
# sending it queries. See the [training documentation](https://cloud.google.com/
|
5800
|
+
# dialogflow/es/docs/training).
|
5575
5801
|
# @param [String] parent
|
5576
5802
|
# Required. The name of the agent to update or create intents in. Format: `
|
5577
5803
|
# projects//agent`.
|
@@ -5857,9 +6083,12 @@ module Google
|
|
5857
6083
|
# Processes a natural language query and returns structured, actionable data as
|
5858
6084
|
# a result. This method is not idempotent, because it may cause contexts and
|
5859
6085
|
# session entity types to be updated, which in turn might affect results of
|
5860
|
-
# future queries.
|
5861
|
-
#
|
5862
|
-
#
|
6086
|
+
# future queries. If you might use [Agent Assist](https://cloud.google.com/
|
6087
|
+
# dialogflow/docs/#aa) or other CCAI products now or in the future, consider
|
6088
|
+
# using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has
|
6089
|
+
# additional functionality for Agent Assist and other CCAI products. Note:
|
6090
|
+
# Always use agent versions for production traffic. See [Versions and
|
6091
|
+
# environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
|
5863
6092
|
# @param [String] session
|
5864
6093
|
# Required. The name of the session this query is sent to. Format: `projects//
|
5865
6094
|
# agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `
|
@@ -7357,7 +7586,10 @@ module Google
|
|
7357
7586
|
execute_or_queue_command(command, &block)
|
7358
7587
|
end
|
7359
7588
|
|
7360
|
-
# Creates a new document.
|
7589
|
+
# Creates a new document. This method is a [long-running operation](https://
|
7590
|
+
# cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
|
7591
|
+
# Operation` type has the following method-specific fields: - `metadata`:
|
7592
|
+
# KnowledgeOperationMetadata - `response`: Document
|
7361
7593
|
# @param [String] parent
|
7362
7594
|
# Required. The knowledge base to create a document for. Format: `projects//
|
7363
7595
|
# locations//knowledgeBases/`.
|
@@ -7391,7 +7623,11 @@ module Google
|
|
7391
7623
|
execute_or_queue_command(command, &block)
|
7392
7624
|
end
|
7393
7625
|
|
7394
|
-
# Deletes the specified document.
|
7626
|
+
# Deletes the specified document. This method is a [long-running operation](
|
7627
|
+
# https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
7628
|
+
# returned `Operation` type has the following method-specific fields: - `
|
7629
|
+
# metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://
|
7630
|
+
# developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
|
7395
7631
|
# @param [String] name
|
7396
7632
|
# Required. The name of the document to delete. Format: `projects//locations//
|
7397
7633
|
# knowledgeBases//documents/`.
|
@@ -7491,7 +7727,10 @@ module Google
|
|
7491
7727
|
execute_or_queue_command(command, &block)
|
7492
7728
|
end
|
7493
7729
|
|
7494
|
-
# Updates the specified document.
|
7730
|
+
# Updates the specified document. This method is a [long-running operation](
|
7731
|
+
# https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
7732
|
+
# returned `Operation` type has the following method-specific fields: - `
|
7733
|
+
# metadata`: KnowledgeOperationMetadata - `response`: Document
|
7495
7734
|
# @param [String] name
|
7496
7735
|
# Optional. The document resource name. The name must be empty when creating a
|
7497
7736
|
# document. Format: `projects//locations//knowledgeBases//documents/`.
|
@@ -7533,9 +7772,12 @@ module Google
|
|
7533
7772
|
# Reloads the specified document from its specified source, content_uri or
|
7534
7773
|
# content. The previously loaded content of the document will be deleted. Note:
|
7535
7774
|
# Even when the content of the document has not changed, there still may be side
|
7536
|
-
# effects because of internal implementation changes.
|
7537
|
-
#
|
7538
|
-
#
|
7775
|
+
# effects because of internal implementation changes. This method is a [long-
|
7776
|
+
# running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
|
7777
|
+
# running-operation). The returned `Operation` type has the following method-
|
7778
|
+
# specific fields: - `metadata`: KnowledgeOperationMetadata - `response`:
|
7779
|
+
# Document Note: The `projects.agent.knowledgeBases.documents` resource is
|
7780
|
+
# deprecated; only use `projects.knowledgeBases.documents`.
|
7539
7781
|
# @param [String] name
|
7540
7782
|
# Required. The name of the document to reload. Format: `projects//locations//
|
7541
7783
|
# knowledgeBases//documents/`
|