Skip to content

Commit

Permalink
docs: Minor formatting (#658)
Browse files Browse the repository at this point in the history
* docs: Minor formatting

PiperOrigin-RevId: 552790519

Source-Link: googleapis/googleapis@a03330a

Source-Link: googleapis/googleapis-gen@4caca49
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: googleapis/googleapis@7154a94

Source-Link: googleapis/googleapis-gen@4538a83
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 <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
  • Loading branch information
3 people authored Aug 1, 2023
1 parent 42a1757 commit 1e506d8
Show file tree
Hide file tree
Showing 17 changed files with 229 additions and 308 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -397,11 +397,11 @@ class InputAudioConfig(proto.Message):
documentation <https://cloud.google.com/speech-to-text/docs/basics#phrase-hints>`__
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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ class Context(proto.Message):
``projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>``.
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
Expand All @@ -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(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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 <https://cloud.google.com/dialogflow/docs/reference/language>`__
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/<Project ID>/agent", if the error is
associated with the entire agent.
- "projects/<Project ID>/agent/intents/<Intent
ID>", if the error is associated with certain
intents.
- "projects/<Project
ID>/agent/intents/<Intent
Id>/trainingPhrases/<Training Phrase ID>", if
the error is associated with certain intent
training phrases.
- "projects/<Project ID>/agent/intents/<Intent
Id>/parameters/<Parameter ID>", if the error
is associated with certain intent parameters.
- "projects/<Project ID>/agent/entities/<Entity
ID>", if the error is associated with certain
entities.
The names of the entries that the error is associated with.
Format:
- ``projects/<Project ID>/agent``, if the error is
associated with the entire agent.
- ``projects/<Project ID>/agent/intents/<Intent ID>``, if
the error is associated with certain intents.
- ``projects/<Project ID>/agent/intents/<Intent Id>/trainingPhrases/<Training Phrase ID>``,
if the error is associated with certain intent training
phrases.
- ``projects/<Project ID>/agent/intents/<Intent Id>/parameters/<Parameter ID>``,
if the error is associated with certain intent
parameters.
- ``projects/<Project ID>/agent/entities/<Entity ID>``, if
the error is associated with certain entities.
error_message (str):
The detailed error message.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 1e506d8

Please sign in to comment.