From 1e506d83aba52f7fe444667784890c993c400d51 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 1 Aug 2023 13:29:29 -0700 Subject: [PATCH] docs: Minor formatting (#658) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Minor formatting PiperOrigin-RevId: 552790519 Source-Link: https://github.com/googleapis/googleapis/commit/a03330aeb83fc06de3734fa79bf4a31c909bf1c5 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4caca49b3e073192cb4a295c1cfa1cf85266c28d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGNhY2E0OWIzZTA3MzE5MmNiNGEyOTVjMWNmYTFjZjg1MjY2YzI4ZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: Minor formatting PiperOrigin-RevId: 552837489 Source-Link: https://github.com/googleapis/googleapis/commit/7154a947675ffa9b846e1a899dbc90bc79598352 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4538a83a0a087c3b1cc09245f0ed86875eb8832d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDUzOGE4M2EwYTA4N2MzYjFjYzA5MjQ1ZjBlZDg2ODc1ZWI4ODMyZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot Co-authored-by: Anthonios Partheniou --- .../services/sessions/async_client.py | 14 +-- .../dialogflow_v2/services/sessions/client.py | 14 +-- .../cloud/dialogflow_v2/types/audio_config.py | 10 +- .../cloud/dialogflow_v2/types/context.py | 42 ++++---- .../cloud/dialogflow_v2/types/conversation.py | 2 +- .../google/cloud/dialogflow_v2/types/gcs.py | 20 ++-- .../cloud/dialogflow_v2/types/session.py | 93 +++++++---------- .../dialogflow_v2/types/validation_result.py | 34 +++---- .../services/sessions/async_client.py | 14 +-- .../services/sessions/client.py | 14 +-- .../dialogflow_v2beta1/types/audio_config.py | 23 +++-- .../cloud/dialogflow_v2beta1/types/context.py | 42 ++++---- .../dialogflow_v2beta1/types/conversation.py | 2 +- .../cloud/dialogflow_v2beta1/types/gcs.py | 30 +++--- .../dialogflow_v2beta1/types/participant.py | 50 ++++------ .../cloud/dialogflow_v2beta1/types/session.py | 99 ++++++++----------- .../types/validation_result.py | 34 +++---- 17 files changed, 229 insertions(+), 308 deletions(-) diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/services/sessions/async_client.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/services/sessions/async_client.py index 7aec8f1db220..527dcd9105fc 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/services/sessions/async_client.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/services/sessions/async_client.py @@ -317,13 +317,13 @@ async def sample_detect_intent(): Required. The input specification. It can be set to: - 1. an audio config - which instructs the speech - recognizer how to process the speech - audio, - 2. a conversational query in the form - of text, or - 3. an event that specifies which intent + 1. an audio config which instructs the + speech recognizer how to process the + speech audio, + + 2. a conversational query in the form of + text, or + 3. an event that specifies which intent to trigger. This corresponds to the ``query_input`` field diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/services/sessions/client.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/services/sessions/client.py index 7a1fe4fb7b93..18172f1643ce 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/services/sessions/client.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/services/sessions/client.py @@ -601,13 +601,13 @@ def sample_detect_intent(): Required. The input specification. It can be set to: - 1. an audio config - which instructs the speech - recognizer how to process the speech - audio, - 2. a conversational query in the form - of text, or - 3. an event that specifies which intent + 1. an audio config which instructs the + speech recognizer how to process the + speech audio, + + 2. a conversational query in the form of + text, or + 3. an event that specifies which intent to trigger. This corresponds to the ``query_input`` field diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/audio_config.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/audio_config.py index 3378ba8c31f8..6bac4cb381d8 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/audio_config.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/audio_config.py @@ -397,11 +397,11 @@ class InputAudioConfig(proto.Message): documentation `__ for more details. - This field is deprecated. Please use `speech_contexts <>`__ - instead. If you specify both `phrase_hints <>`__ and - `speech_contexts <>`__, Dialogflow will treat the - `phrase_hints <>`__ as a single additional - `SpeechContext <>`__. + This field is deprecated. Please use + ```speech_contexts`` <>`__ instead. If you specify both + ```phrase_hints`` <>`__ and ```speech_contexts`` <>`__, + Dialogflow will treat the ```phrase_hints`` <>`__ as a + single additional ```SpeechContext`` <>`__. speech_contexts (MutableSequence[google.cloud.dialogflow_v2.types.SpeechContext]): Context information to assist speech recognition. diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/context.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/context.py index 2f7116ad7d39..e55abf7387b7 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/context.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/context.py @@ -62,8 +62,8 @@ class Context(proto.Message): ``projects//agent/environments//users//sessions//contexts/``. The ``Context ID`` is always converted to lowercase, may - only contain characters in a-zA-Z0-9_-% and may be at most - 250 bytes long. + only contain characters in ``a-zA-Z0-9_-%`` and may be at + most 250 bytes long. If ``Environment ID`` is not specified, we assume default 'draft' environment. If ``User ID`` is not specified, we @@ -83,31 +83,23 @@ class Context(proto.Message): automatically after 20 minutes if there are no matching queries. parameters (google.protobuf.struct_pb2.Struct): - Optional. The collection of parameters - associated with this context. - Depending on your protocol or client library - language, this is a map, associative array, - symbol table, dictionary, or JSON object - composed of a collection of (MapKey, MapValue) - pairs: - - - MapKey type: string - - MapKey value: parameter name - - MapValue type: + Optional. The collection of parameters associated with this + context. - - If parameter's entity type is a - composite entity: map - - Else: depending on parameter value type, - could be one of string, number, - boolean, null, list or map - - MapValue value: - - - If parameter's entity type is a - composite entity: + Depending on your protocol or client library language, this + is a map, associative array, symbol table, dictionary, or + JSON object composed of a collection of (MapKey, MapValue) + pairs: - map from composite entity property names - to property values - - Else: parameter value + - MapKey type: string + - MapKey value: parameter name + - MapValue type: If parameter's entity type is a composite + entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, + boolean, null, list or map. + - MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names + to property values, otherwise, use parameter value. """ name: str = proto.Field( diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/conversation.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/conversation.py index 2458070d2e5b..14d56c3638e1 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/conversation.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/conversation.py @@ -182,7 +182,7 @@ class CreateConversationRequest(proto.Message): the response to return a auto-generated one to you. The conversation ID must be compliant with the regression - fomula "[a-zA-Z][a-zA-Z0-9_-]*" with the characters length + fomula ``[a-zA-Z][a-zA-Z0-9_-]*`` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/gcs.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/gcs.py index 9df331d4a163..7cb742bc70be 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/gcs.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/gcs.py @@ -33,12 +33,9 @@ class GcsSources(proto.Message): Attributes: uris (MutableSequence[str]): - Required. Google Cloud Storage URIs for the - inputs. A URI is of the form: - - gs://bucket/object-prefix-or-name - Whether a prefix or name is used depends on the - use case. + Required. Google Cloud Storage URIs for the inputs. A URI is + of the form: ``gs://bucket/object-prefix-or-name`` Whether a + prefix or name is used depends on the use case. """ uris: MutableSequence[str] = proto.RepeatedField( @@ -52,13 +49,10 @@ class GcsDestination(proto.Message): Attributes: uri (str): - The Google Cloud Storage URIs for the output. - A URI is of the form: - - gs://bucket/object-prefix-or-name - Whether a prefix or name is used depends on the - use case. The requesting user must have - "write-permission" to the bucket. + The Google Cloud Storage URIs for the output. A URI is of + the form: ``gs://bucket/object-prefix-or-name`` Whether a + prefix or name is used depends on the use case. The + requesting user must have "write-permission" to the bucket. """ uri: str = proto.Field( diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/session.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/session.py index e08c5c13ff62..25939bd3f552 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/session.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/session.py @@ -81,12 +81,12 @@ class DetectIntentRequest(proto.Message): Required. The input specification. It can be set to: - 1. an audio config - which instructs the speech recognizer how to - process the speech audio, - 2. a conversational query in the form of text, + 1. an audio config which instructs the speech + recognizer how to process the speech audio, + + 2. a conversational query in the form of text, or - 3. an event that specifies which intent to + 3. an event that specifies which intent to trigger. output_audio_config (google.cloud.dialogflow_v2.types.OutputAudioConfig): Instructs the speech synthesizer how to @@ -382,29 +382,21 @@ class QueryResult(proto.Message): The action name from the matched intent. parameters (google.protobuf.struct_pb2.Struct): The collection of extracted parameters. - Depending on your protocol or client library - language, this is a map, associative array, - symbol table, dictionary, or JSON object - composed of a collection of (MapKey, MapValue) - pairs: - - - MapKey type: string - - MapKey value: parameter name - - MapValue type: - - If parameter's entity type is a - composite entity: map - - Else: depending on parameter value type, - could be one of string, number, - boolean, null, list or map - - MapValue value: - - - If parameter's entity type is a - composite entity: + Depending on your protocol or client library language, this + is a map, associative array, symbol table, dictionary, or + JSON object composed of a collection of (MapKey, MapValue) + pairs: - map from composite entity property names - to property values - - Else: parameter value + - MapKey type: string + - MapKey value: parameter name + - MapValue type: If parameter's entity type is a composite + entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, + boolean, null, list or map. + - MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names + to property values, otherwise, use parameter value. all_required_params_present (bool): This field is set to: @@ -611,12 +603,12 @@ class StreamingDetectIntentRequest(proto.Message): Required. The input specification. It can be set to: - 1. an audio config which instructs the speech - recognizer how to process the speech audio, + 1. an audio config which instructs the speech + recognizer how to process the speech audio, - 2. a conversational query in the form of text, + 2. a conversational query in the form of text, or - 3. an event that specifies which intent to + 3. an event that specifies which intent to trigger. single_utterance (bool): Please use @@ -1060,9 +1052,7 @@ class MessageType(proto.Enum): class TextInput(proto.Message): - r"""============================================================================ - Auxiliary proto messages. - + r"""Auxiliary proto messages. Represents the natural language text to be processed. Attributes: @@ -1102,31 +1092,22 @@ class EventInput(proto.Message): name (str): Required. The unique identifier of the event. parameters (google.protobuf.struct_pb2.Struct): - The collection of parameters associated with - the event. - Depending on your protocol or client library - language, this is a map, associative array, - symbol table, dictionary, or JSON object - composed of a collection of (MapKey, MapValue) - pairs: - - - MapKey type: string - - MapKey value: parameter name - - MapValue type: + The collection of parameters associated with the event. - - If parameter's entity type is a - composite entity: map - - Else: depending on parameter value type, - could be one of string, number, - boolean, null, list or map - - MapValue value: - - - If parameter's entity type is a - composite entity: + Depending on your protocol or client library language, this + is a map, associative array, symbol table, dictionary, or + JSON object composed of a collection of (MapKey, MapValue) + pairs: - map from composite entity property names - to property values - - Else: parameter value + - MapKey type: string + - MapKey value: parameter name + - MapValue type: If parameter's entity type is a composite + entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, + boolean, null, list or map. + - MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names + to property values, otherwise, use parameter value. language_code (str): Required. The language of this query. See `Language Support `__ diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/validation_result.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/validation_result.py index f4a91c561931..88fd11198626 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/validation_result.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2/types/validation_result.py @@ -35,25 +35,21 @@ class ValidationError(proto.Message): severity (google.cloud.dialogflow_v2.types.ValidationError.Severity): The severity of the error. entries (MutableSequence[str]): - The names of the entries that the error is - associated with. Format: - - - "projects//agent", if the error is - associated with the entire agent. - - "projects//agent/intents/", if the error is associated with certain - intents. - - "projects//agent/intents//trainingPhrases/", if - the error is associated with certain intent - training phrases. - - "projects//agent/intents//parameters/", if the error - is associated with certain intent parameters. - - "projects//agent/entities/", if the error is associated with certain - entities. + The names of the entries that the error is associated with. + Format: + + - ``projects//agent``, if the error is + associated with the entire agent. + - ``projects//agent/intents/``, if + the error is associated with certain intents. + - ``projects//agent/intents//trainingPhrases/``, + if the error is associated with certain intent training + phrases. + - ``projects//agent/intents//parameters/``, + if the error is associated with certain intent + parameters. + - ``projects//agent/entities/``, if + the error is associated with certain entities. error_message (str): The detailed error message. """ diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/services/sessions/async_client.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/services/sessions/async_client.py index c0df8c2f755c..bf96fec62087 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/services/sessions/async_client.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/services/sessions/async_client.py @@ -323,13 +323,13 @@ async def sample_detect_intent(): Required. The input specification. It can be set to: - 1. an audio config - which instructs the speech - recognizer how to process the speech - audio, - 2. a conversational query in the form - of text, or - 3. an event that specifies which intent + 1. an audio config which instructs the + speech recognizer how to process the + speech audio, + + 2. a conversational query in the form of + text, or + 3. an event that specifies which intent to trigger. This corresponds to the ``query_input`` field diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/services/sessions/client.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/services/sessions/client.py index 41fad5b6b675..4f5d876c1b99 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/services/sessions/client.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/services/sessions/client.py @@ -627,13 +627,13 @@ def sample_detect_intent(): Required. The input specification. It can be set to: - 1. an audio config - which instructs the speech - recognizer how to process the speech - audio, - 2. a conversational query in the form - of text, or - 3. an event that specifies which intent + 1. an audio config which instructs the + speech recognizer how to process the + speech audio, + + 2. a conversational query in the form of + text, or + 3. an event that specifies which intent to trigger. This corresponds to the ``query_input`` field diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/audio_config.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/audio_config.py index 222881696be6..400b411f1390 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/audio_config.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/audio_config.py @@ -389,12 +389,15 @@ class BargeInConfig(proto.Message): The flow goes like below: - --> Time + :: - without speech detection \| utterance only \| utterance or no-speech - event \| \| +-------------+ \| +------------+ \| +---------------+ - ----------+ no barge-in +-|-+ barge-in +-|-+ normal period - +----------- +-------------+ \| +------------+ \| +---------------+ + --> Time + + without speech detection | utterance only | utterance or no-speech event + | | + +-------------+ | +------------+ | +---------------+ + ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- + +-------------+ | +------------+ | +---------------+ No-speech event is a response with END_OF_UTTERANCE without any transcript following up. @@ -456,11 +459,11 @@ class InputAudioConfig(proto.Message): documentation `__ for more details. - This field is deprecated. Please use `speech_contexts <>`__ - instead. If you specify both `phrase_hints <>`__ and - `speech_contexts <>`__, Dialogflow will treat the - `phrase_hints <>`__ as a single additional - `SpeechContext <>`__. + This field is deprecated. Please use + ```speech_contexts`` <>`__ instead. If you specify both + ```phrase_hints`` <>`__ and ```speech_contexts`` <>`__, + Dialogflow will treat the ```phrase_hints`` <>`__ as a + single additional ```SpeechContext`` <>`__. speech_contexts (MutableSequence[google.cloud.dialogflow_v2beta1.types.SpeechContext]): Context information to assist speech recognition. diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/context.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/context.py index 283fc4b6408c..2e5e87db3447 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/context.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/context.py @@ -65,8 +65,8 @@ class Context(proto.Message): - ``projects//locations//agent/environments//users//sessions//contexts/``, The ``Context ID`` is always converted to lowercase, may - only contain characters in a-zA-Z0-9_-% and may be at most - 250 bytes long. + only contain characters in ``a-zA-Z0-9_-%`` and may be at + most 250 bytes long. If ``Environment ID`` is not specified, we assume default 'draft' environment. If ``User ID`` is not specified, we @@ -86,31 +86,23 @@ class Context(proto.Message): automatically after 20 minutes if there are no matching queries. parameters (google.protobuf.struct_pb2.Struct): - Optional. The collection of parameters - associated with this context. - Depending on your protocol or client library - language, this is a map, associative array, - symbol table, dictionary, or JSON object - composed of a collection of (MapKey, MapValue) - pairs: - - - MapKey type: string - - MapKey value: parameter name - - MapValue type: + Optional. The collection of parameters associated with this + context. - - If parameter's entity type is a - composite entity: map - - Else: depending on parameter value type, - could be one of string, number, - boolean, null, list or map - - MapValue value: - - - If parameter's entity type is a - composite entity: + Depending on your protocol or client library language, this + is a map, associative array, symbol table, dictionary, or + JSON object composed of a collection of (MapKey, MapValue) + pairs: - map from composite entity property names - to property values - - Else: parameter value + - MapKey type: string + - MapKey value: parameter name + - MapValue type: If parameter's entity type is a composite + entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, + boolean, null, list or map. + - MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names + to property values, otherwise, use parameter value. """ name: str = proto.Field( diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/conversation.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/conversation.py index 68e7e3b8715f..74dd85309d5f 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/conversation.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/conversation.py @@ -201,7 +201,7 @@ class CreateConversationRequest(proto.Message): the response to return a auto-generated one to you. The conversation ID must be compliant with the regression - fomula "[a-zA-Z][a-zA-Z0-9_-]*" with the characters length + fomula ``[a-zA-Z][a-zA-Z0-9_-]*`` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/gcs.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/gcs.py index 3220909a562c..bc4a85895a95 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/gcs.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/gcs.py @@ -34,12 +34,9 @@ class GcsSources(proto.Message): Attributes: uris (MutableSequence[str]): - Required. Google Cloud Storage URIs for the - inputs. A URI is of the form: - - gs://bucket/object-prefix-or-name - Whether a prefix or name is used depends on the - use case. + Required. Google Cloud Storage URIs for the inputs. A URI is + of the form: ``gs://bucket/object-prefix-or-name`` Whether a + prefix or name is used depends on the use case. """ uris: MutableSequence[str] = proto.RepeatedField( @@ -53,12 +50,9 @@ class GcsSource(proto.Message): Attributes: uri (str): - Required. The Google Cloud Storage URIs for - the inputs. A URI is of the form: - - gs://bucket/object-prefix-or-name - Whether a prefix or name is used depends on the - use case. + Required. The Google Cloud Storage URIs for the inputs. A + URI is of the form: ``gs://bucket/object-prefix-or-name`` + Whether a prefix or name is used depends on the use case. """ uri: str = proto.Field( @@ -72,13 +66,11 @@ class GcsDestination(proto.Message): Attributes: uri (str): - Required. The Google Cloud Storage URIs for - the output. A URI is of the form: - - gs://bucket/object-prefix-or-name - Whether a prefix or name is used depends on the - use case. The requesting user must have - "write-permission" to the bucket. + Required. The Google Cloud Storage URIs for the output. A + URI is of the form: ``gs://bucket/object-prefix-or-name`` + Whether a prefix or name is used depends on the use case. + The requesting user must have "write-permission" to the + bucket. """ uri: str = proto.Field( diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/participant.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/participant.py index e5c17151f2f8..804871630d4f 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/participant.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/participant.py @@ -599,18 +599,13 @@ class SuggestionInput(proto.Message): - MapKey type: string - MapKey value: parameter name - - MapValue type: - - - If parameter's entity type is a composite entity: map - - Else: depending on parameter value type, could be one - of string, number, boolean, null, list or map - - - MapValue value: - - - If parameter's entity type is a composite entity: map - from composite entity property names to property - values - - Else: parameter value + - MapValue type: If parameter's entity type is a composite + entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, + boolean, null, list or map. + - MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names + to property values, otherwise, use parameter value. intent_input (google.cloud.dialogflow_v2beta1.types.IntentInput): The intent to be triggered on V3 agent. """ @@ -810,26 +805,23 @@ class AnalyzeContentRequest(proto.Message): Note: this field should only be used if you are connecting to a Dialogflow CX agent. message_send_time (google.protobuf.timestamp_pb2.Timestamp): - Optional. The send time of the message from - end user or human agent's perspective. It is - used for identifying the same message under one - participant. + Optional. The send time of the message from end user or + human agent's perspective. It is used for identifying the + same message under one participant. Given two messages under the same participant: - - If send time are different regardless of - whether the content of the messages are - exactly the same, the conversation will regard - them as two distinct messages sent by the - participant. - - If send time is the same regardless of - whether the content of the messages are - exactly the same, the conversation will regard - them as same message, and ignore the message - received later. - If the value is not provided, a new request will - always be regarded as a new message without any - de-duplication. + - If send time are different regardless of whether the + content of the messages are exactly the same, the + conversation will regard them as two distinct messages + sent by the participant. + - If send time is the same regardless of whether the + content of the messages are exactly the same, the + conversation will regard them as same message, and ignore + the message received later. + + If the value is not provided, a new request will always be + regarded as a new message without any de-duplication. request_id (str): A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/session.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/session.py index 1650d631b3a6..d8631d561705 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/session.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/session.py @@ -86,12 +86,12 @@ class DetectIntentRequest(proto.Message): Required. The input specification. It can be set to: - 1. an audio config - which instructs the speech recognizer how to - process the speech audio, - 2. a conversational query in the form of text, + 1. an audio config which instructs the speech + recognizer how to process the speech audio, + + 2. a conversational query in the form of text, or - 3. an event that specifies which intent to + 3. an event that specifies which intent to trigger. output_audio_config (google.cloud.dialogflow_v2beta1.types.OutputAudioConfig): Instructs the speech synthesizer how to @@ -334,12 +334,12 @@ class QueryParameters(proto.Message): class QueryInput(proto.Message): r"""Represents the query input. It can contain either: - 1. An audio config which - instructs the speech recognizer how to process the speech - audio. - 2. A conversational query in the form of text. + 1. An audio config which instructs the speech recognizer how to + process the speech audio. + + 2. A conversational query in the form of text. - 3. An event that specifies which intent to trigger. + 3. An event that specifies which intent to trigger. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -433,29 +433,21 @@ class QueryResult(proto.Message): The action name from the matched intent. parameters (google.protobuf.struct_pb2.Struct): The collection of extracted parameters. - Depending on your protocol or client library - language, this is a map, associative array, - symbol table, dictionary, or JSON object - composed of a collection of (MapKey, MapValue) - pairs: - - - MapKey type: string - - MapKey value: parameter name - - MapValue type: - - - If parameter's entity type is a - composite entity: map - - Else: depending on parameter value type, - could be one of string, number, - boolean, null, list or map - - MapValue value: - - If parameter's entity type is a - composite entity: + Depending on your protocol or client library language, this + is a map, associative array, symbol table, dictionary, or + JSON object composed of a collection of (MapKey, MapValue) + pairs: - map from composite entity property names - to property values - - Else: parameter value + - MapKey type: string + - MapKey value: parameter name + - MapValue type: If parameter's entity type is a composite + entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, + boolean, null, list or map. + - MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names + to property values, otherwise, use parameter value. all_required_params_present (bool): This field is set to: @@ -768,12 +760,12 @@ class StreamingDetectIntentRequest(proto.Message): Required. The input specification. It can be set to: - 1. an audio config which instructs the speech - recognizer how to process the speech audio, + 1. an audio config which instructs the speech + recognizer how to process the speech audio, - 2. a conversational query in the form of text, + 2. a conversational query in the form of text, or - 3. an event that specifies which intent to + 3. an event that specifies which intent to trigger. single_utterance (bool): DEPRECATED. Please use @@ -1309,31 +1301,22 @@ class EventInput(proto.Message): name (str): Required. The unique identifier of the event. parameters (google.protobuf.struct_pb2.Struct): - The collection of parameters associated with - the event. - Depending on your protocol or client library - language, this is a map, associative array, - symbol table, dictionary, or JSON object - composed of a collection of (MapKey, MapValue) - pairs: - - - MapKey type: string - - MapKey value: parameter name - - MapValue type: + The collection of parameters associated with the event. - - If parameter's entity type is a - composite entity: map - - Else: depending on parameter value type, - could be one of string, number, - boolean, null, list or map - - MapValue value: - - - If parameter's entity type is a - composite entity: + Depending on your protocol or client library language, this + is a map, associative array, symbol table, dictionary, or + JSON object composed of a collection of (MapKey, MapValue) + pairs: - map from composite entity property names - to property values - - Else: parameter value + - MapKey type: string + - MapKey value: parameter name + - MapValue type: If parameter's entity type is a composite + entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, + boolean, null, list or map. + - MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names + to property values, otherwise, use parameter value. language_code (str): Required. The language of this query. See `Language Support `__ diff --git a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/validation_result.py b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/validation_result.py index 900a9a93334a..c9945eb9b68a 100644 --- a/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/validation_result.py +++ b/packages/google-cloud-dialogflow/google/cloud/dialogflow_v2beta1/types/validation_result.py @@ -35,25 +35,21 @@ class ValidationError(proto.Message): severity (google.cloud.dialogflow_v2beta1.types.ValidationError.Severity): The severity of the error. entries (MutableSequence[str]): - The names of the entries that the error is - associated with. Format: - - - "projects//agent", if the error is - associated with the entire agent. - - "projects//agent/intents/", if the error is associated with certain - intents. - - "projects//agent/intents//trainingPhrases/", if - the error is associated with certain intent - training phrases. - - "projects//agent/intents//parameters/", if the error - is associated with certain intent parameters. - - "projects//agent/entities/", if the error is associated with certain - entities. + The names of the entries that the error is associated with. + Format: + + - ``projects//agent``, if the error is + associated with the entire agent. + - ``projects//agent/intents/``, if + the error is associated with certain intents. + - ``projects//agent/intents//trainingPhrases/``, + if the error is associated with certain intent training + phrases. + - ``projects//agent/intents//parameters/``, + if the error is associated with certain intent + parameters. + - ``projects//agent/entities/``, if + the error is associated with certain entities. error_message (str): The detailed error message. """