docs: clarified some LRO types

docs: fixed some wrong update mask descriptions

PiperOrigin-RevId: 393365899
pull/671/head^2
Google APIs 4 years ago committed by Copybara-Service
parent 848854523c
commit 43095748d6
  1. 10
      google/cloud/dialogflow/cx/v3/BUILD.bazel
  2. 7
      google/cloud/dialogflow/cx/v3/agent.proto
  3. 51
      google/cloud/dialogflow/cx/v3/audio_config.proto
  4. 6
      google/cloud/dialogflow/cx/v3/flow.proto
  5. 9
      google/cloud/dialogflow/cx/v3/test_case.proto

@ -91,12 +91,18 @@ java_grpc_library(
java_gapic_library( java_gapic_library(
name = "cx_java_gapic", name = "cx_java_gapic",
srcs = [":cx_proto_with_info"], srcs = [":cx_proto_with_info"],
gapic_yaml = None,
grpc_service_config = "dialogflow_grpc_service_config.json", grpc_service_config = "dialogflow_grpc_service_config.json",
service_yaml = "dialogflow_v3.yaml",
test_deps = [ test_deps = [
":cx_java_grpc", ":cx_java_grpc",
"//google/cloud/location:location_java_grpc",
], ],
deps = [ deps = [
":cx_java_proto", ":cx_java_proto",
"//google/api:api_java_proto",
"//google/cloud/location:location_java_grpc",
"//google/cloud/location:location_java_proto",
], ],
) )
@ -129,6 +135,9 @@ java_gapic_assembly_gradle_pkg(
":cx_java_grpc", ":cx_java_grpc",
":cx_java_proto", ":cx_java_proto",
":cx_proto", ":cx_proto",
"//google/cloud/location:location_java_grpc",
"//google/cloud/location:location_java_proto",
"//google/cloud/location:location_proto",
], ],
) )
@ -165,6 +174,7 @@ go_gapic_library(
service_yaml = "dialogflow_v3.yaml", service_yaml = "dialogflow_v3.yaml",
deps = [ deps = [
":cx_go_proto", ":cx_go_proto",
"//google/cloud/location:location_go_proto",
"//google/longrunning:longrunning_go_proto", "//google/longrunning:longrunning_go_proto",
"@com_google_cloud_go//longrunning:go_default_library", "@com_google_cloud_go//longrunning:go_default_library",
"@com_google_cloud_go//longrunning/autogen:go_default_library", "@com_google_cloud_go//longrunning/autogen:go_default_library",

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

@ -19,6 +19,7 @@ package google.cloud.dialogflow.cx.v3;
import "google/api/field_behavior.proto"; import "google/api/field_behavior.proto";
import "google/api/resource.proto"; import "google/api/resource.proto";
import "google/protobuf/duration.proto"; import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto"; import "google/api/annotations.proto";
option cc_enable_arenas = true; option cc_enable_arenas = true;
@ -30,31 +31,6 @@ option java_package = "com.google.cloud.dialogflow.cx.v3";
option objc_class_prefix = "DF"; option objc_class_prefix = "DF";
option ruby_package = "Google::Cloud::Dialogflow::CX::V3"; option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
// Information for a word recognized by the speech recognizer.
message SpeechWordInfo {
// The word this info is for.
string word = 3;
// Time offset relative to the beginning of the audio that corresponds to the
// start of the spoken word. This is an experimental feature and the accuracy
// of the time offset can vary.
google.protobuf.Duration start_offset = 1;
// Time offset relative to the beginning of the audio that corresponds to the
// end of the spoken word. This is an experimental feature and the accuracy of
// the time offset can vary.
google.protobuf.Duration end_offset = 2;
// The Speech confidence between 0.0 and 1.0 for this word. A higher number
// indicates an estimated greater likelihood that the recognized word is
// correct. The default of 0.0 is a sentinel value indicating that confidence
// was not set.
//
// This field is not guaranteed to be fully stable over time for the same
// audio input. Users should also not rely on it to always be provided.
float confidence = 4;
}
// Audio encoding of the audio content sent in the conversational query request. // Audio encoding of the audio content sent in the conversational query request.
// Refer to the // Refer to the
// [Cloud Speech API // [Cloud Speech API
@ -104,6 +80,31 @@ enum AudioEncoding {
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7; AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7;
} }
// Information for a word recognized by the speech recognizer.
message SpeechWordInfo {
// The word this info is for.
string word = 3;
// Time offset relative to the beginning of the audio that corresponds to the
// start of the spoken word. This is an experimental feature and the accuracy
// of the time offset can vary.
google.protobuf.Duration start_offset = 1;
// Time offset relative to the beginning of the audio that corresponds to the
// end of the spoken word. This is an experimental feature and the accuracy of
// the time offset can vary.
google.protobuf.Duration end_offset = 2;
// The Speech confidence between 0.0 and 1.0 for this word. A higher number
// indicates an estimated greater likelihood that the recognized word is
// correct. The default of 0.0 is a sentinel value indicating that confidence
// was not set.
//
// This field is not guaranteed to be fully stable over time for the same
// audio input. Users should also not rely on it to always be provided.
float confidence = 4;
}
// Instructs the speech recognizer on how to process the audio content. // Instructs the speech recognizer on how to process the audio content.
message InputAudioConfig { message InputAudioConfig {
// Required. Audio encoding of the audio content to process. // Required. Audio encoding of the audio content to process.

@ -420,9 +420,9 @@ message UpdateFlowRequest {
// Required. The flow to update. // Required. The flow to update.
Flow flow = 1 [(google.api.field_behavior) = REQUIRED]; Flow flow = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The mask to control which fields get updated. If `update_mask` is not // The mask to control which fields get updated. If the mask is not present,
// specified, an error will be returned. // all fields will be updated.
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; google.protobuf.FieldMask update_mask = 2;
// The language of the following fields in `flow`: // The language of the following fields in `flow`:
// //

@ -94,6 +94,12 @@ service TestCases {
} }
// Kicks off a test case run. // Kicks off a test case run.
// This method is a [long-running
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
// The returned `Operation` type has the following method-specific fields:
//
// - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
// - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
rpc RunTestCase(RunTestCaseRequest) returns (google.longrunning.Operation) { rpc RunTestCase(RunTestCaseRequest) returns (google.longrunning.Operation) {
option (google.api.http) = { option (google.api.http) = {
post: "/v3/{name=projects/*/locations/*/agents/*/testCases/*}:run" post: "/v3/{name=projects/*/locations/*/agents/*/testCases/*}:run"
@ -284,7 +290,7 @@ message ConversationTurn {
// Required. Input only. The diagnostic // Required. Input only. The diagnostic
// [info][Session.DetectIntentResponse.QueryResult.diagnostic_info] // [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
// output for the turn. // output for the turn. Required to calculate the testing coverage.
google.protobuf.Struct diagnostic_info = 6 [ google.protobuf.Struct diagnostic_info = 6 [
(google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = INPUT_ONLY (google.api.field_behavior) = INPUT_ONLY
@ -635,6 +641,7 @@ message RunTestCaseResponse {
} }
// Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase] long running operation. // Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase] long running operation.
// This message currently has no fields.
message RunTestCaseMetadata { message RunTestCaseMetadata {
} }

Loading…
Cancel
Save