google-cloud-dialogflow 0.2.1 → 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (24) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/google/cloud/dialogflow/v2/agents_client.rb +6 -6
  4. data/lib/google/cloud/dialogflow/v2/contexts_client.rb +10 -10
  5. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb +10 -10
  6. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/context.rb +7 -7
  7. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb +25 -25
  8. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/intent.rb +35 -35
  9. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb +53 -53
  10. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session_entity_type.rb +12 -12
  11. data/lib/google/cloud/dialogflow/v2/doc/google/longrunning/operations.rb +9 -9
  12. data/lib/google/cloud/dialogflow/v2/doc/google/protobuf/any.rb +8 -8
  13. data/lib/google/cloud/dialogflow/v2/doc/google/protobuf/empty.rb +1 -1
  14. data/lib/google/cloud/dialogflow/v2/doc/google/protobuf/field_mask.rb +7 -7
  15. data/lib/google/cloud/dialogflow/v2/doc/google/protobuf/struct.rb +11 -11
  16. data/lib/google/cloud/dialogflow/v2/doc/google/rpc/status.rb +11 -11
  17. data/lib/google/cloud/dialogflow/v2/entity_types_client.rb +30 -30
  18. data/lib/google/cloud/dialogflow/v2/intents_client.rb +17 -17
  19. data/lib/google/cloud/dialogflow/v2/session_entity_types_client.rb +10 -10
  20. data/lib/google/cloud/dialogflow/v2/sessions_client.rb +5 -5
  21. data/lib/google/cloud/dialogflow/v2.rb +13 -13
  22. data/lib/google/cloud/dialogflow.rb +13 -13
  23. metadata +3 -4
  24. data/lib/google/cloud/dialogflow/v2/doc/overview.rb +0 -81
@@ -22,10 +22,10 @@ module Google
22
22
  # action is an extraction of a user command or sentence semantics.
23
23
  # @!attribute [rw] name
24
24
  # @return [String]
25
- # Required for all methods except +create+ (+create+ populates the name
25
+ # Required for all methods except `create` (`create` populates the name
26
26
  # automatically.
27
27
  # The unique identifier of this intent.
28
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
28
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
29
29
  # @!attribute [rw] display_name
30
30
  # @return [String]
31
31
  # Required. The name of this intent.
@@ -42,14 +42,14 @@ module Google
42
42
  # @!attribute [rw] ml_disabled
43
43
  # @return [true, false]
44
44
  # Optional. Indicates whether Machine Learning is disabled for the intent.
45
- # Note: If +ml_diabled+ setting is set to true, then this intent is not
46
- # taken into account during inference in +ML ONLY+ match mode. Also,
45
+ # Note: If `ml_diabled` setting is set to true, then this intent is not
46
+ # taken into account during inference in `ML ONLY` match mode. Also,
47
47
  # auto-markup in the UI is turned off.
48
48
  # @!attribute [rw] input_context_names
49
49
  # @return [Array<String>]
50
50
  # Optional. The list of context names required for this intent to be
51
51
  # triggered.
52
- # Format: +projects/<Project ID>/agent/sessions/-/contexts/<Context ID>+.
52
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
53
53
  # @!attribute [rw] events
54
54
  # @return [Array<String>]
55
55
  # Optional. The collection of event names that trigger the intent.
@@ -66,9 +66,9 @@ module Google
66
66
  # @return [Array<Google::Cloud::Dialogflow::V2::Context>]
67
67
  # Optional. The collection of contexts that are activated when the intent
68
68
  # is matched. Context messages in this collection should not set the
69
- # parameters field. Setting the +lifespan_count+ to 0 will reset the context
69
+ # parameters field. Setting the `lifespan_count` to 0 will reset the context
70
70
  # when the intent is matched.
71
- # Format: +projects/<Project ID>/agent/sessions/-/contexts/<Context ID>+.
71
+ # Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
72
72
  # @!attribute [rw] reset_contexts
73
73
  # @return [true, false]
74
74
  # Optional. Indicates whether to delete all contexts in the current
@@ -79,7 +79,7 @@ module Google
79
79
  # @!attribute [rw] messages
80
80
  # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message>]
81
81
  # Optional. The collection of rich messages corresponding to the
82
- # +Response+ field in the Dialogflow console.
82
+ # `Response` field in the Dialogflow console.
83
83
  # @!attribute [rw] default_response_platforms
