Skip to content

Commit 2e29020

Browse files
Google APIscopybara-github
authored andcommitted
docs: test cases doc update
PiperOrigin-RevId: 353683381
1 parent 43655b7 commit 2e29020

3 files changed

Lines changed: 40 additions & 40 deletions

File tree

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

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,31 @@ option java_outer_classname = "AudioConfigProto";
2929
option java_package = "com.google.cloud.dialogflow.cx.v3";
3030
option objc_class_prefix = "DF";
3131

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

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

google/cloud/dialogflow/cx/v3/response_message.proto

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,18 @@ message ResponseMessage {
120120

121121
}
122122

123+
// Specifies an audio clip to be played by the client as part of the response.
124+
message PlayAudio {
125+
// Required. URI of the audio clip. Dialogflow does not impose any validation on this
126+
// value. It is specific to the client that reads it.
127+
string audio_uri = 1 [(google.api.field_behavior) = REQUIRED];
128+
129+
// Output only. Whether the playback of this message can be interrupted by the end
130+
// user's speech and the client can then starts the next Dialogflow
131+
// request.
132+
bool allow_playback_interruption = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
133+
}
134+
123135
// Represents an audio message that is composed of both segments
124136
// synthesized from the Dialogflow agent prompts and ones hosted externally
125137
// at the specified URIs.
@@ -151,18 +163,6 @@ message ResponseMessage {
151163
repeated Segment segments = 1;
152164
}
153165

154-
// Specifies an audio clip to be played by the client as part of the response.
155-
message PlayAudio {
156-
// Required. URI of the audio clip. Dialogflow does not impose any validation on this
157-
// value. It is specific to the client that reads it.
158-
string audio_uri = 1 [(google.api.field_behavior) = REQUIRED];
159-
160-
// Output only. Whether the playback of this message can be interrupted by the end
161-
// user's speech and the client can then starts the next Dialogflow
162-
// request.
163-
bool allow_playback_interruption = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
164-
}
165-
166166
// Required. The rich response message.
167167
oneof message {
168168
// Returns a text response.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -535,9 +535,9 @@ message UpdateTestCaseRequest {
535535
// Required. The test case to update.
536536
TestCase test_case = 1 [(google.api.field_behavior) = REQUIRED];
537537

538-
// Required. The mask to specify which fields should be updated. Only a test case's
539-
// metadata and replayed_conversation_turns may be updated. The original
540-
// test_case_conversation_turns may not be updated.
538+
// Required. The mask to specify which fields should be updated. The
539+
// [`creationTime`][google.cloud.dialogflow.cx.v3.TestCase.creation_time] and
540+
// [`lastTestResult`][google.cloud.dialogflow.cx.v3.TestCase.last_test_result] cannot be updated.
541541
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
542542
}
543543

0 commit comments

Comments
 (0)