1// Copyright 2022 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.discoveryengine.v1; 18 19import "google/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21import "google/cloud/discoveryengine/v1/common.proto"; 22import "google/cloud/discoveryengine/v1/schema.proto"; 23import "google/protobuf/timestamp.proto"; 24 25option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1"; 26option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb"; 27option java_multiple_files = true; 28option java_outer_classname = "DataStoreProto"; 29option java_package = "com.google.cloud.discoveryengine.v1"; 30option objc_class_prefix = "DISCOVERYENGINE"; 31option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1"; 32option ruby_package = "Google::Cloud::DiscoveryEngine::V1"; 33 34// DataStore captures global settings and configs at the DataStore level. 35message DataStore { 36 option (google.api.resource) = { 37 type: "discoveryengine.googleapis.com/DataStore" 38 pattern: "projects/{project}/locations/{location}/dataStores/{data_store}" 39 pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}" 40 }; 41 42 // Content config of the data store. 43 enum ContentConfig { 44 // Default value. 45 CONTENT_CONFIG_UNSPECIFIED = 0; 46 47 // Only contains documents without any 48 // [Document.content][google.cloud.discoveryengine.v1.Document.content]. 49 NO_CONTENT = 1; 50 51 // Only contains documents with 52 // [Document.content][google.cloud.discoveryengine.v1.Document.content]. 53 CONTENT_REQUIRED = 2; 54 55 // The data store is used for public website search. 56 PUBLIC_WEBSITE = 3; 57 } 58 59 // Immutable. The full resource name of the data store. 60 // Format: 61 // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. 62 // 63 // This field must be a UTF-8 encoded string with a length limit of 1024 64 // characters. 65 string name = 1 [(google.api.field_behavior) = IMMUTABLE]; 66 67 // Required. The data store display name. 68 // 69 // This field must be a UTF-8 encoded string with a length limit of 128 70 // characters. Otherwise, an INVALID_ARGUMENT error is returned. 71 string display_name = 2 [(google.api.field_behavior) = REQUIRED]; 72 73 // Immutable. The industry vertical that the data store registers. 74 IndustryVertical industry_vertical = 3 75 [(google.api.field_behavior) = IMMUTABLE]; 76 77 // The solutions that the data store enrolls. Available solutions for each 78 // [industry_vertical][google.cloud.discoveryengine.v1.DataStore.industry_vertical]: 79 // 80 // * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. 81 // * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other 82 // solutions cannot be enrolled. 83 repeated SolutionType solution_types = 5; 84 85 // Output only. The id of the default 86 // [Schema][google.cloud.discoveryengine.v1.Schema] asscociated to this data 87 // store. 88 string default_schema_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; 89 90 // Immutable. The content config of the data store. If this field is unset, 91 // the server behavior defaults to 92 // [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1.DataStore.ContentConfig.NO_CONTENT]. 93 ContentConfig content_config = 6 [(google.api.field_behavior) = IMMUTABLE]; 94 95 // Output only. Timestamp the 96 // [DataStore][google.cloud.discoveryengine.v1.DataStore] was created at. 97 google.protobuf.Timestamp create_time = 4 98 [(google.api.field_behavior) = OUTPUT_ONLY]; 99 100 // The start schema to use for this 101 // [DataStore][google.cloud.discoveryengine.v1.DataStore] when provisioning 102 // it. If unset, a default vertical specialized schema will be used. 103 // 104 // This field is only used by [CreateDataStore][] API, and will be ignored if 105 // used in other APIs. This field will be omitted from all API responses 106 // including [CreateDataStore][] API. To retrieve a schema of a 107 // [DataStore][google.cloud.discoveryengine.v1.DataStore], use 108 // [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] 109 // API instead. 110 // 111 // The provided schema will be validated against certain rules on schema. 112 // Learn more from [this 113 // doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). 114 Schema starting_schema = 28; 115} 116