176 lines
7.2 KiB
Protocol Buffer
176 lines
7.2 KiB
Protocol Buffer
// Copyright 2018 Google Inc.
|
|
//
|
|
// 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.v2beta1;
|
|
|
|
import "google/api/annotations.proto";
|
|
import "google/protobuf/empty.proto";
|
|
import "google/protobuf/field_mask.proto";
|
|
import "google/protobuf/struct.proto";
|
|
|
|
option cc_enable_arenas = true;
|
|
option csharp_namespace = "Google.Cloud.Dialogflow.V2beta1";
|
|
option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow";
|
|
option java_multiple_files = true;
|
|
option java_outer_classname = "ContextProto";
|
|
option java_package = "com.google.cloud.dialogflow.v2beta1";
|
|
option objc_class_prefix = "DF";
|
|
|
|
|
|
// Manages contexts.
|
|
//
|
|
//
|
|
// Refer to the [Dialogflow documentation](https://dialogflow.com/docs/contexts)
|
|
// for more details about contexts.
|
|
// #
|
|
service Contexts {
|
|
// Returns the list of all contexts in the specified session.
|
|
rpc ListContexts(ListContextsRequest) returns (ListContextsResponse) {
|
|
option (google.api.http) = { get: "/v2beta1/{parent=projects/*/agent/sessions/*}/contexts" };
|
|
}
|
|
|
|
// Retrieves the specified context.
|
|
rpc GetContext(GetContextRequest) returns (Context) {
|
|
option (google.api.http) = { get: "/v2beta1/{name=projects/*/agent/sessions/*/contexts/*}" };
|
|
}
|
|
|
|
// Creates a context.
|
|
rpc CreateContext(CreateContextRequest) returns (Context) {
|
|
option (google.api.http) = { post: "/v2beta1/{parent=projects/*/agent/sessions/*}/contexts" body: "context" };
|
|
}
|
|
|
|
// Updates the specified context.
|
|
rpc UpdateContext(UpdateContextRequest) returns (Context) {
|
|
option (google.api.http) = { patch: "/v2beta1/{context.name=projects/*/agent/sessions/*/contexts/*}" body: "context" };
|
|
}
|
|
|
|
// Deletes the specified context.
|
|
rpc DeleteContext(DeleteContextRequest) returns (google.protobuf.Empty) {
|
|
option (google.api.http) = { delete: "/v2beta1/{name=projects/*/agent/sessions/*/contexts/*}" };
|
|
}
|
|
|
|
// Deletes all active contexts in the specified session.
|
|
rpc DeleteAllContexts(DeleteAllContextsRequest) returns (google.protobuf.Empty) {
|
|
option (google.api.http) = { delete: "/v2beta1/{parent=projects/*/agent/sessions/*}/contexts" };
|
|
}
|
|
}
|
|
|
|
// Represents a context.
|
|
message Context {
|
|
// Required. The unique identifier of the context. Format:
|
|
// `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
|
|
// or
|
|
// `projects/<Project ID>/agent/runtimes/<Runtime ID>/sessions/<Session
|
|
// ID>/contexts/<Context ID>`.
|
|
// Note: Runtimes are under construction and will be available soon.
|
|
// The Context ID is always converted to lowercase.
|
|
// If <Runtime ID> is not specified, we assume default 'sandbox' runtime.
|
|
string name = 1;
|
|
|
|
// Optional. The number of conversational query requests after which the
|
|
// context expires. If set to `0` (the default) the context expires
|
|
// immediately. Contexts expire automatically after 10 minutes even if there
|
|
// are no matching queries.
|
|
int32 lifespan_count = 2;
|
|
|
|
// Optional. The collection of parameters associated with this context.
|
|
// Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for
|
|
// syntax.
|
|
google.protobuf.Struct parameters = 3;
|
|
}
|
|
|
|
// The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].
|
|
message ListContextsRequest {
|
|
// Required. The session to list all contexts from.
|
|
// Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
|
|
// `projects/<Project ID>/agent/runtimes/<Runtime ID>/sessions/<Session ID>`.
|
|
// Note: Runtimes are under construction and will be available soon.
|
|
// If <Runtime ID> is not specified, we assume default 'sandbox' runtime.
|
|
string parent = 1;
|
|
|
|
// Optional. The maximum number of items to return in a single page. By
|
|
// default 100 and at most 1000.
|
|
int32 page_size = 2;
|
|
|
|
// Optional. The next_page_token value returned from a previous list request.
|
|
string page_token = 3;
|
|
}
|
|
|
|
// 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.
|
|
repeated Context contexts = 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 [Contexts.GetContext][google.cloud.dialogflow.v2beta1.Contexts.GetContext].
|
|
message GetContextRequest {
|
|
// Required. The name of the context. Format:
|
|
// `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
|
|
// or `projects/<Project ID>/agent/runtimes/<Runtime ID>/sessions/<Session
|
|
// ID>/contexts/<Context ID>`. Note: Runtimes are under construction and will
|
|
// be available soon. If <Runtime ID> is not specified, we assume default
|
|
// 'sandbox' runtime.
|
|
string name = 1;
|
|
}
|
|
|
|
// The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2beta1.Contexts.CreateContext].
|
|
message CreateContextRequest {
|
|
// Required. The session to create a context for.
|
|
// Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
|
|
// `projects/<Project ID>/agent/runtimes/<Runtime ID>/sessions/<Session ID>`.
|
|
// Note: Runtimes are under construction and will be available soon.
|
|
// If <Runtime ID> is not specified, we assume default 'sandbox' runtime.
|
|
string parent = 1;
|
|
|
|
// Required. The context to create.
|
|
Context context = 2;
|
|
}
|
|
|
|
// The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2beta1.Contexts.UpdateContext].
|
|
message UpdateContextRequest {
|
|
// Required. The context to update.
|
|
Context context = 1;
|
|
|
|
// Optional. The mask to control which fields get updated.
|
|
google.protobuf.FieldMask update_mask = 2;
|
|
}
|
|
|
|
// The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2beta1.Contexts.DeleteContext].
|
|
message DeleteContextRequest {
|
|
// Required. The name of the context to delete. Format:
|
|
// `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
|
|
// or `projects/<Project ID>/agent/runtimes/<Runtime ID>/sessions/<Session
|
|
// ID>/contexts/<Context ID>`. Note: Runtimes are under construction and will
|
|
// be available soon. If <Runtime ID> is not specified, we assume default
|
|
// 'sandbox' runtime.
|
|
string name = 1;
|
|
}
|
|
|
|
// The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2beta1.Contexts.DeleteAllContexts].
|
|
message DeleteAllContextsRequest {
|
|
// Required. The name of the session to delete all contexts from. Format:
|
|
// `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project
|
|
// ID>/agent/runtimes/<Runtime ID>/sessions/<Session ID>`. Note: Runtimes are
|
|
// under construction and will be available soon. If <Runtime ID> is not
|
|
// specified we assume default 'sandbox' runtime.
|
|
string parent = 1;
|
|
}
|