84
84
  # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::Platform>]
85
85
  # Optional. The list of platforms for which the first response will be
@@ -88,13 +88,13 @@ module Google
88
88
  # @return [String]
89
89
  # The unique identifier of the root intent in the chain of followup intents.
90
90
  # It identifies the correct followup intents chain for this intent.
91
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
91
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
92
92
  # @!attribute [rw] parent_followup_intent_name
93
93
  # @return [String]
94
94
  # The unique identifier of the parent intent in the chain of followup
95
95
  # intents.
96
96
  # It identifies the parent followup intent.
97
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
97
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
98
98
  # @!attribute [rw] followup_intent_info
99
99
  # @return [Array<Google::Cloud::Dialogflow::V2::Intent::FollowupIntentInfo>]
100
100
  # Optional. Collection of information about all followup intents that have
@@ -110,7 +110,7 @@ module Google
110
110
  # @!attribute [rw] parts
111
111
  # @return [Array<Google::Cloud::Dialogflow::V2::Intent::TrainingPhrase::Part>]
112
112
  # Required. The collection of training phrase parts (can be annotated).
113
- # Fields: +entity_type+, +alias+ and +user_defined+ should be populated
113
+ # Fields: `entity_type`, `alias` and `user_defined` should be populated
114
114
  # only for the annotated parts of the training phrase.
115
115
  # @!attribute [rw] times_added_count
116
116
  # @return [Integer]
@@ -126,7 +126,7 @@ module Google
126
126
  # annotated examples, it is the text for one of the example's parts.
127
127
  # @!attribute [rw] entity_type
128
128
  # @return [String]
129
- # Optional. The entity type name prefixed with +@+. This field is
129
+ # Optional. The entity type name prefixed with `@`. This field is
130
130
  # required for the annotated part of the text and applies only to
131
131
  # examples.
132
132
  # @!attribute [rw] alias
@@ -165,19 +165,19 @@ module Google
165
165
  # @return [String]
166
166
  # Optional. The definition of the parameter value. It can be:
167
167
  # * a constant string,
168
- # * a parameter value defined as +$parameter_name+,
169
- # * an original parameter value defined as +$parameter_name.original+,
168
+ # * a parameter value defined as `$parameter_name`,
169
+ # * an original parameter value defined as `$parameter_name.original`,
170
170
  # * a parameter value from some context defined as
171
- # +#context_name.parameter_name+.
171
+ # `#context_name.parameter_name`.
172
172
  # @!attribute [rw] default_value
173
173
  # @return [String]
174
- # Optional. The default value to use when the +value+ yields an empty
174
+ # Optional. The default value to use when the `value` yields an empty
175
175
  # result.
176
176
  # Default values can be extracted from contexts by using the following
177
- # syntax: +#context_name.parameter_name+.
177
+ # syntax: `#context_name.parameter_name`.
178
178
  # @!attribute [rw] entity_type_display_name
179
179
  # @return [String]
180
- # Optional. The name of the entity type, prefixed with +@+, that
180
+ # Optional. The name of the entity type, prefixed with `@`, that
181
181
  # describes values of the parameter. If the parameter is
182
182
  # required, this must be provided.
183
183
  # @!attribute [rw] mandatory
@@ -194,7 +194,7 @@ module Google
194
194
  # Optional. Indicates whether the parameter represents a list of values.
195
195
  class Parameter; end
196
196
 
197
- # Corresponds to the +Response+ field in the Dialogflow console.
197
+ # Corresponds to the `Response` field in the Dialogflow console.
198
198
  # @!attribute [rw] text
199
199
  # @return [Google::Cloud::Dialogflow::V2::Intent::Message::Text]
200
200
  # The text response.
@@ -300,9 +300,9 @@ module Google
300
300
  class SimpleResponse; end
301
301
 
302
302
  # The collection of simple response candidates.
303
- # This message in +QueryResult.fulfillment_messages+ and
304
- # +WebhookResponse.fulfillment_messages+ should contain only one
305
- # +SimpleResponse+.
303
+ # This message in `QueryResult.fulfillment_messages` and
304
+ # `WebhookResponse.fulfillment_messages` should contain only one
305
+ # `SimpleResponse`.
306
306
  # @!attribute [rw] simple_responses
307
307
  # @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message::SimpleResponse>]
