google-cloud-ai_platform-v1 0.58.0 → 0.59.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/ai_platform/v1/dataset_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/dataset_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +103 -0
- data/lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/client.rb +96 -0
- data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/service_stub.rb +60 -0
- data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/feature_registry_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/feature_registry_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/featurestore_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/featurestore_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/index_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/index_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/job_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/job_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/llm_utility_service/paths.rb +19 -0
- data/lib/google/cloud/ai_platform/v1/metadata_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/metadata_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/migration_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/migration_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/model_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/model_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/notebook_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/notebook_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/persistent_resource_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/persistent_resource_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/pipeline_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/pipeline_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/prediction_service/paths.rb +19 -0
- data/lib/google/cloud/ai_platform/v1/rest.rb +2 -0
- data/lib/google/cloud/ai_platform/v1/schedule_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/schedule_service/paths.rb +38 -0
- data/lib/google/cloud/ai_platform/v1/schedule_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/client.rb +1405 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/operations.rb +810 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/paths.rb +173 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/rest/client.rb +1318 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/rest/operations.rb +4244 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/rest/service_stub.rb +663 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/rest.rb +54 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service.rb +56 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_service/client.rb +672 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_service/paths.rb +69 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_service/rest/client.rb +634 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_service/rest/service_stub.rb +249 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_service/rest.rb +53 -0
- data/lib/google/cloud/ai_platform/v1/vertex_rag_service.rb +55 -0
- data/lib/google/cloud/ai_platform/v1/vizier_service/operations.rb +3 -10
- data/lib/google/cloud/ai_platform/v1/vizier_service/rest/operations.rb +73 -10
- data/lib/google/cloud/ai_platform/v1.rb +2 -0
- data/lib/google/cloud/aiplatform/v1/api_auth_pb.rb +46 -0
- data/lib/google/cloud/aiplatform/v1/endpoint_pb.rb +5 -1
- data/lib/google/cloud/aiplatform/v1/endpoint_service_pb.rb +3 -1
- data/lib/google/cloud/aiplatform/v1/endpoint_service_services_pb.rb +2 -0
- data/lib/google/cloud/aiplatform/v1/io_pb.rb +16 -1
- data/lib/google/cloud/aiplatform/v1/machine_resources_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/notebook_execution_job_pb.rb +6 -1
- data/lib/google/cloud/aiplatform/v1/tool_pb.rb +5 -1
- data/lib/google/cloud/aiplatform/v1/vertex_rag_data_pb.rb +67 -0
- data/lib/google/cloud/aiplatform/v1/vertex_rag_data_service_pb.rb +71 -0
- data/lib/google/cloud/aiplatform/v1/vertex_rag_data_service_services_pb.rb +63 -0
- data/lib/google/cloud/aiplatform/v1/vertex_rag_service_pb.rb +65 -0
- data/lib/google/cloud/aiplatform/v1/vertex_rag_service_services_pb.rb +52 -0
- data/proto_docs/google/cloud/aiplatform/v1/api_auth.rb +45 -0
- data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +30 -0
- data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +22 -0
- data/proto_docs/google/cloud/aiplatform/v1/io.rb +158 -0
- data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +8 -0
- data/proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb +18 -0
- data/proto_docs/google/cloud/aiplatform/v1/tool.rb +72 -0
- data/proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb +334 -0
- data/proto_docs/google/cloud/aiplatform/v1/vertex_rag_data_service.rb +293 -0
- data/proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb +279 -0
- data/proto_docs/google/longrunning/operations.rb +19 -14
- metadata +28 -2
@@ -0,0 +1,334 @@
|
|
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 AIPlatform
|
23
|
+
module V1
|
24
|
+
# Config for the embedding model to use for RAG.
|
25
|
+
# @!attribute [rw] vertex_prediction_endpoint
|
26
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagEmbeddingModelConfig::VertexPredictionEndpoint]
|
27
|
+
# The Vertex AI Prediction Endpoint that either refers to a publisher model
|
28
|
+
# or an endpoint that is hosting a 1P fine-tuned text embedding model.
|
29
|
+
# Endpoints hosting non-1P fine-tuned text embedding models are
|
30
|
+
# currently not supported.
|
31
|
+
# This is used for dense vector search.
|
32
|
+
class RagEmbeddingModelConfig
|
33
|
+
include ::Google::Protobuf::MessageExts
|
34
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
35
|
+
|
36
|
+
# Config representing a model hosted on Vertex Prediction Endpoint.
|
37
|
+
# @!attribute [rw] endpoint
|
38
|
+
# @return [::String]
|
39
|
+
# Required. The endpoint resource name.
|
40
|
+
# Format:
|
41
|
+
# `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
|
42
|
+
# or
|
43
|
+
# `projects/{project}/locations/{location}/endpoints/{endpoint}`
|
44
|
+
# @!attribute [r] model
|
45
|
+
# @return [::String]
|
46
|
+
# Output only. The resource name of the model that is deployed on the
|
47
|
+
# endpoint. Present only when the endpoint is not a publisher model.
|
48
|
+
# Pattern:
|
49
|
+
# `projects/{project}/locations/{location}/models/{model}`
|
50
|
+
# @!attribute [r] model_version_id
|
51
|
+
# @return [::String]
|
52
|
+
# Output only. Version ID of the model that is deployed on the endpoint.
|
53
|
+
# Present only when the endpoint is not a publisher model.
|
54
|
+
class VertexPredictionEndpoint
|
55
|
+
include ::Google::Protobuf::MessageExts
|
56
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
# Config for the Vector DB to use for RAG.
|
61
|
+
# @!attribute [rw] rag_managed_db
|
62
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::RagManagedDb]
|
63
|
+
# The config for the RAG-managed Vector DB.
|
64
|
+
# @!attribute [rw] pinecone
|
65
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::Pinecone]
|
66
|
+
# The config for the Pinecone.
|
67
|
+
# @!attribute [rw] vertex_vector_search
|
68
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::VertexVectorSearch]
|
69
|
+
# The config for the Vertex Vector Search.
|
70
|
+
# @!attribute [rw] api_auth
|
71
|
+
# @return [::Google::Cloud::AIPlatform::V1::ApiAuth]
|
72
|
+
# Authentication config for the chosen Vector DB.
|
73
|
+
# @!attribute [rw] rag_embedding_model_config
|
74
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagEmbeddingModelConfig]
|
75
|
+
# Optional. Immutable. The embedding model config of the Vector DB.
|
76
|
+
class RagVectorDbConfig
|
77
|
+
include ::Google::Protobuf::MessageExts
|
78
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
79
|
+
|
80
|
+
# The config for the default RAG-managed Vector DB.
|
81
|
+
class RagManagedDb
|
82
|
+
include ::Google::Protobuf::MessageExts
|
83
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
84
|
+
end
|
85
|
+
|
86
|
+
# The config for the Pinecone.
|
87
|
+
# @!attribute [rw] index_name
|
88
|
+
# @return [::String]
|
89
|
+
# Pinecone index name.
|
90
|
+
# This value cannot be changed after it's set.
|
91
|
+
class Pinecone
|
92
|
+
include ::Google::Protobuf::MessageExts
|
93
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
94
|
+
end
|
95
|
+
|
96
|
+
# The config for the Vertex Vector Search.
|
97
|
+
# @!attribute [rw] index_endpoint
|
98
|
+
# @return [::String]
|
99
|
+
# The resource name of the Index Endpoint.
|
100
|
+
# Format:
|
101
|
+
# `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
|
102
|
+
# @!attribute [rw] index
|
103
|
+
# @return [::String]
|
104
|
+
# The resource name of the Index.
|
105
|
+
# Format:
|
106
|
+
# `projects/{project}/locations/{location}/indexes/{index}`
|
107
|
+
class VertexVectorSearch
|
108
|
+
include ::Google::Protobuf::MessageExts
|
109
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
# RagFile status.
|
114
|
+
# @!attribute [r] state
|
115
|
+
# @return [::Google::Cloud::AIPlatform::V1::FileStatus::State]
|
116
|
+
# Output only. RagFile state.
|
117
|
+
# @!attribute [r] error_status
|
118
|
+
# @return [::String]
|
119
|
+
# Output only. Only when the `state` field is ERROR.
|
120
|
+
class FileStatus
|
121
|
+
include ::Google::Protobuf::MessageExts
|
122
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
123
|
+
|
124
|
+
# RagFile state.
|
125
|
+
module State
|
126
|
+
# RagFile state is unspecified.
|
127
|
+
STATE_UNSPECIFIED = 0
|
128
|
+
|
129
|
+
# RagFile resource has been created and indexed successfully.
|
130
|
+
ACTIVE = 1
|
131
|
+
|
132
|
+
# RagFile resource is in a problematic state.
|
133
|
+
# See `error_message` field for details.
|
134
|
+
ERROR = 2
|
135
|
+
end
|
136
|
+
end
|
137
|
+
|
138
|
+
# RagCorpus status.
|
139
|
+
# @!attribute [r] state
|
140
|
+
# @return [::Google::Cloud::AIPlatform::V1::CorpusStatus::State]
|
141
|
+
# Output only. RagCorpus life state.
|
142
|
+
# @!attribute [r] error_status
|
143
|
+
# @return [::String]
|
144
|
+
# Output only. Only when the `state` field is ERROR.
|
145
|
+
class CorpusStatus
|
146
|
+
include ::Google::Protobuf::MessageExts
|
147
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
148
|
+
|
149
|
+
# RagCorpus life state.
|
150
|
+
module State
|
151
|
+
# This state is not supposed to happen.
|
152
|
+
UNKNOWN = 0
|
153
|
+
|
154
|
+
# RagCorpus resource entry is initialized, but hasn't done validation.
|
155
|
+
INITIALIZED = 1
|
156
|
+
|
157
|
+
# RagCorpus is provisioned successfully and is ready to serve.
|
158
|
+
ACTIVE = 2
|
159
|
+
|
160
|
+
# RagCorpus is in a problematic situation.
|
161
|
+
# See `error_message` field for details.
|
162
|
+
ERROR = 3
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
# A RagCorpus is a RagFile container and a project can have multiple
|
167
|
+
# RagCorpora.
|
168
|
+
# @!attribute [r] name
|
169
|
+
# @return [::String]
|
170
|
+
# Output only. The resource name of the RagCorpus.
|
171
|
+
# @!attribute [rw] display_name
|
172
|
+
# @return [::String]
|
173
|
+
# Required. The display name of the RagCorpus.
|
174
|
+
# The name can be up to 128 characters long and can consist of any UTF-8
|
175
|
+
# characters.
|
176
|
+
# @!attribute [rw] description
|
177
|
+
# @return [::String]
|
178
|
+
# Optional. The description of the RagCorpus.
|
179
|
+
# @!attribute [r] create_time
|
180
|
+
# @return [::Google::Protobuf::Timestamp]
|
181
|
+
# Output only. Timestamp when this RagCorpus was created.
|
182
|
+
# @!attribute [r] update_time
|
183
|
+
# @return [::Google::Protobuf::Timestamp]
|
184
|
+
# Output only. Timestamp when this RagCorpus was last updated.
|
185
|
+
# @!attribute [r] corpus_status
|
186
|
+
# @return [::Google::Cloud::AIPlatform::V1::CorpusStatus]
|
187
|
+
# Output only. RagCorpus state.
|
188
|
+
# @!attribute [rw] vector_db_config
|
189
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagVectorDbConfig]
|
190
|
+
# Optional. Immutable. The config for the Vector DBs.
|
191
|
+
class RagCorpus
|
192
|
+
include ::Google::Protobuf::MessageExts
|
193
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
194
|
+
end
|
195
|
+
|
196
|
+
# A RagFile contains user data for chunking, embedding and indexing.
|
197
|
+
# @!attribute [r] gcs_source
|
198
|
+
# @return [::Google::Cloud::AIPlatform::V1::GcsSource]
|
199
|
+
# Output only. Google Cloud Storage location of the RagFile.
|
200
|
+
# It does not support wildcards in the Cloud Storage uri for now.
|
201
|
+
# @!attribute [r] google_drive_source
|
202
|
+
# @return [::Google::Cloud::AIPlatform::V1::GoogleDriveSource]
|
203
|
+
# Output only. Google Drive location. Supports importing individual files
|
204
|
+
# as well as Google Drive folders.
|
205
|
+
# @!attribute [r] direct_upload_source
|
206
|
+
# @return [::Google::Cloud::AIPlatform::V1::DirectUploadSource]
|
207
|
+
# Output only. The RagFile is encapsulated and uploaded in the
|
208
|
+
# UploadRagFile request.
|
209
|
+
# @!attribute [rw] slack_source
|
210
|
+
# @return [::Google::Cloud::AIPlatform::V1::SlackSource]
|
211
|
+
# The RagFile is imported from a Slack channel.
|
212
|
+
# @!attribute [rw] jira_source
|
213
|
+
# @return [::Google::Cloud::AIPlatform::V1::JiraSource]
|
214
|
+
# The RagFile is imported from a Jira query.
|
215
|
+
# @!attribute [rw] share_point_sources
|
216
|
+
# @return [::Google::Cloud::AIPlatform::V1::SharePointSources]
|
217
|
+
# The RagFile is imported from a SharePoint source.
|
218
|
+
# @!attribute [r] name
|
219
|
+
# @return [::String]
|
220
|
+
# Output only. The resource name of the RagFile.
|
221
|
+
# @!attribute [rw] display_name
|
222
|
+
# @return [::String]
|
223
|
+
# Required. The display name of the RagFile.
|
224
|
+
# The name can be up to 128 characters long and can consist of any UTF-8
|
225
|
+
# characters.
|
226
|
+
# @!attribute [rw] description
|
227
|
+
# @return [::String]
|
228
|
+
# Optional. The description of the RagFile.
|
229
|
+
# @!attribute [r] create_time
|
230
|
+
# @return [::Google::Protobuf::Timestamp]
|
231
|
+
# Output only. Timestamp when this RagFile was created.
|
232
|
+
# @!attribute [r] update_time
|
233
|
+
# @return [::Google::Protobuf::Timestamp]
|
234
|
+
# Output only. Timestamp when this RagFile was last updated.
|
235
|
+
# @!attribute [r] file_status
|
236
|
+
# @return [::Google::Cloud::AIPlatform::V1::FileStatus]
|
237
|
+
# Output only. State of the RagFile.
|
238
|
+
class RagFile
|
239
|
+
include ::Google::Protobuf::MessageExts
|
240
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
241
|
+
end
|
242
|
+
|
243
|
+
# Specifies the size and overlap of chunks for RagFiles.
|
244
|
+
# @!attribute [rw] fixed_length_chunking
|
245
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagFileChunkingConfig::FixedLengthChunking]
|
246
|
+
# Specifies the fixed length chunking config.
|
247
|
+
class RagFileChunkingConfig
|
248
|
+
include ::Google::Protobuf::MessageExts
|
249
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
250
|
+
|
251
|
+
# Specifies the fixed length chunking config.
|
252
|
+
# @!attribute [rw] chunk_size
|
253
|
+
# @return [::Integer]
|
254
|
+
# The size of the chunks.
|
255
|
+
# @!attribute [rw] chunk_overlap
|
256
|
+
# @return [::Integer]
|
257
|
+
# The overlap between chunks.
|
258
|
+
class FixedLengthChunking
|
259
|
+
include ::Google::Protobuf::MessageExts
|
260
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
261
|
+
end
|
262
|
+
end
|
263
|
+
|
264
|
+
# Specifies the transformation config for RagFiles.
|
265
|
+
# @!attribute [rw] rag_file_chunking_config
|
266
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagFileChunkingConfig]
|
267
|
+
# Specifies the chunking config for RagFiles.
|
268
|
+
class RagFileTransformationConfig
|
269
|
+
include ::Google::Protobuf::MessageExts
|
270
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
271
|
+
end
|
272
|
+
|
273
|
+
# Config for uploading RagFile.
|
274
|
+
# @!attribute [rw] rag_file_transformation_config
|
275
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagFileTransformationConfig]
|
276
|
+
# Specifies the transformation config for RagFiles.
|
277
|
+
class UploadRagFileConfig
|
278
|
+
include ::Google::Protobuf::MessageExts
|
279
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
280
|
+
end
|
281
|
+
|
282
|
+
# Config for importing RagFiles.
|
283
|
+
# @!attribute [rw] gcs_source
|
284
|
+
# @return [::Google::Cloud::AIPlatform::V1::GcsSource]
|
285
|
+
# Google Cloud Storage location. Supports importing individual files as
|
286
|
+
# well as entire Google Cloud Storage directories. Sample formats:
|
287
|
+
# - `gs://bucket_name/my_directory/object_name/my_file.txt`
|
288
|
+
# - `gs://bucket_name/my_directory`
|
289
|
+
# @!attribute [rw] google_drive_source
|
290
|
+
# @return [::Google::Cloud::AIPlatform::V1::GoogleDriveSource]
|
291
|
+
# Google Drive location. Supports importing individual files as
|
292
|
+
# well as Google Drive folders.
|
293
|
+
# @!attribute [rw] slack_source
|
294
|
+
# @return [::Google::Cloud::AIPlatform::V1::SlackSource]
|
295
|
+
# Slack channels with their corresponding access tokens.
|
296
|
+
# @!attribute [rw] jira_source
|
297
|
+
# @return [::Google::Cloud::AIPlatform::V1::JiraSource]
|
298
|
+
# Jira queries with their corresponding authentication.
|
299
|
+
# @!attribute [rw] share_point_sources
|
300
|
+
# @return [::Google::Cloud::AIPlatform::V1::SharePointSources]
|
301
|
+
# SharePoint sources.
|
302
|
+
# @!attribute [rw] partial_failure_gcs_sink
|
303
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
304
|
+
# @return [::Google::Cloud::AIPlatform::V1::GcsDestination]
|
305
|
+
# The Cloud Storage path to write partial failures to.
|
306
|
+
# Deprecated. Prefer to use `import_result_gcs_sink`.
|
307
|
+
# @!attribute [rw] partial_failure_bigquery_sink
|
308
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
309
|
+
# @return [::Google::Cloud::AIPlatform::V1::BigQueryDestination]
|
310
|
+
# The BigQuery destination to write partial failures to. It should be a
|
311
|
+
# bigquery table resource name (e.g.
|
312
|
+
# "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If the
|
313
|
+
# table does not exist, it will be created with the expected schema. If the
|
314
|
+
# table exists, the schema will be validated and data will be added to this
|
315
|
+
# existing table.
|
316
|
+
# Deprecated. Prefer to use `import_result_bq_sink`.
|
317
|
+
# @!attribute [rw] rag_file_transformation_config
|
318
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagFileTransformationConfig]
|
319
|
+
# Specifies the transformation config for RagFiles.
|
320
|
+
# @!attribute [rw] max_embedding_requests_per_min
|
321
|
+
# @return [::Integer]
|
322
|
+
# Optional. The max number of queries per minute that this job is allowed to
|
323
|
+
# make to the embedding model specified on the corpus. This value is specific
|
324
|
+
# to this job and not shared across other import jobs. Consult the Quotas
|
325
|
+
# page on the project to set an appropriate value here.
|
326
|
+
# If unspecified, a default value of 1,000 QPM would be used.
|
327
|
+
class ImportRagFilesConfig
|
328
|
+
include ::Google::Protobuf::MessageExts
|
329
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
330
|
+
end
|
331
|
+
end
|
332
|
+
end
|
333
|
+
end
|
334
|
+
end
|
@@ -0,0 +1,293 @@
|
|
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 AIPlatform
|
23
|
+
module V1
|
24
|
+
# Request message for
|
25
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#create_rag_corpus VertexRagDataService.CreateRagCorpus}.
|
26
|
+
# @!attribute [rw] parent
|
27
|
+
# @return [::String]
|
28
|
+
# Required. The resource name of the Location to create the RagCorpus in.
|
29
|
+
# Format: `projects/{project}/locations/{location}`
|
30
|
+
# @!attribute [rw] rag_corpus
|
31
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagCorpus]
|
32
|
+
# Required. The RagCorpus to create.
|
33
|
+
class CreateRagCorpusRequest
|
34
|
+
include ::Google::Protobuf::MessageExts
|
35
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
36
|
+
end
|
37
|
+
|
38
|
+
# Request message for
|
39
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#get_rag_corpus VertexRagDataService.GetRagCorpus}
|
40
|
+
# @!attribute [rw] name
|
41
|
+
# @return [::String]
|
42
|
+
# Required. The name of the RagCorpus resource.
|
43
|
+
# Format:
|
44
|
+
# `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
|
45
|
+
class GetRagCorpusRequest
|
46
|
+
include ::Google::Protobuf::MessageExts
|
47
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
48
|
+
end
|
49
|
+
|
50
|
+
# Request message for
|
51
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#list_rag_corpora VertexRagDataService.ListRagCorpora}.
|
52
|
+
# @!attribute [rw] parent
|
53
|
+
# @return [::String]
|
54
|
+
# Required. The resource name of the Location from which to list the
|
55
|
+
# RagCorpora. Format: `projects/{project}/locations/{location}`
|
56
|
+
# @!attribute [rw] page_size
|
57
|
+
# @return [::Integer]
|
58
|
+
# Optional. The standard list page size.
|
59
|
+
# @!attribute [rw] page_token
|
60
|
+
# @return [::String]
|
61
|
+
# Optional. The standard list page token.
|
62
|
+
# Typically obtained via
|
63
|
+
# {::Google::Cloud::AIPlatform::V1::ListRagCorporaResponse#next_page_token ListRagCorporaResponse.next_page_token}
|
64
|
+
# of the previous
|
65
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#list_rag_corpora VertexRagDataService.ListRagCorpora}
|
66
|
+
# call.
|
67
|
+
class ListRagCorporaRequest
|
68
|
+
include ::Google::Protobuf::MessageExts
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
|
+
end
|
71
|
+
|
72
|
+
# Response message for
|
73
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#list_rag_corpora VertexRagDataService.ListRagCorpora}.
|
74
|
+
# @!attribute [rw] rag_corpora
|
75
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::RagCorpus>]
|
76
|
+
# List of RagCorpora in the requested page.
|
77
|
+
# @!attribute [rw] next_page_token
|
78
|
+
# @return [::String]
|
79
|
+
# A token to retrieve the next page of results.
|
80
|
+
# Pass to
|
81
|
+
# {::Google::Cloud::AIPlatform::V1::ListRagCorporaRequest#page_token ListRagCorporaRequest.page_token}
|
82
|
+
# to obtain that page.
|
83
|
+
class ListRagCorporaResponse
|
84
|
+
include ::Google::Protobuf::MessageExts
|
85
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
86
|
+
end
|
87
|
+
|
88
|
+
# Request message for
|
89
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#delete_rag_corpus VertexRagDataService.DeleteRagCorpus}.
|
90
|
+
# @!attribute [rw] name
|
91
|
+
# @return [::String]
|
92
|
+
# Required. The name of the RagCorpus resource to be deleted.
|
93
|
+
# Format:
|
94
|
+
# `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
|
95
|
+
# @!attribute [rw] force
|
96
|
+
# @return [::Boolean]
|
97
|
+
# Optional. If set to true, any RagFiles in this RagCorpus will also be
|
98
|
+
# deleted. Otherwise, the request will only work if the RagCorpus has no
|
99
|
+
# RagFiles.
|
100
|
+
class DeleteRagCorpusRequest
|
101
|
+
include ::Google::Protobuf::MessageExts
|
102
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
103
|
+
end
|
104
|
+
|
105
|
+
# Request message for
|
106
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#upload_rag_file VertexRagDataService.UploadRagFile}.
|
107
|
+
# @!attribute [rw] parent
|
108
|
+
# @return [::String]
|
109
|
+
# Required. The name of the RagCorpus resource into which to upload the file.
|
110
|
+
# Format:
|
111
|
+
# `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
|
112
|
+
# @!attribute [rw] rag_file
|
113
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagFile]
|
114
|
+
# Required. The RagFile to upload.
|
115
|
+
# @!attribute [rw] upload_rag_file_config
|
116
|
+
# @return [::Google::Cloud::AIPlatform::V1::UploadRagFileConfig]
|
117
|
+
# Required. The config for the RagFiles to be uploaded into the RagCorpus.
|
118
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#upload_rag_file VertexRagDataService.UploadRagFile}.
|
119
|
+
class UploadRagFileRequest
|
120
|
+
include ::Google::Protobuf::MessageExts
|
121
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
122
|
+
end
|
123
|
+
|
124
|
+
# Response message for
|
125
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#upload_rag_file VertexRagDataService.UploadRagFile}.
|
126
|
+
# @!attribute [rw] rag_file
|
127
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagFile]
|
128
|
+
# The RagFile that had been uploaded into the RagCorpus.
|
129
|
+
# @!attribute [rw] error
|
130
|
+
# @return [::Google::Rpc::Status]
|
131
|
+
# The error that occurred while processing the RagFile.
|
132
|
+
class UploadRagFileResponse
|
133
|
+
include ::Google::Protobuf::MessageExts
|
134
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
135
|
+
end
|
136
|
+
|
137
|
+
# Request message for
|
138
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#import_rag_files VertexRagDataService.ImportRagFiles}.
|
139
|
+
# @!attribute [rw] parent
|
140
|
+
# @return [::String]
|
141
|
+
# Required. The name of the RagCorpus resource into which to import files.
|
142
|
+
# Format:
|
143
|
+
# `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
|
144
|
+
# @!attribute [rw] import_rag_files_config
|
145
|
+
# @return [::Google::Cloud::AIPlatform::V1::ImportRagFilesConfig]
|
146
|
+
# Required. The config for the RagFiles to be synced and imported into the
|
147
|
+
# RagCorpus.
|
148
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#import_rag_files VertexRagDataService.ImportRagFiles}.
|
149
|
+
class ImportRagFilesRequest
|
150
|
+
include ::Google::Protobuf::MessageExts
|
151
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
152
|
+
end
|
153
|
+
|
154
|
+
# Response message for
|
155
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#import_rag_files VertexRagDataService.ImportRagFiles}.
|
156
|
+
# @!attribute [rw] partial_failures_gcs_path
|
157
|
+
# @return [::String]
|
158
|
+
# The Google Cloud Storage path into which the partial failures were
|
159
|
+
# written.
|
160
|
+
# @!attribute [rw] partial_failures_bigquery_table
|
161
|
+
# @return [::String]
|
162
|
+
# The BigQuery table into which the partial failures were written.
|
163
|
+
# @!attribute [rw] imported_rag_files_count
|
164
|
+
# @return [::Integer]
|
165
|
+
# The number of RagFiles that had been imported into the RagCorpus.
|
166
|
+
# @!attribute [rw] failed_rag_files_count
|
167
|
+
# @return [::Integer]
|
168
|
+
# The number of RagFiles that had failed while importing into the RagCorpus.
|
169
|
+
# @!attribute [rw] skipped_rag_files_count
|
170
|
+
# @return [::Integer]
|
171
|
+
# The number of RagFiles that was skipped while importing into the RagCorpus.
|
172
|
+
class ImportRagFilesResponse
|
173
|
+
include ::Google::Protobuf::MessageExts
|
174
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
175
|
+
end
|
176
|
+
|
177
|
+
# Request message for
|
178
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#get_rag_file VertexRagDataService.GetRagFile}
|
179
|
+
# @!attribute [rw] name
|
180
|
+
# @return [::String]
|
181
|
+
# Required. The name of the RagFile resource.
|
182
|
+
# Format:
|
183
|
+
# `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
|
184
|
+
class GetRagFileRequest
|
185
|
+
include ::Google::Protobuf::MessageExts
|
186
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
187
|
+
end
|
188
|
+
|
189
|
+
# Request message for
|
190
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#list_rag_files VertexRagDataService.ListRagFiles}.
|
191
|
+
# @!attribute [rw] parent
|
192
|
+
# @return [::String]
|
193
|
+
# Required. The resource name of the RagCorpus from which to list the
|
194
|
+
# RagFiles. Format:
|
195
|
+
# `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
|
196
|
+
# @!attribute [rw] page_size
|
197
|
+
# @return [::Integer]
|
198
|
+
# Optional. The standard list page size.
|
199
|
+
# @!attribute [rw] page_token
|
200
|
+
# @return [::String]
|
201
|
+
# Optional. The standard list page token.
|
202
|
+
# Typically obtained via
|
203
|
+
# {::Google::Cloud::AIPlatform::V1::ListRagFilesResponse#next_page_token ListRagFilesResponse.next_page_token}
|
204
|
+
# of the previous
|
205
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#list_rag_files VertexRagDataService.ListRagFiles}
|
206
|
+
# call.
|
207
|
+
class ListRagFilesRequest
|
208
|
+
include ::Google::Protobuf::MessageExts
|
209
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
210
|
+
end
|
211
|
+
|
212
|
+
# Response message for
|
213
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#list_rag_files VertexRagDataService.ListRagFiles}.
|
214
|
+
# @!attribute [rw] rag_files
|
215
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::RagFile>]
|
216
|
+
# List of RagFiles in the requested page.
|
217
|
+
# @!attribute [rw] next_page_token
|
218
|
+
# @return [::String]
|
219
|
+
# A token to retrieve the next page of results.
|
220
|
+
# Pass to
|
221
|
+
# {::Google::Cloud::AIPlatform::V1::ListRagFilesRequest#page_token ListRagFilesRequest.page_token}
|
222
|
+
# to obtain that page.
|
223
|
+
class ListRagFilesResponse
|
224
|
+
include ::Google::Protobuf::MessageExts
|
225
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
226
|
+
end
|
227
|
+
|
228
|
+
# Request message for
|
229
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#delete_rag_file VertexRagDataService.DeleteRagFile}.
|
230
|
+
# @!attribute [rw] name
|
231
|
+
# @return [::String]
|
232
|
+
# Required. The name of the RagFile resource to be deleted.
|
233
|
+
# Format:
|
234
|
+
# `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
|
235
|
+
class DeleteRagFileRequest
|
236
|
+
include ::Google::Protobuf::MessageExts
|
237
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
238
|
+
end
|
239
|
+
|
240
|
+
# Runtime operation information for
|
241
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#create_rag_corpus VertexRagDataService.CreateRagCorpus}.
|
242
|
+
# @!attribute [rw] generic_metadata
|
243
|
+
# @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
|
244
|
+
# The operation generic information.
|
245
|
+
class CreateRagCorpusOperationMetadata
|
246
|
+
include ::Google::Protobuf::MessageExts
|
247
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
248
|
+
end
|
249
|
+
|
250
|
+
# Request message for
|
251
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#update_rag_corpus VertexRagDataService.UpdateRagCorpus}.
|
252
|
+
# @!attribute [rw] rag_corpus
|
253
|
+
# @return [::Google::Cloud::AIPlatform::V1::RagCorpus]
|
254
|
+
# Required. The RagCorpus which replaces the resource on the server.
|
255
|
+
class UpdateRagCorpusRequest
|
256
|
+
include ::Google::Protobuf::MessageExts
|
257
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
258
|
+
end
|
259
|
+
|
260
|
+
# Runtime operation information for
|
261
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#update_rag_corpus VertexRagDataService.UpdateRagCorpus}.
|
262
|
+
# @!attribute [rw] generic_metadata
|
263
|
+
# @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
|
264
|
+
# The operation generic information.
|
265
|
+
class UpdateRagCorpusOperationMetadata
|
266
|
+
include ::Google::Protobuf::MessageExts
|
267
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
268
|
+
end
|
269
|
+
|
270
|
+
# Runtime operation information for
|
271
|
+
# {::Google::Cloud::AIPlatform::V1::VertexRagDataService::Client#import_rag_files VertexRagDataService.ImportRagFiles}.
|
272
|
+
# @!attribute [rw] generic_metadata
|
273
|
+
# @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
|
274
|
+
# The operation generic information.
|
275
|
+
# @!attribute [rw] rag_corpus_id
|
276
|
+
# @return [::Integer]
|
277
|
+
# The resource ID of RagCorpus that this operation is executed on.
|
278
|
+
# @!attribute [r] import_rag_files_config
|
279
|
+
# @return [::Google::Cloud::AIPlatform::V1::ImportRagFilesConfig]
|
280
|
+
# Output only. The config that was passed in the ImportRagFilesRequest.
|
281
|
+
# @!attribute [rw] progress_percentage
|
282
|
+
# @return [::Integer]
|
283
|
+
# The progress percentage of the operation. Value is in the range [0, 100].
|
284
|
+
# This percentage is calculated as follows:
|
285
|
+
# progress_percentage = 100 * (successes + failures + skips) / total
|
286
|
+
class ImportRagFilesOperationMetadata
|
287
|
+
include ::Google::Protobuf::MessageExts
|
288
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
289
|
+
end
|
290
|
+
end
|
291
|
+
end
|
292
|
+
end
|
293
|
+
end
|