google-cloud-discovery_engine-v1beta 0.7.2 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +235 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +801 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +221 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +1077 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +136 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest.rb +1 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service.rb +1 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +91 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +45 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +925 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +801 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/paths.rb +97 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +864 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +1077 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/service_stub.rb +403 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +887 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +801 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/paths.rb +73 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +826 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +1077 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +366 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +22 -3
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +19 -0
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +22 -3
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/service_stub.rb +8 -0
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +4 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +48 -10
- data/lib/google/cloud/discovery_engine/v1beta/search_service/paths.rb +19 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +48 -10
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +8 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +646 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/paths.rb +146 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +599 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/service_stub.rb +291 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +1635 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +801 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/paths.rb +127 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +1525 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +1077 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +860 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +8 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversation_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/data_store_service_pb.rb +62 -0
- data/lib/google/cloud/discoveryengine/v1beta/data_store_service_services_pb.rb +61 -0
- data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +53 -0
- data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +62 -0
- data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/schema_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/schema_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +8 -1
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +53 -0
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb +54 -0
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb +53 -0
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +54 -0
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +82 -0
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb +74 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +60 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion.rb +53 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +10 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +19 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +88 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +216 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +219 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +179 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +66 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +41 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +22 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +166 -15
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +247 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +85 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +160 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +528 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +4 -3
- metadata +62 -116
@@ -0,0 +1,216 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Request for
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#create_data_store DataStoreService.CreateDataStore}
|
26
|
+
# method.
|
27
|
+
# @!attribute [rw] parent
|
28
|
+
# @return [::String]
|
29
|
+
# Required. The parent resource name, such as
|
30
|
+
# `projects/{project}/locations/{location}/collections/{collection}`.
|
31
|
+
# @!attribute [rw] data_store
|
32
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DataStore]
|
33
|
+
# Required. The {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} to
|
34
|
+
# create.
|
35
|
+
# @!attribute [rw] data_store_id
|
36
|
+
# @return [::String]
|
37
|
+
# Required. The ID to use for the
|
38
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, which will
|
39
|
+
# become the final component of the
|
40
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}'s resource name.
|
41
|
+
#
|
42
|
+
# This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
43
|
+
# standard with a length limit of 63 characters. Otherwise, an
|
44
|
+
# INVALID_ARGUMENT error is returned.
|
45
|
+
# @!attribute [rw] create_advanced_site_search
|
46
|
+
# @return [::Boolean]
|
47
|
+
# A boolean flag indicating whether user want to directly create an advanced
|
48
|
+
# data store for site search.
|
49
|
+
# If the data store is not configured as site
|
50
|
+
# search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
|
51
|
+
# be ignored.
|
52
|
+
class CreateDataStoreRequest
|
53
|
+
include ::Google::Protobuf::MessageExts
|
54
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
55
|
+
end
|
56
|
+
|
57
|
+
# Request message for
|
58
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#get_data_store DataStoreService.GetDataStore}
|
59
|
+
# method.
|
60
|
+
# @!attribute [rw] name
|
61
|
+
# @return [::String]
|
62
|
+
# Required. Full resource name of
|
63
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, such as
|
64
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
|
65
|
+
#
|
66
|
+
# If the caller does not have permission to access the
|
67
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, regardless of
|
68
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
69
|
+
#
|
70
|
+
# If the requested {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}
|
71
|
+
# does not exist, a NOT_FOUND error is returned.
|
72
|
+
class GetDataStoreRequest
|
73
|
+
include ::Google::Protobuf::MessageExts
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
75
|
+
end
|
76
|
+
|
77
|
+
# Metadata related to the progress of the
|
78
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#create_data_store DataStoreService.CreateDataStore}
|
79
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
80
|
+
# field.
|
81
|
+
# @!attribute [rw] create_time
|
82
|
+
# @return [::Google::Protobuf::Timestamp]
|
83
|
+
# Operation create time.
|
84
|
+
# @!attribute [rw] update_time
|
85
|
+
# @return [::Google::Protobuf::Timestamp]
|
86
|
+
# Operation last update time. If the operation is done, this is also the
|
87
|
+
# finish time.
|
88
|
+
class CreateDataStoreMetadata
|
89
|
+
include ::Google::Protobuf::MessageExts
|
90
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
91
|
+
end
|
92
|
+
|
93
|
+
# Request message for
|
94
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#list_data_stores DataStoreService.ListDataStores}
|
95
|
+
# method.
|
96
|
+
# @!attribute [rw] parent
|
97
|
+
# @return [::String]
|
98
|
+
# Required. The parent branch resource name, such as
|
99
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}`.
|
100
|
+
#
|
101
|
+
# If the caller does not have permission to list
|
102
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s under this
|
103
|
+
# location, regardless of whether or not this data store exists, a
|
104
|
+
# PERMISSION_DENIED error is returned.
|
105
|
+
# @!attribute [rw] page_size
|
106
|
+
# @return [::Integer]
|
107
|
+
# Maximum number of
|
108
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s to return. If
|
109
|
+
# unspecified, defaults to 10. The maximum allowed value is 50. Values above
|
110
|
+
# 50 will be coerced to 50.
|
111
|
+
#
|
112
|
+
# If this field is negative, an INVALID_ARGUMENT is returned.
|
113
|
+
# @!attribute [rw] page_token
|
114
|
+
# @return [::String]
|
115
|
+
# A page token
|
116
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ListDataStoresResponse#next_page_token ListDataStoresResponse.next_page_token},
|
117
|
+
# received from a previous
|
118
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#list_data_stores DataStoreService.ListDataStores}
|
119
|
+
# call. Provide this to retrieve the subsequent page.
|
120
|
+
#
|
121
|
+
# When paginating, all other parameters provided to
|
122
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#list_data_stores DataStoreService.ListDataStores}
|
123
|
+
# must match the call that provided the page token. Otherwise, an
|
124
|
+
# INVALID_ARGUMENT error is returned.
|
125
|
+
# @!attribute [rw] filter
|
126
|
+
# @return [::String]
|
127
|
+
# Filter by solution type. For example: filter =
|
128
|
+
# 'solution_type:SOLUTION_TYPE_SEARCH'
|
129
|
+
class ListDataStoresRequest
|
130
|
+
include ::Google::Protobuf::MessageExts
|
131
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
132
|
+
end
|
133
|
+
|
134
|
+
# Response message for
|
135
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#list_data_stores DataStoreService.ListDataStores}
|
136
|
+
# method.
|
137
|
+
# @!attribute [rw] data_stores
|
138
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::DataStore>]
|
139
|
+
# All the customer's
|
140
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s.
|
141
|
+
# @!attribute [rw] next_page_token
|
142
|
+
# @return [::String]
|
143
|
+
# A token that can be sent as
|
144
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ListDataStoresRequest#page_token ListDataStoresRequest.page_token}
|
145
|
+
# to retrieve the next page. If this field is omitted, there are no
|
146
|
+
# subsequent pages.
|
147
|
+
class ListDataStoresResponse
|
148
|
+
include ::Google::Protobuf::MessageExts
|
149
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
150
|
+
end
|
151
|
+
|
152
|
+
# Request message for
|
153
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#delete_data_store DataStoreService.DeleteDataStore}
|
154
|
+
# method.
|
155
|
+
# @!attribute [rw] name
|
156
|
+
# @return [::String]
|
157
|
+
# Required. Full resource name of
|
158
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, such as
|
159
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
|
160
|
+
#
|
161
|
+
# If the caller does not have permission to delete the
|
162
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, regardless of
|
163
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
164
|
+
#
|
165
|
+
# If the {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} to delete
|
166
|
+
# does not exist, a NOT_FOUND error is returned.
|
167
|
+
class DeleteDataStoreRequest
|
168
|
+
include ::Google::Protobuf::MessageExts
|
169
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
170
|
+
end
|
171
|
+
|
172
|
+
# Request message for
|
173
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#update_data_store DataStoreService.UpdateDataStore}
|
174
|
+
# method.
|
175
|
+
# @!attribute [rw] data_store
|
176
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DataStore]
|
177
|
+
# Required. The {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} to
|
178
|
+
# update.
|
179
|
+
#
|
180
|
+
# If the caller does not have permission to update the
|
181
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, regardless of
|
182
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
183
|
+
#
|
184
|
+
# If the {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} to update
|
185
|
+
# does not exist, a NOT_FOUND error is returned.
|
186
|
+
# @!attribute [rw] update_mask
|
187
|
+
# @return [::Google::Protobuf::FieldMask]
|
188
|
+
# Indicates which fields in the provided
|
189
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} to update.
|
190
|
+
#
|
191
|
+
# If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
|
192
|
+
# is returned.
|
193
|
+
class UpdateDataStoreRequest
|
194
|
+
include ::Google::Protobuf::MessageExts
|
195
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
end
|
197
|
+
|
198
|
+
# Metadata related to the progress of the
|
199
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client#delete_data_store DataStoreService.DeleteDataStore}
|
200
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
201
|
+
# field.
|
202
|
+
# @!attribute [rw] create_time
|
203
|
+
# @return [::Google::Protobuf::Timestamp]
|
204
|
+
# Operation create time.
|
205
|
+
# @!attribute [rw] update_time
|
206
|
+
# @return [::Google::Protobuf::Timestamp]
|
207
|
+
# Operation last update time. If the operation is done, this is also the
|
208
|
+
# finish time.
|
209
|
+
class DeleteDataStoreMetadata
|
210
|
+
include ::Google::Protobuf::MessageExts
|
211
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
212
|
+
end
|
213
|
+
end
|
214
|
+
end
|
215
|
+
end
|
216
|
+
end
|
@@ -85,7 +85,7 @@ module Google
|
|
85
85
|
# @return [::String]
|
86
86
|
# The URI of the content. Only Cloud Storage URIs (e.g.
|
87
87
|
# `gs://bucket-name/path/to/file`) are supported. The maximum file size
|
88
|
-
# is 100 MB.
|
88
|
+
# is 2.5 MB for text-based formats, 100 MB for other formats.
|
89
89
|
# @!attribute [rw] mime_type
|
90
90
|
# @return [::String]
|
91
91
|
# The MIME type of the content. Supported types:
|
@@ -0,0 +1,219 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Metadata that describes the training and serving parameters of an
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}.
|
26
|
+
# @!attribute [rw] chat_engine_config
|
27
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig]
|
28
|
+
# Configurations for the Chat Engine. Only applicable if
|
29
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine#solution_type solution_type}
|
30
|
+
# is
|
31
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
|
32
|
+
# @!attribute [rw] search_engine_config
|
33
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig]
|
34
|
+
# Configurations for the Search Engine. Only applicable if
|
35
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine#solution_type solution_type}
|
36
|
+
# is
|
37
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
|
38
|
+
# @!attribute [r] chat_engine_metadata
|
39
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata]
|
40
|
+
# Output only. Additional information of the Chat Engine. Only applicable
|
41
|
+
# if
|
42
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine#solution_type solution_type}
|
43
|
+
# is
|
44
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
|
45
|
+
# @!attribute [rw] name
|
46
|
+
# @return [::String]
|
47
|
+
# Immutable. The fully qualified resource name of the engine.
|
48
|
+
#
|
49
|
+
# This field must be a UTF-8 encoded string with a length limit of 1024
|
50
|
+
# characters.
|
51
|
+
#
|
52
|
+
# Format:
|
53
|
+
# `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
|
54
|
+
# engine should be 1-63 characters, and valid characters are
|
55
|
+
# /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
56
|
+
# @!attribute [rw] display_name
|
57
|
+
# @return [::String]
|
58
|
+
# Required. The display name of the engine. Should be human readable. UTF-8
|
59
|
+
# encoded string with limit of 1024 characters.
|
60
|
+
# @!attribute [r] create_time
|
61
|
+
# @return [::Google::Protobuf::Timestamp]
|
62
|
+
# Output only. Timestamp the Recommendation Engine was created at.
|
63
|
+
# @!attribute [r] update_time
|
64
|
+
# @return [::Google::Protobuf::Timestamp]
|
65
|
+
# Output only. Timestamp the Recommendation Engine was last updated.
|
66
|
+
# @!attribute [rw] data_store_ids
|
67
|
+
# @return [::Array<::String>]
|
68
|
+
# The data stores associated with this engine.
|
69
|
+
#
|
70
|
+
# For
|
71
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}
|
72
|
+
# and
|
73
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}
|
74
|
+
# type of engines, they can only associate with at most one data store.
|
75
|
+
#
|
76
|
+
# If
|
77
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine#solution_type solution_type}
|
78
|
+
# is
|
79
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT},
|
80
|
+
# multiple {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s in the
|
81
|
+
# same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
|
82
|
+
# associated here.
|
83
|
+
#
|
84
|
+
# Note that when used in
|
85
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CreateEngineRequest CreateEngineRequest},
|
86
|
+
# one DataStore id must be provided as the system will use it for necessary
|
87
|
+
# initializations.
|
88
|
+
# @!attribute [rw] solution_type
|
89
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SolutionType]
|
90
|
+
# Required. The solutions of the engine.
|
91
|
+
# @!attribute [rw] industry_vertical
|
92
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical]
|
93
|
+
# The industry vertical that the engine registers.
|
94
|
+
# The restriction of the Engine industry vertical is based on
|
95
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}: If unspecified,
|
96
|
+
# default to `GENERIC`. Vertical on Engine has to match vertical of the
|
97
|
+
# DataStore liniked to the engine.
|
98
|
+
# @!attribute [rw] common_config
|
99
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig]
|
100
|
+
# Common config spec that specifies the metadata of the engine.
|
101
|
+
class Engine
|
102
|
+
include ::Google::Protobuf::MessageExts
|
103
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
|
+
|
105
|
+
# Configurations for a Search Engine.
|
106
|
+
# @!attribute [rw] search_tier
|
107
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
|
108
|
+
# The search feature tier of this engine.
|
109
|
+
#
|
110
|
+
# Different tiers might have different
|
111
|
+
# pricing. To learn more, please check the pricing documentation.
|
112
|
+
#
|
113
|
+
# Defaults to
|
114
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
|
115
|
+
# if not specified.
|
116
|
+
# @!attribute [rw] search_add_ons
|
117
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
|
118
|
+
# The add-on that this search engine enables.
|
119
|
+
class SearchEngineConfig
|
120
|
+
include ::Google::Protobuf::MessageExts
|
121
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
122
|
+
end
|
123
|
+
|
124
|
+
# Configurations for a Chat Engine.
|
125
|
+
# @!attribute [rw] agent_creation_config
|
126
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
|
127
|
+
# The configurationt generate the Dialogflow agent that is associated to
|
128
|
+
# this Engine.
|
129
|
+
#
|
130
|
+
# Note that these configurations are one-time consumed by
|
131
|
+
# and passed to Dialogflow service. It means they cannot be retrieved using
|
132
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
|
133
|
+
# or
|
134
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
|
135
|
+
# API after engine creation.
|
136
|
+
# @!attribute [rw] dialogflow_agent_to_link
|
137
|
+
# @return [::String]
|
138
|
+
# The resource name of an exist Dialogflow agent to link to this Chat
|
139
|
+
# Engine. Customers can either provide `agent_creation_config` to create
|
140
|
+
# agent or provide an agent name that links the agent with the Chat engine.
|
141
|
+
#
|
142
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
143
|
+
# ID>`.
|
144
|
+
#
|
145
|
+
# Note that the `dialogflow_agent_to_link` are one-time consumed by and
|
146
|
+
# passed to Dialogflow service. It means they cannot be retrieved using
|
147
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
|
148
|
+
# or
|
149
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
|
150
|
+
# API after engine creation. Please use
|
151
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
|
152
|
+
# for actual agent association after Engine is created.
|
153
|
+
class ChatEngineConfig
|
154
|
+
include ::Google::Protobuf::MessageExts
|
155
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
156
|
+
|
157
|
+
# Configurations for generating a Dialogflow agent.
|
158
|
+
#
|
159
|
+
# Note that these configurations are one-time consumed by
|
160
|
+
# and passed to Dialogflow service. It means they cannot be retrieved using
|
161
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
|
162
|
+
# or
|
163
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
|
164
|
+
# API after engine creation.
|
165
|
+
# @!attribute [rw] business
|
166
|
+
# @return [::String]
|
167
|
+
# Name of the company, organization or other entity that the agent
|
168
|
+
# represents. Used for knowledge connector LLM prompt and for knowledge
|
169
|
+
# search.
|
170
|
+
# @!attribute [rw] default_language_code
|
171
|
+
# @return [::String]
|
172
|
+
# Required. The default language of the agent as a language tag.
|
173
|
+
# See [Language
|
174
|
+
# Support](https://cloud.google.com/dialogflow/docs/reference/language)
|
175
|
+
# for a list of the currently supported language codes.
|
176
|
+
# @!attribute [rw] time_zone
|
177
|
+
# @return [::String]
|
178
|
+
# Required. The time zone of the agent from the [time zone
|
179
|
+
# database](https://www.iana.org/time-zones), e.g., America/New_York,
|
180
|
+
# Europe/Paris.
|
181
|
+
# @!attribute [rw] location
|
182
|
+
# @return [::String]
|
183
|
+
# Agent location for Agent creation, supported values: global/us/eu.
|
184
|
+
# If not provided, us Engine will create Agent using us-central-1 by
|
185
|
+
# default; eu Engine will create Agent using eu-west-1 by default.
|
186
|
+
class AgentCreationConfig
|
187
|
+
include ::Google::Protobuf::MessageExts
|
188
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
# Common configurations for an Engine.
|
193
|
+
# @!attribute [rw] company_name
|
194
|
+
# @return [::String]
|
195
|
+
# Immutable. The name of the company, business or entity that is associated
|
196
|
+
# with the engine. Setting this may help improve LLM related features.
|
197
|
+
class CommonConfig
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
|
202
|
+
# Additional information of a Chat Engine.
|
203
|
+
# Fields in this message are output only.
|
204
|
+
# @!attribute [rw] dialogflow_agent
|
205
|
+
# @return [::String]
|
206
|
+
# The resource name of a Dialogflow agent, that this Chat Engine refers
|
207
|
+
# to.
|
208
|
+
#
|
209
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
210
|
+
# ID>`.
|
211
|
+
class ChatEngineMetadata
|
212
|
+
include ::Google::Protobuf::MessageExts
|
213
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
214
|
+
end
|
215
|
+
end
|
216
|
+
end
|
217
|
+
end
|
218
|
+
end
|
219
|
+
end
|
@@ -0,0 +1,179 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Request for
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}
|
26
|
+
# method.
|
27
|
+
# @!attribute [rw] parent
|
28
|
+
# @return [::String]
|
29
|
+
# Required. The parent resource name, such as
|
30
|
+
# `projects/{project}/locations/{location}/collections/{collection}`.
|
31
|
+
# @!attribute [rw] engine
|
32
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
|
33
|
+
# Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to
|
34
|
+
# create.
|
35
|
+
# @!attribute [rw] engine_id
|
36
|
+
# @return [::String]
|
37
|
+
# Required. The ID to use for the
|
38
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, which will become the
|
39
|
+
# final component of the
|
40
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}'s resource name.
|
41
|
+
#
|
42
|
+
# This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
43
|
+
# standard with a length limit of 63 characters. Otherwise, an
|
44
|
+
# INVALID_ARGUMENT error is returned.
|
45
|
+
class CreateEngineRequest
|
46
|
+
include ::Google::Protobuf::MessageExts
|
47
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
48
|
+
end
|
49
|
+
|
50
|
+
# Metadata related to the progress of the
|
51
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}
|
52
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
53
|
+
# field.
|
54
|
+
# @!attribute [rw] create_time
|
55
|
+
# @return [::Google::Protobuf::Timestamp]
|
56
|
+
# Operation create time.
|
57
|
+
# @!attribute [rw] update_time
|
58
|
+
# @return [::Google::Protobuf::Timestamp]
|
59
|
+
# Operation last update time. If the operation is done, this is also the
|
60
|
+
# finish time.
|
61
|
+
class CreateEngineMetadata
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
end
|
65
|
+
|
66
|
+
# Request message for
|
67
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#delete_engine EngineService.DeleteEngine}
|
68
|
+
# method.
|
69
|
+
# @!attribute [rw] name
|
70
|
+
# @return [::String]
|
71
|
+
# Required. Full resource name of
|
72
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, such as
|
73
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
|
74
|
+
#
|
75
|
+
# If the caller does not have permission to delete the
|
76
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, regardless of whether
|
77
|
+
# or not it exists, a PERMISSION_DENIED error is returned.
|
78
|
+
#
|
79
|
+
# If the {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to delete does
|
80
|
+
# not exist, a NOT_FOUND error is returned.
|
81
|
+
class DeleteEngineRequest
|
82
|
+
include ::Google::Protobuf::MessageExts
|
83
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
84
|
+
end
|
85
|
+
|
86
|
+
# Metadata related to the progress of the
|
87
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#delete_engine EngineService.DeleteEngine}
|
88
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
89
|
+
# field.
|
90
|
+
# @!attribute [rw] create_time
|
91
|
+
# @return [::Google::Protobuf::Timestamp]
|
92
|
+
# Operation create time.
|
93
|
+
# @!attribute [rw] update_time
|
94
|
+
# @return [::Google::Protobuf::Timestamp]
|
95
|
+
# Operation last update time. If the operation is done, this is also the
|
96
|
+
# finish time.
|
97
|
+
class DeleteEngineMetadata
|
98
|
+
include ::Google::Protobuf::MessageExts
|
99
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
100
|
+
end
|
101
|
+
|
102
|
+
# Request message for
|
103
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
|
104
|
+
# method.
|
105
|
+
# @!attribute [rw] name
|
106
|
+
# @return [::String]
|
107
|
+
# Required. Full resource name of
|
108
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, such as
|
109
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
|
110
|
+
class GetEngineRequest
|
111
|
+
include ::Google::Protobuf::MessageExts
|
112
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
|
+
end
|
114
|
+
|
115
|
+
# Request message for
|
116
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
|
117
|
+
# method.
|
118
|
+
# @!attribute [rw] parent
|
119
|
+
# @return [::String]
|
120
|
+
# Required. The parent resource name, such as
|
121
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}`.
|
122
|
+
# @!attribute [rw] page_size
|
123
|
+
# @return [::Integer]
|
124
|
+
# Optional. Not supported.
|
125
|
+
# @!attribute [rw] page_token
|
126
|
+
# @return [::String]
|
127
|
+
# Optional. Not supported.
|
128
|
+
# @!attribute [rw] filter
|
129
|
+
# @return [::String]
|
130
|
+
# Optional. Filter by solution type. For example:
|
131
|
+
# solution_type=SOLUTION_TYPE_SEARCH
|
132
|
+
class ListEnginesRequest
|
133
|
+
include ::Google::Protobuf::MessageExts
|
134
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
135
|
+
end
|
136
|
+
|
137
|
+
# Response message for
|
138
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
|
139
|
+
# method.
|
140
|
+
# @!attribute [rw] engines
|
141
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Engine>]
|
142
|
+
# All the customer's {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}s.
|
143
|
+
# @!attribute [rw] next_page_token
|
144
|
+
# @return [::String]
|
145
|
+
# Not supported.
|
146
|
+
class ListEnginesResponse
|
147
|
+
include ::Google::Protobuf::MessageExts
|
148
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
149
|
+
end
|
150
|
+
|
151
|
+
# Request message for
|
152
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#update_engine EngineService.UpdateEngine}
|
153
|
+
# method.
|
154
|
+
# @!attribute [rw] engine
|
155
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
|
156
|
+
# Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to
|
157
|
+
# update.
|
158
|
+
#
|
159
|
+
# If the caller does not have permission to update the
|
160
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, regardless of whether
|
161
|
+
# or not it exists, a PERMISSION_DENIED error is returned.
|
162
|
+
#
|
163
|
+
# If the {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to update does
|
164
|
+
# not exist, a NOT_FOUND error is returned.
|
165
|
+
# @!attribute [rw] update_mask
|
166
|
+
# @return [::Google::Protobuf::FieldMask]
|
167
|
+
# Indicates which fields in the provided
|
168
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to update.
|
169
|
+
#
|
170
|
+
# If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
|
171
|
+
# is returned.
|
172
|
+
class UpdateEngineRequest
|
173
|
+
include ::Google::Protobuf::MessageExts
|
174
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
175
|
+
end
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|