mirror of
https://github.com/googleapis/googleapis.git
synced 2026-08-17 13:06:47 +02:00
95410d763c
feat: document schema id is no longer required docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 518297793
78 lines
3.3 KiB
Protocol Buffer
78 lines
3.3 KiB
Protocol Buffer
// Copyright 2022 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.discoveryengine.v1beta;
|
|
|
|
import "google/api/field_behavior.proto";
|
|
import "google/api/resource.proto";
|
|
import "google/protobuf/struct.proto";
|
|
|
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
|
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
|
option java_multiple_files = true;
|
|
option java_outer_classname = "DocumentProto";
|
|
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
|
option objc_class_prefix = "DISCOVERYENGINE";
|
|
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
|
|
option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
|
|
|
// Document captures all raw metadata information of items to be recommended or
|
|
// searched.
|
|
message Document {
|
|
option (google.api.resource) = {
|
|
type: "discoveryengine.googleapis.com/Document"
|
|
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}"
|
|
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}"
|
|
};
|
|
|
|
// Data representation. One of
|
|
// [struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data] or
|
|
// [json_data][google.cloud.discoveryengine.v1beta.Document.json_data] should
|
|
// be provided otherwise an INVALID_ARGUMENT error is thrown.
|
|
oneof data {
|
|
// The structured JSON data for the document. It should conform to the
|
|
// registered [schema][] or an INVALID_ARGUMENT error is thrown.
|
|
google.protobuf.Struct struct_data = 4;
|
|
|
|
// The JSON string representation of the document. It should conform to the
|
|
// registered [schema][] or an INVALID_ARGUMENT error is thrown.
|
|
string json_data = 5;
|
|
}
|
|
|
|
// Immutable. The full resource name of the document.
|
|
// Format:
|
|
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
|
|
//
|
|
// This field must be a UTF-8 encoded string with a length limit of 1024
|
|
// characters.
|
|
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
|
|
|
|
// Immutable. The identifier of the document.
|
|
//
|
|
// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
|
// standard with a length limit of 63 characters.
|
|
string id = 2 [(google.api.field_behavior) = IMMUTABLE];
|
|
|
|
// The identifier of the schema located in the same data store.
|
|
string schema_id = 3;
|
|
|
|
// The identifier of the parent document. Currently supports at most two level
|
|
// document hierarchy.
|
|
//
|
|
// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
|
// standard with a length limit of 63 characters.
|
|
string parent_document_id = 7;
|
|
}
|