Skip to content

Commit 24d9b56

Browse files
feat: [cx] updated v3 dialogflow client libraries with dtmf_pattern and trace_blocks (#7846)
* feat: updated v3beta1 dialogflow client libraries with `dtmf_pattern` and `trace_blocks` PiperOrigin-RevId: 887053734 Source-Link: googleapis/googleapis@7e8511a Source-Link: googleapis/googleapis-gen@ff745a4 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpYWxvZ2Zsb3ctY3gvLk93bEJvdC55YW1sIiwiaCI6ImZmNzQ1YTQ5OGEwMWMyY2YzMjlhZTVjOWRiMDcwZGRmY2NiMDM2MjEifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: updated v3 dialogflow client libraries with `dtmf_pattern` and `trace_blocks` PiperOrigin-RevId: 888886398 Source-Link: googleapis/googleapis@59d5f2b Source-Link: googleapis/googleapis-gen@614ee10 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpYWxvZ2Zsb3ctY3gvLk93bEJvdC55YW1sIiwiaCI6IjYxNGVlMTA5MWUzOTcxYzhhZmM2MzgxY2QxNTljZmYwNDE1NThhMTUifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 48591e5 commit 24d9b56

9 files changed

Lines changed: 16661 additions & 12800 deletions

File tree

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/intent.proto

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,9 @@ message Intent {
281281
// Human readable description for better understanding an intent like its
282282
// scope, content, result etc. Maximum character limit: 140 characters.
283283
string description = 8;
284+
285+
// Optional. Matching DTMF pattern for the intent.
286+
string dtmf_pattern = 16 [(google.api.field_behavior) = OPTIONAL];
284287
}
285288

286289
// The request message for

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/session.proto

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import "google/cloud/dialogflow/cx/v3/page.proto";
3030
import "google/cloud/dialogflow/cx/v3/response_message.proto";
3131
import "google/cloud/dialogflow/cx/v3/session_entity_type.proto";
3232
import "google/cloud/dialogflow/cx/v3/tool_call.proto";
33+
import "google/cloud/dialogflow/cx/v3/trace.proto";
3334
import "google/protobuf/duration.proto";
3435
import "google/protobuf/field_mask.proto";
3536
import "google/protobuf/struct.proto";
@@ -1134,6 +1135,13 @@ message QueryResult {
11341135
// Filled only when data stores are involved in serving the query.
11351136
DataStoreConnectionSignals data_store_connection_signals = 35
11361137
[(google.api.field_behavior) = OPTIONAL];
1138+
1139+
// Optional. Contains the sequence of trace blocks from the current
1140+
// conversation turn. Trace blocks are ordered chronologically and contain
1141+
// detailed traces of runtime behavior such as tool calls, LLM calls, flow and
1142+
// playbook invocations, agent utterances and user utterances.
1143+
repeated TraceBlock trace_blocks = 37
1144+
[(google.api.field_behavior) = OPTIONAL];
11371145
}
11381146

11391147
// Represents the natural language text to be processed.

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/trace.proto

Lines changed: 78 additions & 0 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/struct.proto";
22+
import "google/protobuf/timestamp.proto";
2223

2324
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
2425
option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
@@ -28,6 +29,83 @@ option java_package = "com.google.cloud.dialogflow.cx.v3";
2829
option objc_class_prefix = "DF";
2930
option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
3031

32+
// The trace block tracks a sequence of actions taken by the agent in a flow or
33+
// a playbook.
34+
message TraceBlock {
35+
// Metadata of the trace.
36+
oneof trace_metadata {
37+
// Metadata of the playbook trace.
38+
PlaybookTraceMetadata playbook_trace_metadata = 1;
39+
40+
// Metadata of the flow trace.
41+
FlowTraceMetadata flow_trace_metadata = 2;
42+
43+
// Metadata of the speech-to-text and speech-to-text processing.
44+
SpeechProcessingMetadata speech_processing_metadata = 8;
45+
}
46+
47+
// The actions performed by the agent and the user during this session.
48+
repeated Action actions = 3;
49+
50+
// Output only. Timestamp of the start of the trace block.
51+
google.protobuf.Timestamp start_time = 4
52+
[(google.api.field_behavior) = OUTPUT_ONLY];
53+
54+
// Output only. Timestamp of the end of the trace block.
55+
google.protobuf.Timestamp complete_time = 5
56+
[(google.api.field_behavior) = OUTPUT_ONLY];
57+
58+
// Optional. A list of input parameters of the trace block.
59+
google.protobuf.Struct input_parameters = 9
60+
[(google.api.field_behavior) = OPTIONAL];
61+
62+
// Optional. A list of output parameters of the trace block.
63+
google.protobuf.Struct output_parameters = 6
64+
[(google.api.field_behavior) = OPTIONAL];
65+
66+
// Optional. Output only. The end state of the trace block.
67+
OutputState end_state = 7 [
68+
(google.api.field_behavior) = OUTPUT_ONLY,
69+
(google.api.field_behavior) = OPTIONAL
70+
];
71+
}
72+
73+
// Metadata of the speech-to-text and text-to-speech processing.
74+
message SpeechProcessingMetadata {
75+
// Output only. The display name of the speech processing.
76+
string display_name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
77+
}
78+
79+
// Metadata of the playbook trace.
80+
message PlaybookTraceMetadata {
81+
// Required. The unique identifier of the playbook.
82+
// Format:
83+
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
84+
string playbook = 1 [
85+
(google.api.field_behavior) = REQUIRED,
86+
(google.api.resource_reference) = {
87+
type: "dialogflow.googleapis.com/Playbook"
88+
}
89+
];
90+
91+
// Output only. The display name of the playbook.
92+
string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
93+
}
94+
95+
// Metadata of the flow trace.
96+
message FlowTraceMetadata {
97+
// Required. The unique identifier of the flow.
98+
// Format:
99+
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
100+
string flow = 1 [
101+
(google.api.field_behavior) = REQUIRED,
102+
(google.api.resource_reference) = { type: "dialogflow.googleapis.com/Flow" }
103+
];
104+
105+
// Output only. The display name of the flow.
106+
string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
107+
}
108+
31109
// Input of the playbook.
32110
message PlaybookInput {
33111
// Optional. Summary string of the preceding conversation for the child

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/intent.proto

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,9 @@ message Intent {
283283
// Human readable description for better understanding an intent like its
284284
// scope, content, result etc. Maximum character limit: 140 characters.
285285
string description = 8;
286+
287+
// Optional. Matching DTMF pattern for the intent.
288+
string dtmf_pattern = 16 [(google.api.field_behavior) = OPTIONAL];
286289
}
287290

288291
// The request message for

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/session.proto

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import "google/cloud/dialogflow/cx/v3beta1/page.proto";
3131
import "google/cloud/dialogflow/cx/v3beta1/response_message.proto";
3232
import "google/cloud/dialogflow/cx/v3beta1/session_entity_type.proto";
3333
import "google/cloud/dialogflow/cx/v3beta1/tool_call.proto";
34+
import "google/cloud/dialogflow/cx/v3beta1/trace.proto";
3435
import "google/protobuf/duration.proto";
3536
import "google/protobuf/field_mask.proto";
3637
import "google/protobuf/struct.proto";
@@ -1167,6 +1168,13 @@ message QueryResult {
11671168
// Filled only when data stores are involved in serving the query.
11681169
DataStoreConnectionSignals data_store_connection_signals = 35
11691170
[(google.api.field_behavior) = OPTIONAL];
1171+
1172+
// Optional. Contains the sequence of trace blocks from the current
1173+
// conversation turn. Trace blocks are ordered chronologically and contain
1174+
// detailed traces of runtime behavior such as tool calls, LLM calls, flow and
1175+
// playbook invocations, agent utterances and user utterances.
1176+
repeated TraceBlock trace_blocks = 37
1177+
[(google.api.field_behavior) = OPTIONAL];
11701178
}
11711179

11721180
// Represents the natural language text to be processed.

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/trace.proto

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,83 @@ option java_package = "com.google.cloud.dialogflow.cx.v3beta1";
3030
option objc_class_prefix = "DF";
3131
option ruby_package = "Google::Cloud::Dialogflow::CX::V3beta1";
3232

33+
// The trace block tracks a sequence of actions taken by the agent in a flow or
34+
// a playbook.
35+
message TraceBlock {
36+
// Metadata of the trace.
37+
oneof trace_metadata {
38+
// Metadata of the playbook trace.
39+
PlaybookTraceMetadata playbook_trace_metadata = 1;
40+
41+
// Metadata of the flow trace.
42+
FlowTraceMetadata flow_trace_metadata = 2;
43+
44+
// Metadata of the speech-to-text and speech-to-text processing.
45+
SpeechProcessingMetadata speech_processing_metadata = 8;
46+
}
47+
48+
// The actions performed by the agent and the user during this session.
49+
repeated Action actions = 3;
50+
51+
// Output only. Timestamp of the start of the trace block.
52+
google.protobuf.Timestamp start_time = 4
53+
[(google.api.field_behavior) = OUTPUT_ONLY];
54+
55+
// Output only. Timestamp of the end of the trace block.
56+
google.protobuf.Timestamp complete_time = 5
57+
[(google.api.field_behavior) = OUTPUT_ONLY];
58+
59+
// Optional. A list of input parameters of the trace block.
60+
google.protobuf.Struct input_parameters = 9
61+
[(google.api.field_behavior) = OPTIONAL];
62+
63+
// Optional. A list of output parameters of the trace block.
64+
google.protobuf.Struct output_parameters = 6
65+
[(google.api.field_behavior) = OPTIONAL];
66+
67+
// Optional. Output only. The end state of the trace block.
68+
OutputState end_state = 7 [
69+
(google.api.field_behavior) = OUTPUT_ONLY,
70+
(google.api.field_behavior) = OPTIONAL
71+
];
72+
}
73+
74+
// Metadata of the speech-to-text and text-to-speech processing.
75+
message SpeechProcessingMetadata {
76+
// Output only. The display name of the speech processing.
77+
string display_name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
78+
}
79+
80+
// Metadata of the playbook trace.
81+
message PlaybookTraceMetadata {
82+
// Required. The unique identifier of the playbook.
83+
// Format:
84+
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
85+
string playbook = 1 [
86+
(google.api.field_behavior) = REQUIRED,
87+
(google.api.resource_reference) = {
88+
type: "dialogflow.googleapis.com/Playbook"
89+
}
90+
];
91+
92+
// Output only. The display name of the playbook.
93+
string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
94+
}
95+
96+
// Metadata of the flow trace.
97+
message FlowTraceMetadata {
98+
// Required. The unique identifier of the flow.
99+
// Format:
100+
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
101+
string flow = 1 [
102+
(google.api.field_behavior) = REQUIRED,
103+
(google.api.resource_reference) = { type: "dialogflow.googleapis.com/Flow" }
104+
];
105+
106+
// Output only. The display name of the flow.
107+
string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
108+
}
109+
33110
// Action performed by end user or Dialogflow agent in the conversation.
34111
message Action {
35112
// Stores metadata of the intent match action.

0 commit comments

Comments
 (0)