Skip to content

Commit 4d9606e

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Reformat some comments and documentation
PiperOrigin-RevId: 504029060
1 parent 281dcfc commit 4d9606e

18 files changed

Lines changed: 839 additions & 496 deletions

‎google/cloud/dialogflow/v2beta1/agent.proto‎

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,8 @@ service Agents {
133133
//
134134
// - `metadata`: An empty [Struct
135135
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
136-
// - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]
136+
// - `response`:
137+
// [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]
137138
rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
138139
option (google.api.http) = {
139140
post: "/v2beta1/{parent=projects/*}/agent:export"
@@ -154,11 +155,13 @@ service Agents {
154155
//
155156
// Uploads new intents and entity types without deleting the existing ones.
156157
// Intents and entity types with the same name are replaced with the new
157-
// versions from [ImportAgentRequest][google.cloud.dialogflow.v2beta1.ImportAgentRequest]. After the import, the imported draft
158-
// agent will be trained automatically (unless disabled in agent settings).
159-
// However, once the import is done, training may not be completed yet. Please
160-
// call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it returns in order to train
161-
// explicitly.
158+
// versions from
159+
// [ImportAgentRequest][google.cloud.dialogflow.v2beta1.ImportAgentRequest].
160+
// After the import, the imported draft agent will be trained automatically
161+
// (unless disabled in agent settings). However, once the import is done,
162+
// training may not be completed yet. Please call
163+
// [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait
164+
// for the operation it returns in order to train explicitly.
162165
//
163166
// This method is a [long-running
164167
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
@@ -196,8 +199,9 @@ service Agents {
196199
// entity types in the older version are deleted. After the restore, the
197200
// restored draft agent will be trained automatically (unless disabled in
198201
// agent settings). However, once the restore is done, training may not be
199-
// completed yet. Please call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it
200-
// returns in order to train explicitly.
202+
// completed yet. Please call
203+
// [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait
204+
// for the operation it returns in order to train explicitly.
201205
//
202206
// This method is a [long-running
203207
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
@@ -231,7 +235,8 @@ service Agents {
231235

232236
// Gets agent validation result. Agent validation is performed during
233237
// training time and is updated automatically when training is completed.
234-
rpc GetValidationResult(GetValidationResultRequest) returns (ValidationResult) {
238+
rpc GetValidationResult(GetValidationResultRequest)
239+
returns (ValidationResult) {
235240
option (google.api.http) = {
236241
get: "/v2beta1/{parent=projects/*}/agent/validationResult"
237242
additional_bindings {
@@ -368,7 +373,8 @@ message Agent {
368373
Tier tier = 15;
369374
}
370375

371-
// The request message for [Agents.GetAgent][google.cloud.dialogflow.v2beta1.Agents.GetAgent].
376+
// The request message for
377+
// [Agents.GetAgent][google.cloud.dialogflow.v2beta1.Agents.GetAgent].
372378
message GetAgentRequest {
373379
// Required. The project that the agent to fetch is associated with.
374380
// Format: `projects/<Project ID>` or
@@ -381,7 +387,8 @@ message GetAgentRequest {
381387
];
382388
}
383389

384-
// The request message for [Agents.SetAgent][google.cloud.dialogflow.v2beta1.Agents.SetAgent].
390+
// The request message for
391+
// [Agents.SetAgent][google.cloud.dialogflow.v2beta1.Agents.SetAgent].
385392
message SetAgentRequest {
386393
// Required. The agent to update.
387394
Agent agent = 1 [(google.api.field_behavior) = REQUIRED];
@@ -390,7 +397,8 @@ message SetAgentRequest {
390397
google.protobuf.FieldMask update_mask = 2;
391398
}
392399

393-
// The request message for [Agents.DeleteAgent][google.cloud.dialogflow.v2beta1.Agents.DeleteAgent].
400+
// The request message for
401+
// [Agents.DeleteAgent][google.cloud.dialogflow.v2beta1.Agents.DeleteAgent].
394402
message DeleteAgentRequest {
395403
// Required. The project that the agent to delete is associated with.
396404
// Format: `projects/<Project ID>` or
@@ -416,7 +424,8 @@ message SubAgent {
416424
string environment = 2;
417425
}
418426

419-
// The request message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].
427+
// The request message for
428+
// [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].
420429
message SearchAgentsRequest {
421430
// Required. The project to list agents from.
422431
// Format: `projects/<Project ID or '-'>` or
@@ -436,7 +445,8 @@ message SearchAgentsRequest {
436445
string page_token = 3;
437446
}
438447

439-
// The response message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].
448+
// The response message for
449+
// [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].
440450
message SearchAgentsResponse {
441451
// The list of agents. There will be a maximum number of items returned based
442452
// on the page_size field in the request.
@@ -447,7 +457,8 @@ message SearchAgentsResponse {
447457
string next_page_token = 2;
448458
}
449459

450-
// The request message for [Agents.TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent].
460+
// The request message for
461+
// [Agents.TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent].
451462
message TrainAgentRequest {
452463
// Required. The project that the agent to train is associated with.
453464
// Format: `projects/<Project ID>` or
@@ -460,7 +471,8 @@ message TrainAgentRequest {
460471
];
461472
}
462473

463-
// The request message for [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent].
474+
// The request message for
475+
// [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent].
464476
message ExportAgentRequest {
465477
// Required. The project that the agent to export is associated with.
466478
// Format: `projects/<Project ID>` or
@@ -486,7 +498,8 @@ message ExportAgentRequest {
486498
string agent_uri = 2;
487499
}
488500

489-
// The response message for [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent].
501+
// The response message for
502+
// [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent].
490503
message ExportAgentResponse {
491504
// The exported agent.
492505
oneof agent {
@@ -499,7 +512,8 @@ message ExportAgentResponse {
499512
}
500513
}
501514

502-
// The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent].
515+
// The request message for
516+
// [Agents.ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent].
503517
message ImportAgentRequest {
504518
// Required. The project that the agent to import is associated with.
505519
// Format: `projects/<Project ID>` or
@@ -528,7 +542,8 @@ message ImportAgentRequest {
528542
}
529543
}
530544

531-
// The request message for [Agents.RestoreAgent][google.cloud.dialogflow.v2beta1.Agents.RestoreAgent].
545+
// The request message for
546+
// [Agents.RestoreAgent][google.cloud.dialogflow.v2beta1.Agents.RestoreAgent].
532547
message RestoreAgentRequest {
533548
// Required. The project that the agent to restore is associated with.
534549
// Format: `projects/<Project ID>` or
@@ -557,7 +572,8 @@ message RestoreAgentRequest {
557572
}
558573
}
559574

560-
// The request message for [Agents.GetValidationResult][google.cloud.dialogflow.v2beta1.Agents.GetValidationResult].
575+
// The request message for
576+
// [Agents.GetValidationResult][google.cloud.dialogflow.v2beta1.Agents.GetValidationResult].
561577
message GetValidationResultRequest {
562578
// Required. The project that the agent is associated with.
563579
// Format: `projects/<Project ID>` or

‎google/cloud/dialogflow/v2beta1/answer_record.proto‎

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ option java_outer_classname = "AnswerRecordsProto";
3232
option java_package = "com.google.cloud.dialogflow.v2beta1";
3333
option objc_class_prefix = "DF";
3434

35-
// Service for managing [AnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecord].
35+
// Service for managing
36+
// [AnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecord].
3637
service AnswerRecords {
3738
option (google.api.default_host) = "dialogflow.googleapis.com";
3839
option (google.api.oauth_scopes) =
@@ -53,7 +54,8 @@ service AnswerRecords {
5354

5455
// Returns the list of all answer records in the specified project in reverse
5556
// chronological order.
56-
rpc ListAnswerRecords(ListAnswerRecordsRequest) returns (ListAnswerRecordsResponse) {
57+
rpc ListAnswerRecords(ListAnswerRecordsRequest)
58+
returns (ListAnswerRecordsResponse) {
5759
option (google.api.http) = {
5860
get: "/v2beta1/{parent=projects/*}/answerRecords"
5961
additional_bindings {
@@ -98,9 +100,12 @@ service AnswerRecords {
98100
// A typical workflow for customers provide feedback to an answer is:
99101
//
100102
// 1. For human agent assistant, customers get suggestion via ListSuggestions
101-
// API. Together with the answers, [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] are returned to the
102-
// customers.
103-
// 2. The customer uses the [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] to call the
103+
// API. Together with the answers,
104+
// [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] are
105+
// returned to the customers.
106+
// 2. The customer uses the
107+
// [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] to
108+
// call the
104109
// [UpdateAnswerRecord][] method to send feedback about a specific answer
105110
// that they believe is wrong.
106111
message AnswerRecord {
@@ -111,14 +116,15 @@ message AnswerRecord {
111116
};
112117

113118
// The unique identifier of this answer record.
114-
// Required for [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord] method.
115-
// Format: `projects/<Project ID>/locations/<Location
119+
// Required for
120+
// [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord]
121+
// method. Format: `projects/<Project ID>/locations/<Location
116122
// ID>/answerRecords/<Answer Record ID>`.
117123
string name = 1;
118124

119125
// Optional. The AnswerFeedback for this record. You can set this with
120-
// [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord] in order to give us feedback about
121-
// this answer.
126+
// [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord]
127+
// in order to give us feedback about this answer.
122128
AnswerFeedback answer_feedback = 3;
123129

124130
// Output only. The record for this answer.
@@ -133,7 +139,8 @@ message AgentAssistantRecord {
133139
// Output only. The agent assistant answer.
134140
oneof answer {
135141
// Output only. The article suggestion answer.
136-
ArticleAnswer article_suggestion_answer = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
142+
ArticleAnswer article_suggestion_answer = 5
143+
[(google.api.field_behavior) = OUTPUT_ONLY];
137144

138145
// Output only. The FAQ answer.
139146
FaqAnswer faq_answer = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -255,39 +262,40 @@ message AgentAssistantFeedback {
255262

256263
// Optional. Whether or not the suggested document is efficient. For example,
257264
// if the document is poorly written, hard to understand, hard to use or
258-
// too long to find useful information, [document_efficiency][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.document_efficiency] is
265+
// too long to find useful information,
266+
// [document_efficiency][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.document_efficiency]
267+
// is
259268
// [DocumentEfficiency.INEFFICIENT][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.DocumentEfficiency.INEFFICIENT].
260269
DocumentEfficiency document_efficiency = 3;
261270

262271
// Feedback for conversation summarization.
263272
SummarizationFeedback summarization_feedback = 4;
264273
}
265274

266-
// Request message for [AnswerRecords.GetAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.GetAnswerRecord].
275+
// Request message for
276+
// [AnswerRecords.GetAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.GetAnswerRecord].
267277
message GetAnswerRecordRequest {
268278
// Required. The name of the answer record to retrieve.
269279
// Format: `projects/<Project ID>/locations/<Location
270280
// ID>/answerRecords/<Answer Record Id>`.
271281
string name = 1;
272282
}
273283

274-
// Request message for [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecords.ListAnswerRecords].
284+
// Request message for
285+
// [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecords.ListAnswerRecords].
275286
message ListAnswerRecordsRequest {
276287
// Required. The project to list all answer records for in reverse
277288
// chronological order. Format: `projects/<Project ID>/locations/<Location
278289
// ID>`.
279290
string parent = 1 [(google.api.resource_reference) = {
280-
child_type: "dialogflow.googleapis.com/AnswerRecord"
281-
}];
291+
child_type: "dialogflow.googleapis.com/AnswerRecord"
292+
}];
282293

283294
// Optional. Filters to restrict results to specific answer records.
284295
//
285296
// For more information about filtering, see
286297
// [API Filtering](https://aip.dev/160).
287-
string filter = 2 [
288-
deprecated = true,
289-
(google.api.field_behavior) = OPTIONAL
290-
];
298+
string filter = 2 [deprecated = true, (google.api.field_behavior) = OPTIONAL];
291299

292300
// Optional. The maximum number of records to return in a single page.
293301
// The server may return fewer records than this. If unspecified, we use 10.
@@ -301,7 +309,8 @@ message ListAnswerRecordsRequest {
301309
string page_token = 4;
302310
}
303311

304-
// Response message for [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecords.ListAnswerRecords].
312+
// Response message for
313+
// [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecords.ListAnswerRecords].
305314
message ListAnswerRecordsResponse {
306315
// The list of answer records.
307316
repeated AnswerRecord answer_records = 1;
@@ -315,7 +324,8 @@ message ListAnswerRecordsResponse {
315324
string next_page_token = 2;
316325
}
317326

318-
// Request message for [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord].
327+
// Request message for
328+
// [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord].
319329
message UpdateAnswerRecordRequest {
320330
// Required. Answer record to update.
321331
AnswerRecord answer_record = 1 [(google.api.field_behavior) = REQUIRED];

‎google/cloud/dialogflow/v2beta1/audio_config.proto‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ option (google.api.resource_definition) = {
3131
type: "automl.googleapis.com/Model"
3232
pattern: "projects/{project}/locations/{location}/models/{model}"
3333
};
34+
option (google.api.resource_definition) = {
35+
type: "speech.googleapis.com/PhraseSet"
36+
pattern: "projects/{project}/locations/{location}/phraseSets/{phrase_set}"
37+
};
3438

3539
// Audio encoding of the audio content sent in the conversational query request.
3640
// Refer to the

‎google/cloud/dialogflow/v2beta1/context.proto‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@ service Contexts {
136136
}
137137

138138
// Deletes all active contexts in the specified session.
139-
rpc DeleteAllContexts(DeleteAllContextsRequest) returns (google.protobuf.Empty) {
139+
rpc DeleteAllContexts(DeleteAllContextsRequest)
140+
returns (google.protobuf.Empty) {
140141
option (google.api.http) = {
141142
delete: "/v2beta1/{parent=projects/*/agent/sessions/*}/contexts"
142143
additional_bindings {
@@ -227,7 +228,8 @@ message Context {
227228
google.protobuf.Struct parameters = 3;
228229
}
229230

230-
// The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].
231+
// The request message for
232+
// [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].
231233
message ListContextsRequest {
232234
// Required. The session to list all contexts from. Supported formats:
233235
// - `projects/<Project ID>/agent/sessions/<Session ID>,
@@ -257,7 +259,8 @@ message ListContextsRequest {
257259
string page_token = 3;
258260
}
259261

260-
// The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].
262+
// The response message for
263+
// [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].
261264
message ListContextsResponse {
262265
// The list of contexts. There will be a maximum number of items
263266
// returned based on the page_size field in the request.
@@ -268,7 +271,8 @@ message ListContextsResponse {
268271
string next_page_token = 2;
269272
}
270273

271-
// The request message for [Contexts.GetContext][google.cloud.dialogflow.v2beta1.Contexts.GetContext].
274+
// The request message for
275+
// [Contexts.GetContext][google.cloud.dialogflow.v2beta1.Contexts.GetContext].
272276
message GetContextRequest {
273277
// Required. The name of the context. Supported formats:
274278
// - `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context
@@ -292,7 +296,8 @@ message GetContextRequest {
292296
];
293297
}
294298

295-
// The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2beta1.Contexts.CreateContext].
299+
// The request message for
300+
// [Contexts.CreateContext][google.cloud.dialogflow.v2beta1.Contexts.CreateContext].
296301
message CreateContextRequest {
297302
// Required. The session to create a context for. Supported formats:
298303
// - `projects/<Project ID>/agent/sessions/<Session ID>,
@@ -318,16 +323,19 @@ message CreateContextRequest {
318323
Context context = 2 [(google.api.field_behavior) = REQUIRED];
319324
}
320325

321-
// The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2beta1.Contexts.UpdateContext].
326+
// The request message for
327+
// [Contexts.UpdateContext][google.cloud.dialogflow.v2beta1.Contexts.UpdateContext].
322328
message UpdateContextRequest {
323329
// Required. The context to update.
324330
Context context = 1 [(google.api.field_behavior) = REQUIRED];
325331

326332
// Optional. The mask to control which fields get updated.
327-
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL];
333+
google.protobuf.FieldMask update_mask = 2
334+
[(google.api.field_behavior) = OPTIONAL];
328335
}
329336

330-
// The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2beta1.Contexts.DeleteContext].
337+
// The request message for
338+
// [Contexts.DeleteContext][google.cloud.dialogflow.v2beta1.Contexts.DeleteContext].
331339
message DeleteContextRequest {
332340
// Required. The name of the context to delete. Supported formats:
333341
// - `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context
@@ -351,9 +359,11 @@ message DeleteContextRequest {
351359
];
352360
}
353361

354-
// The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2beta1.Contexts.DeleteAllContexts].
362+
// The request message for
363+
// [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2beta1.Contexts.DeleteAllContexts].
355364
message DeleteAllContextsRequest {
356-
// Required. The name of the session to delete all contexts from. Supported formats:
365+
// Required. The name of the session to delete all contexts from. Supported
366+
// formats:
357367
// - `projects/<Project ID>/agent/sessions/<Session ID>,
358368
// - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
359369
// ID>`,

0 commit comments

Comments
 (0)