308
308
  # Required. The list of simple responses.
@@ -517,11 +517,11 @@ module Google
517
517
  # @!attribute [rw] followup_intent_name
518
518
  # @return [String]
519
519
  # The unique identifier of the followup intent.
520
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
520
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
521
521
  # @!attribute [rw] parent_followup_intent_name
522
522
  # @return [String]
523
523
  # The unique identifier of the followup intent parent.
524
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
524
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
525
525
  class FollowupIntentInfo; end
526
526
 
527
527
  # Represents the different states that webhooks can be in.
@@ -542,7 +542,7 @@ module Google
542
542
  # @!attribute [rw] parent
543
543
  # @return [String]
544
544
  # Required. The agent to list all intents from.
545
- # Format: +projects/<Project ID>/agent+.
545
+ # Format: `projects/<Project ID>/agent`.
546
546
  # @!attribute [rw] language_code
547
547
  # @return [String]
548
548
  # Optional. The language to list training phrases, parameters and rich
@@ -577,7 +577,7 @@ module Google
577
577
  # @!attribute [rw] name
578
578
  # @return [String]
579
579
  # Required. The name of the intent.
580
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
580
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
581
581
  # @!attribute [rw] language_code
582
582
  # @return [String]
583
583
  # Optional. The language to retrieve training phrases, parameters and rich
@@ -594,14 +594,14 @@ module Google
594
594
  # @!attribute [rw] parent
595
595
  # @return [String]
596
596
  # Required. The agent to create a intent for.
597
- # Format: +projects/<Project ID>/agent+.
597
+ # Format: `projects/<Project ID>/agent`.
598
598
  # @!attribute [rw] intent
599
599
  # @return [Google::Cloud::Dialogflow::V2::Intent]
600
600
  # Required. The intent to create.
601
601
  # @!attribute [rw] language_code
602
602
  # @return [String]
603
603
  # Optional. The language of training phrases, parameters and rich messages
604
- # defined in +intent+. If not specified, the agent's default language is
604
+ # defined in `intent`. If not specified, the agent's default language is
605
605
  # used. [More than a dozen
606
606
  # languages](https://dialogflow.com/docs/reference/language) are supported.
607
607
  # Note: languages must be enabled in the agent, before they can be used.
@@ -614,11 +614,11 @@ module Google
614
614
  # @!attribute [rw] intent
615
615
  # @return [Google::Cloud::Dialogflow::V2::Intent]
616
616
  # Required. The intent to update.
617
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
617
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
618
618
  # @!attribute [rw] language_code
619
619
  # @return [String]
620
620
  # Optional. The language of training phrases, parameters and rich messages
621
- # defined in +intent+. If not specified, the agent's default language is
621
+ # defined in `intent`. If not specified, the agent's default language is
622
622
  # used. [More than a dozen
623
623
  # languages](https://dialogflow.com/docs/reference/language) are supported.
624
624
  # Note: languages must be enabled in the agent, before they can be used.
@@ -634,14 +634,14 @@ module Google
634
634
  # @!attribute [rw] name
635
635
  # @return [String]
636
636
  # Required. The name of the intent to delete.
637
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
637
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
638
638
  class DeleteIntentRequest; end
639
639
 
640
640
  # The request message for {Google::Cloud::Dialogflow::V2::Intents::BatchUpdateIntents Intents::BatchUpdateIntents}.
641
641
  # @!attribute [rw] parent
642
642
  # @return [String]
643
643
  # Required. The name of the agent to update or create intents in.
644
- # Format: +projects/<Project ID>/agent+.
644
+ # Format: `projects/<Project ID>/agent`.
645
645
  # @!attribute [rw] intent_batch_uri
646
646
  # @return [String]
647
647
  # The URI to a Google Cloud Storage file containing intents to update or
@@ -653,7 +653,7 @@ module Google
653
653
  # @!attribute [rw] language_code
654
654
  # @return [String]
655
655
  # Optional. The language of training phrases, parameters and rich messages
656
- # defined in +intents+. If not specified, the agent's default language is
656
+ # defined in `intents`. If not specified, the agent's default language is
657
657
  # used. [More than a dozen
658
658
  # languages](https://dialogflow.com/docs/reference/language) are supported.
659
659
  # Note: languages must be enabled in the agent, before they can be used.
