google-cloud-dialogflow-v2 0.11.1 → 0.11.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/v2/agent_pb.rb +2 -2
  4. data/lib/google/cloud/dialogflow/v2/agent_services_pb.rb +39 -5
  5. data/lib/google/cloud/dialogflow/v2/agents/client.rb +252 -31
  6. data/lib/google/cloud/dialogflow/v2/agents/operations.rb +115 -12
  7. data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +2 -2
  8. data/lib/google/cloud/dialogflow/v2/answer_record_services_pb.rb +1 -1
  9. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +46 -6
  10. data/lib/google/cloud/dialogflow/v2/audio_config_pb.rb +3 -2
  11. data/lib/google/cloud/dialogflow/v2/context_pb.rb +2 -2
  12. data/lib/google/cloud/dialogflow/v2/context_services_pb.rb +1 -1
  13. data/lib/google/cloud/dialogflow/v2/contexts/client.rb +126 -18
  14. data/lib/google/cloud/dialogflow/v2/conversation_event_pb.rb +2 -2
  15. data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +2 -2
  16. data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +4 -2
  17. data/lib/google/cloud/dialogflow/v2/conversation_profile_services_pb.rb +1 -1
  18. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +106 -15
  19. data/lib/google/cloud/dialogflow/v2/conversation_profiles/paths.rb +19 -0
  20. data/lib/google/cloud/dialogflow/v2/conversation_services_pb.rb +1 -1
  21. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +112 -15
  22. data/lib/google/cloud/dialogflow/v2/document_pb.rb +2 -2
  23. data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +27 -10
  24. data/lib/google/cloud/dialogflow/v2/documents/client.rb +180 -27
  25. data/lib/google/cloud/dialogflow/v2/documents/operations.rb +115 -12
  26. data/lib/google/cloud/dialogflow/v2/entity_type_pb.rb +2 -2
  27. data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb +45 -1
  28. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +284 -30
  29. data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +115 -12
  30. data/lib/google/cloud/dialogflow/v2/environment_pb.rb +2 -2
  31. data/lib/google/cloud/dialogflow/v2/environment_services_pb.rb +1 -1
  32. data/lib/google/cloud/dialogflow/v2/environments/client.rb +132 -18
  33. data/lib/google/cloud/dialogflow/v2/fulfillment_pb.rb +2 -2
  34. data/lib/google/cloud/dialogflow/v2/fulfillment_services_pb.rb +1 -1
  35. data/lib/google/cloud/dialogflow/v2/fulfillments/client.rb +40 -6
  36. data/lib/google/cloud/dialogflow/v2/gcs_pb.rb +2 -2
  37. data/lib/google/cloud/dialogflow/v2/human_agent_assistant_event_pb.rb +2 -2
  38. data/lib/google/cloud/dialogflow/v2/intent_pb.rb +2 -2
  39. data/lib/google/cloud/dialogflow/v2/intent_services_pb.rb +16 -1
  40. data/lib/google/cloud/dialogflow/v2/intents/client.rb +175 -21
  41. data/lib/google/cloud/dialogflow/v2/intents/operations.rb +115 -12
  42. data/lib/google/cloud/dialogflow/v2/knowledge_base_pb.rb +2 -2
  43. data/lib/google/cloud/dialogflow/v2/knowledge_base_services_pb.rb +1 -1
  44. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +106 -15
  45. data/lib/google/cloud/dialogflow/v2/participant_pb.rb +2 -2
  46. data/lib/google/cloud/dialogflow/v2/participant_services_pb.rb +1 -1
  47. data/lib/google/cloud/dialogflow/v2/participants/client.rb +146 -21
  48. data/lib/google/cloud/dialogflow/v2/session_entity_type_pb.rb +2 -2
  49. data/lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb +1 -1
  50. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +106 -15
  51. data/lib/google/cloud/dialogflow/v2/session_pb.rb +2 -2
  52. data/lib/google/cloud/dialogflow/v2/session_services_pb.rb +15 -1
  53. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +58 -3
  54. data/lib/google/cloud/dialogflow/v2/validation_result_pb.rb +1 -1
  55. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  56. data/lib/google/cloud/dialogflow/v2/version_pb.rb +2 -2
  57. data/lib/google/cloud/dialogflow/v2/version_services_pb.rb +1 -1
  58. data/lib/google/cloud/dialogflow/v2/versions/client.rb +106 -15
  59. data/lib/google/cloud/dialogflow/v2/webhook_pb.rb +2 -2
  60. data/proto_docs/google/cloud/dialogflow/v2/agent.rb +4 -3
  61. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +25 -8
  62. data/proto_docs/google/cloud/dialogflow/v2/session.rb +38 -33
  63. metadata +6 -5
