Skip to content

Commit 4309574

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: clarified some LRO types
docs: fixed some wrong update mask descriptions PiperOrigin-RevId: 393365899
1 parent 8488545 commit 4309574

5 files changed

Lines changed: 54 additions & 29 deletions

File tree

‎google/cloud/dialogflow/cx/v3/BUILD.bazel‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,18 @@ java_grpc_library(
9191
java_gapic_library(
9292
name = "cx_java_gapic",
9393
srcs = [":cx_proto_with_info"],
94+
gapic_yaml = None,
9495
grpc_service_config = "dialogflow_grpc_service_config.json",
96+
service_yaml = "dialogflow_v3.yaml",
9597
test_deps = [
9698
":cx_java_grpc",
99+
"//google/cloud/location:location_java_grpc",
97100
],
98101
deps = [
99102
":cx_java_proto",
103+
"//google/api:api_java_proto",
104+
"//google/cloud/location:location_java_grpc",
105+
"//google/cloud/location:location_java_proto",
100106
],
101107
)
102108

@@ -129,6 +135,9 @@ java_gapic_assembly_gradle_pkg(
129135
":cx_java_grpc",
130136
":cx_java_proto",
131137
":cx_proto",
138+
"//google/cloud/location:location_java_grpc",
139+
"//google/cloud/location:location_java_proto",
140+
"//google/cloud/location:location_proto",
132141
],
133142
)
134143

@@ -165,6 +174,7 @@ go_gapic_library(
165174
service_yaml = "dialogflow_v3.yaml",
166175
deps = [
167176
":cx_go_proto",
177+
"//google/cloud/location:location_go_proto",
168178
"//google/longrunning:longrunning_go_proto",
169179
"@com_google_cloud_go//longrunning:go_default_library",
170180
"@com_google_cloud_go//longrunning/autogen:go_default_library",

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,13 @@ service Agents {
9494
}
9595

9696
// Exports the specified agent to a binary file.
97+
// This method is a [long-running
98+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
99+
// The returned `Operation` type has the following method-specific fields:
100+
//
101+
// - `metadata`: An empty [Struct
102+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
103+
// - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
97104
rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
98105
option (google.api.http) = {
99106
post: "/v3/{name=projects/*/locations/*/agents/*}:export"

‎google/cloud/dialogflow/cx/v3/audio_config.proto‎

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ package google.cloud.dialogflow.cx.v3;
1919
import "google/api/field_behavior.proto";
2020
import "google/api/resource.proto";
2121
import "google/protobuf/duration.proto";
22+
import "google/protobuf/timestamp.proto";
2223
import "google/api/annotations.proto";
2324

2425
option cc_enable_arenas = true;
@@ -30,31 +31,6 @@ option java_package = "com.google.cloud.dialogflow.cx.v3";
3031
option objc_class_prefix = "DF";
3132
option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
3233

33-
// Information for a word recognized by the speech recognizer.
34-
message SpeechWordInfo {
35-
// The word this info is for.
36-
string word = 3;
37-
38-
// Time offset relative to the beginning of the audio that corresponds to the
39-
// start of the spoken word. This is an experimental feature and the accuracy
40-
// of the time offset can vary.
41-
google.protobuf.Duration start_offset = 1;
42-
43-
// Time offset relative to the beginning of the audio that corresponds to the
44-
// end of the spoken word. This is an experimental feature and the accuracy of
45-
// the time offset can vary.
46-
google.protobuf.Duration end_offset = 2;
47-
48-
// The Speech confidence between 0.0 and 1.0 for this word. A higher number
49-
// indicates an estimated greater likelihood that the recognized word is
50-
// correct. The default of 0.0 is a sentinel value indicating that confidence
51-
// was not set.
52-
//
53-
// This field is not guaranteed to be fully stable over time for the same
54-
// audio input. Users should also not rely on it to always be provided.
55-
float confidence = 4;
56-
}
57-
5834
// Audio encoding of the audio content sent in the conversational query request.
5935
// Refer to the
6036
// [Cloud Speech API
@@ -104,6 +80,31 @@ enum AudioEncoding {
10480
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7;
10581
}
10682

83+
// Information for a word recognized by the speech recognizer.
84+
message SpeechWordInfo {
85+
// The word this info is for.
86+
string word = 3;
87+
88+
// Time offset relative to the beginning of the audio that corresponds to the
89+
// start of the spoken word. This is an experimental feature and the accuracy
90+
// of the time offset can vary.
91+
google.protobuf.Duration start_offset = 1;
92+
93+
// Time offset relative to the beginning of the audio that corresponds to the
94+
// end of the spoken word. This is an experimental feature and the accuracy of
95+
// the time offset can vary.
96+
google.protobuf.Duration end_offset = 2;
97+
98+
// The Speech confidence between 0.0 and 1.0 for this word. A higher number
99+
// indicates an estimated greater likelihood that the recognized word is
100+
// correct. The default of 0.0 is a sentinel value indicating that confidence
101+
// was not set.
102+
//
103+
// This field is not guaranteed to be fully stable over time for the same
104+
// audio input. Users should also not rely on it to always be provided.
105+
float confidence = 4;
106+
}
107+
107108
// Instructs the speech recognizer on how to process the audio content.
108109
message InputAudioConfig {
109110
// Required. Audio encoding of the audio content to process.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -420,9 +420,9 @@ message UpdateFlowRequest {
420420
// Required. The flow to update.
421421
Flow flow = 1 [(google.api.field_behavior) = REQUIRED];
422422

423-
// Required. The mask to control which fields get updated. If `update_mask` is not
424-
// specified, an error will be returned.
425-
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
423+
// The mask to control which fields get updated. If the mask is not present,
424+
// all fields will be updated.
425+
google.protobuf.FieldMask update_mask = 2;
426426

427427
// The language of the following fields in `flow`:
428428
//

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,12 @@ service TestCases {
9494
}
9595

9696
// Kicks off a test case run.
97+
// This method is a [long-running
98+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
99+
// The returned `Operation` type has the following method-specific fields:
100+
//
101+
// - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
102+
// - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
97103
rpc RunTestCase(RunTestCaseRequest) returns (google.longrunning.Operation) {
98104
option (google.api.http) = {
99105
post: "/v3/{name=projects/*/locations/*/agents/*/testCases/*}:run"
@@ -284,7 +290,7 @@ message ConversationTurn {
284290

285291
// Required. Input only. The diagnostic
286292
// [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
287-
// output for the turn.
293+
// output for the turn. Required to calculate the testing coverage.
288294
google.protobuf.Struct diagnostic_info = 6 [
289295
(google.api.field_behavior) = REQUIRED,
290296
(google.api.field_behavior) = INPUT_ONLY
@@ -635,6 +641,7 @@ message RunTestCaseResponse {
635641
}
636642

637643
// Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase] long running operation.
644+
// This message currently has no fields.
638645
message RunTestCaseMetadata {
639646

640647
}

0 commit comments

Comments
 (0)