Skip to content

Commit 4dd75c2

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: added explanation for uri fields in resources
docs: improved docs format PiperOrigin-RevId: 435479428
1 parent cb38285 commit 4dd75c2

5 files changed

Lines changed: 79 additions & 48 deletions

File tree

‎google/cloud/dialogflow/cx/v3beta1/agent.proto‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,12 @@ message ExportAgentRequest {
348348
// export the agent to. The format of this URI must be
349349
// `gs://<bucket-name>/<object-name>`.
350350
// If left unspecified, the serialized agent is returned inline.
351+
//
352+
// Dialogflow performs a write operation for the Cloud Storage object
353+
// on the caller's behalf, so your request authentication must
354+
// have write permissions for the object. For more information, see
355+
// [Dialogflow access
356+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
351357
string agent_uri = 2 [(google.api.field_behavior) = OPTIONAL];
352358

353359
// Optional. Environment name. If not set, draft environment is assumed.
@@ -405,6 +411,12 @@ message RestoreAgentRequest {
405411
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
406412
// to restore agent from. The format of this URI must be
407413
// `gs://<bucket-name>/<object-name>`.
414+
//
415+
// Dialogflow performs a read operation for the Cloud Storage object
416+
// on the caller's behalf, so your request authentication must
417+
// have read permissions for the object. For more information, see
418+
// [Dialogflow access
419+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
408420
string agent_uri = 2;
409421

410422
// Uncompressed raw byte content for agent.

‎google/cloud/dialogflow/cx/v3beta1/flow.proto‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -559,6 +559,12 @@ message ImportFlowRequest {
559559
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
560560
// to import flow from. The format of this URI must be
561561
// `gs://<bucket-name>/<object-name>`.
562+
//
563+
// Dialogflow performs a read operation for the Cloud Storage object
564+
// on the caller's behalf, so your request authentication must
565+
// have read permissions for the object. For more information, see
566+
// [Dialogflow access
567+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
562568
string flow_uri = 2;
563569

564570
// Uncompressed raw byte content for flow.
@@ -595,6 +601,12 @@ message ExportFlowRequest {
595601
// export the flow to. The format of this URI must be
596602
// `gs://<bucket-name>/<object-name>`.
597603
// If left unspecified, the serialized flow is returned inline.
604+
//
605+
// Dialogflow performs a write operation for the Cloud Storage object
606+
// on the caller's behalf, so your request authentication must
607+
// have write permissions for the object. For more information, see
608+
// [Dialogflow access
609+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
598610
string flow_uri = 2 [(google.api.field_behavior) = OPTIONAL];
599611

600612
// Optional. Whether to export flows referenced by the specified flow.

‎google/cloud/dialogflow/cx/v3beta1/session.proto‎

Lines changed: 41 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -198,27 +198,26 @@ message DetectIntentResponse {
198198
//
199199
// Multiple request messages should be sent in order:
200200
//
201-
// 1. The first message must contain
202-
// [session][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.session],
203-
// [query_input][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.query_input] plus optionally
204-
// [query_params][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.query_params]. If the client
205-
// wants to receive an audio response, it should also contain
206-
// [output_audio_config][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.output_audio_config].
201+
// 1. The first message must contain
202+
// [session][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.session],
203+
// [query_input][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.query_input] plus optionally
204+
// [query_params][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.query_params]. If the client
205+
// wants to receive an audio response, it should also contain
206+
// [output_audio_config][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.output_audio_config].
207207
//
208208
// 2. If [query_input][google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequest.query_input] was set to
209-
// [query_input.audio.config][google.cloud.dialogflow.cx.v3beta1.AudioInput.config], all subsequent messages
210-
// must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3beta1.AudioInput.audio] to continue with
211-
// Speech recognition.
212-
// If you decide to rather detect an intent from text
213-
// input after you already started Speech recognition, please send a message
214-
// with [query_input.text][google.cloud.dialogflow.cx.v3beta1.QueryInput.text].
209+
// [query_input.audio.config][google.cloud.dialogflow.cx.v3beta1.AudioInput.config], all subsequent messages
210+
// must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3beta1.AudioInput.audio] to continue with
211+
// Speech recognition.
212+
// If you decide to rather detect an intent from text
213+
// input after you already started Speech recognition, please send a message
214+
// with [query_input.text][google.cloud.dialogflow.cx.v3beta1.QueryInput.text].
215215
//
216-
// However, note that:
217-
//
218-
// * Dialogflow will bill you for the audio duration so far.
219-
// * Dialogflow discards all Speech recognition results in favor of the
220-
// input text.
221-
// * Dialogflow will use the language code from the first message.
216+
// However, note that:
217+
// * Dialogflow will bill you for the audio duration so far.
218+
// * Dialogflow discards all Speech recognition results in favor of the input
219+
// text.
220+
// * Dialogflow will use the language code from the first message.
222221
//
223222
// After you sent all input, you must half-close or abort the request stream.
224223
message StreamingDetectIntentRequest {
@@ -438,16 +437,14 @@ message QueryParameters {
438437
// map, associative array, symbol table, dictionary, or JSON object
439438
// composed of a collection of (MapKey, MapValue) pairs:
440439
//
441-
// - MapKey type: string
442-
// - MapKey value: parameter name
443-
// - MapValue type:
444-
// - If parameter's entity type is a composite entity: map
445-
// - Else: depending on parameter value type, could be one of string,
446-
// number, boolean, null, list or map
447-
// - MapValue value:
448-
// - If parameter's entity type is a composite entity:
449-
// map from composite entity property names to property values
450-
// - Else: parameter value
440+
// * MapKey type: string
441+
// * MapKey value: parameter name
442+
// * MapValue type: If parameter's entity type is a composite entity then use
443+
// map, otherwise, depending on the parameter value type, it could be one of
444+
// string, number, boolean, null, list or map.
445+
// * MapValue value: If parameter's entity type is a composite entity then use
446+
// map from composite entity property names to property values, otherwise,
447+
// use parameter value.
451448
google.protobuf.Struct parameters = 5;
452449

453450
// The unique identifier of the [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
@@ -573,16 +570,14 @@ message QueryResult {
573570
// map, associative array, symbol table, dictionary, or JSON object
574571
// composed of a collection of (MapKey, MapValue) pairs:
575572
//
576-
// - MapKey type: string
577-
// - MapKey value: parameter name
578-
// - MapValue type:
579-
// - If parameter's entity type is a composite entity: map
580-
// - Else: depending on parameter value type, could be one of string,
581-
// number, boolean, null, list or map
582-
// - MapValue value:
583-
// - If parameter's entity type is a composite entity:
584-
// map from composite entity property names to property values
585-
// - Else: parameter value
573+
// * MapKey type: string
574+
// * MapKey value: parameter name
575+
// * MapValue type: If parameter's entity type is a composite entity then use
576+
// map, otherwise, depending on the parameter value type, it could be one of
577+
// string, number, boolean, null, list or map.
578+
// * MapValue value: If parameter's entity type is a composite entity then use
579+
// map from composite entity property names to property values, otherwise,
580+
// use parameter value.
586581
google.protobuf.Struct parameters = 3;
587582

588583
// The list of rich messages returned to the client. Responses vary from
@@ -726,16 +721,14 @@ message Match {
726721
// map, associative array, symbol table, dictionary, or JSON object
727722
// composed of a collection of (MapKey, MapValue) pairs:
728723
//
729-
// - MapKey type: string
730-
// - MapKey value: parameter name
731-
// - MapValue type:
732-
// - If parameter's entity type is a composite entity: map
733-
// - Else: depending on parameter value type, could be one of string,
734-
// number, boolean, null, list or map
735-
// - MapValue value:
736-
// - If parameter's entity type is a composite entity:
737-
// map from composite entity property names to property values
738-
// - Else: parameter value
724+
// * MapKey type: string
725+
// * MapKey value: parameter name
726+
// * MapValue type: If parameter's entity type is a composite entity then use
727+
// map, otherwise, depending on the parameter value type, it could be one of
728+
// string, number, boolean, null, list or map.
729+
// * MapValue value: If parameter's entity type is a composite entity then use
730+
// map from composite entity property names to property values, otherwise,
731+
// use parameter value.
739732
google.protobuf.Struct parameters = 2;
740733

741734
// Final text input which was matched during MatchIntent. This value can be

‎google/cloud/dialogflow/cx/v3beta1/test_case.proto‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -761,6 +761,12 @@ message ImportTestCasesRequest {
761761
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
762762
// to import test cases from. The format of this URI must be
763763
// `gs://<bucket-name>/<object-name>`.
764+
//
765+
// Dialogflow performs a read operation for the Cloud Storage object
766+
// on the caller's behalf, so your request authentication must
767+
// have read permissions for the object. For more information, see
768+
// [Dialogflow access
769+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
764770
string gcs_uri = 2;
765771

766772
// Uncompressed raw byte content for test cases.
@@ -823,6 +829,12 @@ message ExportTestCasesRequest {
823829
// export the test cases to. The format of this URI must be
824830
// `gs://<bucket-name>/<object-name>`. If unspecified, the serialized test
825831
// cases is returned inline.
832+
//
833+
// Dialogflow performs a write operation for the Cloud Storage object
834+
// on the caller's behalf, so your request authentication must
835+
// have write permissions for the object. For more information, see
836+
// [Dialogflow access
837+
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
826838
string gcs_uri = 2;
827839
}
828840

‎google/cloud/dialogflow/cx/v3beta1/webhook.proto‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,12 @@ message Webhook {
121121
// N.B. Make sure the HTTPS server certificates are signed with "subject alt
122122
// name". For instance a certificate can be self-signed using the following
123123
// command,
124+
// ```
124125
// openssl x509 -req -days 200 -in example.com.csr \
125126
// -signkey example.com.key \
126127
// -out example.com.crt \
127128
// -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
129+
// ```
128130
repeated bytes allowed_ca_certs = 5 [(google.api.field_behavior) = OPTIONAL];
129131
}
130132

0 commit comments

Comments
 (0)