@@ -675,10 +675,10 @@ module Google
675
675
  # @!attribute [rw] parent
676
676
  # @return [String]
677
677
  # Required. The name of the agent to delete all entities types for. Format:
678
- # +projects/<Project ID>/agent+.
678
+ # `projects/<Project ID>/agent`.
679
679
  # @!attribute [rw] intents
680
680
  # @return [Array<Google::Cloud::Dialogflow::V2::Intent>]
681
- # Required. The collection of intents to delete. Only intent +name+ must be
681
+ # Required. The collection of intents to delete. Only intent `name` must be
682
682
  # filled in.
683
683
  class BatchDeleteIntentsRequest; end
684
684
 
@@ -21,7 +21,7 @@ module Google
21
21
  # @!attribute [rw] session
22
22
  # @return [String]
23
23
  # Required. The name of the session this query is sent to. Format:
24
- # +projects/<Project ID>/agent/sessions/<Session ID>+. It's up to the API
24
+ # `projects/<Project ID>/agent/sessions/<Session ID>`. It's up to the API
25
25
  # caller to choose an appropriate session ID. It can be a random number or
26
26
  # some type of user identifier (preferably hashed). The length of the session
27
27
  # ID must not exceed 36 bytes.
@@ -41,7 +41,7 @@ module Google
41
41
  # @!attribute [rw] input_audio
42
42
  # @return [String]
43
43
  # Optional. The natural language speech audio to be processed. This field
44
- # should be populated iff +query_input+ is set to an input audio config.
44
+ # should be populated iff `query_input` is set to an input audio config.
45
45
  # A single request can contain up to 1 minute of speech audio data.
46
46
  class DetectIntentRequest; end
47
47
 
@@ -55,7 +55,7 @@ module Google
55
55
  # The results of the conversational query or event processing.
56
56
  # @!attribute [rw] webhook_status
57
57
  # @return [Google::Rpc::Status]
58
- # Specifies the status of the webhook request. +webhook_status+
58
+ # Specifies the status of the webhook request. `webhook_status`
59
59
  # is never populated in webhook requests.
60
60
  class DetectIntentResponse; end
61
61
 
@@ -111,12 +111,12 @@ module Google
111
111
  # @!attribute [rw] query_text
112
112
  # @return [String]
113
113
  # The original conversational query text:
114
- # * If natural language text was provided as input, +query_text+ contains
114
+ # * If natural language text was provided as input, `query_text` contains
115
115
  # a copy of the input.
116
- # * If natural language speech audio was provided as input, +query_text+
116
+ # * If natural language speech audio was provided as input, `query_text`
117
117
  # contains the speech recognition result. If speech recognizer produced
118
118
  # multiple alternatives, a particular one is picked.
119
- # * If an event was provided as input, +query_text+ is not set.
119
+ # * If an event was provided as input, `query_text` is not set.
120
120
  # @!attribute [rw] language_code
121
121
  # @return [String]
122
122
  # The language that was triggered during intent detection.
@@ -142,9 +142,9 @@ module Google
142
142
  # @!attribute [rw] all_required_params_present
143
143
  # @return [true, false]
144
144
  # This field is set to:
145
- # * +false+ if the matched intent has required parameters and not all of
145
+ # * `false` if the matched intent has required parameters and not all of
146
146
  # the required parameter values have been collected.
147
- # * +true+ if all required parameter values have been collected, or if the
147
+ # * `true` if all required parameter values have been collected, or if the
148
148
  # matched intent doesn't contain any required parameters.
149
149
  # @!attribute [rw] fulfillment_text
150
150
  # @return [String]
@@ -155,22 +155,22 @@ module Google
155
155
  # @!attribute [rw] webhook_source
156
156
  # @return [String]
157
157
  # If the query was fulfilled by a webhook call, this field is set to the
158
- # value of the +source+ field returned in the webhook response.
158
+ # value of the `source` field returned in the webhook response.
159
159
  # @!attribute [rw] webhook_payload
160
160
  # @return [Google::Protobuf::Struct]
161
161
  # If the query was fulfilled by a webhook call, this field is set to the
162
- # value of the +payload+ field returned in the webhook response.
162
+ # value of the `payload` field returned in the webhook response.
163
163
  # @!attribute [rw] output_contexts
164
164
  # @return [Array<Google::Cloud::Dialogflow::V2::Context>]
