|
| 1 | +// Copyright 2025 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +syntax = "proto3"; |
| 16 | + |
| 17 | +package google.cloud.dialogflow.v2; |
| 18 | + |
| 19 | +import "google/api/field_behavior.proto"; |
| 20 | + |
| 21 | +option csharp_namespace = "Google.Cloud.Dialogflow.V2"; |
| 22 | +option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb"; |
| 23 | +option java_multiple_files = true; |
| 24 | +option java_outer_classname = "AgentCoachingInstructionProto"; |
| 25 | +option java_package = "com.google.cloud.dialogflow.v2"; |
| 26 | +option objc_class_prefix = "DF"; |
| 27 | + |
| 28 | +// Agent Coaching instructions that customer can configure. |
| 29 | +message AgentCoachingInstruction { |
| 30 | + // Duplication check for the suggestion. |
| 31 | + message DuplicateCheckResult { |
| 32 | + // The duplicate suggestion details. |
| 33 | + message DuplicateSuggestion { |
| 34 | + // Output only. The answer record id of the past duplicate suggestion. |
| 35 | + string answer_record = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; |
| 36 | + |
| 37 | + // Output only. The index of the duplicate suggestion in the past |
| 38 | + // suggestion list. |
| 39 | + int32 suggestion_index = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; |
| 40 | + |
| 41 | + // Output only. The similarity score of between the past and current |
| 42 | + // suggestion. |
| 43 | + float similarity_score = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; |
| 44 | + } |
| 45 | + |
| 46 | + // Output only. The duplicate suggestions. |
| 47 | + repeated DuplicateSuggestion duplicate_suggestions = 1 |
| 48 | + [(google.api.field_behavior) = OUTPUT_ONLY]; |
| 49 | + } |
| 50 | + |
| 51 | + // The event that should trigger this instruction. |
| 52 | + enum TriggerEvent { |
| 53 | + // Default value for TriggerEvent. |
| 54 | + TRIGGER_EVENT_UNSPECIFIED = 0; |
| 55 | + |
| 56 | + // Triggers when each chat message or voice utterance ends. |
| 57 | + END_OF_UTTERANCE = 1; |
| 58 | + |
| 59 | + // Triggers on the conversation manually by API calls. |
| 60 | + MANUAL_CALL = 2; |
| 61 | + |
| 62 | + // Triggers after each customer message. |
| 63 | + CUSTOMER_MESSAGE = 3; |
| 64 | + |
| 65 | + // Triggers after each agent message. |
| 66 | + AGENT_MESSAGE = 4; |
| 67 | + |
| 68 | + // Triggers on tool call completion. |
| 69 | + TOOL_CALL_COMPLETION = 5; |
| 70 | + } |
| 71 | + |
| 72 | + // Optional. Display name for the instruction. |
| 73 | + string display_name = 1 [(google.api.field_behavior) = OPTIONAL]; |
| 74 | + |
| 75 | + // Optional. The detailed description of this instruction. |
| 76 | + string display_details = 2 [(google.api.field_behavior) = OPTIONAL]; |
| 77 | + |
| 78 | + // Optional. The condition of the instruction. For example, "the customer |
| 79 | + // wants to cancel an order". If the users want the instruction to be |
| 80 | + // triggered unconditionally, the condition can be empty. |
| 81 | + string condition = 3 [(google.api.field_behavior) = OPTIONAL]; |
| 82 | + |
| 83 | + // Optional. The action that human agent should take. For example, "apologize |
| 84 | + // for the slow shipping". If the users only want to use agent coaching for |
| 85 | + // intent detection, agent_action can be empty |
| 86 | + string agent_action = 4 [(google.api.field_behavior) = OPTIONAL]; |
| 87 | + |
| 88 | + // Optional. The action that system should take. For example, |
| 89 | + // "call GetOrderTime with order_number={order number provided by the |
| 90 | + // customer}". If the users don't have plugins or don't want to trigger |
| 91 | + // plugins, the system_action can be empty |
| 92 | + string system_action = 5 [(google.api.field_behavior) = OPTIONAL]; |
| 93 | + |
| 94 | + // Output only. Duplication check for the AgentCoachingInstruction. |
| 95 | + DuplicateCheckResult duplicate_check_result = 8 |
| 96 | + [(google.api.field_behavior) = OUTPUT_ONLY]; |
| 97 | + |
| 98 | + // Optional. The event that should trigger this instruction. |
| 99 | + // If UNSPECIFIED, the instruction triggering will be same as the generator's |
| 100 | + // trigger_event. |
| 101 | + TriggerEvent triggering_event = 10 [(google.api.field_behavior) = OPTIONAL]; |
| 102 | +} |
0 commit comments