262 lines
10 KiB
Protocol Buffer
262 lines
10 KiB
Protocol Buffer
// Copyright 2020 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
syntax = "proto3";
|
|
|
|
package google.cloud.dialogflow.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/v3/flow.proto";
|
|
import "google/longrunning/operations.proto";
|
|
import "google/protobuf/empty.proto";
|
|
import "google/protobuf/field_mask.proto";
|
|
import "google/protobuf/timestamp.proto";
|
|
|
|
option cc_enable_arenas = true;
|
|
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 = "VersionProto";
|
|
option java_package = "com.google.cloud.dialogflow.cx.v3";
|
|
option objc_class_prefix = "DF";
|
|
|
|
// Service for managing [Versions][google.cloud.dialogflow.cx.v3.Version].
|
|
service Versions {
|
|
option (google.api.default_host) = "dialogflow.googleapis.com";
|
|
option (google.api.oauth_scopes) =
|
|
"https://www.googleapis.com/auth/cloud-platform,"
|
|
"https://www.googleapis.com/auth/dialogflow";
|
|
|
|
// Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
|
|
rpc ListVersions(ListVersionsRequest) returns (ListVersionsResponse) {
|
|
option (google.api.http) = {
|
|
get: "/v3/{parent=projects/*/locations/*/agents/*/flows/*}/versions"
|
|
};
|
|
option (google.api.method_signature) = "parent";
|
|
}
|
|
|
|
// Retrieves the specified [Version][google.cloud.dialogflow.cx.v3.Version].
|
|
rpc GetVersion(GetVersionRequest) returns (Version) {
|
|
option (google.api.http) = {
|
|
get: "/v3/{name=projects/*/locations/*/agents/*/flows/*/versions/*}"
|
|
};
|
|
option (google.api.method_signature) = "name";
|
|
}
|
|
|
|
// Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
|
|
rpc CreateVersion(CreateVersionRequest) returns (google.longrunning.Operation) {
|
|
option (google.api.http) = {
|
|
post: "/v3/{parent=projects/*/locations/*/agents/*/flows/*}/versions"
|
|
body: "version"
|
|
};
|
|
option (google.api.method_signature) = "parent,version";
|
|
option (google.longrunning.operation_info) = {
|
|
response_type: "Version"
|
|
metadata_type: "CreateVersionOperationMetadata"
|
|
};
|
|
}
|
|
|
|
// Updates the specified [Version][google.cloud.dialogflow.cx.v3.Version].
|
|
rpc UpdateVersion(UpdateVersionRequest) returns (Version) {
|
|
option (google.api.http) = {
|
|
patch: "/v3/{version.name=projects/*/locations/*/agents/*/flows/*/versions/*}"
|
|
body: "version"
|
|
};
|
|
option (google.api.method_signature) = "version,update_mask";
|
|
}
|
|
|
|
// Deletes the specified [Version][google.cloud.dialogflow.cx.v3.Version].
|
|
rpc DeleteVersion(DeleteVersionRequest) returns (google.protobuf.Empty) {
|
|
option (google.api.http) = {
|
|
delete: "/v3/{name=projects/*/locations/*/agents/*/flows/*/versions/*}"
|
|
};
|
|
option (google.api.method_signature) = "name";
|
|
}
|
|
|
|
// Loads a specified version to draft version.
|
|
rpc LoadVersion(LoadVersionRequest) returns (google.longrunning.Operation) {
|
|
option (google.api.http) = {
|
|
post: "/v3/{name=projects/*/locations/*/agents/*/flows/*/versions/*}:load"
|
|
body: "*"
|
|
};
|
|
option (google.api.method_signature) = "name";
|
|
option (google.longrunning.operation_info) = {
|
|
response_type: "google.protobuf.Empty"
|
|
metadata_type: "google.protobuf.Struct"
|
|
};
|
|
}
|
|
}
|
|
|
|
// Metadata associated with the long running operation for
|
|
// [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].
|
|
message CreateVersionOperationMetadata {
|
|
// Name of the created version.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>/versions/<Version ID>`.
|
|
string version = 1 [(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/Version"
|
|
}];
|
|
}
|
|
|
|
// Represents a version of a flow.
|
|
message Version {
|
|
option (google.api.resource) = {
|
|
type: "dialogflow.googleapis.com/Version"
|
|
pattern: "projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/versions/{version}"
|
|
};
|
|
|
|
// The state of the version.
|
|
enum State {
|
|
// Not specified. This value is not used.
|
|
STATE_UNSPECIFIED = 0;
|
|
|
|
// Version is not ready to serve (e.g. training is running).
|
|
RUNNING = 1;
|
|
|
|
// Training has succeeded and this version is ready to serve.
|
|
SUCCEEDED = 2;
|
|
|
|
// Version training failed.
|
|
FAILED = 3;
|
|
}
|
|
|
|
// Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>/versions/<Version ID>. Version ID is a self-increasing
|
|
// number generated by Dialogflow upon version creation.
|
|
string name = 1;
|
|
|
|
// Required. The human-readable name of the version. Limit of 64 characters.
|
|
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
|
|
|
|
// The description of the version. The maximum length is 500 characters. If
|
|
// exceeded, the request is rejected.
|
|
string description = 3;
|
|
|
|
// Output only. The NLU settings of the flow at version creation.
|
|
NluSettings nlu_settings = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
|
|
// Output only. Create time of the version.
|
|
google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
|
|
// Output only. The state of this version. This field is read-only and cannot be set by
|
|
// create and update methods.
|
|
State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
}
|
|
|
|
// The request message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
|
|
message ListVersionsRequest {
|
|
// Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>`.
|
|
string parent = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
child_type: "dialogflow.googleapis.com/Version"
|
|
}
|
|
];
|
|
|
|
// The maximum number of items to return in a single page. By default 20 and
|
|
// at most 100.
|
|
int32 page_size = 2;
|
|
|
|
// The next_page_token value returned from a previous list request.
|
|
string page_token = 3;
|
|
}
|
|
|
|
// The response message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
|
|
message ListVersionsResponse {
|
|
// A list of versions. There will be a maximum number of items returned based
|
|
// on the page_size field in the request. The list may in some cases be empty
|
|
// or contain fewer entries than page_size even if this isn't the last page.
|
|
repeated Version versions = 1;
|
|
|
|
// Token to retrieve the next page of results, or empty if there are no more
|
|
// results in the list.
|
|
string next_page_token = 2;
|
|
}
|
|
|
|
// The request message for [Versions.GetVersion][google.cloud.dialogflow.cx.v3.Versions.GetVersion].
|
|
message GetVersionRequest {
|
|
// Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version].
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>/versions/<Version ID>`.
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/Version"
|
|
}
|
|
];
|
|
}
|
|
|
|
// The request message for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].
|
|
message CreateVersionRequest {
|
|
// Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>`.
|
|
string parent = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
child_type: "dialogflow.googleapis.com/Version"
|
|
}
|
|
];
|
|
|
|
// Required. The version to create.
|
|
Version version = 2 [(google.api.field_behavior) = REQUIRED];
|
|
}
|
|
|
|
// The request message for [Versions.UpdateVersion][google.cloud.dialogflow.cx.v3.Versions.UpdateVersion].
|
|
message UpdateVersionRequest {
|
|
// Required. The version to update.
|
|
Version version = 1 [(google.api.field_behavior) = REQUIRED];
|
|
|
|
// Required. The mask to control which fields get updated. Currently only `description`
|
|
// and `display_name` can be updated.
|
|
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
|
|
}
|
|
|
|
// The request message for [Versions.DeleteVersion][google.cloud.dialogflow.cx.v3.Versions.DeleteVersion].
|
|
message DeleteVersionRequest {
|
|
// Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>/versions/<Version ID>`.
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/Version"
|
|
}
|
|
];
|
|
}
|
|
|
|
// The request message for [Versions.LoadVersion][google.cloud.dialogflow.cx.v3.Versions.LoadVersion].
|
|
message LoadVersionRequest {
|
|
// Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft version.
|
|
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
|
// ID>/flows/<Flow ID>/versions/<Version ID>`.
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/Version"
|
|
}
|
|
];
|
|
|
|
// This field is used to prevent accidental overwrite of other agent resources
|
|
// in the draft version, which can potentially impact other flow's behavior.
|
|
// If `allow_override_agent_resources` is false, conflicted agent-level
|
|
// resources will not be overridden (i.e. intents, entities, webhooks).
|
|
bool allow_override_agent_resources = 2;
|
|
}
|