165
165
  # The collection of output contexts. If applicable,
166
- # +output_contexts.parameters+ contains entries with name
167
- # +<parameter name>.original+ containing the original parameter values
166
+ # `output_contexts.parameters` contains entries with name
167
+ # `<parameter name>.original` containing the original parameter values
168
168
  # before the query.
169
169
  # @!attribute [rw] intent
170
170
  # @return [Google::Cloud::Dialogflow::V2::Intent]
171
171
  # The intent that matched the conversational query. Some, not
172
172
  # all fields are filled in this message, including but not limited to:
173
- # +name+, +display_name+ and +webhook_state+.
173
+ # `name`, `display_name` and `webhook_state`.
174
174
  # @!attribute [rw] intent_detection_confidence
175
175
  # @return [Float]
176
176
  # The intent detection confidence. Values range from 0.0
@@ -182,21 +182,21 @@ module Google
182
182
  class QueryResult; end
183
183
 
184
184
  # The top-level message sent by the client to the
185
- # +StreamingDetectIntent+ method.
185
+ # `StreamingDetectIntent` method.
186
186
  #
187
187
  # Multiple request messages should be sent in order:
188
188
  #
189
- # 1. The first message must contain +session+, +query_input+ plus optionally
190
- # +query_params+ and/or +single_utterance+. The message must not contain +input_audio+.
189
+ # 1. The first message must contain `session`, `query_input` plus optionally
190
+ # `query_params` and/or `single_utterance`. The message must not contain `input_audio`.
191
191
  #
192
- # 2. If +query_input+ was set to a streaming input audio config,
193
- # all subsequent messages must contain only +input_audio+.
192
+ # 2. If `query_input` was set to a streaming input audio config,
193
+ # all subsequent messages must contain only `input_audio`.
194
194
  # Otherwise, finish the request stream.
195
195
  # @!attribute [rw] session
196
196
  # @return [String]
197
197
  # Required. The name of the session the query is sent to.
198
198
  # Format of the session name:
199
- # +projects/<Project ID>/agent/sessions/<Session ID>+. It’s up to the API
199
+ # `projects/<Project ID>/agent/sessions/<Session ID>`. It’s up to the API
200
200
  # caller to choose an appropriate <Session ID>. It can be a random number or
201
201
  # some type of user identifier (preferably hashed). The length of the session
202
202
  # ID must not exceed 36 characters.
@@ -215,33 +215,33 @@ module Google
215
215
  # 3. an event that specifies which intent to trigger.
216
216
  # @!attribute [rw] single_utterance
217
217
  # @return [true, false]
218
- # Optional. If +false+ (default), recognition does not cease until the
218
+ # Optional. If `false` (default), recognition does not cease until the
219
219
  # client closes the stream.
220
- # If +true+, the recognizer will detect a single spoken utterance in input
220
+ # If `true`, the recognizer will detect a single spoken utterance in input
221
221
  # audio. Recognition ceases when it detects the audio's voice has
222
222
  # stopped or paused. In this case, once a detected intent is received, the
223
223
  # client should close the stream and start a new request with a new stream as
224
224
  # needed.
225
- # This setting is ignored when +query_input+ is a piece of text or an event.
225
+ # This setting is ignored when `query_input` is a piece of text or an event.
226
226
  # @!attribute [rw] input_audio
227
227
  # @return [String]
228
228
  # Optional. The input audio content to be recognized. Must be sent if
229
- # +query_input+ was set to a streaming input audio config. The complete audio
229
+ # `query_input` was set to a streaming input audio config. The complete audio
230
230
  # over all streaming messages must not exceed 1 minute.
231
231
  class StreamingDetectIntentRequest; end
232
232
 
233
233
  # The top-level message returned from the
234
- # +StreamingDetectIntent+ method.
234
+ # `StreamingDetectIntent` method.
235
235
  #
236
236
  # Multiple response messages can be returned in order:
237
237
  #
238
238
  # 1. If the input was set to streaming audio, the first one or more messages
239
- # contain +recognition_result+. Each +recognition_result+ represents a more
240
- # complete transcript of what the user said. The last +recognition_result+
241
- # has +is_final+ set to +true+.
239
+ # contain `recognition_result`. Each `recognition_result` represents a more
240
+ # complete transcript of what the user said. The last `recognition_result`
241
+ # has `is_final` set to `true`.
242
242
  #
