google-cloud-vector_search-v1 0.a → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +153 -8
- data/lib/google/cloud/vector_search/v1/bindings_override.rb +75 -0
- data/lib/google/cloud/vector_search/v1/data_object_search_service/client.rb +851 -0
- data/lib/google/cloud/vector_search/v1/data_object_search_service/credentials.rb +47 -0
- data/lib/google/cloud/vector_search/v1/data_object_search_service/paths.rb +73 -0
- data/lib/google/cloud/vector_search/v1/data_object_search_service/rest/client.rb +788 -0
- data/lib/google/cloud/vector_search/v1/data_object_search_service/rest/service_stub.rb +329 -0
- data/lib/google/cloud/vector_search/v1/data_object_search_service/rest.rb +53 -0
- data/lib/google/cloud/vector_search/v1/data_object_search_service.rb +55 -0
- data/lib/google/cloud/vector_search/v1/data_object_service/client.rb +1115 -0
- data/lib/google/cloud/vector_search/v1/data_object_service/credentials.rb +47 -0
- data/lib/google/cloud/vector_search/v1/data_object_service/paths.rb +73 -0
- data/lib/google/cloud/vector_search/v1/data_object_service/rest/client.rb +1031 -0
- data/lib/google/cloud/vector_search/v1/data_object_service/rest/service_stub.rb +513 -0
- data/lib/google/cloud/vector_search/v1/data_object_service/rest.rb +53 -0
- data/lib/google/cloud/vector_search/v1/data_object_service.rb +55 -0
- data/lib/google/cloud/vector_search/v1/rest.rb +40 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service/client.rb +1831 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service/credentials.rb +47 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service/operations.rb +843 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service/paths.rb +111 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service/rest/client.rb +1712 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service/rest/operations.rb +927 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service/rest/service_stub.rb +819 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service/rest.rb +58 -0
- data/lib/google/cloud/vector_search/v1/vector_search_service.rb +60 -0
- data/lib/google/cloud/vector_search/v1/version.rb +7 -2
- data/lib/google/cloud/vector_search/v1.rb +47 -0
- data/lib/google/cloud/vectorsearch/v1/common_pb.rb +21 -0
- data/lib/google/cloud/vectorsearch/v1/data_object_pb.rb +29 -0
- data/lib/google/cloud/vectorsearch/v1/data_object_search_service_pb.rb +53 -0
- data/lib/google/cloud/vectorsearch/v1/data_object_search_service_services_pb.rb +51 -0
- data/lib/google/cloud/vectorsearch/v1/data_object_service_pb.rb +37 -0
- data/lib/google/cloud/vectorsearch/v1/data_object_service_services_pb.rb +57 -0
- data/lib/google/cloud/vectorsearch/v1/embedding_config_pb.rb +24 -0
- data/lib/google/cloud/vectorsearch/v1/encryption_spec_pb.rb +24 -0
- data/lib/google/cloud/vectorsearch/v1/vectorsearch_service_pb.rb +69 -0
- data/lib/google/cloud/vectorsearch/v1/vectorsearch_service_services_pb.rb +71 -0
- data/lib/google-cloud-vector_search-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +593 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/vectorsearch/v1/common.rb +38 -0
- data/proto_docs/google/cloud/vectorsearch/v1/data_object.rb +104 -0
- data/proto_docs/google/cloud/vectorsearch/v1/data_object_search_service.rb +455 -0
- data/proto_docs/google/cloud/vectorsearch/v1/data_object_service.rb +156 -0
- data/proto_docs/google/cloud/vectorsearch/v1/embedding_config.rb +82 -0
- data/proto_docs/google/cloud/vectorsearch/v1/encryption_spec.rb +40 -0
- data/proto_docs/google/cloud/vectorsearch/v1/vectorsearch_service.rb +723 -0
- data/proto_docs/google/longrunning/operations.rb +191 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/struct.rb +108 -0
- data/proto_docs/google/protobuf/timestamp.rb +128 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- metadata +122 -9
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 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 VectorSearch
|
|
23
|
+
module V1
|
|
24
|
+
# Message describing the configuration for generating embeddings for a vector
|
|
25
|
+
# field using Vertex AI embeddings API.
|
|
26
|
+
# @!attribute [rw] model_id
|
|
27
|
+
# @return [::String]
|
|
28
|
+
# Required. Required: ID of the embedding model to use. See
|
|
29
|
+
# https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models
|
|
30
|
+
# for the list of supported models.
|
|
31
|
+
# @!attribute [rw] text_template
|
|
32
|
+
# @return [::String]
|
|
33
|
+
# Optional. Text template for the input to the model. The template must
|
|
34
|
+
# contain one or more references to fields in the DataObject, e.g.: "Movie
|
|
35
|
+
# Title: \\{title} ---- Movie Plot: \\{plot}".
|
|
36
|
+
#
|
|
37
|
+
# Required when using the text-only path.
|
|
38
|
+
# @!attribute [rw] task_type
|
|
39
|
+
# @return [::Google::Cloud::VectorSearch::V1::EmbeddingTaskType]
|
|
40
|
+
# Optional. Optional: Task type for the embeddings. Required for text-only
|
|
41
|
+
# embedding models, see
|
|
42
|
+
# https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/embeddings/task-types
|
|
43
|
+
# Not needed for multi modal embedding models, see
|
|
44
|
+
# https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/embeddings/get-multimodal-embeddings#specify-task-instructions
|
|
45
|
+
class VertexEmbeddingConfig
|
|
46
|
+
include ::Google::Protobuf::MessageExts
|
|
47
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Represents the task the embeddings will be used for.
|
|
51
|
+
module EmbeddingTaskType
|
|
52
|
+
# Unspecified task type.
|
|
53
|
+
EMBEDDING_TASK_TYPE_UNSPECIFIED = 0
|
|
54
|
+
|
|
55
|
+
# Specifies the given text is a query in a search/retrieval setting.
|
|
56
|
+
RETRIEVAL_QUERY = 1
|
|
57
|
+
|
|
58
|
+
# Specifies the given text is a document from the corpus being searched.
|
|
59
|
+
RETRIEVAL_DOCUMENT = 2
|
|
60
|
+
|
|
61
|
+
# Specifies the given text will be used for STS.
|
|
62
|
+
SEMANTIC_SIMILARITY = 3
|
|
63
|
+
|
|
64
|
+
# Specifies that the given text will be classified.
|
|
65
|
+
CLASSIFICATION = 4
|
|
66
|
+
|
|
67
|
+
# Specifies that the embeddings will be used for clustering.
|
|
68
|
+
CLUSTERING = 5
|
|
69
|
+
|
|
70
|
+
# Specifies that the embeddings will be used for question answering.
|
|
71
|
+
QUESTION_ANSWERING = 6
|
|
72
|
+
|
|
73
|
+
# Specifies that the embeddings will be used for fact verification.
|
|
74
|
+
FACT_VERIFICATION = 7
|
|
75
|
+
|
|
76
|
+
# Specifies that the embeddings will be used for code retrieval.
|
|
77
|
+
CODE_RETRIEVAL_QUERY = 8
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 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 VectorSearch
|
|
23
|
+
module V1
|
|
24
|
+
# Represents a customer-managed encryption key specification that can be
|
|
25
|
+
# applied to a Vector Search collection.
|
|
26
|
+
# @!attribute [rw] crypto_key_name
|
|
27
|
+
# @return [::String]
|
|
28
|
+
# Required. Resource name of the Cloud KMS key used to protect the resource.
|
|
29
|
+
#
|
|
30
|
+
# The Cloud KMS key must be in the same region as the resource. It must have
|
|
31
|
+
# the format
|
|
32
|
+
# `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
|
|
33
|
+
class EncryptionSpec
|
|
34
|
+
include ::Google::Protobuf::MessageExts
|
|
35
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|