@@ -63,9 +63,21 @@ module Google
63
63
  # Settings for speech transcription.
64
64
  # @!attribute [rw] language_code
65
65
  # @return [::String]
66
- # Language which represents the conversationProfile.
67
- # If unspecified, the default language code en-us applies. Users need to
68
- # create a ConversationProfile for each language they want to support.
66
+ # Language code for the conversation profile. If not specified, the language
67
+ # is en-US. Language at ConversationProfile should be set for all non en-US
68
+ # languages.
69
+ # This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
70
+ # language tag. Example: "en-US".
71
+ # @!attribute [rw] time_zone
72
+ # @return [::String]
73
+ # The time zone of this conversational profile from the
74
+ # [time zone database](https://www.iana.org/time-zones), e.g.,
75
+ # America/New_York, Europe/Paris. Defaults to America/New_York.
76
+ # @!attribute [rw] security_settings
77
+ # @return [::String]
78
+ # Name of the CX SecuritySettings reference for the agent.
79
+ # Format: `projects/<Project ID>/locations/<Location
80
+ # ID>/securitySettings/<Security Settings ID>`.
69
81
  class ConversationProfile
70
82
  include ::Google::Protobuf::MessageExts
71
83
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -162,11 +174,16 @@ module Google
162
174
  # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API
163
175
  # Service Agent` role in this project.
164
176
  #
165
- # Format: `projects/<Project ID>/locations/<Location
177
+ # - For ES agents, use format: `projects/<Project ID>/locations/<Location
166
178
  # ID>/agent/environments/<Environment ID or '-'>`. If environment is not
167
179
  # specified, the default `draft` environment is used. Refer to
168
180
  # [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)
169
181
  # for more details.
182
+ #
183
+ # - For CX agents, use format `projects/<Project ID>/locations/<Location
184
+ # ID>/agents/<Agent ID>/environments/<Environment ID
185
+ # or '-'>`. If environment is not specified, the default `draft` environment
186
+ # is used.
170
187
  class AutomatedAgentConfig
171
188
  include ::Google::Protobuf::MessageExts
172
189
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -289,7 +306,7 @@ module Google
289
306
  # If this field is not set, it defaults to 0.0, which means that all
290
307
  # suggestions are returned.
291
308
  #
292
- # Supported features: ARTICLE_SUGGESTION.
309
+ # Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE.
293
310
  # @!attribute [rw] context_filter_settings
294
311
  # @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings]
295
312
  # Determines how recent conversation context is filtered when generating
@@ -471,13 +488,13 @@ module Google
471
488
 
472
489
  # Format of cloud pub/sub message.
473
490
  module MessageFormat
474
- # If it is unspeified, PROTO will be used.
491
+ # If it is unspecified, PROTO will be used.
475
492
  MESSAGE_FORMAT_UNSPECIFIED = 0
476
493
 
477
- # Pubsub message will be serialized proto.
494
+ # Pub/Sub message will be serialized proto.
478
495
  PROTO = 1
479
496
 
480
- # Pubsub message will be json.
497
+ # Pub/Sub message will be json.
481
498
  JSON = 2
482
499
  end
483
500
  end
@@ -406,10 +406,11 @@ module Google
406
406
  #
407
407
  # Multiple response messages can be returned in order:
408
408
  #
409
- # 1. If the input was set to streaming audio, the first one or more messages
410
- # contain `recognition_result`. Each `recognition_result` represents a more
411
- # complete transcript of what the user said. The last `recognition_result`
412
- # has `is_final` set to `true`.
409
+ # 1. If the `StreamingDetectIntentRequest.input_audio` field was
410
+ # set, the `recognition_result` field is populated for one
411
+ # or more messages.
412
+ # See the {::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult StreamingRecognitionResult} message for details
413
+ # about the result message sequence.
413
414
  #