243
- # 2. The next message contains +response_id+, +query_result+
244
- # and optionally +webhook_status+ if a WebHook was called.
243
+ # 2. The next message contains `response_id`, `query_result`
244
+ # and optionally `webhook_status` if a WebHook was called.
245
245
  # @!attribute [rw] response_id
246
246
  # @return [String]
247
247
  # The unique identifier of the response. It can be used to
@@ -276,34 +276,34 @@ module Google
276
276
  #
277
277
  # 6. transcript: " that is"
278
278
  #
279
- # 7. recognition_event_type: +RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE+
279
+ # 7. recognition_event_type: `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE`
280
280
  #
281
281
  # 8. transcript: " that is the question"
282
282
  # is_final: true
283
283
  #
284
284
  # Only two of the responses contain final results (#4 and #8 indicated by
285
- # +is_final: true+). Concatenating these generates the full transcript: "to be
285
+ # `is_final: true`). Concatenating these generates the full transcript: "to be
286
286
  # or not to be that is the question".
287
287
  #
288
288
  # In each response we populate:
289
289
  #
290
- # * for +MESSAGE_TYPE_TRANSCRIPT+: +transcript+ and possibly +is_final+.
290
+ # * for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`.
291
291
  #
292
- # * for +MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE+: only +event_type+.
292
+ # * for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`.
293
293
  # @!attribute [rw] message_type
294
294
  # @return [Google::Cloud::Dialogflow::V2::StreamingRecognitionResult::MessageType]
295
295
  # Type of the result message.
296
296
  # @!attribute [rw] transcript
297
297
  # @return [String]
298
298
  # Transcript text representing the words that the user spoke.
299
- # Populated if and only if +event_type+ = +RECOGNITION_EVENT_TRANSCRIPT+.
299
+ # Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
300
300
  # @!attribute [rw] is_final
301
301
  # @return [true, false]
302
- # The default of 0.0 is a sentinel value indicating +confidence+ was not set.
303
- # If +false+, the +StreamingRecognitionResult+ represents an
304
- # interim result that may change. If +true+, the recognizer will not return
302
+ # The default of 0.0 is a sentinel value indicating `confidence` was not set.
303
+ # If `false`, the `StreamingRecognitionResult` represents an
304
+ # interim result that may change. If `true`, the recognizer will not return
305
305
  # any further hypotheses about this piece of the audio. May only be populated
306
- # for +event_type+ = +RECOGNITION_EVENT_TRANSCRIPT+.
306
+ # for `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
307
307
  # @!attribute [rw] confidence
308
308
  # @return [Float]
309
309
  # The Speech confidence between 0.0 and 1.0 for the current portion of audio.
@@ -311,7 +311,7 @@ module Google
311
311
  # recognized words are correct. The default of 0.0 is a sentinel value
312
312
  # indicating that confidence was not set.
313
313
  #
314
- # This field is typically only provided if +is_final+ is true and you should
314
+ # This field is typically only provided if `is_final` is true and you should
315
315
  # not rely on it being accurate or even set.
316
316
  class StreamingRecognitionResult
317
317
  # Type of the response message.
@@ -328,7 +328,7 @@ module Google
328
328
  # additional results). The client should stop sending additional audio
329
329
  # data, half-close the gRPC connection, and wait for any additional results
330
330
  # until the server closes the gRPC connection. This message is only sent if
331
- # +single_utterance+ was set to +true+, and is not used otherwise.
331
+ # `single_utterance` was set to `true`, and is not used otherwise.
332
332
  END_OF_SINGLE_UTTERANCE = 2
333
333
  end
334
334
  end
@@ -371,10 +371,10 @@ module Google
371
371
  class TextInput; end
372
372
 
373
373
  # Events allow for matching intents by event name instead of the natural
374
- # language input. For instance, input +<event: { name: “welcome_event”,
375
- # parameters: { name: “Sam” } }>+ can trigger a personalized welcome response.
376
- # The parameter +name+ may be used by the agent in the response:
377
- # +“Hello #welcome_event.name! What can I do for you today?”+.
374
+ # language input. For instance, input `<event: { name: “welcome_event”,
375
+ # parameters: { name: “Sam” } }>` can trigger a personalized welcome response.
376
+ # The parameter `name` may be used by the agent in the response:
377
+ # `“Hello #welcome_event.name! What can I do for you today?”`.
378
378
  # @!attribute [rw] name
