-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
conversation_model.proto
706 lines (604 loc) · 26.6 KB
/
conversation_model.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.dialogflow.v2;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.V2";
option go_package = "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb";
option java_multiple_files = true;
option java_outer_classname = "ConversationModelProto";
option java_package = "com.google.cloud.dialogflow.v2";
option objc_class_prefix = "DF";
// Manages a collection of models for human agent assistant.
service ConversationModels {
option (google.api.default_host) = "dialogflow.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/dialogflow";
// Creates a model.
//
// This method is a [long-running
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
// The returned `Operation` type has the following method-specific fields:
//
// - `metadata`:
// [CreateConversationModelOperationMetadata][google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata]
// - `response`:
// [ConversationModel][google.cloud.dialogflow.v2.ConversationModel]
rpc CreateConversationModel(CreateConversationModelRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2/{parent=projects/*}/conversationModels"
body: "conversation_model"
additional_bindings {
post: "/v2/{parent=projects/*/locations/*}/conversationModels"
body: "conversation_model"
}
};
option (google.api.method_signature) = "parent,conversation_model";
option (google.longrunning.operation_info) = {
response_type: "ConversationModel"
metadata_type: "CreateConversationModelOperationMetadata"
};
}
// Gets conversation model.
rpc GetConversationModel(GetConversationModelRequest)
returns (ConversationModel) {
option (google.api.http) = {
get: "/v2/{name=projects/*/conversationModels/*}"
additional_bindings {
get: "/v2/{name=projects/*/locations/*/conversationModels/*}"
}
};
option (google.api.method_signature) = "name";
}
// Lists conversation models.
rpc ListConversationModels(ListConversationModelsRequest)
returns (ListConversationModelsResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*}/conversationModels"
additional_bindings {
get: "/v2/{parent=projects/*/locations/*}/conversationModels"
}
};
option (google.api.method_signature) = "parent";
}
// Deletes a model.
//
// This method is a [long-running
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
// The returned `Operation` type has the following method-specific fields:
//
// - `metadata`:
// [DeleteConversationModelOperationMetadata][google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata]
// - `response`: An [Empty
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
rpc DeleteConversationModel(DeleteConversationModelRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v2/{name=projects/*/conversationModels/*}"
additional_bindings {
delete: "/v2/{name=projects/*/locations/*/conversationModels/*}"
}
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteConversationModelOperationMetadata"
};
}
// Deploys a model. If a model is already deployed, deploying it
// has no effect. A model can only serve prediction requests after it gets
// deployed. For article suggestion, custom model will not be used unless
// it is deployed.
//
// This method is a [long-running
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
// The returned `Operation` type has the following method-specific fields:
//
// - `metadata`:
// [DeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata]
// - `response`: An [Empty
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
rpc DeployConversationModel(DeployConversationModelRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2/{name=projects/*/conversationModels/*}:deploy"
body: "*"
additional_bindings {
post: "/v2/{name=projects/*/locations/*/conversationModels/*}:deploy"
body: "*"
}
};
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeployConversationModelOperationMetadata"
};
}
// Undeploys a model. If the model is not deployed this method has no effect.
// If the model is currently being used:
// - For article suggestion, article suggestion will fallback to the default
// model if model is undeployed.
//
// This method is a [long-running
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
// The returned `Operation` type has the following method-specific fields:
//
// - `metadata`:
// [UndeployConversationModelOperationMetadata][google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata]
// - `response`: An [Empty
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
rpc UndeployConversationModel(UndeployConversationModelRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2/{name=projects/*/conversationModels/*}:undeploy"
body: "*"
additional_bindings {
post: "/v2/{name=projects/*/locations/*/conversationModels/*}:undeploy"
body: "*"
}
};
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "UndeployConversationModelOperationMetadata"
};
}
// Gets an evaluation of conversation model.
rpc GetConversationModelEvaluation(GetConversationModelEvaluationRequest)
returns (ConversationModelEvaluation) {
option (google.api.http) = {
get: "/v2/{name=projects/*/conversationModels/*/evaluations/*}"
additional_bindings {
get: "/v2/{name=projects/*/locations/*/conversationModels/*/evaluations/*}"
}
};
option (google.api.method_signature) = "name";
}
// Lists evaluations of a conversation model.
rpc ListConversationModelEvaluations(ListConversationModelEvaluationsRequest)
returns (ListConversationModelEvaluationsResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*/conversationModels/*}/evaluations"
additional_bindings {
get: "/v2/{parent=projects/*/locations/*/conversationModels/*}/evaluations"
}
};
option (google.api.method_signature) = "parent";
}
// Creates evaluation of a conversation model.
rpc CreateConversationModelEvaluation(
CreateConversationModelEvaluationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/locations/*/conversationModels/*}/evaluations"
body: "*"
};
option (google.api.method_signature) =
"parent,conversation_model_evaluation";
option (google.longrunning.operation_info) = {
response_type: "ConversationModelEvaluation"
metadata_type: "CreateConversationModelEvaluationOperationMetadata"
};
}
}
// Represents a conversation model.
message ConversationModel {
option (google.api.resource) = {
type: "dialogflow.googleapis.com/ConversationModel"
pattern: "projects/{project}/locations/{location}/conversationModels/{conversation_model}"
pattern: "projects/{project}/conversationModels/{conversation_model}"
};
// State of the model.
enum State {
// Should not be used, an un-set enum has this value by default.
STATE_UNSPECIFIED = 0;
// Model being created.
CREATING = 1;
// Model is not deployed but ready to deploy.
UNDEPLOYED = 2;
// Model is deploying.
DEPLOYING = 3;
// Model is deployed and ready to use.
DEPLOYED = 4;
// Model is undeploying.
UNDEPLOYING = 5;
// Model is deleting.
DELETING = 6;
// Model is in error state. Not ready to deploy and use.
FAILED = 7;
// Model is being created but the training has not started,
// The model may remain in this state until there is enough capacity to
// start training.
PENDING = 8;
}
// Model type.
enum ModelType {
// ModelType unspecified.
MODEL_TYPE_UNSPECIFIED = 0;
// ModelType smart reply dual encoder model.
SMART_REPLY_DUAL_ENCODER_MODEL = 2;
// ModelType smart reply bert model.
SMART_REPLY_BERT_MODEL = 6;
}
// ConversationModel resource name. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model ID>`
string name = 1;
// Required. The display name of the model. At most 64 bytes long.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Output only. Creation time of this model.
google.protobuf.Timestamp create_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Required. Datasets used to create model.
repeated InputDataset datasets = 4 [(google.api.field_behavior) = REQUIRED];
// Output only. State of the model. A model can only serve prediction requests
// after it gets deployed.
State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
// Language code for the conversation model. If not specified, the language
// is en-US. Language at ConversationModel should be set for all non en-us
// languages.
// This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
// language tag. Example: "en-US".
string language_code = 19;
// Required.
// The model metadata that is specific to the problem type.
// Must match the metadata type of the dataset used to train the model.
oneof model_metadata {
// Metadata for article suggestion models.
ArticleSuggestionModelMetadata article_suggestion_model_metadata = 8;
// Metadata for smart reply models.
SmartReplyModelMetadata smart_reply_model_metadata = 9;
}
}
// Represents evaluation result of a conversation model.
message ConversationModelEvaluation {
option (google.api.resource) = {
type: "dialogflow.googleapis.com/ConversationModelEvaluation"
pattern: "projects/{project}/conversationModels/{conversation_model}/evaluations/{evaluation}"
pattern: "projects/{project}/locations/{location}/conversationModels/{conversation_model}/evaluations/{evaluation}"
};
// The resource name of the evaluation. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model
// ID>/evaluations/<Evaluation ID>`
string name = 1;
// Optional. The display name of the model evaluation. At most 64 bytes long.
string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The configuration of the evaluation task.
EvaluationConfig evaluation_config = 6
[(google.api.field_behavior) = OPTIONAL];
// Output only. Creation time of this model.
google.protobuf.Timestamp create_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Metrics details.
oneof metrics {
// Output only. Only available when model is for smart reply.
SmartReplyMetrics smart_reply_metrics = 5
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. Human eval template in csv format.
// It tooks real-world conversations provided through input dataset, generates
// example suggestions for customer to verify quality of the model.
// For Smart Reply, the generated csv file contains columns of
// Context, (Suggestions,Q1,Q2)*3, Actual reply.
// Context contains at most 10 latest messages in the conversation prior to
// the current suggestion.
// Q1: "Would you send it as the next message of agent?"
// Evaluated based on whether the suggest is appropriate to be sent by
// agent in current context.
// Q2: "Does the suggestion move the conversation closer to resolution?"
// Evaluated based on whether the suggestion provide solutions, or answers
// customer's question or collect information from customer to resolve the
// customer's issue.
// Actual reply column contains the actual agent reply sent in the context.
string raw_human_eval_template_csv = 8
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// The configuration for model evaluation.
message EvaluationConfig {
// Smart reply specific configuration for evaluation job.
message SmartReplyConfig {
// The allowlist document resource name.
// Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
// ID>/documents/<Document ID>`. Only used for smart reply model.
string allowlist_document = 1 [(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/Document"
}];
// Required. The model to be evaluated can return multiple results with
// confidence score on each query. These results will be sorted by the
// descending order of the scores and we only keep the first
// max_result_count results as the final results to evaluate.
int32 max_result_count = 2 [(google.api.field_behavior) = REQUIRED];
}
// Smart compose specific configuration for evaluation job.
message SmartComposeConfig {
// The allowlist document resource name.
// Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
// ID>/documents/<Document ID>`. Only used for smart compose model.
string allowlist_document = 1 [(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/Document"
}];
// Required. The model to be evaluated can return multiple results with
// confidence score on each query. These results will be sorted by the
// descending order of the scores and we only keep the first
// max_result_count results as the final results to evaluate.
int32 max_result_count = 2 [(google.api.field_behavior) = REQUIRED];
}
// Required. Datasets used for evaluation.
repeated InputDataset datasets = 3 [(google.api.field_behavior) = REQUIRED];
// Specific configurations for different models in order to do evaluation.
oneof model_specific_config {
// Configuration for smart reply model evalution.
SmartReplyConfig smart_reply_config = 2;
// Configuration for smart compose model evalution.
SmartComposeConfig smart_compose_config = 4;
}
}
// InputDataset used to create model or do evaluation.
// NextID:5
message InputDataset {
// Required. ConversationDataset resource name. Format:
// `projects/<Project ID>/locations/<Location
// ID>/conversationDatasets/<Conversation Dataset ID>`
string dataset = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/ConversationDataset"
}
];
}
// Metadata for article suggestion models.
message ArticleSuggestionModelMetadata {
// Optional. Type of the article suggestion model. If not provided, model_type
// is used.
ConversationModel.ModelType training_model_type = 3
[(google.api.field_behavior) = OPTIONAL];
}
// Metadata for smart reply models.
message SmartReplyModelMetadata {
// Optional. Type of the smart reply model. If not provided, model_type is
// used.
ConversationModel.ModelType training_model_type = 6
[(google.api.field_behavior) = OPTIONAL];
}
// The evaluation metrics for smart reply model.
message SmartReplyMetrics {
// Evaluation metrics when retrieving `n` smart replies with the model.
message TopNMetrics {
// Number of retrieved smart replies. For example, when `n` is 3, this
// evaluation contains metrics for when Dialogflow retrieves 3 smart replies
// with the model.
int32 n = 1;
// Defined as `number of queries whose top n smart replies have at least one
// similar (token match similarity above the defined threshold) reply as the
// real reply` divided by `number of queries with at least one smart reply`.
// Value ranges from 0.0 to 1.0 inclusive.
float recall = 2;
}
// Percentage of target participant messages in the evaluation dataset for
// which similar messages have appeared at least once in the allowlist. Should
// be [0, 1].
float allowlist_coverage = 1;
// Metrics of top n smart replies, sorted by [TopNMetric.n][].
repeated TopNMetrics top_n_metrics = 2;
// Total number of conversations used to generate this metric.
int64 conversation_count = 3;
}
// The request message for
// [ConversationModels.CreateConversationModel][google.cloud.dialogflow.v2.ConversationModels.CreateConversationModel]
message CreateConversationModelRequest {
// The project to create conversation model for. Format:
// `projects/<Project ID>`
string parent = 1;
// Required. The conversation model to create.
ConversationModel conversation_model = 2
[(google.api.field_behavior) = REQUIRED];
}
// The request message for
// [ConversationModels.GetConversationModel][google.cloud.dialogflow.v2.ConversationModels.GetConversationModel]
message GetConversationModelRequest {
// Required. The conversation model to retrieve. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model ID>`
string name = 1 [(google.api.field_behavior) = REQUIRED];
}
// The request message for
// [ConversationModels.ListConversationModels][google.cloud.dialogflow.v2.ConversationModels.ListConversationModels]
message ListConversationModelsRequest {
// Required. The project to list all conversation models for.
// Format: `projects/<Project ID>`
string parent = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. Maximum number of conversation models to return in a single
// page. By default 100 and at most 1000.
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The next_page_token value returned from a previous list request.
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
}
// The response message for
// [ConversationModels.ListConversationModels][google.cloud.dialogflow.v2.ConversationModels.ListConversationModels]
message ListConversationModelsResponse {
// The list of models to return.
repeated ConversationModel conversation_models = 1;
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
string next_page_token = 2;
}
// The request message for
// [ConversationModels.DeleteConversationModel][google.cloud.dialogflow.v2.ConversationModels.DeleteConversationModel]
message DeleteConversationModelRequest {
// Required. The conversation model to delete. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model ID>`
string name = 1 [(google.api.field_behavior) = REQUIRED];
}
// The request message for
// [ConversationModels.DeployConversationModel][google.cloud.dialogflow.v2.ConversationModels.DeployConversationModel]
message DeployConversationModelRequest {
// Required. The conversation model to deploy. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model ID>`
string name = 1 [(google.api.field_behavior) = REQUIRED];
}
// The request message for
// [ConversationModels.UndeployConversationModel][google.cloud.dialogflow.v2.ConversationModels.UndeployConversationModel]
message UndeployConversationModelRequest {
// Required. The conversation model to undeploy. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model ID>`
string name = 1 [(google.api.field_behavior) = REQUIRED];
}
// The request message for
// [ConversationModels.GetConversationModelEvaluation][google.cloud.dialogflow.v2.ConversationModels.GetConversationModelEvaluation]
message GetConversationModelEvaluationRequest {
// Required. The conversation model evaluation resource name. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model
// ID>/evaluations/<Evaluation ID>`
string name = 1 [(google.api.field_behavior) = REQUIRED];
}
// The request message for
// [ConversationModels.ListConversationModelEvaluations][google.cloud.dialogflow.v2.ConversationModels.ListConversationModelEvaluations]
message ListConversationModelEvaluationsRequest {
// Required. The conversation model resource name. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model ID>`
string parent = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. Maximum number of evaluations to return in a
// single page. By default 100 and at most 1000.
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The next_page_token value returned from a previous list request.
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
}
// The response message for
// [ConversationModels.ListConversationModelEvaluations][google.cloud.dialogflow.v2.ConversationModels.ListConversationModelEvaluations]
message ListConversationModelEvaluationsResponse {
// The list of evaluations to return.
repeated ConversationModelEvaluation conversation_model_evaluations = 1;
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
string next_page_token = 2;
}
// The request message for
// [ConversationModels.CreateConversationModelEvaluation][google.cloud.dialogflow.v2.ConversationModels.CreateConversationModelEvaluation]
message CreateConversationModelEvaluationRequest {
// Required. The conversation model resource name. Format:
// `projects/<Project ID>/locations/<Location
// ID>/conversationModels/<Conversation Model ID>`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "dialogflow.googleapis.com/ConversationModelEvaluation"
}
];
// Required. The conversation model evaluation to be created.
ConversationModelEvaluation conversation_model_evaluation = 2
[(google.api.field_behavior) = REQUIRED];
}
// Metadata for a
// [ConversationModels.CreateConversationModel][google.cloud.dialogflow.v2.ConversationModels.CreateConversationModel]
// operation.
message CreateConversationModelOperationMetadata {
// State of CreateConversationModel operation.
enum State {
// Invalid.
STATE_UNSPECIFIED = 0;
// Request is submitted, but training has not started yet.
// The model may remain in this state until there is enough capacity to
// start training.
PENDING = 1;
// The training has succeeded.
SUCCEEDED = 2;
// The training has succeeded.
FAILED = 3;
// The training has been cancelled.
CANCELLED = 4;
// The training is in cancelling state.
CANCELLING = 5;
// Custom model is training.
TRAINING = 6;
}
// The resource name of the conversation model. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model Id>`
string conversation_model = 1;
// State of CreateConversationModel operation.
State state = 2;
// Timestamp when the request to create conversation model is submitted. The
// time is measured on server side.
google.protobuf.Timestamp create_time = 3;
}
// Metadata for a
// [ConversationModels.DeployConversationModel][google.cloud.dialogflow.v2.ConversationModels.DeployConversationModel]
// operation.
message DeployConversationModelOperationMetadata {
// The resource name of the conversation model. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model Id>`
string conversation_model = 1;
// Timestamp when request to deploy conversation model was submitted. The time
// is measured on server side.
google.protobuf.Timestamp create_time = 3;
}
// Metadata for a
// [ConversationModels.UndeployConversationModel][google.cloud.dialogflow.v2.ConversationModels.UndeployConversationModel]
// operation.
message UndeployConversationModelOperationMetadata {
// The resource name of the conversation model. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model Id>`
string conversation_model = 1;
// Timestamp when the request to undeploy conversation model was submitted.
// The time is measured on server side.
google.protobuf.Timestamp create_time = 3;
}
// Metadata for a
// [ConversationModels.DeleteConversationModel][google.cloud.dialogflow.v2.ConversationModels.DeleteConversationModel]
// operation.
message DeleteConversationModelOperationMetadata {
// The resource name of the conversation model. Format:
// `projects/<Project ID>/conversationModels/<Conversation Model Id>`
string conversation_model = 1;
// Timestamp when delete conversation model request was created. The time is
// measured on server side.
google.protobuf.Timestamp create_time = 3;
}
// Metadata for a
// [ConversationModels.CreateConversationModelEvaluation][google.cloud.dialogflow.v2.ConversationModels.CreateConversationModelEvaluation]
// operation.
message CreateConversationModelEvaluationOperationMetadata {
// State of CreateConversationModel operation.
enum State {
// Operation status not specified.
STATE_UNSPECIFIED = 0;
// The operation is being prepared.
INITIALIZING = 1;
// The operation is running.
RUNNING = 2;
// The operation is cancelled.
CANCELLED = 3;
// The operation has succeeded.
SUCCEEDED = 4;
// The operation has failed.
FAILED = 5;
}
// The resource name of the conversation model. Format:
// `projects/<Project ID>/locations/<Location
// ID>/conversationModels/<Conversation Model Id>/evaluations/<Evaluation Id>`
string conversation_model_evaluation = 1;
// The resource name of the conversation model. Format:
// `projects/<Project ID>/locations/<Location
// ID>/conversationModels/<Conversation Model Id>`
string conversation_model = 4;
// State of CreateConversationModel operation.
State state = 2;
// Timestamp when the request to create conversation model was submitted. The
// time is measured on server side.
google.protobuf.Timestamp create_time = 3;
}