414
415
  # 2. The next message contains `response_id`, `query_result`
415
416
  # and optionally `webhook_status` if a WebHook was called.
@@ -450,35 +451,39 @@ module Google
450
451
  # that is currently being processed or an indication that this is the end
451
452
  # of the single requested utterance.
452
453
  #
453
- # Example:
454
- #
455
- # 1. transcript: "tube"
456
- #
457
- # 2. transcript: "to be a"
458
- #
459
- # 3. transcript: "to be"
460
- #
461
- # 4. transcript: "to be or not to be"
462
- # is_final: true
463
- #
464
- # 5. transcript: " that's"
465
- #
466
- # 6. transcript: " that is"
467
- #
468
- # 7. message_type: `END_OF_SINGLE_UTTERANCE`
469
- #
470
- # 8. transcript: " that is the question"
471
- # is_final: true
472
- #
473
- # Only two of the responses contain final results (#4 and #8 indicated by
474
- # `is_final: true`). Concatenating these generates the full transcript: "to be
475
- # or not to be that is the question".
476
- #
477
- # In each response we populate:
478
- #
479
- # * for `TRANSCRIPT`: `transcript` and possibly `is_final`.
480
- #
481
- # * for `END_OF_SINGLE_UTTERANCE`: only `message_type`.
454
+ # While end-user audio is being processed, Dialogflow sends a series of
455
+ # results. Each result may contain a `transcript` value. A transcript
456
+ # represents a portion of the utterance. While the recognizer is processing
457
+ # audio, transcript values may be interim values or finalized values.
458
+ # Once a transcript is finalized, the `is_final` value is set to true and
459
+ # processing continues for the next transcript.
460
+ #
461
+ # If `StreamingDetectIntentRequest.query_input.audio_config.single_utterance`
462
+ # was true, and the recognizer has completed processing audio,
463
+ # the `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the
464
+ # following (last) result contains the last finalized transcript.
465
+ #
466
+ # The complete end-user utterance is determined by concatenating the
467
+ # finalized transcript values received for the series of results.
468
+ #
469
+ # In the following example, single utterance is enabled. In the case where
470
+ # single utterance is not enabled, result 7 would not occur.
471
+ #
472
+ # ```
473
+ # Num | transcript | message_type | is_final
474
+ # --- | ----------------------- | ----------------------- | --------
475
+ # 1 | "tube" | TRANSCRIPT | false
476
+ # 2 | "to be a" | TRANSCRIPT | false
477
+ # 3 | "to be" | TRANSCRIPT | false
478
+ # 4 | "to be or not to be" | TRANSCRIPT | true
479
+ # 5 | "that's" | TRANSCRIPT | false
480
+ # 6 | "that is | TRANSCRIPT | false
481
+ # 7 | unset | END_OF_SINGLE_UTTERANCE | unset
482
+ # 8 | " that is the question" | TRANSCRIPT | true
483
+ # ```
484
+ #
485
+ # Concatenating the finalized transcripts with `is_final` set to true,
486
+ # the complete utterance becomes "to be or not to be that is the question".
482
487
  # @!attribute [rw] message_type
483
488
  # @return [::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult::MessageType]
484
489
  # Type of the result message.
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.11.1
4
+ version: 0.11.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-08-11 00:00:00.000000000 Z
11
+ date: 2021-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -160,9 +160,10 @@ description: Dialogflow is an end-to-end, build-once deploy-everywhere developme
160
160
  suite for creating conversational interfaces for websites, mobile applications,
161
161
  popular messaging platforms, and IoT devices. You can use it to build interfaces
162
162
  (such as chatbots and conversational IVR) that enable natural and rich interactions
163
- between your users and your business. Note that google-cloud-dialogflow-v2 is a
164
- version-specific client library. For most uses, we recommend installing the main
165
- client library google-cloud-dialogflow instead. See the readme for more details.
163
+ between your users and your business. This client is for Dialogflow ES, providing
164
+ the standard agent type suitable for small and simple agents. Note that google-cloud-dialogflow-v2
165
+ is a version-specific client library. For most uses, we recommend installing the
166
+ main client library google-cloud-dialogflow instead. See the readme for more details.
166
167
  email: googleapis-packages@google.com
167
168
  executables: []
168
169
  extensions: []