444 lines
17 KiB
Protocol Buffer
444 lines
17 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.v2beta1;
|
|
|
|
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/v2beta1/gcs.proto";
|
|
import "google/longrunning/operations.proto";
|
|
import "google/protobuf/empty.proto";
|
|
import "google/protobuf/field_mask.proto";
|
|
import "google/protobuf/timestamp.proto";
|
|
import "google/rpc/status.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 = "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 Documents {
|
|
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 documents of the knowledge base.
|
|
//
|
|
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
|
// only use `projects.knowledgeBases.documents`.
|
|
rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse) {
|
|
option (google.api.http) = {
|
|
get: "/v2beta1/{parent=projects/*/knowledgeBases/*}/documents"
|
|
additional_bindings {
|
|
get: "/v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documents"
|
|
}
|
|
additional_bindings {
|
|
get: "/v2beta1/{parent=projects/*/agent/knowledgeBases/*}/documents"
|
|
}
|
|
};
|
|
option (google.api.method_signature) = "parent";
|
|
}
|
|
|
|
// Retrieves the specified document.
|
|
//
|
|
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
|
// only use `projects.knowledgeBases.documents`.
|
|
rpc GetDocument(GetDocumentRequest) returns (Document) {
|
|
option (google.api.http) = {
|
|
get: "/v2beta1/{name=projects/*/knowledgeBases/*/documents/*}"
|
|
additional_bindings {
|
|
get: "/v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}"
|
|
}
|
|
additional_bindings {
|
|
get: "/v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}"
|
|
}
|
|
};
|
|
option (google.api.method_signature) = "name";
|
|
}
|
|
|
|
// Creates a new document.
|
|
//
|
|
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
|
// only use `projects.knowledgeBases.documents`.
|
|
rpc CreateDocument(CreateDocumentRequest) returns (google.longrunning.Operation) {
|
|
option (google.api.http) = {
|
|
post: "/v2beta1/{parent=projects/*/knowledgeBases/*}/documents"
|
|
body: "document"
|
|
additional_bindings {
|
|
post: "/v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documents"
|
|
body: "document"
|
|
}
|
|
additional_bindings {
|
|
post: "/v2beta1/{parent=projects/*/agent/knowledgeBases/*}/documents"
|
|
body: "document"
|
|
}
|
|
};
|
|
option (google.api.method_signature) = "parent,document";
|
|
option (google.longrunning.operation_info) = {
|
|
response_type: "Document"
|
|
metadata_type: "KnowledgeOperationMetadata"
|
|
};
|
|
}
|
|
|
|
// Deletes the specified document.
|
|
//
|
|
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
|
// only use `projects.knowledgeBases.documents`.
|
|
rpc DeleteDocument(DeleteDocumentRequest) returns (google.longrunning.Operation) {
|
|
option (google.api.http) = {
|
|
delete: "/v2beta1/{name=projects/*/knowledgeBases/*/documents/*}"
|
|
additional_bindings {
|
|
delete: "/v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}"
|
|
}
|
|
additional_bindings {
|
|
delete: "/v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}"
|
|
}
|
|
};
|
|
option (google.api.method_signature) = "name";
|
|
option (google.longrunning.operation_info) = {
|
|
response_type: "google.protobuf.Empty"
|
|
metadata_type: "KnowledgeOperationMetadata"
|
|
};
|
|
}
|
|
|
|
// Updates the specified document.
|
|
//
|
|
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
|
// only use `projects.knowledgeBases.documents`.
|
|
rpc UpdateDocument(UpdateDocumentRequest) returns (google.longrunning.Operation) {
|
|
option (google.api.http) = {
|
|
patch: "/v2beta1/{document.name=projects/*/knowledgeBases/*/documents/*}"
|
|
body: "document"
|
|
additional_bindings {
|
|
patch: "/v2beta1/{document.name=projects/*/locations/*/knowledgeBases/*/documents/*}"
|
|
body: "document"
|
|
}
|
|
additional_bindings {
|
|
patch: "/v2beta1/{document.name=projects/*/agent/knowledgeBases/*/documents/*}"
|
|
body: "document"
|
|
}
|
|
};
|
|
option (google.api.method_signature) = "document,update_mask";
|
|
option (google.api.method_signature) = "document";
|
|
option (google.longrunning.operation_info) = {
|
|
response_type: "Document"
|
|
metadata_type: "KnowledgeOperationMetadata"
|
|
};
|
|
}
|
|
|
|
// Reloads the specified document from its specified source, content_uri or
|
|
// content. The previously loaded content of the document will be deleted.
|
|
// Note: Even when the content of the document has not changed, there still
|
|
// may be side effects because of internal implementation changes.
|
|
// Note: If the document source is Google Cloud Storage URI, its metadata will
|
|
// be replaced with the custom metadata from Google Cloud Storage if the
|
|
// `import_gcs_custom_metadata` field is set to true in the request.
|
|
//
|
|
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
|
// only use `projects.knowledgeBases.documents`.
|
|
rpc ReloadDocument(ReloadDocumentRequest) returns (google.longrunning.Operation) {
|
|
option (google.api.http) = {
|
|
post: "/v2beta1/{name=projects/*/knowledgeBases/*/documents/*}:reload"
|
|
body: "*"
|
|
additional_bindings {
|
|
post: "/v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}:reload"
|
|
body: "*"
|
|
}
|
|
additional_bindings {
|
|
post: "/v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}:reload"
|
|
body: "*"
|
|
}
|
|
};
|
|
option (google.api.method_signature) = "name,gcs_source";
|
|
option (google.longrunning.operation_info) = {
|
|
response_type: "Document"
|
|
metadata_type: "KnowledgeOperationMetadata"
|
|
};
|
|
}
|
|
}
|
|
|
|
// 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).
|
|
//
|
|
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
|
|
// only use `projects.knowledgeBases.documents`.
|
|
message Document {
|
|
option (google.api.resource) = {
|
|
type: "dialogflow.googleapis.com/Document"
|
|
pattern: "projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}"
|
|
pattern: "projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}"
|
|
};
|
|
|
|
// The status of a reload attempt.
|
|
message ReloadStatus {
|
|
// Output only. The time of a reload attempt.
|
|
// This reload may have been triggered automatically or manually and may
|
|
// not have succeeded.
|
|
google.protobuf.Timestamp time = 1;
|
|
|
|
// Output only. The status of a reload attempt or the initial load.
|
|
google.rpc.Status status = 2;
|
|
}
|
|
|
|
// The knowledge type of document content.
|
|
enum KnowledgeType {
|
|
// The type is unspecified or arbitrary.
|
|
KNOWLEDGE_TYPE_UNSPECIFIED = 0;
|
|
|
|
// The document content contains question and answer pairs as either HTML or
|
|
// CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats
|
|
// may fail to be parsed.
|
|
//
|
|
// CSV must have questions in the first column and answers in the second,
|
|
// with no header. Because of this explicit format, they are always parsed
|
|
// accurately.
|
|
FAQ = 1;
|
|
|
|
// Documents for which unstructured text is extracted and used for
|
|
// question answering.
|
|
EXTRACTIVE_QA = 2;
|
|
}
|
|
|
|
// Optional. The document resource name.
|
|
// The name must be empty when creating a document.
|
|
// Format: `projects/<Project ID>/locations/<Location
|
|
// ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
|
|
string name = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
|
|
// Required. The display name of the document. The name must be 1024 bytes or
|
|
// less; otherwise, the creation request fails.
|
|
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
|
|
|
|
// Required. The MIME type of this 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];
|
|
|
|
// The source of this document.
|
|
oneof source {
|
|
// The URI where the file content is located.
|
|
//
|
|
// For documents stored in Google Cloud Storage, these URIs must have
|
|
// the form `gs://<bucket-name>/<object-name>`.
|
|
//
|
|
// NOTE: External URLs must correspond to public webpages, i.e., they must
|
|
// be indexed by Google Search. In particular, URLs for showing documents in
|
|
// Google Cloud Storage (i.e. the URL in your browser) are not supported.
|
|
// Instead use the `gs://` format URI described above.
|
|
string content_uri = 5;
|
|
|
|
// The raw content of the document. This field is only permitted for
|
|
// EXTRACTIVE_QA and FAQ knowledge types.
|
|
// Note: This field is in the process of being deprecated, please use
|
|
// raw_content instead.
|
|
string content = 6 [deprecated = true];
|
|
|
|
// The raw content of the document. This field is only permitted for
|
|
// EXTRACTIVE_QA and FAQ knowledge types.
|
|
bytes raw_content = 9;
|
|
}
|
|
|
|
// Optional. If true, we try to automatically reload the document every day
|
|
// (at a time picked by the system). If false or unspecified, we don't try
|
|
// to automatically reload the document.
|
|
//
|
|
// Currently you can only enable automatic reload for documents sourced from
|
|
// a public url, see `source` field for the source types.
|
|
//
|
|
// Reload status can be tracked in `latest_reload_status`. If a reload
|
|
// fails, we will keep the document unchanged.
|
|
//
|
|
// If a reload fails with internal errors, the system will try to reload the
|
|
// document on the next day.
|
|
// If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
|
|
// system will not try to reload the document anymore. You need to manually
|
|
// reload the document successfully by calling `ReloadDocument` and clear the
|
|
// errors.
|
|
bool enable_auto_reload = 11 [(google.api.field_behavior) = OPTIONAL];
|
|
|
|
// 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];
|
|
}
|
|
|
|
// Request message for [Documents.GetDocument][google.cloud.dialogflow.v2beta1.Documents.GetDocument].
|
|
message GetDocumentRequest {
|
|
// Required. The name of the document to retrieve.
|
|
// Format `projects/<Project ID>/locations/<Location
|
|
// ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/Document"
|
|
}
|
|
];
|
|
}
|
|
|
|
// Request message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments].
|
|
message ListDocumentsRequest {
|
|
// Required. The knowledge base to list all documents for.
|
|
// Format: `projects/<Project ID>/locations/<Location
|
|
// ID>/knowledgeBases/<Knowledge Base ID>`.
|
|
string parent = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
child_type: "dialogflow.googleapis.com/Document"
|
|
}
|
|
];
|
|
|
|
// The maximum number of items to return in a single page. By
|
|
// default 10 and at most 100.
|
|
int32 page_size = 2;
|
|
|
|
// The next_page_token value returned from a previous list request.
|
|
string page_token = 3;
|
|
|
|
// The filter expression used to filter documents returned by the list method.
|
|
// The expression has the following syntax:
|
|
//
|
|
// <field> <operator> <value> [AND <field> <operator> <value>] ...
|
|
//
|
|
// The following fields and operators are supported:
|
|
//
|
|
// * knowledge_types with has(:) operator
|
|
// * display_name with has(:) operator
|
|
// * state with equals(=) operator
|
|
//
|
|
// Examples:
|
|
//
|
|
// * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
|
|
// * "display_name:customer" matches documents whose display name contains
|
|
// "customer".
|
|
// * "state=ACTIVE" matches documents with ACTIVE state.
|
|
// * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
|
|
//
|
|
// For more information about filtering, see
|
|
// [API Filtering](https://aip.dev/160).
|
|
string filter = 4;
|
|
}
|
|
|
|
// Response message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments].
|
|
message ListDocumentsResponse {
|
|
// The list of documents.
|
|
repeated Document documents = 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;
|
|
}
|
|
|
|
// Request message for [Documents.CreateDocument][google.cloud.dialogflow.v2beta1.Documents.CreateDocument].
|
|
message CreateDocumentRequest {
|
|
// Required. The knowledge base to create a document for.
|
|
// Format: `projects/<Project ID>/locations/<Location
|
|
// ID>/knowledgeBases/<Knowledge Base ID>`.
|
|
string parent = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
child_type: "dialogflow.googleapis.com/Document"
|
|
}
|
|
];
|
|
|
|
// Required. The document to create.
|
|
Document document = 2 [(google.api.field_behavior) = REQUIRED];
|
|
|
|
// Whether to import custom metadata from Google Cloud Storage.
|
|
// Only valid when the document source is Google Cloud Storage URI.
|
|
bool import_gcs_custom_metadata = 3;
|
|
}
|
|
|
|
// Request message for [Documents.DeleteDocument][google.cloud.dialogflow.v2beta1.Documents.DeleteDocument].
|
|
message DeleteDocumentRequest {
|
|
// Required. The name of the document to delete.
|
|
// Format: `projects/<Project ID>/locations/<Location
|
|
// ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/Document"
|
|
}
|
|
];
|
|
}
|
|
|
|
// Request message for [Documents.UpdateDocument][google.cloud.dialogflow.v2beta1.Documents.UpdateDocument].
|
|
message UpdateDocumentRequest {
|
|
// Required. The document to update.
|
|
Document document = 1 [(google.api.field_behavior) = REQUIRED];
|
|
|
|
// Optional. Not specified means `update all`.
|
|
// Currently, only `display_name` can be updated, an InvalidArgument will be
|
|
// returned for attempting to update other fields.
|
|
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
}
|
|
|
|
// Metadata in google::longrunning::Operation for Knowledge operations.
|
|
message KnowledgeOperationMetadata {
|
|
// States of the operation.
|
|
enum State {
|
|
// State unspecified.
|
|
STATE_UNSPECIFIED = 0;
|
|
|
|
// The operation has been created.
|
|
PENDING = 1;
|
|
|
|
// The operation is currently running.
|
|
RUNNING = 2;
|
|
|
|
// The operation is done, either cancelled or completed.
|
|
DONE = 3;
|
|
}
|
|
|
|
// Required. Output only. The current state of this operation.
|
|
State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
}
|
|
|
|
// Request message for [Documents.ReloadDocument][google.cloud.dialogflow.v2beta1.Documents.ReloadDocument].
|
|
message ReloadDocumentRequest {
|
|
// Required. The name of the document to reload.
|
|
// Format: `projects/<Project ID>/locations/<Location
|
|
// ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.resource_reference) = {
|
|
type: "dialogflow.googleapis.com/Document"
|
|
}
|
|
];
|
|
|
|
// The source for document reloading.
|
|
// Optional. If provided, the service will load the contents from the source
|
|
// and update document in the knowledge base.
|
|
oneof source {
|
|
// The path for a Cloud Storage source file for reloading document content.
|
|
// If not provided, the Document's existing source will be reloaded.
|
|
GcsSource gcs_source = 3;
|
|
}
|
|
|
|
// Whether to import custom metadata from Google Cloud Storage.
|
|
// Only valid when the document source is Google Cloud Storage URI.
|
|
bool import_gcs_custom_metadata = 4;
|
|
}
|