google-cloud-dialogflow-v2 0.11.3 → 0.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/AUTHENTICATION.md +7 -25
  4. data/lib/google/cloud/dialogflow/v2/agents/client.rb +215 -27
  5. data/lib/google/cloud/dialogflow/v2/agents/operations.rb +115 -12
  6. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +46 -6
  7. data/lib/google/cloud/dialogflow/v2/contexts/client.rb +126 -18
  8. data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +4 -0
  9. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +106 -15
  10. data/lib/google/cloud/dialogflow/v2/conversation_profiles/paths.rb +19 -0
  11. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +112 -15
  12. data/lib/google/cloud/dialogflow/v2/document_pb.rb +13 -0
  13. data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +10 -0
  14. data/lib/google/cloud/dialogflow/v2/documents/client.rb +303 -20
  15. data/lib/google/cloud/dialogflow/v2/documents/operations.rb +115 -12
  16. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +242 -30
  17. data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +115 -12
  18. data/lib/google/cloud/dialogflow/v2/environments/client.rb +132 -18
  19. data/lib/google/cloud/dialogflow/v2/fulfillments/client.rb +40 -6
  20. data/lib/google/cloud/dialogflow/v2/gcs_pb.rb +4 -0
  21. data/lib/google/cloud/dialogflow/v2/intents/client.rb +161 -21
  22. data/lib/google/cloud/dialogflow/v2/intents/operations.rb +115 -12
  23. data/lib/google/cloud/dialogflow/v2/knowledge_base_pb.rb +1 -0
  24. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +134 -16
  25. data/lib/google/cloud/dialogflow/v2/participant_pb.rb +9 -0
  26. data/lib/google/cloud/dialogflow/v2/participants/client.rb +155 -24
  27. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +106 -15
  28. data/lib/google/cloud/dialogflow/v2/session_pb.rb +1 -0
  29. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +44 -3
  30. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  31. data/lib/google/cloud/dialogflow/v2/versions/client.rb +106 -15
  32. data/proto_docs/google/api/resource.rb +10 -71
  33. data/proto_docs/google/cloud/dialogflow/v2/agent.rb +4 -3
  34. data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +4 -1
  35. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +28 -8
  36. data/proto_docs/google/cloud/dialogflow/v2/document.rb +53 -0
  37. data/proto_docs/google/cloud/dialogflow/v2/gcs.rb +39 -0
  38. data/proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb +28 -0
  39. data/proto_docs/google/cloud/dialogflow/v2/participant.rb +69 -0
  40. data/proto_docs/google/cloud/dialogflow/v2/session.rb +38 -33
  41. metadata +4 -3
@@ -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.3
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: 2021-10-18 00:00:00.000000000 Z
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.2.17
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