docs: Minor formatting

PiperOrigin-RevId: 552790519
googleapis · Aug 1, 2023 · a03330a · a03330a
1 parent 1dcb40c
commit a03330a
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 74 deletions.
diff --git a/google/cloud/dialogflow/v2beta1/audio_config.proto b/google/cloud/dialogflow/v2beta1/audio_config.proto
@@ -115,13 +115,15 @@ message SpeechWordInfo {
 //
 // The flow goes like below:
 //
+// ```
 // --> 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.
@@ -167,9 +169,9 @@ message InputAudioConfig {
   // 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`]().
   repeated string phrase_hints = 4 [deprecated = true];
 
   // Context information to assist speech recognition.

diff --git a/google/cloud/dialogflow/v2beta1/context.proto b/google/cloud/dialogflow/v2beta1/context.proto
@@ -190,7 +190,7 @@ message Context {
   //   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.
+  // 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 assume default '-' user.
@@ -215,16 +215,14 @@ message Context {
   // 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:
-  //         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.
   google.protobuf.Struct parameters = 3;
 }
 

diff --git a/google/cloud/dialogflow/v2beta1/conversation.proto b/google/cloud/dialogflow/v2beta1/conversation.proto
@@ -290,7 +290,7 @@ message CreateConversationRequest {
   // 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 in range of [3,64].
+  // `[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
   // 1. the uniqueness of the ID, otherwise the request will be rejected.
   // 2. the consistency for whether to use custom ID or not under a project to

diff --git a/google/cloud/dialogflow/v2beta1/gcs.proto b/google/cloud/dialogflow/v2beta1/gcs.proto
@@ -30,7 +30,7 @@ option objc_class_prefix = "DF";
 message GcsSources {
   // Required. Google Cloud Storage URIs for the inputs. A URI is of the
   // form:
-  //   gs://bucket/object-prefix-or-name
+  // `gs://bucket/object-prefix-or-name`
   // Whether a prefix or name is used depends on the use case.
   repeated string uris = 2 [(google.api.field_behavior) = REQUIRED];
 }
@@ -39,7 +39,7 @@ message GcsSources {
 message GcsSource {
   // Required. The Google Cloud Storage URIs for the inputs. A URI is of the
   // form:
-  //   gs://bucket/object-prefix-or-name
+  // `gs://bucket/object-prefix-or-name`
   // Whether a prefix or name is used depends on the use case.
   string uri = 1;
 }
@@ -48,7 +48,7 @@ message GcsSource {
 message GcsDestination {
   // Required. The Google Cloud Storage URIs for the output. A URI is of the
   // form:
-  //   gs://bucket/object-prefix-or-name
+  // `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.
   string uri = 1;

diff --git a/google/cloud/dialogflow/v2beta1/participant.proto b/google/cloud/dialogflow/v2beta1/participant.proto
@@ -568,16 +568,14 @@ message SuggestionInput {
   // 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:
-  //         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.
   google.protobuf.Struct parameters = 4;
 
   // The intent to be triggered on V3 agent.
@@ -720,12 +718,12 @@ message AnalyzeContentRequest {
   // 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 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.

diff --git a/google/cloud/dialogflow/v2beta1/session.proto b/google/cloud/dialogflow/v2beta1/session.proto
@@ -146,12 +146,12 @@ message DetectIntentRequest {
 
   // 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, or
+  // 2. a conversational query in the form of text, or
   //
-  // 3.  an event that specifies which intent to trigger.
+  // 3. an event that specifies which intent to trigger.
   QueryInput query_input = 3 [(google.api.field_behavior) = REQUIRED];
 
   // Instructs the speech synthesizer how to generate the output
@@ -275,12 +275,12 @@ message QueryParameters {
 
 // Represents the query input. It can contain either:
 //
-// 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.
 //
-// 3.  An event that specifies which intent to trigger.
+// 3. An event that specifies which intent to trigger.
 message QueryInput {
   // Required. The input specification.
   oneof input {
@@ -337,16 +337,14 @@ message QueryResult {
   // 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:
-  //         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.
   google.protobuf.Struct parameters = 4;
 
   // This field is set to:
@@ -545,12 +543,12 @@ message StreamingDetectIntentRequest {
 
   // 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, or
+  // 2. a conversational query in the form of text, or
   //
-  // 3.  an event that specifies which intent to trigger.
+  // 3. an event that specifies which intent to trigger.
   QueryInput query_input = 3 [(google.api.field_behavior) = REQUIRED];
 
   // DEPRECATED. Please use
@@ -857,16 +855,14 @@ message EventInput {
   // 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:
-  //         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.
   google.protobuf.Struct parameters = 2;
 
   // Required. The language of this query. See [Language

diff --git a/google/cloud/dialogflow/v2beta1/validation_result.proto b/google/cloud/dialogflow/v2beta1/validation_result.proto
@@ -50,16 +50,16 @@ message ValidationError {
   // The names of the entries that the error is associated with.
   // Format:
   //
-  // - "projects/<Project ID>/agent", if the error is associated with the entire
+  // - `projects/<Project ID>/agent`, if the error is associated with the entire
   // agent.
-  // - "projects/<Project ID>/agent/intents/<Intent ID>", if the error is
+  // - `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
+  // - `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.
   repeated string entries = 3;