379
379
  # @return [String]
380
380
  # Required. The unique identifier of the event.
@@ -399,32 +399,32 @@ module Google
399
399
  # Uncompressed 16-bit signed little-endian samples (Linear PCM).
400
400
  AUDIO_ENCODING_LINEAR_16 = 1
401
401
 
402
- # [+FLAC+](https://xiph.org/flac/documentation.html) (Free Lossless Audio
402
+ # [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio
403
403
  # Codec) is the recommended encoding because it is lossless (therefore
404
404
  # recognition is not compromised) and requires only about half the
405
- # bandwidth of +LINEAR16+. +FLAC+ stream encoding supports 16-bit and
406
- # 24-bit samples, however, not all fields in +STREAMINFO+ are supported.
405
+ # bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and
406
+ # 24-bit samples, however, not all fields in `STREAMINFO` are supported.
407
407
  AUDIO_ENCODING_FLAC = 2
408
408
 
409
409
  # 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
410
410
  AUDIO_ENCODING_MULAW = 3
411
411
 
412
- # Adaptive Multi-Rate Narrowband codec. +sample_rate_hertz+ must be 8000.
412
+ # Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.
413
413
  AUDIO_ENCODING_AMR = 4
414
414
 
415
- # Adaptive Multi-Rate Wideband codec. +sample_rate_hertz+ must be 16000.
415
+ # Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.
416
416
  AUDIO_ENCODING_AMR_WB = 5
417
417
 
418
418
  # Opus encoded audio frames in Ogg container
419
419
  # ([OggOpus](https://wiki.xiph.org/OggOpus)).
420
- # +sample_rate_hertz+ must be 16000.
420
+ # `sample_rate_hertz` must be 16000.
421
421
  AUDIO_ENCODING_OGG_OPUS = 6
422
422
 
423
423
  # Although the use of lossy encodings is not recommended, if a very low
424
- # bitrate encoding is required, +OGG_OPUS+ is highly preferred over
424
+ # bitrate encoding is required, `OGG_OPUS` is highly preferred over
425
425
  # Speex encoding. The [Speex](https://speex.org/) encoding supported by
426
426
  # Dialogflow API has a header byte in each block, as in MIME type
427
- # +audio/x-speex-with-header-byte+.
427
+ # `audio/x-speex-with-header-byte`.
428
428
  # It is a variant of the RTP Speex encoding defined in
429
429
  # [RFC 5574](https://tools.ietf.org/html/rfc5574).
430
430
  # The stream is a sequence of blocks, one block per RTP packet. Each block
@@ -432,7 +432,7 @@ module Google
432
432
  # by one or more frames of Speex data, padded to an integral number of
433
433
  # bytes (octets) as specified in RFC 5574. In other words, each RTP header
434
434
  # is replaced with a single byte containing the block length. Only Speex
435
- # wideband is supported. +sample_rate_hertz+ must be 16000.
435
+ # wideband is supported. `sample_rate_hertz` must be 16000.
436
436
  AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7
437
437
  end
438
438
  end
@@ -27,8 +27,8 @@ module Google
27
27
  # @!attribute [rw] name
28
28
  # @return [String]
29
29
  # Required. The unique identifier of this session entity type. Format:
30
- # +projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
31
- # Display Name>+.
30
+ # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
31
+ # Display Name>`.
32
32
  # @!attribute [rw] entity_override_mode
33
33
  # @return [Google::Cloud::Dialogflow::V2::SessionEntityType::EntityOverrideMode]
34
34
  # Required. Indicates whether the additional data should override or
@@ -49,8 +49,8 @@ module Google
49
49
 
50
50
  # The collection of session entities extends the collection of entities in
51
51
  # the corresponding developer entity type.
52
- # Calls to +ListSessionEntityTypes+, +GetSessionEntityType+,
53
- # +CreateSessionEntityType+ and +UpdateSessionEntityType+ return the full
52
+ # Calls to `ListSessionEntityTypes`, `GetSessionEntityType`,
53
+ # `CreateSessionEntityType` and `UpdateSessionEntityType` return the full
54
54
  # collection of entities from the developer entity type in the agent's
55
55
  # default language and the session entity type.
56
56
  ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
