Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

feat!: move to v3 API surface #35

Merged
merged 6 commits into from
Nov 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,26 @@

syntax = "proto3";

package google.cloud.dialogflow.cx.v3beta1;
package google.cloud.dialogflow.cx.v3;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/dialogflow/cx/v3beta1/flow.proto";
import "google/cloud/dialogflow/cx/v3/flow.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";

option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3beta1;cx";
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3;cx";
option java_multiple_files = true;
option java_outer_classname = "AgentProto";
option java_package = "com.google.cloud.dialogflow.cx.v3beta1";
option java_package = "com.google.cloud.dialogflow.cx.v3";
option objc_class_prefix = "DF";

// Service for managing [Agents][google.cloud.dialogflow.cx.v3beta1.Agent].
// Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].
service Agents {
option (google.api.default_host) = "dialogflow.googleapis.com";
option (google.api.oauth_scopes) =
Expand All @@ -43,23 +43,23 @@ service Agents {
// Returns the list of all agents in the specified location.
rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) {
option (google.api.http) = {
get: "/v3beta1/{parent=projects/*/locations/*}/agents"
get: "/v3/{parent=projects/*/locations/*}/agents"
};
option (google.api.method_signature) = "parent";
}

// Retrieves the specified agent.
rpc GetAgent(GetAgentRequest) returns (Agent) {
option (google.api.http) = {
get: "/v3beta1/{name=projects/*/locations/*/agents/*}"
get: "/v3/{name=projects/*/locations/*/agents/*}"
};
option (google.api.method_signature) = "name";
}

// Creates an agent in the specified location.
rpc CreateAgent(CreateAgentRequest) returns (Agent) {
option (google.api.http) = {
post: "/v3beta1/{parent=projects/*/locations/*}/agents"
post: "/v3/{parent=projects/*/locations/*}/agents"
body: "agent"
};
option (google.api.method_signature) = "parent,agent";
Expand All @@ -68,7 +68,7 @@ service Agents {
// Updates the specified agent.
rpc UpdateAgent(UpdateAgentRequest) returns (Agent) {
option (google.api.http) = {
patch: "/v3beta1/{agent.name=projects/*/locations/*/agents/*}"
patch: "/v3/{agent.name=projects/*/locations/*/agents/*}"
body: "agent"
};
option (google.api.method_signature) = "agent,update_mask";
Expand All @@ -77,15 +77,15 @@ service Agents {
// Deletes the specified agent.
rpc DeleteAgent(DeleteAgentRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v3beta1/{name=projects/*/locations/*/agents/*}"
delete: "/v3/{name=projects/*/locations/*/agents/*}"
};
option (google.api.method_signature) = "name";
}

// Exports the specified agent to a binary file.
rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v3beta1/{name=projects/*/locations/*/agents/*}:export"
post: "/v3/{name=projects/*/locations/*/agents/*}:export"
body: "*"
};
option (google.longrunning.operation_info) = {
Expand All @@ -100,7 +100,7 @@ service Agents {
// in agent (e.g. intents, entity types, flows) will be removed.
rpc RestoreAgent(RestoreAgentRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v3beta1/{name=projects/*/locations/*/agents/*}:restore"
post: "/v3/{name=projects/*/locations/*/agents/*}:restore"
body: "*"
};
option (google.longrunning.operation_info) = {
Expand All @@ -121,17 +121,17 @@ message SpeechToTextSettings {
// in your app, product, or service to determine user intent and respond to the
// user in a natural way.
//
// After you create an agent, you can add [Intents][google.cloud.dialogflow.cx.v3beta1.Intent],
// [Entity Types][google.cloud.dialogflow.cx.v3beta1.EntityType], [Flows][google.cloud.dialogflow.cx.v3beta1.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3beta1.Fulfillment],
// [Webhooks][google.cloud.dialogflow.cx.v3beta1.Webhook], and so on to manage the conversation flows..
// After you create an agent, you can add [Intents][google.cloud.dialogflow.cx.v3.Intent],
// [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment],
// [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
message Agent {
option (google.api.resource) = {
type: "dialogflow.googleapis.com/Agent"
pattern: "projects/{project}/locations/{location}/agents/{agent}"
};

// The unique identifier of the agent.
// Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.CreateAgent]
// Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
// populates the name automatically.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
string name = 1;
Expand All @@ -143,7 +143,7 @@ message Agent {
// See [Language
// Support](https://cloud.google.com/dialogflow/docs/reference/language)
// for a list of the currently supported language codes.
// This field cannot be set by the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.UpdateAgent] method.
// This field cannot be set by the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method.
string default_language_code = 3 [(google.api.field_behavior) = IMMUTABLE];

// Required. The time zone of the agent from the [time zone
Expand Down Expand Up @@ -184,7 +184,7 @@ message Agent {
bool enable_spell_correction = 20;
}

// The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3beta1.Agents.ListAgents].
// The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
message ListAgentsRequest {
// Required. The location to list all agents for.
// Format: `projects/<Project ID>/locations/<Location ID>`.
Expand All @@ -203,7 +203,7 @@ message ListAgentsRequest {
string page_token = 3;
}

// The response message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3beta1.Agents.ListAgents].
// The response message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
message ListAgentsResponse {
// The list of agents. There will be a maximum number of items returned based
// on the page_size field in the request.
Expand All @@ -214,7 +214,7 @@ message ListAgentsResponse {
string next_page_token = 2;
}

// The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3beta1.Agents.GetAgent].
// The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].
message GetAgentRequest {
// Required. The name of the agent.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
Expand All @@ -226,7 +226,7 @@ message GetAgentRequest {
];
}

// The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.CreateAgent].
// The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].
message CreateAgentRequest {
// Required. The location to create a agent for.
// Format: `projects/<Project ID>/locations/<Location ID>`.
Expand All @@ -241,7 +241,7 @@ message CreateAgentRequest {
Agent agent = 2 [(google.api.field_behavior) = REQUIRED];
}

// The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.UpdateAgent].
// The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].
message UpdateAgentRequest {
// Required. The agent to update.
Agent agent = 1 [(google.api.field_behavior) = REQUIRED];
Expand All @@ -251,7 +251,7 @@ message UpdateAgentRequest {
google.protobuf.FieldMask update_mask = 2;
}

// The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3beta1.Agents.DeleteAgent].
// The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].
message DeleteAgentRequest {
// Required. The name of the agent to delete.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
Expand All @@ -263,7 +263,7 @@ message DeleteAgentRequest {
];
}

// The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3beta1.Agents.ExportAgent].
// The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].
message ExportAgentRequest {
// Required. The name of the agent to export.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
Expand All @@ -281,20 +281,20 @@ message ExportAgentRequest {
string agent_uri = 2 [(google.api.field_behavior) = OPTIONAL];
}

// The response message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3beta1.Agents.ExportAgent].
// The response message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].
message ExportAgentResponse {
// The exported agent.
oneof agent {
// The URI to a file containing the exported agent. This field is populated
// only if `agent_uri` is specified in [ExportAgentRequest][google.cloud.dialogflow.cx.v3beta1.ExportAgentRequest].
// only if `agent_uri` is specified in [ExportAgentRequest][google.cloud.dialogflow.cx.v3.ExportAgentRequest].
string agent_uri = 1;

// Uncompressed raw byte content for agent.
bytes agent_content = 2;
}
}

// The request message for [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3beta1.Agents.RestoreAgent].
// The request message for [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3.Agents.RestoreAgent].
message RestoreAgentRequest {
// Required. The name of the agent to restore into.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@

syntax = "proto3";

package google.cloud.dialogflow.cx.v3beta1;
package google.cloud.dialogflow.cx.v3;

import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/api/annotations.proto";

option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3beta1;cx";
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3;cx";
option java_multiple_files = true;
option java_outer_classname = "AudioConfigProto";
option java_package = "com.google.cloud.dialogflow.cx.v3beta1";
option java_package = "com.google.cloud.dialogflow.cx.v3";
option objc_class_prefix = "DF";

// Information for a word recognized by the speech recognizer.
Expand Down Expand Up @@ -115,8 +115,8 @@ message InputAudioConfig {
// more details.
int32 sample_rate_hertz = 2;

// Optional. If `true`, Dialogflow returns [SpeechWordInfo][google.cloud.dialogflow.cx.v3beta1.SpeechWordInfo] in
// [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult] with information about the recognized speech
// Optional. If `true`, Dialogflow returns [SpeechWordInfo][google.cloud.dialogflow.cx.v3.SpeechWordInfo] in
// [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult] with information about the recognized speech
// words, e.g. start and end time offsets. If false or unspecified, Speech
// doesn't return any word-level information.
bool enable_word_info = 13;
Expand All @@ -142,7 +142,7 @@ message InputAudioConfig {
// for more details.
string model = 7;

// Optional. Which variant of the [Speech model][google.cloud.dialogflow.cx.v3beta1.InputAudioConfig.model] to use.
// Optional. Which variant of the [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
SpeechModelVariant model_variant = 10;

// Optional. If `false` (default), recognition does not cease until the
Expand All @@ -156,7 +156,7 @@ message InputAudioConfig {
bool single_utterance = 8;
}

// Variant of the specified [Speech model][google.cloud.dialogflow.cx.v3beta1.InputAudioConfig.model] to use.
// Variant of the specified [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
//
// See the [Cloud Speech
// documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models)
Expand Down Expand Up @@ -185,7 +185,7 @@ enum SpeechModelVariant {
// Use an enhanced model variant:
//
// * If an enhanced variant does not exist for the given
// [model][google.cloud.dialogflow.cx.v3beta1.InputAudioConfig.model] and request language, Dialogflow falls
// [model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] and request language, Dialogflow falls
// back to the standard variant.
//
// The [Cloud Speech
Expand All @@ -203,12 +203,12 @@ enum SpeechModelVariant {
message VoiceSelectionParams {
// Optional. The name of the voice. If not set, the service will choose a
// voice based on the other parameters such as language_code and
// [ssml_gender][google.cloud.dialogflow.cx.v3beta1.VoiceSelectionParams.ssml_gender].
// [ssml_gender][google.cloud.dialogflow.cx.v3.VoiceSelectionParams.ssml_gender].
string name = 1;

// Optional. The preferred gender of the voice. If not set, the service will
// choose a voice based on the other parameters such as language_code and
// [name][google.cloud.dialogflow.cx.v3beta1.VoiceSelectionParams.name]. Note that this is only a preference, not requirement. If a
// [name][google.cloud.dialogflow.cx.v3.VoiceSelectionParams.name]. Note that this is only a preference, not requirement. If a
// voice of the appropriate gender is not available, the synthesizer should
// substitute a voice with a different gender rather than failing the request.
SsmlVoiceGender ssml_gender = 2;
Expand Down
Loading