From cbfa3878e69d235c9601f304c92f48309cc19c68 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 24 Jan 2023 11:51:50 -0800 Subject: [PATCH] docs: Reformat some comments and documentation (#3875) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Reformat some comments and documentation PiperOrigin-RevId: 504029060 Source-Link: https://github.com/googleapis/googleapis/commit/4d9606ecc1415ccab14796dc74ba2ffdd0633bf0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/a77ae2d90dd0539409c8bad976908df613096ded Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpYWxvZ2Zsb3cvLk93bEJvdC55YW1sIiwiaCI6ImE3N2FlMmQ5MGRkMDUzOTQwOWM4YmFkOTc2OTA4ZGY2MTMwOTZkZWQifQ== * 🦉 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 Co-authored-by: sofisl <55454395+sofisl@users.noreply.github.com> --- .../cloud/dialogflow/v2beta1/agent.proto | 56 ++-- .../dialogflow/v2beta1/answer_record.proto | 52 +-- .../dialogflow/v2beta1/audio_config.proto | 4 + .../cloud/dialogflow/v2beta1/context.proto | 30 +- .../dialogflow/v2beta1/conversation.proto | 98 +++--- .../v2beta1/conversation_profile.proto | 139 +++++--- .../cloud/dialogflow/v2beta1/document.proto | 81 +++-- .../dialogflow/v2beta1/entity_type.proto | 92 ++++-- .../dialogflow/v2beta1/environment.proto | 98 +++--- .../dialogflow/v2beta1/fulfillment.proto | 22 +- .../v2beta1/human_agent_assistant_event.proto | 9 +- .../cloud/dialogflow/v2beta1/intent.proto | 105 +++--- .../dialogflow/v2beta1/knowledge_base.proto | 30 +- .../dialogflow/v2beta1/participant.proto | 300 +++++++++++------- .../cloud/dialogflow/v2beta1/session.proto | 99 +++--- .../v2beta1/session_entity_type.proto | 47 ++- .../cloud/dialogflow/v2beta1/version.proto | 40 ++- .../cloud/dialogflow/v2beta1/webhook.proto | 33 +- .../v2beta1/contexts.delete_all_contexts.js | 3 +- .../conversations.batch_create_messages.js | 3 +- .../conversations.create_conversation.js | 4 +- .../environments.get_environment_history.js | 4 +- .../v2beta1/environments.list_environments.js | 4 +- .../v2beta1/participants.suggest_articles.js | 5 +- .../v2beta1/sessions.detect_intent.js | 12 +- .../sessions.streaming_detect_intent.js | 30 +- ...adata.google.cloud.dialogflow.v2beta1.json | 10 +- .../v2beta1/versions.list_versions.js | 4 +- .../src/v2beta1/agents_client.ts | 20 +- .../src/v2beta1/answer_records_client.ts | 3 +- .../src/v2beta1/contexts_client.ts | 3 +- .../v2beta1/conversation_profiles_client.ts | 21 +- .../src/v2beta1/conversations_client.ts | 23 +- .../src/v2beta1/documents_client.ts | 21 +- .../src/v2beta1/entity_types_client.ts | 6 +- .../src/v2beta1/environments_client.ts | 27 +- .../src/v2beta1/fulfillments_client.ts | 3 +- .../src/v2beta1/intents_client.ts | 3 +- .../src/v2beta1/knowledge_bases_client.ts | 3 +- .../src/v2beta1/participants_client.ts | 38 ++- .../v2beta1/session_entity_types_client.ts | 3 +- .../src/v2beta1/sessions_client.ts | 14 +- .../src/v2beta1/versions_client.ts | 12 +- 43 files changed, 1005 insertions(+), 609 deletions(-) diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/agent.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/agent.proto index 95b3933a6d4..b446af773f3 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/agent.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/agent.proto @@ -133,7 +133,8 @@ service Agents { // // - `metadata`: An empty [Struct // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse] + // - `response`: + // [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse] rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*}/agent:export" @@ -154,11 +155,13 @@ service Agents { // // Uploads new intents and entity types without deleting the existing ones. // Intents and entity types with the same name are replaced with the new - // versions from [ImportAgentRequest][google.cloud.dialogflow.v2beta1.ImportAgentRequest]. After the import, the imported draft - // agent will be trained automatically (unless disabled in agent settings). - // However, once the import is done, training may not be completed yet. Please - // call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it returns in order to train - // explicitly. + // versions from + // [ImportAgentRequest][google.cloud.dialogflow.v2beta1.ImportAgentRequest]. + // After the import, the imported draft agent will be trained automatically + // (unless disabled in agent settings). However, once the import is done, + // training may not be completed yet. Please call + // [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait + // for the operation it returns in order to train explicitly. // // This method is a [long-running // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). @@ -196,8 +199,9 @@ service Agents { // entity types in the older version are deleted. After the restore, the // restored draft agent will be trained automatically (unless disabled in // agent settings). However, once the restore is done, training may not be - // completed yet. Please call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it - // returns in order to train explicitly. + // completed yet. Please call + // [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait + // for the operation it returns in order to train explicitly. // // This method is a [long-running // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). @@ -231,7 +235,8 @@ service Agents { // Gets agent validation result. Agent validation is performed during // training time and is updated automatically when training is completed. - rpc GetValidationResult(GetValidationResultRequest) returns (ValidationResult) { + rpc GetValidationResult(GetValidationResultRequest) + returns (ValidationResult) { option (google.api.http) = { get: "/v2beta1/{parent=projects/*}/agent/validationResult" additional_bindings { @@ -368,7 +373,8 @@ message Agent { Tier tier = 15; } -// The request message for [Agents.GetAgent][google.cloud.dialogflow.v2beta1.Agents.GetAgent]. +// The request message for +// [Agents.GetAgent][google.cloud.dialogflow.v2beta1.Agents.GetAgent]. message GetAgentRequest { // Required. The project that the agent to fetch is associated with. // Format: `projects/` or @@ -381,7 +387,8 @@ message GetAgentRequest { ]; } -// The request message for [Agents.SetAgent][google.cloud.dialogflow.v2beta1.Agents.SetAgent]. +// The request message for +// [Agents.SetAgent][google.cloud.dialogflow.v2beta1.Agents.SetAgent]. message SetAgentRequest { // Required. The agent to update. Agent agent = 1 [(google.api.field_behavior) = REQUIRED]; @@ -390,7 +397,8 @@ message SetAgentRequest { google.protobuf.FieldMask update_mask = 2; } -// The request message for [Agents.DeleteAgent][google.cloud.dialogflow.v2beta1.Agents.DeleteAgent]. +// The request message for +// [Agents.DeleteAgent][google.cloud.dialogflow.v2beta1.Agents.DeleteAgent]. message DeleteAgentRequest { // Required. The project that the agent to delete is associated with. // Format: `projects/` or @@ -416,7 +424,8 @@ message SubAgent { string environment = 2; } -// The request message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents]. +// The request message for +// [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents]. message SearchAgentsRequest { // Required. The project to list agents from. // Format: `projects/` or @@ -436,7 +445,8 @@ message SearchAgentsRequest { string page_token = 3; } -// The response message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents]. +// The response message for +// [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents]. message SearchAgentsResponse { // The list of agents. There will be a maximum number of items returned based // on the page_size field in the request. @@ -447,7 +457,8 @@ message SearchAgentsResponse { string next_page_token = 2; } -// The request message for [Agents.TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent]. +// The request message for +// [Agents.TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent]. message TrainAgentRequest { // Required. The project that the agent to train is associated with. // Format: `projects/` or @@ -460,7 +471,8 @@ message TrainAgentRequest { ]; } -// The request message for [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent]. +// The request message for +// [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent]. message ExportAgentRequest { // Required. The project that the agent to export is associated with. // Format: `projects/` or @@ -486,7 +498,8 @@ message ExportAgentRequest { string agent_uri = 2; } -// The response message for [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent]. +// The response message for +// [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent]. message ExportAgentResponse { // The exported agent. oneof agent { @@ -499,7 +512,8 @@ message ExportAgentResponse { } } -// The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent]. +// The request message for +// [Agents.ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent]. message ImportAgentRequest { // Required. The project that the agent to import is associated with. // Format: `projects/` or @@ -528,7 +542,8 @@ message ImportAgentRequest { } } -// The request message for [Agents.RestoreAgent][google.cloud.dialogflow.v2beta1.Agents.RestoreAgent]. +// The request message for +// [Agents.RestoreAgent][google.cloud.dialogflow.v2beta1.Agents.RestoreAgent]. message RestoreAgentRequest { // Required. The project that the agent to restore is associated with. // Format: `projects/` or @@ -557,7 +572,8 @@ message RestoreAgentRequest { } } -// The request message for [Agents.GetValidationResult][google.cloud.dialogflow.v2beta1.Agents.GetValidationResult]. +// The request message for +// [Agents.GetValidationResult][google.cloud.dialogflow.v2beta1.Agents.GetValidationResult]. message GetValidationResultRequest { // Required. The project that the agent is associated with. // Format: `projects/` or diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/answer_record.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/answer_record.proto index 1193f90c617..762b1ea1b45 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/answer_record.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/answer_record.proto @@ -32,7 +32,8 @@ option java_outer_classname = "AnswerRecordsProto"; option java_package = "com.google.cloud.dialogflow.v2beta1"; option objc_class_prefix = "DF"; -// Service for managing [AnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecord]. +// Service for managing +// [AnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecord]. service AnswerRecords { option (google.api.default_host) = "dialogflow.googleapis.com"; option (google.api.oauth_scopes) = @@ -53,7 +54,8 @@ service AnswerRecords { // Returns the list of all answer records in the specified project in reverse // chronological order. - rpc ListAnswerRecords(ListAnswerRecordsRequest) returns (ListAnswerRecordsResponse) { + rpc ListAnswerRecords(ListAnswerRecordsRequest) + returns (ListAnswerRecordsResponse) { option (google.api.http) = { get: "/v2beta1/{parent=projects/*}/answerRecords" additional_bindings { @@ -98,9 +100,12 @@ service AnswerRecords { // A typical workflow for customers provide feedback to an answer is: // // 1. For human agent assistant, customers get suggestion via ListSuggestions -// API. Together with the answers, [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] are returned to the -// customers. -// 2. The customer uses the [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] to call the +// API. Together with the answers, +// [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] are +// returned to the customers. +// 2. The customer uses the +// [AnswerRecord.name][google.cloud.dialogflow.v2beta1.AnswerRecord.name] to +// call the // [UpdateAnswerRecord][] method to send feedback about a specific answer // that they believe is wrong. message AnswerRecord { @@ -111,14 +116,15 @@ message AnswerRecord { }; // The unique identifier of this answer record. - // Required for [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord] method. - // Format: `projects//locations//locations//answerRecords/`. string name = 1; // Optional. The AnswerFeedback for this record. You can set this with - // [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord] in order to give us feedback about - // this answer. + // [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord] + // in order to give us feedback about this answer. AnswerFeedback answer_feedback = 3; // Output only. The record for this answer. @@ -133,7 +139,8 @@ message AgentAssistantRecord { // Output only. The agent assistant answer. oneof answer { // Output only. The article suggestion answer. - ArticleAnswer article_suggestion_answer = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + ArticleAnswer article_suggestion_answer = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The FAQ answer. FaqAnswer faq_answer = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -255,7 +262,9 @@ message AgentAssistantFeedback { // Optional. Whether or not the suggested document is efficient. For example, // if the document is poorly written, hard to understand, hard to use or - // too long to find useful information, [document_efficiency][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.document_efficiency] is + // too long to find useful information, + // [document_efficiency][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.document_efficiency] + // is // [DocumentEfficiency.INEFFICIENT][google.cloud.dialogflow.v2beta1.AgentAssistantFeedback.DocumentEfficiency.INEFFICIENT]. DocumentEfficiency document_efficiency = 3; @@ -263,7 +272,8 @@ message AgentAssistantFeedback { SummarizationFeedback summarization_feedback = 4; } -// Request message for [AnswerRecords.GetAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.GetAnswerRecord]. +// Request message for +// [AnswerRecords.GetAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.GetAnswerRecord]. message GetAnswerRecordRequest { // Required. The name of the answer record to retrieve. // Format: `projects//locations//locations/`. string parent = 1 [(google.api.resource_reference) = { - child_type: "dialogflow.googleapis.com/AnswerRecord" - }]; + child_type: "dialogflow.googleapis.com/AnswerRecord" + }]; // Optional. Filters to restrict results to specific answer records. // // For more information about filtering, see // [API Filtering](https://aip.dev/160). - string filter = 2 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + string filter = 2 [deprecated = true, (google.api.field_behavior) = OPTIONAL]; // Optional. The maximum number of records to return in a single page. // The server may return fewer records than this. If unspecified, we use 10. @@ -301,7 +309,8 @@ message ListAnswerRecordsRequest { string page_token = 4; } -// Response message for [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecords.ListAnswerRecords]. +// Response message for +// [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2beta1.AnswerRecords.ListAnswerRecords]. message ListAnswerRecordsResponse { // The list of answer records. repeated AnswerRecord answer_records = 1; @@ -315,7 +324,8 @@ message ListAnswerRecordsResponse { string next_page_token = 2; } -// Request message for [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord]. +// Request message for +// [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2beta1.AnswerRecords.UpdateAnswerRecord]. message UpdateAnswerRecordRequest { // Required. Answer record to update. AnswerRecord answer_record = 1 [(google.api.field_behavior) = REQUIRED]; diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/audio_config.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/audio_config.proto index b9e83b20bef..0f34aa6663d 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/audio_config.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/audio_config.proto @@ -31,6 +31,10 @@ option (google.api.resource_definition) = { type: "automl.googleapis.com/Model" pattern: "projects/{project}/locations/{location}/models/{model}" }; +option (google.api.resource_definition) = { + type: "speech.googleapis.com/PhraseSet" + pattern: "projects/{project}/locations/{location}/phraseSets/{phrase_set}" +}; // Audio encoding of the audio content sent in the conversational query request. // Refer to the diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/context.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/context.proto index a8e8c21f91f..7a7525e3c87 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/context.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/context.proto @@ -136,7 +136,8 @@ service Contexts { } // Deletes all active contexts in the specified session. - rpc DeleteAllContexts(DeleteAllContextsRequest) returns (google.protobuf.Empty) { + rpc DeleteAllContexts(DeleteAllContextsRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v2beta1/{parent=projects/*/agent/sessions/*}/contexts" additional_bindings { @@ -227,7 +228,8 @@ message Context { google.protobuf.Struct parameters = 3; } -// The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts]. +// The request message for +// [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts]. message ListContextsRequest { // Required. The session to list all contexts from. Supported formats: // - `projects//agent/sessions/, @@ -257,7 +259,8 @@ message ListContextsRequest { string page_token = 3; } -// The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts]. +// The response message for +// [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts]. message ListContextsResponse { // The list of contexts. There will be a maximum number of items // returned based on the page_size field in the request. @@ -268,7 +271,8 @@ message ListContextsResponse { string next_page_token = 2; } -// The request message for [Contexts.GetContext][google.cloud.dialogflow.v2beta1.Contexts.GetContext]. +// The request message for +// [Contexts.GetContext][google.cloud.dialogflow.v2beta1.Contexts.GetContext]. message GetContextRequest { // Required. The name of the context. Supported formats: // - `projects//agent/sessions//contexts//agent/sessions/, @@ -318,16 +323,19 @@ message CreateContextRequest { Context context = 2 [(google.api.field_behavior) = REQUIRED]; } -// The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2beta1.Contexts.UpdateContext]. +// The request message for +// [Contexts.UpdateContext][google.cloud.dialogflow.v2beta1.Contexts.UpdateContext]. message UpdateContextRequest { // Required. The context to update. Context context = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2beta1.Contexts.DeleteContext]. +// The request message for +// [Contexts.DeleteContext][google.cloud.dialogflow.v2beta1.Contexts.DeleteContext]. message DeleteContextRequest { // Required. The name of the context to delete. Supported formats: // - `projects//agent/sessions//contexts//agent/sessions/, // - `projects//locations//agent/sessions/`, diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/conversation.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/conversation.proto index 432d8c08024..7fb0d557a65 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/conversation.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/conversation.proto @@ -31,7 +31,8 @@ option java_outer_classname = "ConversationProto"; option java_package = "com.google.cloud.dialogflow.v2beta1"; option objc_class_prefix = "DF"; -// Service for managing [Conversations][google.cloud.dialogflow.v2beta1.Conversation]. +// Service for managing +// [Conversations][google.cloud.dialogflow.v2beta1.Conversation]. service Conversations { option (google.api.default_host) = "dialogflow.googleapis.com"; option (google.api.oauth_scopes) = @@ -51,11 +52,14 @@ service Conversations { // For Assist Stage, there's no dialogflow agent responding to user queries. // But we will provide suggestions which are generated from conversation. // - // If [Conversation.conversation_profile][google.cloud.dialogflow.v2beta1.Conversation.conversation_profile] is configured for a dialogflow - // agent, conversation will start from `Automated Agent Stage`, otherwise, it - // will start from `Assist Stage`. And during `Automated Agent Stage`, once an - // [Intent][google.cloud.dialogflow.v2beta1.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff] is triggered, conversation - // will transfer to Assist Stage. + // If + // [Conversation.conversation_profile][google.cloud.dialogflow.v2beta1.Conversation.conversation_profile] + // is configured for a dialogflow agent, conversation will start from + // `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And + // during `Automated Agent Stage`, once an + // [Intent][google.cloud.dialogflow.v2beta1.Intent] with + // [Intent.live_agent_handoff][google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff] + // is triggered, conversation will transfer to Assist Stage. rpc CreateConversation(CreateConversationRequest) returns (Conversation) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*}/conversations" @@ -69,7 +73,8 @@ service Conversations { } // Returns the list of all conversations in the specified project. - rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) { + rpc ListConversations(ListConversationsRequest) + returns (ListConversationsResponse) { option (google.api.http) = { get: "/v2beta1/{parent=projects/*}/conversations" additional_bindings { @@ -106,7 +111,8 @@ service Conversations { // Batch ingests messages to conversation. Customers can use this RPC to // ingest historical messages to conversation. - rpc BatchCreateMessages(BatchCreateMessagesRequest) returns (BatchCreateMessagesResponse) { + rpc BatchCreateMessages(BatchCreateMessagesRequest) + returns (BatchCreateMessagesResponse) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*/conversations/*}/messages:batchCreate" body: "*" @@ -136,7 +142,8 @@ service Conversations { // Suggest summary for a conversation based on specific historical messages. // The range of the messages to be used for summary can be specified in the // request. - rpc SuggestConversationSummary(SuggestConversationSummaryRequest) returns (SuggestConversationSummaryResponse) { + rpc SuggestConversationSummary(SuggestConversationSummaryRequest) + returns (SuggestConversationSummaryResponse) { option (google.api.http) = { post: "/v2beta1/{conversation=projects/*/conversations/*}/suggestions:suggestConversationSummary" body: "*" @@ -195,7 +202,8 @@ message Conversation { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The current state of the Conversation. - LifecycleState lifecycle_state = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + LifecycleState lifecycle_state = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The Conversation Profile to be used to configure this // Conversation. This field cannot be updated. @@ -210,28 +218,34 @@ message Conversation { // Output only. Required if the conversation is to be connected over // telephony. - ConversationPhoneNumber phone_number = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + ConversationPhoneNumber phone_number = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The stage of a conversation. It indicates whether the virtual agent or a // human agent is handling the conversation. // // If the conversation is created with the conversation profile that has // Dialogflow config set, defaults to - // [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE]; Otherwise, defaults to + // [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE]; + // Otherwise, defaults to // [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE]. // // If the conversation is created with the conversation profile that has // Dialogflow config set but explicitly sets conversation_stage to - // [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE], it skips - // [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE] stage and directly goes to + // [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE], + // it skips + // [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE] + // stage and directly goes to // [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE]. ConversationStage conversation_stage = 7; // Output only. The time the conversation was started. - google.protobuf.Timestamp start_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time the conversation was finished. - google.protobuf.Timestamp end_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Represents a phone number for telephony integration. It allows for connecting @@ -241,7 +255,8 @@ message ConversationPhoneNumber { string phone_number = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// The request message for [Conversations.CreateConversation][google.cloud.dialogflow.v2beta1.Conversations.CreateConversation]. +// The request message for +// [Conversations.CreateConversation][google.cloud.dialogflow.v2beta1.Conversations.CreateConversation]. message CreateConversationRequest { // Required. Resource identifier of the project creating the conversation. // Format: `projects//locations/`. @@ -255,8 +270,8 @@ message CreateConversationRequest { // Required. The conversation to create. Conversation conversation = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. Identifier of the conversation. Generally it's auto generated by Google. - // Only set it if you cannot wait for the response to return a + // Optional. Identifier of the conversation. Generally it's auto generated by + // Google. Only set it if you cannot wait for the response to return a // auto-generated one to you. // // The conversation ID must be compliant with the regression fomula @@ -268,7 +283,8 @@ message CreateConversationRequest { string conversation_id = 3 [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [Conversations.ListConversations][google.cloud.dialogflow.v2beta1.Conversations.ListConversations]. +// The request message for +// [Conversations.ListConversations][google.cloud.dialogflow.v2beta1.Conversations.ListConversations]. message ListConversationsRequest { // Required. The project from which to list all conversation. // Format: `projects//locations/`. @@ -306,7 +322,8 @@ message ListConversationsRequest { string filter = 4; } -// The response message for [Conversations.ListConversations][google.cloud.dialogflow.v2beta1.Conversations.ListConversations]. +// The response message for +// [Conversations.ListConversations][google.cloud.dialogflow.v2beta1.Conversations.ListConversations]. message ListConversationsResponse { // The list of conversations. There will be a maximum number of items // returned based on the page_size field in the request. @@ -317,7 +334,8 @@ message ListConversationsResponse { string next_page_token = 2; } -// The request message for [Conversations.GetConversation][google.cloud.dialogflow.v2beta1.Conversations.GetConversation]. +// The request message for +// [Conversations.GetConversation][google.cloud.dialogflow.v2beta1.Conversations.GetConversation]. message GetConversationRequest { // Required. The name of the conversation. Format: // `projects//locations//conversations//locations//locations//locations//locations//conversations//messages/`. string latest_message = 3 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - }]; + type: "dialogflow.googleapis.com/Message" + }]; // Max number of messages prior to and including // [latest_message] to use as context when compiling the @@ -455,7 +480,8 @@ message SuggestConversationSummaryRequest { int32 context_size = 4; } -// The response message for [Conversations.SuggestConversationSummary][google.cloud.dialogflow.v2beta1.Conversations.SuggestConversationSummary]. +// The response message for +// [Conversations.SuggestConversationSummary][google.cloud.dialogflow.v2beta1.Conversations.SuggestConversationSummary]. message SuggestConversationSummaryResponse { // Generated summary for a conversation. message Summary { @@ -470,8 +496,8 @@ message SuggestConversationSummaryResponse { // The name of the answer record. Format: // "projects//answerRecords/" string answer_record = 3 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/AnswerRecord" - }]; + type: "dialogflow.googleapis.com/AnswerRecord" + }]; } // Generated summary. @@ -483,8 +509,8 @@ message SuggestConversationSummaryResponse { // Format: `projects//locations//conversations//messages/`. string latest_message = 2 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - }]; + type: "dialogflow.googleapis.com/Message" + }]; // Number of messages prior to and including // [last_conversation_message][] used to compile the suggestion. It may be diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/conversation_profile.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/conversation_profile.proto index 0c1f5529620..c01970a69d9 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/conversation_profile.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/conversation_profile.proto @@ -43,7 +43,8 @@ option (google.api.resource_definition) = { pattern: "projects/{project}/locations/{location}/conversationModels/{conversation_model}" }; -// Service for managing [ConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfile]. +// Service for managing +// [ConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfile]. service ConversationProfiles { option (google.api.default_host) = "dialogflow.googleapis.com"; option (google.api.oauth_scopes) = @@ -51,7 +52,8 @@ service ConversationProfiles { "https://www.googleapis.com/auth/dialogflow"; // Returns the list of all conversation profiles in the specified project. - rpc ListConversationProfiles(ListConversationProfilesRequest) returns (ListConversationProfilesResponse) { + rpc ListConversationProfiles(ListConversationProfilesRequest) + returns (ListConversationProfilesResponse) { option (google.api.http) = { get: "/v2beta1/{parent=projects/*}/conversationProfiles" additional_bindings { @@ -62,7 +64,8 @@ service ConversationProfiles { } // Retrieves the specified conversation profile. - rpc GetConversationProfile(GetConversationProfileRequest) returns (ConversationProfile) { + rpc GetConversationProfile(GetConversationProfileRequest) + returns (ConversationProfile) { option (google.api.http) = { get: "/v2beta1/{name=projects/*/conversationProfiles/*}" additional_bindings { @@ -76,8 +79,10 @@ service ConversationProfiles { // // [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] // aren't populated in the response. You can retrieve them via - // [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile] API. - rpc CreateConversationProfile(CreateConversationProfileRequest) returns (ConversationProfile) { + // [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile] + // API. + rpc CreateConversationProfile(CreateConversationProfileRequest) + returns (ConversationProfile) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*}/conversationProfiles" body: "conversation_profile" @@ -93,8 +98,10 @@ service ConversationProfiles { // // [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] // aren't populated in the response. You can retrieve them via - // [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile] API. - rpc UpdateConversationProfile(UpdateConversationProfileRequest) returns (ConversationProfile) { + // [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile] + // API. + rpc UpdateConversationProfile(UpdateConversationProfileRequest) + returns (ConversationProfile) { option (google.api.http) = { patch: "/v2beta1/{conversation_profile.name=projects/*/conversationProfiles/*}" body: "conversation_profile" @@ -107,7 +114,8 @@ service ConversationProfiles { } // Deletes the specified conversation profile. - rpc DeleteConversationProfile(DeleteConversationProfileRequest) returns (google.protobuf.Empty) { + rpc DeleteConversationProfile(DeleteConversationProfileRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v2beta1/{name=projects/*/conversationProfiles/*}" additional_bindings { @@ -126,14 +134,17 @@ service ConversationProfiles { // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). // The returned `Operation` type has the following method-specific fields: // - // - `metadata`: [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata] - // - `response`: [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile] + // - `metadata`: + // [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata] + // - `response`: + // [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile] // // If a long running operation to add or update suggestion feature // config for the same conversation profile, participant role and suggestion // feature type exists, please cancel the existing long running operation // before sending such request, otherwise the request will be rejected. - rpc SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest) returns (google.longrunning.Operation) { + rpc SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2beta1/{conversation_profile=projects/*/conversationProfiles/*}:setSuggestionFeatureConfig" body: "*" @@ -156,9 +167,12 @@ service ConversationProfiles { // operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). // The returned `Operation` type has the following method-specific fields: // - // - `metadata`: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata] - // - `response`: [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile] - rpc ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest) returns (google.longrunning.Operation) { + // - `metadata`: + // [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata] + // - `response`: + // [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile] + rpc ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2beta1/{conversation_profile=projects/*/conversationProfiles/*}:clearSuggestionFeatureConfig" body: "*" @@ -192,10 +206,12 @@ message ConversationProfile { string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Output only. Create time of the conversation profile. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Update time of the conversation profile. - google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Configuration for an automated agent to use with this profile. AutomatedAgentConfig automated_agent_config = 3; @@ -216,7 +232,8 @@ message ConversationProfile { LoggingConfig logging_config = 7; // Configuration for publishing new message events. Event will be sent in - // format of [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] + // format of + // [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] NotificationConfig new_message_event_notification_config = 8; // Settings for speech transcription. @@ -238,8 +255,8 @@ message ConversationProfile { // Format: `projects//locations//securitySettings/`. string security_settings = 13 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/CXSecuritySettings" - }]; + type: "dialogflow.googleapis.com/CXSecuritySettings" + }]; } // Defines the Automated Agent to connect to a conversation. @@ -365,8 +382,8 @@ message HumanAgentAssistantConfig { // // Supported feature: DIALOGFLOW_ASSIST. message DialogflowQuerySource { - // Required. The name of a dialogflow virtual agent used for end user side intent - // detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in // the same Dialogflow project. string agent = 1 [ @@ -443,8 +460,8 @@ message HumanAgentAssistantConfig { // Conversation model resource name. Format: `projects//conversationModels/`. string model = 1 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/ConversationModel" - }]; + type: "dialogflow.googleapis.com/ConversationModel" + }]; } // Config to process conversation. @@ -470,11 +487,17 @@ message HumanAgentAssistantConfig { // and identifies the prevailing subjective opinion, especially to determine // a user's attitude as positive, negative, or neutral: // https://cloud.google.com/natural-language/docs/basics#sentiment_analysis - // For [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] method, result will be in + // For + // [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] + // method, result will be in // [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentResponse.message]. - // For [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] method, result will be in + // For + // [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] + // method, result will be in // [AnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2beta1.AnalyzeContentResponse.message] - // For [Conversations.ListMessages][google.cloud.dialogflow.v2beta1.Conversations.ListMessages] method, result will be in + // For + // [Conversations.ListMessages][google.cloud.dialogflow.v2beta1.Conversations.ListMessages] + // method, result will be in // [ListMessagesResponse.messages.SentimentAnalysisResult][google.cloud.dialogflow.v2beta1.ListMessagesResponse.messages] // If Pub/Sub notification is configured, result will be in // [ConversationEvent.new_message_payload.SentimentAnalysisResult][google.cloud.dialogflow.v2beta1.ConversationEvent.new_message_payload]. @@ -554,8 +577,10 @@ message NotificationConfig { // Name of the Pub/Sub topic to publish conversation // events like - // [CONVERSATION_STARTED][google.cloud.dialogflow.v2beta1.ConversationEvent.Type.CONVERSATION_STARTED] as - // serialized [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] protos. + // [CONVERSATION_STARTED][google.cloud.dialogflow.v2beta1.ConversationEvent.Type.CONVERSATION_STARTED] + // as serialized + // [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] + // protos. // // For telephony integration to receive notification, make sure either this // topic is in the same project as the conversation or you grant @@ -576,13 +601,15 @@ message NotificationConfig { // Defines logging behavior for conversation lifecycle events. message LoggingConfig { // Whether to log conversation events like - // [CONVERSATION_STARTED][google.cloud.dialogflow.v2beta1.ConversationEvent.Type.CONVERSATION_STARTED] to - // Stackdriver in the conversation project as JSON format - // [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] protos. + // [CONVERSATION_STARTED][google.cloud.dialogflow.v2beta1.ConversationEvent.Type.CONVERSATION_STARTED] + // to Stackdriver in the conversation project as JSON format + // [ConversationEvent][google.cloud.dialogflow.v2beta1.ConversationEvent] + // protos. bool enable_stackdriver_logging = 3; } -// The request message for [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles]. +// The request message for +// [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles]. message ListConversationProfilesRequest { // Required. The project to list all conversation profiles from. // Format: `projects//locations/`. @@ -601,7 +628,8 @@ message ListConversationProfilesRequest { string page_token = 3; } -// The response message for [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles]. +// The response message for +// [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles]. message ListConversationProfilesResponse { // The list of project conversation profiles. There is a maximum number // of items returned based on the page_size field in the request. @@ -612,7 +640,8 @@ message ListConversationProfilesResponse { string next_page_token = 2; } -// The request message for [ConversationProfiles.GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile]. +// The request message for +// [ConversationProfiles.GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile]. message GetConversationProfileRequest { // Required. The resource name of the conversation profile. // Format: `projects//locations//locations/`. @@ -637,19 +667,24 @@ message CreateConversationProfileRequest { ]; // Required. The conversation profile to create. - ConversationProfile conversation_profile = 2 [(google.api.field_behavior) = REQUIRED]; + ConversationProfile conversation_profile = 2 + [(google.api.field_behavior) = REQUIRED]; } -// The request message for [ConversationProfiles.UpdateConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.UpdateConversationProfile]. +// The request message for +// [ConversationProfiles.UpdateConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.UpdateConversationProfile]. message UpdateConversationProfileRequest { // Required. The conversation profile to update. - ConversationProfile conversation_profile = 1 [(google.api.field_behavior) = REQUIRED]; + ConversationProfile conversation_profile = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The mask to control which fields to update. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } -// The request message for [ConversationProfiles.DeleteConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.DeleteConversationProfile]. +// The request message for +// [ConversationProfiles.DeleteConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.DeleteConversationProfile]. // // This operation fails if the conversation profile is still referenced from // a phone number. @@ -675,10 +710,12 @@ message SetSuggestionFeatureConfigRequest { // Required. The participant role to add or update the suggestion feature // config. Only HUMAN_AGENT or END_USER can be used. - Participant.Role participant_role = 2 [(google.api.field_behavior) = REQUIRED]; + Participant.Role participant_role = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. The suggestion feature config to add or update. - HumanAgentAssistantConfig.SuggestionFeatureConfig suggestion_feature_config = 3 [(google.api.field_behavior) = REQUIRED]; + HumanAgentAssistantConfig.SuggestionFeatureConfig suggestion_feature_config = + 3 [(google.api.field_behavior) = REQUIRED]; } // The request message for [ConversationProfiles.ClearFeature][]. @@ -690,10 +727,12 @@ message ClearSuggestionFeatureConfigRequest { // Required. The participant role to remove the suggestion feature // config. Only HUMAN_AGENT or END_USER can be used. - Participant.Role participant_role = 2 [(google.api.field_behavior) = REQUIRED]; + Participant.Role participant_role = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. The type of the suggestion feature to remove. - SuggestionFeature.Type suggestion_feature_type = 3 [(google.api.field_behavior) = REQUIRED]; + SuggestionFeature.Type suggestion_feature_type = 3 + [(google.api.field_behavior) = REQUIRED]; } // Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] @@ -706,10 +745,12 @@ message SetSuggestionFeatureConfigOperationMetadata { // Required. The participant role to add or update the suggestion feature // config. Only HUMAN_AGENT or END_USER can be used. - Participant.Role participant_role = 2 [(google.api.field_behavior) = REQUIRED]; + Participant.Role participant_role = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. The type of the suggestion feature to add or update. - SuggestionFeature.Type suggestion_feature_type = 3 [(google.api.field_behavior) = REQUIRED]; + SuggestionFeature.Type suggestion_feature_type = 3 + [(google.api.field_behavior) = REQUIRED]; // Timestamp whe the request was created. The time is measured on server side. google.protobuf.Timestamp create_time = 4; @@ -725,10 +766,12 @@ message ClearSuggestionFeatureConfigOperationMetadata { // Required. The participant role to remove the suggestion feature // config. Only HUMAN_AGENT or END_USER can be used. - Participant.Role participant_role = 2 [(google.api.field_behavior) = REQUIRED]; + Participant.Role participant_role = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. The type of the suggestion feature to remove. - SuggestionFeature.Type suggestion_feature_type = 3 [(google.api.field_behavior) = REQUIRED]; + SuggestionFeature.Type suggestion_feature_type = 3 + [(google.api.field_behavior) = REQUIRED]; // Timestamp whe the request was created. The time is measured on server side. google.protobuf.Timestamp create_time = 4; diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/document.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/document.proto index 9ecdb5fb54c..ae5b8498e77 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/document.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/document.proto @@ -34,7 +34,8 @@ option java_outer_classname = "DocumentProto"; option java_package = "com.google.cloud.dialogflow.v2beta1"; option objc_class_prefix = "DF"; -// Service for managing knowledge [Documents][google.cloud.dialogflow.v2beta1.Document]. +// Service for managing knowledge +// [Documents][google.cloud.dialogflow.v2beta1.Document]. service Documents { option (google.api.default_host) = "dialogflow.googleapis.com"; option (google.api.oauth_scopes) = @@ -81,12 +82,14 @@ service Documents { // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). // The returned `Operation` type has the following method-specific fields: // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + // - `metadata`: + // [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] // - `response`: [Document][google.cloud.dialogflow.v2beta1.Document] // // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; // only use `projects.knowledgeBases.documents`. - rpc CreateDocument(CreateDocumentRequest) returns (google.longrunning.Operation) { + rpc CreateDocument(CreateDocumentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*/knowledgeBases/*}/documents" body: "document" @@ -114,9 +117,12 @@ service Documents { // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). // The returned `Operation` type has the following method-specific fields: // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] - // - `response`: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse] - rpc ImportDocuments(ImportDocumentsRequest) returns (google.longrunning.Operation) { + // - `metadata`: + // [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + // - `response`: + // [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse] + rpc ImportDocuments(ImportDocumentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*/knowledgeBases/*}/documents:import" body: "*" @@ -137,13 +143,15 @@ service Documents { // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). // The returned `Operation` type has the following method-specific fields: // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + // - `metadata`: + // [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] // - `response`: An [Empty // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) // // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; // only use `projects.knowledgeBases.documents`. - rpc DeleteDocument(DeleteDocumentRequest) returns (google.longrunning.Operation) { + rpc DeleteDocument(DeleteDocumentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v2beta1/{name=projects/*/knowledgeBases/*/documents/*}" additional_bindings { @@ -166,12 +174,14 @@ service Documents { // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). // The returned `Operation` type has the following method-specific fields: // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + // - `metadata`: + // [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] // - `response`: [Document][google.cloud.dialogflow.v2beta1.Document] // // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; // only use `projects.knowledgeBases.documents`. - rpc UpdateDocument(UpdateDocumentRequest) returns (google.longrunning.Operation) { + rpc UpdateDocument(UpdateDocumentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v2beta1/{document.name=projects/*/knowledgeBases/*/documents/*}" body: "document" @@ -204,12 +214,14 @@ service Documents { // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). // The returned `Operation` type has the following method-specific fields: // - // - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + // - `metadata`: + // [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] // - `response`: [Document][google.cloud.dialogflow.v2beta1.Document] // // Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; // only use `projects.knowledgeBases.documents`. - rpc ReloadDocument(ReloadDocumentRequest) returns (google.longrunning.Operation) { + rpc ReloadDocument(ReloadDocumentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2beta1/{name=projects/*/knowledgeBases/*/documents/*}:reload" body: "*" @@ -230,7 +242,8 @@ service Documents { } } -// A knowledge document to be used by a [KnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBase]. +// A knowledge document to be used by a +// [KnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBase]. // // For more information, see the [knowledge base // guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). @@ -321,7 +334,8 @@ message Document { string mime_type = 3 [(google.api.field_behavior) = REQUIRED]; // Required. The knowledge type of document content. - repeated KnowledgeType knowledge_types = 4 [(google.api.field_behavior) = REQUIRED]; + repeated KnowledgeType knowledge_types = 4 + [(google.api.field_behavior) = REQUIRED]; // The source of this document. oneof source { @@ -368,7 +382,8 @@ message Document { // Output only. The time and status of the latest reload. // This reload may have been triggered automatically or manually // and may not have succeeded. - ReloadStatus latest_reload_status = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + ReloadStatus latest_reload_status = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. Metadata for the document. The metadata supports arbitrary // key-value pairs. Suggested use cases include storing a document's title, @@ -380,7 +395,8 @@ message Document { State state = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request message for [Documents.GetDocument][google.cloud.dialogflow.v2beta1.Documents.GetDocument]. +// Request message for +// [Documents.GetDocument][google.cloud.dialogflow.v2beta1.Documents.GetDocument]. message GetDocumentRequest { // Required. The name of the document to retrieve. // Format `projects//locations//locations//locations//locations/ metadata = 3; } -// Response message for [Documents.ImportDocuments][google.cloud.dialogflow.v2beta1.Documents.ImportDocuments]. +// Response message for +// [Documents.ImportDocuments][google.cloud.dialogflow.v2beta1.Documents.ImportDocuments]. message ImportDocumentsResponse { // Includes details about skipped documents or any other warnings. repeated google.rpc.Status warnings = 1; } -// Request message for [Documents.DeleteDocument][google.cloud.dialogflow.v2beta1.Documents.DeleteDocument]. +// Request message for +// [Documents.DeleteDocument][google.cloud.dialogflow.v2beta1.Documents.DeleteDocument]. message DeleteDocumentRequest { // Required. The name of the document to delete. // Format: `projects//locations//locations//agent/entityTypes/` // - `projects//locations//agent/entityTypes/` @@ -362,7 +374,8 @@ message EntityType { // Optional. Indicates whether the entity type can be automatically // expanded. - AutoExpansionMode auto_expansion_mode = 4 [(google.api.field_behavior) = OPTIONAL]; + AutoExpansionMode auto_expansion_mode = 4 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The collection of entity entries associated with the entity type. repeated Entity entities = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -371,7 +384,8 @@ message EntityType { bool enable_fuzzy_extraction = 7 [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.ListEntityTypes]. +// The request message for +// [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.ListEntityTypes]. message ListEntityTypesRequest { // Required. The agent to list all entity types from. // Supported formats: @@ -399,7 +413,8 @@ message ListEntityTypesRequest { string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; } -// The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.ListEntityTypes]. +// The response message for +// [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.ListEntityTypes]. message ListEntityTypesResponse { // The list of agent entity types. There will be a maximum number of items // returned based on the page_size field in the request. @@ -410,7 +425,8 @@ message ListEntityTypesResponse { string next_page_token = 2; } -// The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.GetEntityType]. +// The request message for +// [EntityTypes.GetEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.GetEntityType]. message GetEntityTypeRequest { // Required. The name of the entity type. // Supported formats: @@ -432,7 +448,8 @@ message GetEntityTypeRequest { string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.CreateEntityType]. +// The request message for +// [EntityTypes.CreateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.CreateEntityType]. message CreateEntityTypeRequest { // Required. The agent to create a entity type for. // Supported formats: @@ -456,7 +473,8 @@ message CreateEntityTypeRequest { string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.UpdateEntityType]. +// The request message for +// [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.UpdateEntityType]. message UpdateEntityTypeRequest { // Required. The entity type to update. EntityType entity_type = 1 [(google.api.field_behavior) = REQUIRED]; @@ -469,10 +487,12 @@ message UpdateEntityTypeRequest { string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 3 + [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.DeleteEntityType]. +// The request message for +// [EntityTypes.DeleteEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.DeleteEntityType]. message DeleteEntityTypeRequest { // Required. The name of the entity type to delete. // Supported formats: @@ -487,7 +507,8 @@ message DeleteEntityTypeRequest { ]; } -// The request message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes]. +// The request message for +// [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes]. message BatchUpdateEntityTypesRequest { // Required. The name of the agent to update or create entity types in. // Supported formats: @@ -525,16 +546,19 @@ message BatchUpdateEntityTypesRequest { string language_code = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 5 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 5 + [(google.api.field_behavior) = OPTIONAL]; } -// The response message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes]. +// The response message for +// [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes]. message BatchUpdateEntityTypesResponse { // The collection of updated or created entity types. repeated EntityType entity_types = 1; } -// The request message for [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntityTypes]. +// The request message for +// [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntityTypes]. message BatchDeleteEntityTypesRequest { // Required. The name of the agent to delete all entities types for. // Supported formats: @@ -549,10 +573,12 @@ message BatchDeleteEntityTypesRequest { // Required. The names entity types to delete. All names must point to the // same agent as `parent`. - repeated string entity_type_names = 2 [(google.api.field_behavior) = REQUIRED]; + repeated string entity_type_names = 2 + [(google.api.field_behavior) = REQUIRED]; } -// The request message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchCreateEntities]. +// The request message for +// [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchCreateEntities]. message BatchCreateEntitiesRequest { // Required. The name of the entity type to create entities in. // Supported formats: @@ -567,7 +593,8 @@ message BatchCreateEntitiesRequest { ]; // Required. The entities to create. - repeated EntityType.Entity entities = 2 [(google.api.field_behavior) = REQUIRED]; + repeated EntityType.Entity entities = 2 + [(google.api.field_behavior) = REQUIRED]; // Optional. The language used to access language-specific data. // If not specified, the agent's default language is used. @@ -577,7 +604,8 @@ message BatchCreateEntitiesRequest { string language_code = 3 [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [EntityTypes.BatchUpdateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntities]. +// The request message for +// [EntityTypes.BatchUpdateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntities]. message BatchUpdateEntitiesRequest { // Required. The name of the entity type to update or create entities in. // Supported formats: @@ -592,7 +620,8 @@ message BatchUpdateEntitiesRequest { ]; // Required. The entities to update or create. - repeated EntityType.Entity entities = 2 [(google.api.field_behavior) = REQUIRED]; + repeated EntityType.Entity entities = 2 + [(google.api.field_behavior) = REQUIRED]; // Optional. The language used to access language-specific data. // If not specified, the agent's default language is used. @@ -605,7 +634,8 @@ message BatchUpdateEntitiesRequest { google.protobuf.FieldMask update_mask = 4; } -// The request message for [EntityTypes.BatchDeleteEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntities]. +// The request message for +// [EntityTypes.BatchDeleteEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntities]. message BatchDeleteEntitiesRequest { // Required. The name of the entity type to delete entries for. // Supported formats: diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/environment.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/environment.proto index dd95cab9af3..4fa6653f714 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/environment.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/environment.proto @@ -34,7 +34,8 @@ option java_outer_classname = "EnvironmentProto"; option java_package = "com.google.cloud.dialogflow.v2beta1"; option objc_class_prefix = "DF"; -// Service for managing [Environments][google.cloud.dialogflow.v2beta1.Environment]. +// Service for managing +// [Environments][google.cloud.dialogflow.v2beta1.Environment]. service Environments { option (google.api.default_host) = "dialogflow.googleapis.com"; option (google.api.oauth_scopes) = @@ -42,7 +43,8 @@ service Environments { "https://www.googleapis.com/auth/dialogflow"; // Returns the list of all non-draft environments of the specified agent. - rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) { + rpc ListEnvironments(ListEnvironmentsRequest) + returns (ListEnvironmentsResponse) { option (google.api.http) = { get: "/v2beta1/{parent=projects/*/agent}/environments" additional_bindings { @@ -98,7 +100,8 @@ service Environments { } // Deletes the specified agent environment. - rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (google.protobuf.Empty) { + rpc DeleteEnvironment(DeleteEnvironmentRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v2beta1/{name=projects/*/agent/environments/*}" additional_bindings { @@ -108,7 +111,8 @@ service Environments { } // Gets the history of the specified environment. - rpc GetEnvironmentHistory(GetEnvironmentHistoryRequest) returns (EnvironmentHistory) { + rpc GetEnvironmentHistory(GetEnvironmentHistoryRequest) + returns (EnvironmentHistory) { option (google.api.http) = { get: "/v2beta1/{parent=projects/*/agent/environments/*}/history" additional_bindings { @@ -185,16 +189,18 @@ message Environment { } ]; - // Output only. The state of this environment. This field is read-only, i.e., it cannot be - // set by create and update methods. + // Output only. The state of this environment. This field is read-only, i.e., + // it cannot be set by create and update methods. State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The last update time of this environment. This field is read-only, i.e., it - // cannot be set by create and update methods. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The last update time of this environment. This field is + // read-only, i.e., it cannot be set by create and update methods. + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. Text to speech settings for this environment. - TextToSpeechSettings text_to_speech_settings = 7 [(google.api.field_behavior) = OPTIONAL]; + TextToSpeechSettings text_to_speech_settings = 7 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The fulfillment settings to use for this environment. Fulfillment fulfillment = 8 [(google.api.field_behavior) = OPTIONAL]; @@ -202,27 +208,30 @@ message Environment { // Instructs the speech synthesizer on how to generate the output audio content. message TextToSpeechSettings { - // Optional. Indicates whether text to speech is enabled. Even when this field is false, - // other settings in this proto are still retained. + // Optional. Indicates whether text to speech is enabled. Even when this field + // is false, other settings in this proto are still retained. bool enable_text_to_speech = 1 [(google.api.field_behavior) = OPTIONAL]; // Required. Audio encoding of the synthesized audio content. - OutputAudioEncoding output_audio_encoding = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then - // the synthesizer will use the default sample rate based on the audio - // encoding. If this is different from the voice's natural sample rate, then - // the synthesizer will honor this request by converting to the desired sample - // rate (which might result in worse audio quality). + OutputAudioEncoding output_audio_encoding = 2 + [(google.api.field_behavior) = REQUIRED]; + + // Optional. The synthesis sample rate (in hertz) for this audio. If not + // provided, then the synthesizer will use the default sample rate based on + // the audio encoding. If this is different from the voice's natural sample + // rate, then the synthesizer will honor this request by converting to the + // desired sample rate (which might result in worse audio quality). int32 sample_rate_hertz = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Configuration of how speech should be synthesized, mapping from language - // (https://cloud.google.com/dialogflow/docs/reference/language) to + // Optional. Configuration of how speech should be synthesized, mapping from + // language (https://cloud.google.com/dialogflow/docs/reference/language) to // SynthesizeSpeechConfig. - map synthesize_speech_configs = 4 [(google.api.field_behavior) = OPTIONAL]; + map synthesize_speech_configs = 4 + [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [Environments.ListEnvironments][google.cloud.dialogflow.v2beta1.Environments.ListEnvironments]. +// The request message for +// [Environments.ListEnvironments][google.cloud.dialogflow.v2beta1.Environments.ListEnvironments]. message ListEnvironmentsRequest { // Required. The agent to list all environments from. // Format: @@ -235,15 +244,16 @@ message ListEnvironmentsRequest { } ]; - // Optional. The maximum number of items to return in a single page. By default 100 and - // at most 1000. + // Optional. The maximum number of items 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 [Environments.ListEnvironments][google.cloud.dialogflow.v2beta1.Environments.ListEnvironments]. +// The response message for +// [Environments.ListEnvironments][google.cloud.dialogflow.v2beta1.Environments.ListEnvironments]. message ListEnvironmentsResponse { // The list of agent environments. There will be a maximum number of items // returned based on the page_size field in the request. @@ -254,7 +264,8 @@ message ListEnvironmentsResponse { string next_page_token = 2; } -// The request message for [Environments.GetEnvironment][google.cloud.dialogflow.v2beta1.Environments.GetEnvironment]. +// The request message for +// [Environments.GetEnvironment][google.cloud.dialogflow.v2beta1.Environments.GetEnvironment]. message GetEnvironmentRequest { // Required. The name of the environment. // Supported formats: @@ -269,7 +280,8 @@ message GetEnvironmentRequest { ]; } -// The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.v2beta1.Environments.CreateEnvironment]. +// The request message for +// [Environments.CreateEnvironment][google.cloud.dialogflow.v2beta1.Environments.CreateEnvironment]. message CreateEnvironmentRequest { // Required. The agent to create an environment for. // Supported formats: @@ -289,22 +301,26 @@ message CreateEnvironmentRequest { string environment_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.v2beta1.Environments.UpdateEnvironment]. +// The request message for +// [Environments.UpdateEnvironment][google.cloud.dialogflow.v2beta1.Environments.UpdateEnvironment]. message UpdateEnvironmentRequest { // Required. The environment to update. Environment environment = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The mask to control which fields get updated. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; // Optional. This field is used to prevent accidental overwrite of the draft // environment, which is an operation that cannot be undone. To confirm that // the caller desires this overwrite, this field must be explicitly set to // true when updating the draft environment (environment ID = `-`). - bool allow_load_to_draft_and_discard_changes = 3 [(google.api.field_behavior) = OPTIONAL]; + bool allow_load_to_draft_and_discard_changes = 3 + [(google.api.field_behavior) = OPTIONAL]; } -// The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.v2beta1.Environments.DeleteEnvironment]. +// The request message for +// [Environments.DeleteEnvironment][google.cloud.dialogflow.v2beta1.Environments.DeleteEnvironment]. message DeleteEnvironmentRequest { // Required. The name of the environment to delete. // / Format: @@ -319,7 +335,8 @@ message DeleteEnvironmentRequest { ]; } -// The request message for [Environments.GetEnvironmentHistory][google.cloud.dialogflow.v2beta1.Environments.GetEnvironmentHistory]. +// The request message for +// [Environments.GetEnvironmentHistory][google.cloud.dialogflow.v2beta1.Environments.GetEnvironmentHistory]. message GetEnvironmentHistoryRequest { // Required. The name of the environment to retrieve history for. // Supported formats: @@ -333,15 +350,16 @@ message GetEnvironmentHistoryRequest { } ]; - // Optional. The maximum number of items to return in a single page. By default 100 and - // at most 1000. + // Optional. The maximum number of items 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 [Environments.GetEnvironmentHistory][google.cloud.dialogflow.v2beta1.Environments.GetEnvironmentHistory]. +// The response message for +// [Environments.GetEnvironmentHistory][google.cloud.dialogflow.v2beta1.Environments.GetEnvironmentHistory]. message EnvironmentHistory { // Represents an environment history entry. message Entry { @@ -362,11 +380,11 @@ message EnvironmentHistory { // ID>/agent/environments/` string parent = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The list of agent environments. There will be a maximum number of items - // returned based on the page_size field in the request. + // Output only. The list of agent environments. There will be a maximum number + // of items returned based on the page_size field in the request. repeated Entry entries = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Token to retrieve the next page of results, or empty if there are no - // more results in the list. + // Output only. Token to retrieve the next page of results, or empty if there + // are no more results in the list. string next_page_token = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/fulfillment.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/fulfillment.proto index 8efe32af2f0..e537a2f0227 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/fulfillment.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/fulfillment.proto @@ -30,7 +30,8 @@ option java_outer_classname = "FulfillmentProto"; option java_package = "com.google.cloud.dialogflow.v2beta1"; option objc_class_prefix = "DF"; -// Service for managing [Fulfillments][google.cloud.dialogflow.v2beta1.Fulfillment]. +// Service for managing +// [Fulfillments][google.cloud.dialogflow.v2beta1.Fulfillment]. service Fulfillments { option (google.api.default_host) = "dialogflow.googleapis.com"; option (google.api.oauth_scopes) = @@ -101,15 +102,13 @@ message Fulfillment { // The HTTP request headers to send together with fulfillment requests. map request_headers = 4; - // Optional. Indicates if generic web service is created through Cloud Functions - // integration. Defaults to false. + // Optional. Indicates if generic web service is created through Cloud + // Functions integration. Defaults to false. // // is_cloud_function is deprecated. Cloud functions can be configured by // its uri as a regular web service now. - bool is_cloud_function = 5 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + bool is_cloud_function = 5 + [deprecated = true, (google.api.field_behavior) = OPTIONAL]; } // Whether fulfillment is enabled for the specific feature. @@ -154,7 +153,8 @@ message Fulfillment { repeated Feature features = 5; } -// The request message for [Fulfillments.GetFulfillment][google.cloud.dialogflow.v2beta1.Fulfillments.GetFulfillment]. +// The request message for +// [Fulfillments.GetFulfillment][google.cloud.dialogflow.v2beta1.Fulfillments.GetFulfillment]. message GetFulfillmentRequest { // Required. The name of the fulfillment. // Supported formats: @@ -169,12 +169,14 @@ message GetFulfillmentRequest { ]; } -// The request message for [Fulfillments.UpdateFulfillment][google.cloud.dialogflow.v2beta1.Fulfillments.UpdateFulfillment]. +// The request message for +// [Fulfillments.UpdateFulfillment][google.cloud.dialogflow.v2beta1.Fulfillments.UpdateFulfillment]. message UpdateFulfillmentRequest { // Required. The fulfillment to update. Fulfillment fulfillment = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The mask to control which fields get updated. If the mask is not // present, all fields will be updated. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/human_agent_assistant_event.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/human_agent_assistant_event.proto index 9716f74e5b0..7f8214eb5b4 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/human_agent_assistant_event.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/human_agent_assistant_event.proto @@ -34,12 +34,13 @@ message HumanAgentAssistantEvent { string conversation = 1; // The participant that the suggestion is compiled for. And This field is used - // to call [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] API. Format: - // `projects//conversations//conversations//participants/`. // It will not be set in legacy workflow. - // [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more - // information. + // [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] + // for more information. string participant = 3; // The suggestion results payload that this notification refers to. It will diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/intent.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/intent.proto index 99e9cafd762..6c6536f2049 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/intent.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/intent.proto @@ -132,12 +132,14 @@ service Intents { // // - `metadata`: An empty [Struct // message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - // - `response`: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse] + // - `response`: + // [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse] // // Note: You should always train an agent prior to sending it queries. See the // [training // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc BatchUpdateIntents(BatchUpdateIntentsRequest) returns (google.longrunning.Operation) { + rpc BatchUpdateIntents(BatchUpdateIntentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*/agent}/intents:batchUpdate" body: "*" @@ -168,7 +170,8 @@ service Intents { // Note: You should always train an agent prior to sending it queries. See the // [training // documentation](https://cloud.google.com/dialogflow/es/docs/training). - rpc BatchDeleteIntents(BatchDeleteIntentsRequest) returns (google.longrunning.Operation) { + rpc BatchDeleteIntents(BatchDeleteIntentsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*/agent}/intents:batchDelete" body: "*" @@ -271,7 +274,9 @@ message Intent { // so the training phrase is well formatted when the parts are concatenated. // // If the training phrase does not need to be annotated with parameters, - // you just need a single part with only the [Part.text][google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part.text] field set. + // you just need a single part with only the + // [Part.text][google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part.text] + // field set. // // If you want to annotate the training phrase, you must create multiple // parts, where the fields of each part are populated in one of two ways: @@ -620,7 +625,9 @@ message Intent { // with media and suggestions. // // If you want to show a single card with more control over the layout, - // please use [RbmStandaloneCard][google.cloud.dialogflow.v2beta1.Intent.Message.RbmStandaloneCard] instead. + // please use + // [RbmStandaloneCard][google.cloud.dialogflow.v2beta1.Intent.Message.RbmStandaloneCard] + // instead. message RbmCarouselCard { // The width of the cards in the carousel. enum CardWidth { @@ -647,8 +654,9 @@ message Intent { // Rich cards allow you to respond to users with more vivid content, e.g. // with media and suggestions. // - // You can group multiple rich cards into one using [RbmCarouselCard][google.cloud.dialogflow.v2beta1.Intent.Message.RbmCarouselCard] but - // carousel cards will give you less control over the card layout. + // You can group multiple rich cards into one using + // [RbmCarouselCard][google.cloud.dialogflow.v2beta1.Intent.Message.RbmCarouselCard] + // but carousel cards will give you less control over the card layout. message RbmStandaloneCard { // Orientation of the card. enum CardOrientation { @@ -811,9 +819,7 @@ message Intent { // Opens the device's location chooser so the user can pick a location // to send back to the agent. - message RbmSuggestedActionShareLocation { - - } + message RbmSuggestedActionShareLocation {} // Text to display alongside the action. string text = 1; @@ -980,7 +986,8 @@ message Intent { repeated BasicCard.Button buttons = 6; } - // Column properties for [TableCard][google.cloud.dialogflow.v2beta1.Intent.Message.TableCard]. + // Column properties for + // [TableCard][google.cloud.dialogflow.v2beta1.Intent.Message.TableCard]. message ColumnProperties { // Text alignments within a cell. enum HorizontalAlignment { @@ -1004,7 +1011,8 @@ message Intent { HorizontalAlignment horizontal_alignment = 2; } - // Row of [TableCard][google.cloud.dialogflow.v2beta1.Intent.Message.TableCard]. + // Row of + // [TableCard][google.cloud.dialogflow.v2beta1.Intent.Message.TableCard]. message TableCardRow { // Optional. List of cells that make up this row. repeated TableCardCell cells = 1; @@ -1013,7 +1021,8 @@ message Intent { bool divider_after = 2; } - // Cell of [TableCardRow][google.cloud.dialogflow.v2beta1.Intent.Message.TableCardRow]. + // Cell of + // [TableCardRow][google.cloud.dialogflow.v2beta1.Intent.Message.TableCardRow]. message TableCardCell { // Required. Text in this cell. string text = 1; @@ -1101,7 +1110,10 @@ message Intent { } // Optional. The unique identifier of this intent. - // Required for [Intents.UpdateIntent][google.cloud.dialogflow.v2beta1.Intents.UpdateIntent] and [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents] + // Required for + // [Intents.UpdateIntent][google.cloud.dialogflow.v2beta1.Intents.UpdateIntent] + // and + // [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents] // methods. // Supported formats: // @@ -1140,10 +1152,8 @@ message Intent { // ml_enabled = false / ml_disabled = true. // - After April 15th, 2018 the default is: // ml_enabled = true / ml_disabled = false. - bool ml_enabled = 5 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + bool ml_enabled = 5 + [deprecated = true, (google.api.field_behavior) = OPTIONAL]; // Optional. Indicates whether Machine Learning is disabled for the intent. // Note: If `ml_disabled` setting is set to true, then this intent is not @@ -1169,7 +1179,8 @@ message Intent { // - `projects//agent/sessions/-/contexts/` // - `projects//locations//agent/sessions/-/contexts/` - repeated string input_context_names = 7 [(google.api.field_behavior) = OPTIONAL]; + repeated string input_context_names = 7 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The collection of event names that trigger the intent. // If the collection of input contexts is not empty, all of the contexts must @@ -1179,7 +1190,8 @@ message Intent { // Optional. The collection of examples that the agent is // trained on. - repeated TrainingPhrase training_phrases = 9 [(google.api.field_behavior) = OPTIONAL]; + repeated TrainingPhrase training_phrases = 9 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The name of the action associated with the intent. // Note: The action name must not contain whitespaces. @@ -1190,7 +1202,8 @@ message Intent { // parameters field. Setting the `lifespan_count` to 0 will reset the context // when the intent is matched. // Format: `projects//agent/sessions/-/contexts/`. - repeated Context output_contexts = 11 [(google.api.field_behavior) = OPTIONAL]; + repeated Context output_contexts = 11 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Indicates whether to delete all contexts in the current // session when this intent is matched. @@ -1205,31 +1218,37 @@ message Intent { // Optional. The list of platforms for which the first responses will be // copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). - repeated Message.Platform default_response_platforms = 15 [(google.api.field_behavior) = OPTIONAL]; + repeated Message.Platform default_response_platforms = 15 + [(google.api.field_behavior) = OPTIONAL]; // Output only. The unique identifier of the root intent in the chain of // followup intents. It identifies the correct followup intents chain for // this intent. // // Format: `projects//agent/intents/`. - string root_followup_intent_name = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + string root_followup_intent_name = 16 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The unique identifier of the parent intent in the // chain of followup intents. You can set this field when creating an intent, - // for example with [CreateIntent][google.cloud.dialogflow.v2beta1.Intents.CreateIntent] or - // [BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents], in order to make this - // intent a followup intent. + // for example with + // [CreateIntent][google.cloud.dialogflow.v2beta1.Intents.CreateIntent] or + // [BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents], + // in order to make this intent a followup intent. // // It identifies the parent followup intent. // Format: `projects//agent/intents/`. - string parent_followup_intent_name = 17 [(google.api.field_behavior) = OPTIONAL]; + string parent_followup_intent_name = 17 + [(google.api.field_behavior) = OPTIONAL]; - // Output only. Information about all followup intents that have this intent as - // a direct or indirect parent. We populate this field only in the output. - repeated FollowupIntentInfo followup_intent_info = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Information about all followup intents that have this intent + // as a direct or indirect parent. We populate this field only in the output. + repeated FollowupIntentInfo followup_intent_info = 18 + [(google.api.field_behavior) = OUTPUT_ONLY]; } -// The request message for [Intents.ListIntents][google.cloud.dialogflow.v2beta1.Intents.ListIntents]. +// The request message for +// [Intents.ListIntents][google.cloud.dialogflow.v2beta1.Intents.ListIntents]. message ListIntentsRequest { // Required. The agent to list all intents from. // Format: `projects//agent` or `projects//locations/`. @@ -211,7 +215,8 @@ message ListKnowledgeBasesRequest { string filter = 4; } -// Response message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBases.ListKnowledgeBases]. +// Response message for +// [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBases.ListKnowledgeBases]. message ListKnowledgeBasesResponse { // The list of knowledge bases. repeated KnowledgeBase knowledge_bases = 1; @@ -221,7 +226,8 @@ message ListKnowledgeBasesResponse { string next_page_token = 2; } -// Request message for [KnowledgeBases.GetKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.GetKnowledgeBase]. +// Request message for +// [KnowledgeBases.GetKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.GetKnowledgeBase]. message GetKnowledgeBaseRequest { // Required. The name of the knowledge base to retrieve. // Format `projects//locations//locations/`. @@ -249,7 +256,8 @@ message CreateKnowledgeBaseRequest { KnowledgeBase knowledge_base = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [KnowledgeBases.DeleteKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.DeleteKnowledgeBase]. +// Request message for +// [KnowledgeBases.DeleteKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.DeleteKnowledgeBase]. message DeleteKnowledgeBaseRequest { // Required. The name of the knowledge base to delete. // Format: `projects//locations/ [first item's create_time of previous // request]` and empty page_token. - rpc ListSuggestions(ListSuggestionsRequest) returns (ListSuggestionsResponse) { + rpc ListSuggestions(ListSuggestionsRequest) + returns (ListSuggestionsResponse) { option deprecated = true; option (google.api.http) = { get: "/v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions" }; } - // Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead. + // Deprecated. use + // [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] + // and + // [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] + // instead. // // Gets suggestions for a participant based on specific historical // messages. // - // Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated - // suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion - // based on the provided conversation context in the real time. - rpc CompileSuggestion(CompileSuggestionRequest) returns (CompileSuggestionResponse) { + // Note that + // [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] + // will only list the auto-generated suggestions, while + // [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] + // will try to compile suggestion based on the provided conversation context + // in the real time. + rpc CompileSuggestion(CompileSuggestionRequest) + returns (CompileSuggestionResponse) { option deprecated = true; option (google.api.http) = { post: "/v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:compile" @@ -247,23 +264,27 @@ message Participant { // ID>/conversations//participants/`. string name = 1 [(google.api.field_behavior) = OPTIONAL]; - // Immutable. The role this participant plays in the conversation. This field must be set - // during participant creation and is then immutable. + // Immutable. The role this participant plays in the conversation. This field + // must be set during participant creation and is then immutable. Role role = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Optional. Obfuscated user id that should be associated with the created participant. + // Optional. Obfuscated user id that should be associated with the created + // participant. // // You can specify a user id as follows: // // 1. If you set this field in - // [CreateParticipantRequest][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant] or + // [CreateParticipantRequest][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant] + // or // [UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant], // Dialogflow adds the obfuscated user id with the participant. // // 2. If you set this field in - // [AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id] or + // [AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id] + // or // [StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id], - // Dialogflow will update [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.Participant.obfuscated_external_user_id]. + // Dialogflow will update + // [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.Participant.obfuscated_external_user_id]. // // Dialogflow uses this user id for following purposes: // 1) Billing and measurement. If user with the same @@ -279,14 +300,16 @@ message Participant { // * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a // hash function like SHA-512. // * The length of the user id must be <= 256 characters. - string obfuscated_external_user_id = 7 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Key-value filters on the metadata of documents returned by article - // suggestion. If specified, article suggestion only returns suggested - // documents that match all filters in their [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata]. Multiple - // values for a metadata key should be concatenated by comma. For example, - // filters to match all documents that have 'US' or 'CA' in their market - // metadata values and 'agent' in their user metadata values will be + string obfuscated_external_user_id = 7 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Key-value filters on the metadata of documents returned by + // article suggestion. If specified, article suggestion only returns suggested + // documents that match all filters in their + // [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata]. + // Multiple values for a metadata key should be concatenated by comma. For + // example, filters to match all documents that have 'US' or 'CA' in their + // market metadata values and 'agent' in their user metadata values will be // ``` // documents_metadata_filters { // key: "market" @@ -297,7 +320,8 @@ message Participant { // value: "agent" // } // ``` - map documents_metadata_filters = 8 [(google.api.field_behavior) = OPTIONAL]; + map documents_metadata_filters = 8 + [(google.api.field_behavior) = OPTIONAL]; } // Represents a message posted into a conversation. @@ -325,22 +349,28 @@ message Message { string participant = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The role of the participant. - Participant.Role participant_role = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + Participant.Role participant_role = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the message was created in Contact Center AI. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The time when the message was sent. - google.protobuf.Timestamp send_time = 9 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Timestamp send_time = 9 + [(google.api.field_behavior) = OPTIONAL]; // Output only. The annotation for the message. - MessageAnnotation message_annotation = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + MessageAnnotation message_annotation = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The sentiment analysis result for the message. - SentimentAnalysisResult sentiment_analysis = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + SentimentAnalysisResult sentiment_analysis = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; } -// The request message for [Participants.CreateParticipant][google.cloud.dialogflow.v2beta1.Participants.CreateParticipant]. +// The request message for +// [Participants.CreateParticipant][google.cloud.dialogflow.v2beta1.Participants.CreateParticipant]. message CreateParticipantRequest { // Required. Resource identifier of the conversation adding the participant. // Format: `projects//locations//locations//conversations//locations//locations/ // /agents//intents/`. string intent = 4 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Intent" - }]; + type: "dialogflow.googleapis.com/Intent" + }]; // Event name if an event is triggered for the query. string event = 5; @@ -531,10 +568,11 @@ message SuggestionFeature { message AssistQueryParameters { // Key-value filters on the metadata of documents returned by article // suggestion. If specified, article suggestion only returns suggested - // documents that match all filters in their [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata]. Multiple - // values for a metadata key should be concatenated by comma. For example, - // filters to match all documents that have 'US' or 'CA' in their market - // metadata values and 'agent' in their user metadata values will be + // documents that match all filters in their + // [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata]. + // Multiple values for a metadata key should be concatenated by comma. For + // example, filters to match all documents that have 'US' or 'CA' in their + // market metadata values and 'agent' in their user metadata values will be // ``` // documents_metadata_filters { // key: "market" @@ -548,7 +586,8 @@ message AssistQueryParameters { map documents_metadata_filters = 1; } -// The request message for [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent]. +// The request message for +// [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent]. message AnalyzeContentRequest { // Required. The name of the participant this text comes from. // Format: `projects//locations//locations//answerRecords/" string answer_record = 3 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/AnswerRecord" - }]; + type: "dialogflow.googleapis.com/AnswerRecord" + }]; } // One response of different type of suggestion response which is used in -// the response of [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] and -// [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent], as well as [HumanAgentAssistantEvent][google.cloud.dialogflow.v2beta1.HumanAgentAssistantEvent]. +// the response of +// [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] +// and +// [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent], +// as well as +// [HumanAgentAssistantEvent][google.cloud.dialogflow.v2beta1.HumanAgentAssistantEvent]. message SuggestionResult { // Different type of suggestion response. oneof suggestion_response { @@ -1009,7 +1070,8 @@ message SuggestionResult { } } -// The request message for [Participants.SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles]. +// The request message for +// [Participants.SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles]. message SuggestArticlesRequest { // Required. The name of the participant to fetch suggestion for. // Format: `projects//locations//locations//locations//locations//conversations//messages/`. string latest_message = 2 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - }]; + type: "dialogflow.googleapis.com/Message" + }]; // Optional. Max number of messages prior to and including // [latest_message] to use as context when compiling the @@ -1147,7 +1218,8 @@ message SuggestSmartRepliesRequest { int32 context_size = 3; } -// The response message for [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2beta1.Participants.SuggestSmartReplies]. +// The response message for +// [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2beta1.Participants.SuggestSmartReplies]. message SuggestSmartRepliesResponse { // Output only. Multiple reply options provided by smart reply service. The // order is based on the rank of the model prediction. @@ -1160,14 +1232,15 @@ message SuggestSmartRepliesResponse { // Format: `projects//locations//conversations//messages/`. string latest_message = 2 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Message" - }]; + type: "dialogflow.googleapis.com/Message" + }]; // Number of messages prior to and including - // [latest_message][google.cloud.dialogflow.v2beta1.SuggestSmartRepliesResponse.latest_message] to compile the - // suggestion. It may be smaller than the - // [SuggestSmartRepliesRequest.context_size][google.cloud.dialogflow.v2beta1.SuggestSmartRepliesRequest.context_size] field in the request if there - // aren't that many messages in the conversation. + // [latest_message][google.cloud.dialogflow.v2beta1.SuggestSmartRepliesResponse.latest_message] + // to compile the suggestion. It may be smaller than the + // [SuggestSmartRepliesRequest.context_size][google.cloud.dialogflow.v2beta1.SuggestSmartRepliesRequest.context_size] + // field in the request if there aren't that many messages in the + // conversation. int32 context_size = 3; } @@ -1247,7 +1320,8 @@ message Suggestion { string latest_message = 7; } -// The request message for [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]. +// The request message for +// [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]. message ListSuggestionsRequest { option deprecated = true; @@ -1274,7 +1348,8 @@ message ListSuggestionsRequest { string filter = 4; } -// The response message for [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]. +// The response message for +// [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]. message ListSuggestionsResponse { option deprecated = true; @@ -1288,7 +1363,8 @@ message ListSuggestionsResponse { string next_page_token = 2; } -// The request message for [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]. +// The request message for +// [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]. message CompileSuggestionRequest { option deprecated = true; @@ -1310,7 +1386,8 @@ message CompileSuggestionRequest { int32 context_size = 3; } -// The response message for [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]. +// The response message for +// [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]. message CompileSuggestionResponse { option deprecated = true; @@ -1327,8 +1404,9 @@ message CompileSuggestionResponse { // Number of messages prior to and including // [latest_message][google.cloud.dialogflow.v2beta1.CompileSuggestionResponse.latest_message] // to compile the suggestion. It may be smaller than the - // [CompileSuggestionRequest.context_size][google.cloud.dialogflow.v2beta1.CompileSuggestionRequest.context_size] field in the request if - // there aren't that many messages in the conversation. + // [CompileSuggestionRequest.context_size][google.cloud.dialogflow.v2beta1.CompileSuggestionRequest.context_size] + // field in the request if there aren't that many messages in the + // conversation. int32 context_size = 3; } @@ -1358,9 +1436,7 @@ message ResponseMessage { } // Indicates that interaction with the Dialogflow agent has ended. - message EndInteraction { - - } + message EndInteraction {} // Represents an audio message that is composed of both segments // synthesized from the Dialogflow agent prompts and ones hosted externally diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/session.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/session.proto index 4f45bce45bb..de6cde47d8b 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/session.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/session.proto @@ -105,8 +105,8 @@ service Sessions { // Note: Always use agent versions for production traffic. // See [Versions and // environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). - rpc StreamingDetectIntent(stream StreamingDetectIntentRequest) returns (stream StreamingDetectIntentResponse) { - } + rpc StreamingDetectIntent(stream StreamingDetectIntentRequest) + returns (stream StreamingDetectIntentResponse) {} } // The request to detect user's intent. @@ -159,12 +159,14 @@ message DetectIntentRequest { // configured, no output audio is generated. OutputAudioConfig output_audio_config = 4; - // Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config] indicating which settings in this - // request-level config should override speech synthesizer settings defined at - // agent-level. + // Mask for + // [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config] + // indicating which settings in this request-level config should override + // speech synthesizer settings defined at agent-level. // - // If unspecified or empty, [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config] replaces the agent-level - // config in its entirety. + // If unspecified or empty, + // [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config] + // replaces the agent-level config in its entirety. google.protobuf.FieldMask output_audio_config_mask = 7; // The natural language speech audio to be processed. This field @@ -438,8 +440,8 @@ message KnowledgeAnswers { // Format: `projects//knowledgeBases//documents/`. string source = 1 [(google.api.resource_reference) = { - type: "dialogflow.googleapis.com/Document" - }]; + type: "dialogflow.googleapis.com/Document" + }]; // The corresponding FAQ question if the answer was extracted from a FAQ // Document, empty otherwise. @@ -473,25 +475,29 @@ message KnowledgeAnswers { } // The top-level message sent by the client to the -// [Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent] method. +// [Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent] +// method. // // Multiple request messages should be sent in order: // // 1. The first message must contain // [session][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.session], -// [query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input] plus optionally -// [query_params][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_params]. If the client -// wants to receive an audio response, it should also contain +// [query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input] +// plus optionally +// [query_params][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_params]. +// If the client wants to receive an audio response, it should also contain // [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config]. // The message must not contain // [input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.input_audio]. -// 2. If [query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input] was set to -// [query_input.audio_config][google.cloud.dialogflow.v2beta1.InputAudioConfig], all subsequent -// messages must contain -// [input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.input_audio] to continue with -// Speech recognition. -// If you decide to rather detect an intent from text input after you -// already started Speech recognition, please send a message with +// 2. If +// [query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input] +// was set to +// [query_input.audio_config][google.cloud.dialogflow.v2beta1.InputAudioConfig], +// all subsequent messages must contain +// [input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.input_audio] +// to continue with Speech recognition. If you decide to rather detect an +// intent from text input after you already started Speech recognition, +// please send a message with // [query_input.text][google.cloud.dialogflow.v2beta1.QueryInput.text]. // // However, note that: @@ -547,15 +553,15 @@ message StreamingDetectIntentRequest { // 3. an event that specifies which intent to trigger. QueryInput query_input = 3 [(google.api.field_behavior) = REQUIRED]; - // DEPRECATED. Please use [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2beta1.InputAudioConfig.single_utterance] instead. - // If `false` (default), recognition does not cease until the - // client closes the stream. - // If `true`, the recognizer will detect a single spoken utterance in input - // audio. Recognition ceases when it detects the audio's voice has - // stopped or paused. In this case, once a detected intent is received, the - // client should close the stream and start a new request with a new stream as - // needed. - // This setting is ignored when `query_input` is a piece of text or an event. + // DEPRECATED. Please use + // [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2beta1.InputAudioConfig.single_utterance] + // instead. If `false` (default), recognition does not cease until the client + // closes the stream. If `true`, the recognizer will detect a single spoken + // utterance in input audio. Recognition ceases when it detects the audio's + // voice has stopped or paused. In this case, once a detected intent is + // received, the client should close the stream and start a new request with a + // new stream as needed. This setting is ignored when `query_input` is a piece + // of text or an event. bool single_utterance = 4 [deprecated = true]; // Instructs the speech synthesizer how to generate the output @@ -563,12 +569,14 @@ message StreamingDetectIntentRequest { // configured, no output audio is generated. OutputAudioConfig output_audio_config = 5; - // Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] indicating which settings in this - // request-level config should override speech synthesizer settings defined at - // agent-level. + // Mask for + // [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] + // indicating which settings in this request-level config should override + // speech synthesizer settings defined at agent-level. // - // If unspecified or empty, [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] replaces the agent-level - // config in its entirety. + // If unspecified or empty, + // [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] + // replaces the agent-level config in its entirety. google.protobuf.FieldMask output_audio_config_mask = 7; // The input audio content to be recognized. Must be sent if @@ -585,8 +593,9 @@ message StreamingDetectIntentRequest { // 1. If the `StreamingDetectIntentRequest.input_audio` field was // set, the `recognition_result` field is populated for one // or more messages. -// See the [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] message for details -// about the result message sequence. +// See the +// [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] +// message for details about the result message sequence. // // 2. The next message contains `response_id`, `query_result`, // `alternative_query_results` and optionally `webhook_status` if a WebHook @@ -736,7 +745,8 @@ message StreamingRecognitionResult { float stability = 6; // Word-specific information for the words recognized by Speech in - // [transcript][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.transcript]. Populated if and only if `message_type` = `TRANSCRIPT` and + // [transcript][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.transcript]. + // Populated if and only if `message_type` = `TRANSCRIPT` and // [InputAudioConfig.enable_word_info] is set. repeated SpeechWordInfo speech_word_info = 7; @@ -797,8 +807,8 @@ message EventInput { // the same session do not necessarily need to specify the same language. // // This field is ignored when used in the context of a - // [WebhookResponse.followup_event_input][google.cloud.dialogflow.v2beta1.WebhookResponse.followup_event_input] field, - // because the language was already defined in the originating detect + // [WebhookResponse.followup_event_input][google.cloud.dialogflow.v2beta1.WebhookResponse.followup_event_input] + // field, because the language was already defined in the originating detect // intent request. string language_code = 3; } @@ -815,11 +825,14 @@ message SentimentAnalysisRequestConfig { // and identifies the prevailing subjective opinion, especially to determine a // user's attitude as positive, negative, or neutral. // For [Participants.DetectIntent][], it needs to be configured in -// [DetectIntentRequest.query_params][google.cloud.dialogflow.v2beta1.DetectIntentRequest.query_params]. For -// [Participants.StreamingDetectIntent][], it needs to be configured in +// [DetectIntentRequest.query_params][google.cloud.dialogflow.v2beta1.DetectIntentRequest.query_params]. +// For [Participants.StreamingDetectIntent][], it needs to be configured in // [StreamingDetectIntentRequest.query_params][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_params]. -// And for [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] and -// [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent], it needs to be configured in +// And for +// [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent] +// and +// [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent], +// it needs to be configured in // [ConversationProfile.human_agent_assistant_config][google.cloud.dialogflow.v2beta1.ConversationProfile.human_agent_assistant_config] message SentimentAnalysisResult { // The sentiment analysis result for `query_text`. diff --git a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/session_entity_type.proto b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/session_entity_type.proto index 4b1c5873d26..3ff4fbd7725 100644 --- a/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/session_entity_type.proto +++ b/packages/google-cloud-dialogflow/protos/google/cloud/dialogflow/v2beta1/session_entity_type.proto @@ -32,7 +32,8 @@ option java_outer_classname = "SessionEntityTypeProto"; option java_package = "com.google.cloud.dialogflow.v2beta1"; option objc_class_prefix = "DF"; -// Service for managing [SessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityType]. +// Service for managing +// [SessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityType]. service SessionEntityTypes { option (google.api.default_host) = "dialogflow.googleapis.com"; option (google.api.oauth_scopes) = @@ -44,7 +45,8 @@ service SessionEntityTypes { // This method doesn't work with Google Assistant integration. // Contact Dialogflow support if you need to use session entities // with Google Assistant integration. - rpc ListSessionEntityTypes(ListSessionEntityTypesRequest) returns (ListSessionEntityTypesResponse) { + rpc ListSessionEntityTypes(ListSessionEntityTypesRequest) + returns (ListSessionEntityTypesResponse) { option (google.api.http) = { get: "/v2beta1/{parent=projects/*/agent/sessions/*}/entityTypes" additional_bindings { @@ -65,7 +67,8 @@ service SessionEntityTypes { // This method doesn't work with Google Assistant integration. // Contact Dialogflow support if you need to use session entities // with Google Assistant integration. - rpc GetSessionEntityType(GetSessionEntityTypeRequest) returns (SessionEntityType) { + rpc GetSessionEntityType(GetSessionEntityTypeRequest) + returns (SessionEntityType) { option (google.api.http) = { get: "/v2beta1/{name=projects/*/agent/sessions/*/entityTypes/*}" additional_bindings { @@ -89,7 +92,8 @@ service SessionEntityTypes { // This method doesn't work with Google Assistant integration. // Contact Dialogflow support if you need to use session entities // with Google Assistant integration. - rpc CreateSessionEntityType(CreateSessionEntityTypeRequest) returns (SessionEntityType) { + rpc CreateSessionEntityType(CreateSessionEntityTypeRequest) + returns (SessionEntityType) { option (google.api.http) = { post: "/v2beta1/{parent=projects/*/agent/sessions/*}/entityTypes" body: "session_entity_type" @@ -114,7 +118,8 @@ service SessionEntityTypes { // This method doesn't work with Google Assistant integration. // Contact Dialogflow support if you need to use session entities // with Google Assistant integration. - rpc UpdateSessionEntityType(UpdateSessionEntityTypeRequest) returns (SessionEntityType) { + rpc UpdateSessionEntityType(UpdateSessionEntityTypeRequest) + returns (SessionEntityType) { option (google.api.http) = { patch: "/v2beta1/{session_entity_type.name=projects/*/agent/sessions/*/entityTypes/*}" body: "session_entity_type" @@ -140,7 +145,8 @@ service SessionEntityTypes { // This method doesn't work with Google Assistant integration. // Contact Dialogflow support if you need to use session entities // with Google Assistant integration. - rpc DeleteSessionEntityType(DeleteSessionEntityTypeRequest) returns (google.protobuf.Empty) { + rpc DeleteSessionEntityType(DeleteSessionEntityTypeRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v2beta1/{name=projects/*/agent/sessions/*/entityTypes/*}" additional_bindings { @@ -190,8 +196,9 @@ message SessionEntityType { // `GetSessionEntityType`, `CreateSessionEntityType` and // `UpdateSessionEntityType` only return the additional entities added in // this session entity type. If you want to get the supplemented list, - // please call [EntityTypes.GetEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.GetEntityType] on the custom entity type - // and merge. + // please call + // [EntityTypes.GetEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.GetEntityType] + // on the custom entity type and merge. ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2; } @@ -223,7 +230,8 @@ message SessionEntityType { repeated EntityType.Entity entities = 3; } -// The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes]. +// The request message for +// [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes]. message ListSessionEntityTypesRequest { // Required. The session to list all session entity types from. // Supported formats: @@ -254,7 +262,8 @@ message ListSessionEntityTypesRequest { string page_token = 3; } -// The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes]. +// The response message for +// [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes]. message ListSessionEntityTypesResponse { // The list of session entity types. There will be a maximum number of items // returned based on the page_size field in the request. @@ -265,7 +274,8 @@ message ListSessionEntityTypesResponse { string next_page_token = 2; } -// The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.GetSessionEntityType]. +// The request message for +// [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.GetSessionEntityType]. message GetSessionEntityTypeRequest { // Required. The name of the session entity type. Supported formats: // - `projects//agent/sessions//entityTypes//agent/sessions/, * - `projects//locations//agent/sessions/`, diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/conversations.batch_create_messages.js b/packages/google-cloud-dialogflow/samples/generated/v2beta1/conversations.batch_create_messages.js index bb30b296467..09d24b388bd 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/conversations.batch_create_messages.js +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/conversations.batch_create_messages.js @@ -37,7 +37,8 @@ function main(parent, requests) { /** * Required. A maximum of 1000 Messages can be created in a batch. * CreateMessageRequest.message.send_time is required. All created - * messages will have identical Message.create_time google.cloud.dialogflow.v2beta1.Message.create_time. + * messages will have identical + * Message.create_time google.cloud.dialogflow.v2beta1.Message.create_time. */ // const requests = 1234 diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/conversations.create_conversation.js b/packages/google-cloud-dialogflow/samples/generated/v2beta1/conversations.create_conversation.js index 5a7ade8af1e..ec271930dcf 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/conversations.create_conversation.js +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/conversations.create_conversation.js @@ -38,8 +38,8 @@ function main(parent, conversation) { */ // const conversation = {} /** - * Optional. Identifier of the conversation. Generally it's auto generated by Google. - * Only set it if you cannot wait for the response to return a + * Optional. Identifier of the conversation. Generally it's auto generated by + * Google. Only set it if you cannot wait for the response to return a * auto-generated one to you. * The conversation ID must be compliant with the regression fomula * "a-zA-Z a-zA-Z0-9_-*" with the characters length in range of 3,64. diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/environments.get_environment_history.js b/packages/google-cloud-dialogflow/samples/generated/v2beta1/environments.get_environment_history.js index 54a87c2bb72..4ce90a8c51b 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/environments.get_environment_history.js +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/environments.get_environment_history.js @@ -37,8 +37,8 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. */ // const pageSize = 1234 /** diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/environments.list_environments.js b/packages/google-cloud-dialogflow/samples/generated/v2beta1/environments.list_environments.js index a3e1843ba33..3986571c5ae 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/environments.list_environments.js +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/environments.list_environments.js @@ -36,8 +36,8 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. */ // const pageSize = 1234 /** diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/participants.suggest_articles.js b/packages/google-cloud-dialogflow/samples/generated/v2beta1/participants.suggest_articles.js index be08470e75f..b7000549af1 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/participants.suggest_articles.js +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/participants.suggest_articles.js @@ -43,8 +43,9 @@ function main(parent) { // const latestMessage = 'abc123' /** * Optional. Max number of messages prior to and including - * latest_message google.cloud.dialogflow.v2beta1.SuggestArticlesRequest.latest_message to use as context - * when compiling the suggestion. By default 20 and at most 50. + * latest_message google.cloud.dialogflow.v2beta1.SuggestArticlesRequest.latest_message + * to use as context when compiling the suggestion. By default 20 and at + * most 50. */ // const contextSize = 1234 /** diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/sessions.detect_intent.js b/packages/google-cloud-dialogflow/samples/generated/v2beta1/sessions.detect_intent.js index 0e0c6932600..902730ec5d4 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/sessions.detect_intent.js +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/sessions.detect_intent.js @@ -71,11 +71,13 @@ function main(session, queryInput) { */ // const outputAudioConfig = {} /** - * Mask for output_audio_config google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config indicating which settings in this - * request-level config should override speech synthesizer settings defined at - * agent-level. - * If unspecified or empty, output_audio_config google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config replaces the agent-level - * config in its entirety. + * Mask for + * output_audio_config google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config + * indicating which settings in this request-level config should override + * speech synthesizer settings defined at agent-level. + * If unspecified or empty, + * output_audio_config google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config + * replaces the agent-level config in its entirety. */ // const outputAudioConfigMask = {} /** diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/sessions.streaming_detect_intent.js b/packages/google-cloud-dialogflow/samples/generated/v2beta1/sessions.streaming_detect_intent.js index f9f37a4e364..567bba7487e 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/sessions.streaming_detect_intent.js +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/sessions.streaming_detect_intent.js @@ -65,15 +65,15 @@ function main(session, queryInput) { */ // const queryInput = {} /** - * DEPRECATED. Please use InputAudioConfig.single_utterance google.cloud.dialogflow.v2beta1.InputAudioConfig.single_utterance instead. - * If `false` (default), recognition does not cease until the - * client closes the stream. - * If `true`, the recognizer will detect a single spoken utterance in input - * audio. Recognition ceases when it detects the audio's voice has - * stopped or paused. In this case, once a detected intent is received, the - * client should close the stream and start a new request with a new stream as - * needed. - * This setting is ignored when `query_input` is a piece of text or an event. + * DEPRECATED. Please use + * InputAudioConfig.single_utterance google.cloud.dialogflow.v2beta1.InputAudioConfig.single_utterance + * instead. If `false` (default), recognition does not cease until the client + * closes the stream. If `true`, the recognizer will detect a single spoken + * utterance in input audio. Recognition ceases when it detects the audio's + * voice has stopped or paused. In this case, once a detected intent is + * received, the client should close the stream and start a new request with a + * new stream as needed. This setting is ignored when `query_input` is a piece + * of text or an event. */ // const singleUtterance = true /** @@ -83,11 +83,13 @@ function main(session, queryInput) { */ // const outputAudioConfig = {} /** - * Mask for output_audio_config google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config indicating which settings in this - * request-level config should override speech synthesizer settings defined at - * agent-level. - * If unspecified or empty, output_audio_config google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config replaces the agent-level - * config in its entirety. + * Mask for + * output_audio_config google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config + * indicating which settings in this request-level config should override + * speech synthesizer settings defined at agent-level. + * If unspecified or empty, + * output_audio_config google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config + * replaces the agent-level config in its entirety. */ // const outputAudioConfigMask = {} /** diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/snippet_metadata.google.cloud.dialogflow.v2beta1.json b/packages/google-cloud-dialogflow/samples/generated/v2beta1/snippet_metadata.google.cloud.dialogflow.v2beta1.json index e838a072773..235bdc5a6e5 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/snippet_metadata.google.cloud.dialogflow.v2beta1.json +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/snippet_metadata.google.cloud.dialogflow.v2beta1.json @@ -770,7 +770,7 @@ "segments": [ { "start": 25, - "end": 64, + "end": 65, "type": "FULL" } ], @@ -1302,7 +1302,7 @@ "segments": [ { "start": 25, - "end": 62, + "end": 63, "type": "FULL" } ], @@ -3522,7 +3522,7 @@ "segments": [ { "start": 25, - "end": 72, + "end": 73, "type": "FULL" } ], @@ -3994,7 +3994,7 @@ "segments": [ { "start": 25, - "end": 106, + "end": 108, "type": "FULL" } ], @@ -4054,7 +4054,7 @@ "segments": [ { "start": 25, - "end": 122, + "end": 124, "type": "FULL" } ], diff --git a/packages/google-cloud-dialogflow/samples/generated/v2beta1/versions.list_versions.js b/packages/google-cloud-dialogflow/samples/generated/v2beta1/versions.list_versions.js index d461fb30d2c..488fb79f290 100644 --- a/packages/google-cloud-dialogflow/samples/generated/v2beta1/versions.list_versions.js +++ b/packages/google-cloud-dialogflow/samples/generated/v2beta1/versions.list_versions.js @@ -36,8 +36,8 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. */ // const pageSize = 1234 /** diff --git a/packages/google-cloud-dialogflow/src/v2beta1/agents_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/agents_client.ts index 5ab62628769..fc8f42fefb6 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/agents_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/agents_client.ts @@ -1115,7 +1115,8 @@ export class AgentsClient { * * - `metadata`: An empty [Struct * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - * - `response`: {@link google.cloud.dialogflow.v2beta1.ExportAgentResponse|ExportAgentResponse} + * - `response`: + * {@link google.cloud.dialogflow.v2beta1.ExportAgentResponse|ExportAgentResponse} * * @param {Object} request * The request object that will be sent. @@ -1271,11 +1272,13 @@ export class AgentsClient { * * Uploads new intents and entity types without deleting the existing ones. * Intents and entity types with the same name are replaced with the new - * versions from {@link google.cloud.dialogflow.v2beta1.ImportAgentRequest|ImportAgentRequest}. After the import, the imported draft - * agent will be trained automatically (unless disabled in agent settings). - * However, once the import is done, training may not be completed yet. Please - * call {@link google.cloud.dialogflow.v2beta1.Agents.TrainAgent|TrainAgent} and wait for the operation it returns in order to train - * explicitly. + * versions from + * {@link google.cloud.dialogflow.v2beta1.ImportAgentRequest|ImportAgentRequest}. + * After the import, the imported draft agent will be trained automatically + * (unless disabled in agent settings). However, once the import is done, + * training may not be completed yet. Please call + * {@link google.cloud.dialogflow.v2beta1.Agents.TrainAgent|TrainAgent} and wait + * for the operation it returns in order to train explicitly. * * This method is a [long-running * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). @@ -1445,8 +1448,9 @@ export class AgentsClient { * entity types in the older version are deleted. After the restore, the * restored draft agent will be trained automatically (unless disabled in * agent settings). However, once the restore is done, training may not be - * completed yet. Please call {@link google.cloud.dialogflow.v2beta1.Agents.TrainAgent|TrainAgent} and wait for the operation it - * returns in order to train explicitly. + * completed yet. Please call + * {@link google.cloud.dialogflow.v2beta1.Agents.TrainAgent|TrainAgent} and wait + * for the operation it returns in order to train explicitly. * * This method is a [long-running * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). diff --git a/packages/google-cloud-dialogflow/src/v2beta1/answer_records_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/answer_records_client.ts index 4fac06276dc..12c479d03b3 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/answer_records_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/answer_records_client.ts @@ -40,7 +40,8 @@ import * as gapicConfig from './answer_records_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.AnswerRecord|AnswerRecords}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.AnswerRecord|AnswerRecords}. * @class * @memberof v2beta1 */ diff --git a/packages/google-cloud-dialogflow/src/v2beta1/contexts_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/contexts_client.ts index 5fd34e8e7c8..67e193731c5 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/contexts_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/contexts_client.ts @@ -879,7 +879,8 @@ export class ContextsClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The name of the session to delete all contexts from. Supported formats: + * Required. The name of the session to delete all contexts from. Supported + * formats: * - `projects//agent/sessions/, * - `projects//locations//agent/sessions/`, diff --git a/packages/google-cloud-dialogflow/src/v2beta1/conversation_profiles_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/conversation_profiles_client.ts index 7ff4309f9c3..2121a293f77 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/conversation_profiles_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/conversation_profiles_client.ts @@ -42,7 +42,8 @@ import * as gapicConfig from './conversation_profiles_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfiles}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfiles}. * @class * @memberof v2beta1 */ @@ -662,7 +663,8 @@ export class ConversationProfilesClient { * * {@link |ConversationProfile.CreateTime} and {@link |ConversationProfile.UpdateTime} * aren't populated in the response. You can retrieve them via - * {@link google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile|GetConversationProfile} API. + * {@link google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile|GetConversationProfile} + * API. * * @param {Object} request * The request object that will be sent. @@ -770,7 +772,8 @@ export class ConversationProfilesClient { * * {@link |ConversationProfile.CreateTime} and {@link |ConversationProfile.UpdateTime} * aren't populated in the response. You can retrieve them via - * {@link google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile|GetConversationProfile} API. + * {@link google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile|GetConversationProfile} + * API. * * @param {Object} request * The request object that will be sent. @@ -986,8 +989,10 @@ export class ConversationProfilesClient { * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). * The returned `Operation` type has the following method-specific fields: * - * - `metadata`: {@link google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata|SetSuggestionFeatureConfigOperationMetadata} - * - `response`: {@link google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile} + * - `metadata`: + * {@link google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata|SetSuggestionFeatureConfigOperationMetadata} + * - `response`: + * {@link google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile} * * If a long running operation to add or update suggestion feature * config for the same conversation profile, participant role and suggestion @@ -1148,8 +1153,10 @@ export class ConversationProfilesClient { * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). * The returned `Operation` type has the following method-specific fields: * - * - `metadata`: {@link google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata|ClearSuggestionFeatureConfigOperationMetadata} - * - `response`: {@link google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile} + * - `metadata`: + * {@link google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata|ClearSuggestionFeatureConfigOperationMetadata} + * - `response`: + * {@link google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile} * * @param {Object} request * The request object that will be sent. diff --git a/packages/google-cloud-dialogflow/src/v2beta1/conversations_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/conversations_client.ts index 8795e512fb8..662f9bd3820 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/conversations_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/conversations_client.ts @@ -40,7 +40,8 @@ import * as gapicConfig from './conversations_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.Conversation|Conversations}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.Conversation|Conversations}. * @class * @memberof v2beta1 */ @@ -482,11 +483,14 @@ export class ConversationsClient { * For Assist Stage, there's no dialogflow agent responding to user queries. * But we will provide suggestions which are generated from conversation. * - * If {@link google.cloud.dialogflow.v2beta1.Conversation.conversation_profile|Conversation.conversation_profile} is configured for a dialogflow - * agent, conversation will start from `Automated Agent Stage`, otherwise, it - * will start from `Assist Stage`. And during `Automated Agent Stage`, once an - * {@link google.cloud.dialogflow.v2beta1.Intent|Intent} with {@link google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff|Intent.live_agent_handoff} is triggered, conversation - * will transfer to Assist Stage. + * If + * {@link google.cloud.dialogflow.v2beta1.Conversation.conversation_profile|Conversation.conversation_profile} + * is configured for a dialogflow agent, conversation will start from + * `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And + * during `Automated Agent Stage`, once an + * {@link google.cloud.dialogflow.v2beta1.Intent|Intent} with + * {@link google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff|Intent.live_agent_handoff} + * is triggered, conversation will transfer to Assist Stage. * * @param {Object} request * The request object that will be sent. @@ -496,8 +500,8 @@ export class ConversationsClient { * @param {google.cloud.dialogflow.v2beta1.Conversation} request.conversation * Required. The conversation to create. * @param {string} [request.conversationId] - * Optional. Identifier of the conversation. Generally it's auto generated by Google. - * Only set it if you cannot wait for the response to return a + * Optional. Identifier of the conversation. Generally it's auto generated by + * Google. Only set it if you cannot wait for the response to return a * auto-generated one to you. * * The conversation ID must be compliant with the regression fomula @@ -808,7 +812,8 @@ export class ConversationsClient { * @param {number[]} request.requests * Required. A maximum of 1000 Messages can be created in a batch. * {@link |CreateMessageRequest.message.send_time} is required. All created - * messages will have identical {@link google.cloud.dialogflow.v2beta1.Message.create_time|Message.create_time}. + * messages will have identical + * {@link google.cloud.dialogflow.v2beta1.Message.create_time|Message.create_time}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. diff --git a/packages/google-cloud-dialogflow/src/v2beta1/documents_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/documents_client.ts index be05182a99b..97ee09903fe 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/documents_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/documents_client.ts @@ -42,7 +42,8 @@ import * as gapicConfig from './documents_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing knowledge {@link google.cloud.dialogflow.v2beta1.Document|Documents}. + * Service for managing knowledge + * {@link google.cloud.dialogflow.v2beta1.Document|Documents}. * @class * @memberof v2beta1 */ @@ -679,7 +680,8 @@ export class DocumentsClient { * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). * The returned `Operation` type has the following method-specific fields: * - * - `metadata`: {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} + * - `metadata`: + * {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} * - `response`: {@link google.cloud.dialogflow.v2beta1.Document|Document} * * Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; @@ -836,8 +838,10 @@ export class DocumentsClient { * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). * The returned `Operation` type has the following method-specific fields: * - * - `metadata`: {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} - * - `response`: {@link google.cloud.dialogflow.v2beta1.ImportDocumentsResponse|ImportDocumentsResponse} + * - `metadata`: + * {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} + * - `response`: + * {@link google.cloud.dialogflow.v2beta1.ImportDocumentsResponse|ImportDocumentsResponse} * * @param {Object} request * The request object that will be sent. @@ -995,7 +999,8 @@ export class DocumentsClient { * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). * The returned `Operation` type has the following method-specific fields: * - * - `metadata`: {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} + * - `metadata`: + * {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} * - `response`: An [Empty * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) * @@ -1146,7 +1151,8 @@ export class DocumentsClient { * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). * The returned `Operation` type has the following method-specific fields: * - * - `metadata`: {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} + * - `metadata`: + * {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} * - `response`: {@link google.cloud.dialogflow.v2beta1.Document|Document} * * Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; @@ -1304,7 +1310,8 @@ export class DocumentsClient { * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). * The returned `Operation` type has the following method-specific fields: * - * - `metadata`: {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} + * - `metadata`: + * {@link google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata|KnowledgeOperationMetadata} * - `response`: {@link google.cloud.dialogflow.v2beta1.Document|Document} * * Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; diff --git a/packages/google-cloud-dialogflow/src/v2beta1/entity_types_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/entity_types_client.ts index 9ad9b37c6c7..41ebe28858d 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/entity_types_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/entity_types_client.ts @@ -42,7 +42,8 @@ import * as gapicConfig from './entity_types_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.EntityType|EntityTypes}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.EntityType|EntityTypes}. * @class * @memberof v2beta1 */ @@ -1023,7 +1024,8 @@ export class EntityTypesClient { * * - `metadata`: An empty [Struct * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - * - `response`: {@link google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse|BatchUpdateEntityTypesResponse} + * - `response`: + * {@link google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse|BatchUpdateEntityTypesResponse} * * Note: You should always train an agent prior to sending it queries. See the * [training diff --git a/packages/google-cloud-dialogflow/src/v2beta1/environments_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/environments_client.ts index 3e0b6083921..a51d218dae6 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/environments_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/environments_client.ts @@ -40,7 +40,8 @@ import * as gapicConfig from './environments_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.Environment|Environments}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.Environment|Environments}. * @class * @memberof v2beta1 */ @@ -894,8 +895,8 @@ export class EnvironmentsClient { * - `projects//agent` * - `projects//locations//agent` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] @@ -996,8 +997,8 @@ export class EnvironmentsClient { * - `projects//agent` * - `projects//locations//agent` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] @@ -1046,8 +1047,8 @@ export class EnvironmentsClient { * - `projects//agent` * - `projects//locations//agent` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] @@ -1096,8 +1097,8 @@ export class EnvironmentsClient { * - `projects//locations//agent/environments/` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] @@ -1199,8 +1200,8 @@ export class EnvironmentsClient { * - `projects//locations//agent/environments/` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] @@ -1250,8 +1251,8 @@ export class EnvironmentsClient { * - `projects//locations//agent/environments/` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] diff --git a/packages/google-cloud-dialogflow/src/v2beta1/fulfillments_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/fulfillments_client.ts index 706508d2c96..c9732aeb393 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/fulfillments_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/fulfillments_client.ts @@ -38,7 +38,8 @@ import * as gapicConfig from './fulfillments_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.Fulfillment|Fulfillments}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.Fulfillment|Fulfillments}. * @class * @memberof v2beta1 */ diff --git a/packages/google-cloud-dialogflow/src/v2beta1/intents_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/intents_client.ts index 3e359a8befa..72697eda2c8 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/intents_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/intents_client.ts @@ -970,7 +970,8 @@ export class IntentsClient { * * - `metadata`: An empty [Struct * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - * - `response`: {@link google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse|BatchUpdateIntentsResponse} + * - `response`: + * {@link google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse|BatchUpdateIntentsResponse} * * Note: You should always train an agent prior to sending it queries. See the * [training diff --git a/packages/google-cloud-dialogflow/src/v2beta1/knowledge_bases_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/knowledge_bases_client.ts index 34bc4858b68..a52eedbd2ea 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/knowledge_bases_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/knowledge_bases_client.ts @@ -40,7 +40,8 @@ import * as gapicConfig from './knowledge_bases_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.KnowledgeBase|KnowledgeBases}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.KnowledgeBase|KnowledgeBases}. * @class * @memberof v2beta1 */ diff --git a/packages/google-cloud-dialogflow/src/v2beta1/participants_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/participants_client.ts index cd769101e74..d05049b6810 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/participants_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/participants_client.ts @@ -40,7 +40,8 @@ import * as gapicConfig from './participants_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.Participant|Participants}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.Participant|Participants}. * @class * @memberof v2beta1 */ @@ -948,9 +949,12 @@ export class ParticipantsClient { * Gets suggested articles for a participant based on specific historical * messages. * - * Note that {@link google.cloud.dialogflow.v2beta1.Participants.ListSuggestions|ListSuggestions} will only list the auto-generated - * suggestions, while {@link google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion|CompileSuggestion} will try to compile suggestion - * based on the provided conversation context in the real time. + * Note that + * {@link google.cloud.dialogflow.v2beta1.Participants.ListSuggestions|ListSuggestions} + * will only list the auto-generated suggestions, while + * {@link google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion|CompileSuggestion} + * will try to compile suggestion based on the provided conversation context + * in the real time. * * @param {Object} request * The request object that will be sent. @@ -966,8 +970,9 @@ export class ParticipantsClient { * ID>/conversations//messages/`. * @param {number} [request.contextSize] * Optional. Max number of messages prior to and including - * {@link google.cloud.dialogflow.v2beta1.SuggestArticlesRequest.latest_message|latest_message} to use as context - * when compiling the suggestion. By default 20 and at most 50. + * {@link google.cloud.dialogflow.v2beta1.SuggestArticlesRequest.latest_message|latest_message} + * to use as context when compiling the suggestion. By default 20 and at + * most 50. * @param {google.cloud.dialogflow.v2beta1.AssistQueryParameters} [request.assistQueryParams] * Optional. Parameters for a human assist query. * @param {object} [options] @@ -1287,14 +1292,21 @@ export class ParticipantsClient { return this.innerApiCalls.suggestSmartReplies(request, options, callback); } /** - * Deprecated. use {@link google.cloud.dialogflow.v2beta1.Participants.SuggestArticles|SuggestArticles} and {@link google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers|SuggestFaqAnswers} instead. + * Deprecated. use + * {@link google.cloud.dialogflow.v2beta1.Participants.SuggestArticles|SuggestArticles} + * and + * {@link google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers|SuggestFaqAnswers} + * instead. * * Gets suggestions for a participant based on specific historical * messages. * - * Note that {@link google.cloud.dialogflow.v2beta1.Participants.ListSuggestions|ListSuggestions} will only list the auto-generated - * suggestions, while {@link google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion|CompileSuggestion} will try to compile suggestion - * based on the provided conversation context in the real time. + * Note that + * {@link google.cloud.dialogflow.v2beta1.Participants.ListSuggestions|ListSuggestions} + * will only list the auto-generated suggestions, while + * {@link google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion|CompileSuggestion} + * will try to compile suggestion based on the provided conversation context + * in the real time. * * @param {Object} request * The request object that will be sent. @@ -1644,9 +1656,9 @@ export class ParticipantsClient { /** * Deprecated: Use inline suggestion, event based suggestion or * Suggestion* API instead. - * See {@link google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name|HumanAgentAssistantConfig.name} for more - * details. - * Removal Date: 2020-09-01. + * See + * {@link google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name|HumanAgentAssistantConfig.name} + * for more details. Removal Date: 2020-09-01. * * Retrieves suggestions for live agents. * diff --git a/packages/google-cloud-dialogflow/src/v2beta1/session_entity_types_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/session_entity_types_client.ts index 7337fbc876c..f8305c20c11 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/session_entity_types_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/session_entity_types_client.ts @@ -40,7 +40,8 @@ import * as gapicConfig from './session_entity_types_client_config.json'; const version = require('../../../package.json').version; /** - * Service for managing {@link google.cloud.dialogflow.v2beta1.SessionEntityType|SessionEntityTypes}. + * Service for managing + * {@link google.cloud.dialogflow.v2beta1.SessionEntityType|SessionEntityTypes}. * @class * @memberof v2beta1 */ diff --git a/packages/google-cloud-dialogflow/src/v2beta1/sessions_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/sessions_client.ts index 03ea086ba10..b1730dba9d3 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/sessions_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/sessions_client.ts @@ -536,12 +536,14 @@ export class SessionsClient { * audio. If this field is not set and agent-level speech synthesizer is not * configured, no output audio is generated. * @param {google.protobuf.FieldMask} request.outputAudioConfigMask - * Mask for {@link google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config|output_audio_config} indicating which settings in this - * request-level config should override speech synthesizer settings defined at - * agent-level. - * - * If unspecified or empty, {@link google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config|output_audio_config} replaces the agent-level - * config in its entirety. + * Mask for + * {@link google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config|output_audio_config} + * indicating which settings in this request-level config should override + * speech synthesizer settings defined at agent-level. + * + * If unspecified or empty, + * {@link google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config|output_audio_config} + * replaces the agent-level config in its entirety. * @param {Buffer} request.inputAudio * The natural language speech audio to be processed. This field * should be populated iff `query_input` is set to an input audio config. diff --git a/packages/google-cloud-dialogflow/src/v2beta1/versions_client.ts b/packages/google-cloud-dialogflow/src/v2beta1/versions_client.ts index 44cf0e27f5d..b216c98b78f 100644 --- a/packages/google-cloud-dialogflow/src/v2beta1/versions_client.ts +++ b/packages/google-cloud-dialogflow/src/v2beta1/versions_client.ts @@ -862,8 +862,8 @@ export class VersionsClient { * - `projects//agent` * - `projects//locations//agent` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] @@ -964,8 +964,8 @@ export class VersionsClient { * - `projects//agent` * - `projects//locations//agent` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options] @@ -1014,8 +1014,8 @@ export class VersionsClient { * - `projects//agent` * - `projects//locations//agent` * @param {number} [request.pageSize] - * Optional. The maximum number of items to return in a single page. By default 100 and - * at most 1000. + * Optional. The maximum number of items to return in a single page. By + * default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @param {object} [options]