@@ -61,7 +61,7 @@ module Google
61
61
  # @!attribute [rw] parent
62
62
  # @return [String]
63
63
  # Required. The session to list all session entity types from.
64
- # Format: +projects/<Project ID>/agent/sessions/<Session ID>+.
64
+ # Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
65
65
  # @!attribute [rw] page_size
66
66
  # @return [Integer]
67
67
  # Optional. The maximum number of items to return in a single page. By
@@ -86,15 +86,15 @@ module Google
86
86
  # @!attribute [rw] name
87
87
  # @return [String]
88
88
  # Required. The name of the session entity type. Format:
89
- # +projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
90
- # Display Name>+.
89
+ # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
90
+ # Display Name>`.
91
91
  class GetSessionEntityTypeRequest; end
92
92
 
93
93
  # The request message for {Google::Cloud::Dialogflow::V2::SessionEntityTypes::CreateSessionEntityType SessionEntityTypes::CreateSessionEntityType}.
94
94
  # @!attribute [rw] parent
95
95
  # @return [String]
96
96
  # Required. The session to create a session entity type for.
97
- # Format: +projects/<Project ID>/agent/sessions/<Session ID>+.
97
+ # Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
98
98
  # @!attribute [rw] session_entity_type
99
99
  # @return [Google::Cloud::Dialogflow::V2::SessionEntityType]
100
100
  # Required. The session entity type to create.
@@ -104,8 +104,8 @@ module Google
104
104
  # @!attribute [rw] session_entity_type
105
105
  # @return [Google::Cloud::Dialogflow::V2::SessionEntityType]
106
106
  # Required. The entity type to update. Format:
107
- # +projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
108
- # Display Name>+.
107
+ # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
108
+ # Display Name>`.
109
109
  # @!attribute [rw] update_mask
110
110
  # @return [Google::Protobuf::FieldMask]
111
111
  # Optional. The mask to control which fields get updated.
@@ -115,8 +115,8 @@ module Google
115
115
  # @!attribute [rw] name
116
116
  # @return [String]
117
117
  # Required. The name of the entity type to delete. Format:
118
- # +projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
119
- # Display Name>+.
118
+ # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
119
+ # Display Name>`.
120
120
  class DeleteSessionEntityTypeRequest; end
121
121
  end
122
122
  end
@@ -21,7 +21,7 @@ module Google
21
21
  # @return [String]
22
22
  # The server-assigned name, which is only unique within the same service that
23
23
  # originally returns it. If you use the default HTTP mapping, the
24
- # +name+ should have the format of +operations/some/unique/name+.
24
+ # `name` should have the format of `operations/some/unique/name`.
25
25
  # @!attribute [rw] metadata
26
26
  # @return [Google::Protobuf::Any]
27
27
  # Service-specific metadata associated with the operation. It typically
@@ -30,8 +30,8 @@ module Google
30
30
  # long-running operation should document the metadata type, if any.
31
31
  # @!attribute [rw] done
32
32
  # @return [true, false]
33
- # If the value is +false+, it means the operation is still in progress.
34
- # If true, the operation is completed, and either +error+ or +response+ is
33
+ # If the value is `false`, it means the operation is still in progress.
34
+ # If true, the operation is completed, and either `error` or `response` is
35
35
  # available.
36
36
  # @!attribute [rw] error
37
37
  # @return [Google::Rpc::Status]
@@ -39,13 +39,13 @@ module Google
39
39
  # @!attribute [rw] response
40
40
  # @return [Google::Protobuf::Any]
41
41
  # The normal response of the operation in case of success. If the original
42
- # method returns no data on success, such as +Delete+, the response is
43
- # +google.protobuf.Empty+. If the original method is standard
44
- # +Get+/+Create+/+Update+, the response should be the resource. For other
45
- # methods, the response should have the type +XxxResponse+, where +Xxx+
42
+ # method returns no data on success, such as `Delete`, the response is
43
+ # `google.protobuf.Empty`. If the original method is standard
44
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
45
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
46
46
  # is the original method name. For example, if the original method name
47
- # is +TakeSnapshot()+, the inferred response type is
48
- # +TakeSnapshotResponse+.
47
+ # is `TakeSnapshot()`, the inferred response type is
48
+ # `TakeSnapshotResponse`.
49
49
  class Operation; end
50
50
 
51
51
  # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.