-
Notifications
You must be signed in to change notification settings - Fork 440
feat(vectorsearch): generate library #16012
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
scotthart
merged 4 commits into
googleapis:main
from
scotthart:feat-vectorsearch-generate-library
Feb 27, 2026
+17,679
−0
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| @googleapis//google/api:annotations_proto | ||
| @googleapis//google/api:client_proto | ||
| @googleapis//google/api:field_behavior_proto | ||
| @googleapis//google/api:field_info_proto | ||
| @googleapis//google/api:http_proto | ||
| @googleapis//google/api:launch_stage_proto | ||
| @googleapis//google/api:resource_proto | ||
| @googleapis//google/longrunning:operations_proto | ||
| @googleapis//google/rpc:status_proto |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| @googleapis//google/cloud/vectorsearch/v1:common.proto | ||
| @googleapis//google/cloud/vectorsearch/v1:data_object.proto | ||
| @googleapis//google/cloud/vectorsearch/v1:data_object_search_service.proto | ||
| @googleapis//google/cloud/vectorsearch/v1:data_object_service.proto | ||
| @googleapis//google/cloud/vectorsearch/v1:embedding_config.proto | ||
| @googleapis//google/cloud/vectorsearch/v1:vectorsearch_service.proto |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| load("//bazel:gapic.bzl", "cc_gapic_library") | ||
|
|
||
| package(default_visibility = ["//visibility:private"]) | ||
|
|
||
| licenses(["notice"]) # Apache 2.0 | ||
|
|
||
| service_dirs = ["v1/"] | ||
|
|
||
| googleapis_deps = [ | ||
| "@googleapis//google/cloud/vectorsearch/v1:vectorsearch_cc_grpc", | ||
| ] | ||
|
|
||
| cc_gapic_library( | ||
| name = "vectorsearch", | ||
| googleapis_deps = googleapis_deps, | ||
| service_dirs = service_dirs, | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # ~~~ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # ~~~ | ||
|
|
||
| include(GoogleCloudCppLibrary) | ||
|
|
||
| google_cloud_cpp_add_gapic_library(vectorsearch "Vector Search API" | ||
| SERVICE_DIRS "v1/") | ||
|
|
||
| if (BUILD_TESTING AND GOOGLE_CLOUD_CPP_ENABLE_CXX_EXCEPTIONS) | ||
| add_executable(vectorsearch_quickstart "quickstart/quickstart.cc") | ||
| target_link_libraries(vectorsearch_quickstart | ||
| PRIVATE google-cloud-cpp::vectorsearch) | ||
| google_cloud_cpp_add_common_options(vectorsearch_quickstart) | ||
| add_test( | ||
| NAME vectorsearch_quickstart | ||
| COMMAND | ||
| cmake -P "${PROJECT_SOURCE_DIR}/cmake/quickstart-runner.cmake" | ||
| $<TARGET_FILE:vectorsearch_quickstart> GOOGLE_CLOUD_PROJECT | ||
| GOOGLE_CLOUD_CPP_TEST_REGION) | ||
| set_tests_properties(vectorsearch_quickstart | ||
| PROPERTIES LABELS "integration-test;quickstart") | ||
| endif () |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Vector Search API C++ Client Library | ||
|
|
||
| This directory contains an idiomatic C++ client library for the | ||
| [Vector Search API][cloud-service-docs]. | ||
|
|
||
| The Vector Search API provides a fully-managed, highly performant, and scalable | ||
| vector database designed to power next-generation search, recommendation, and | ||
| generative AI applications. It allows you to store, index, and query your data | ||
| and its corresponding vector embeddings through a simple, intuitive interface. | ||
| With Vector Search, you can define custom schemas for your data, insert objects | ||
| with associated metadata, automatically generate embeddings from your data, and | ||
| perform fast approximate nearest neighbor (ANN) searches to find semantically | ||
| similar items at scale. | ||
|
|
||
| While this library is **GA**, please note that the Google Cloud C++ client | ||
| libraries do **not** follow [Semantic Versioning](https://semver.org/). | ||
|
|
||
| ## Quickstart | ||
|
|
||
| The [quickstart/](quickstart/README.md) directory contains a minimal environment | ||
| to get started using this client library in a larger project. The following | ||
| "Hello World" program is used in this quickstart, and should give you a taste of | ||
| this library. | ||
|
|
||
| <!-- inject-quickstart-start --> | ||
|
|
||
| ```cc | ||
| #include "google/cloud/vectorsearch/v1/vector_search_client.h" | ||
| #include "google/cloud/location.h" | ||
| #include <iostream> | ||
|
|
||
| int main(int argc, char* argv[]) try { | ||
| if (argc != 3) { | ||
| std::cerr << "Usage: " << argv[0] << " project-id location-id\n"; | ||
| return 1; | ||
| } | ||
|
|
||
| auto const location = google::cloud::Location(argv[1], argv[2]); | ||
|
|
||
| namespace vectorsearch = ::google::cloud::vectorsearch_v1; | ||
| auto client = vectorsearch::VectorSearchServiceClient( | ||
| vectorsearch::MakeVectorSearchServiceConnection()); | ||
|
|
||
| for (auto r : client.ListCollections(location.FullName())) { | ||
| if (!r) throw std::move(r).status(); | ||
| std::cout << r->DebugString() << "\n"; | ||
| } | ||
|
|
||
| return 0; | ||
| } catch (google::cloud::Status const& status) { | ||
| std::cerr << "google::cloud::Status thrown: " << status << "\n"; | ||
| return 1; | ||
| } | ||
| ``` | ||
|
|
||
| <!-- inject-quickstart-end --> | ||
|
|
||
| ## More Information | ||
|
|
||
| - Official documentation about the [Vector Search API][cloud-service-docs] | ||
| service | ||
| - [Reference doxygen documentation][doxygen-link] for each release of this | ||
| client library | ||
| - Detailed header comments in our [public `.h`][source-link] files | ||
|
|
||
| [cloud-service-docs]: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview | ||
| [doxygen-link]: https://cloud.google.com/cpp/docs/reference/vectorsearch/latest/ | ||
| [source-link]: https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/vectorsearch |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /*! | ||
| @page vectorsearch-env Environment Variables | ||
|
|
||
| A number of environment variables can be used to configure the behavior of | ||
| the library. There are also functions to configure this behavior in code. The | ||
| environment variables are convenient when troubleshooting problems. | ||
|
|
||
| @section vectorsearch-env-endpoint Endpoint Overrides | ||
|
|
||
| <!-- inject-endpoint-env-vars-start --> | ||
|
|
||
| - `GOOGLE_CLOUD_CPP_DATA_OBJECT_SEARCH_SERVICE_ENDPOINT=...` overrides the | ||
| `EndpointOption` (which defaults to "vectorsearch.googleapis.com") | ||
| used by `MakeDataObjectSearchServiceConnection()`. | ||
|
|
||
| - `GOOGLE_CLOUD_CPP_DATA_OBJECT_SERVICE_ENDPOINT=...` overrides the | ||
| `EndpointOption` (which defaults to "vectorsearch.googleapis.com") | ||
| used by `MakeDataObjectServiceConnection()`. | ||
|
|
||
| - `GOOGLE_CLOUD_CPP_VECTOR_SEARCH_SERVICE_ENDPOINT=...` overrides the | ||
| `EndpointOption` (which defaults to "vectorsearch.googleapis.com") | ||
| used by `MakeVectorSearchServiceConnection()`. | ||
|
|
||
| <!-- inject-endpoint-env-vars-end --> | ||
|
|
||
| @see google::cloud::EndpointOption | ||
|
|
||
| @section vectorsearch-env-logging Logging | ||
|
|
||
| `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC | ||
| calls. The library injects an additional Stub decorator that prints each gRPC | ||
| request and response. Unless you have configured your own logging backend, | ||
| you should also set `GOOGLE_CLOUD_CPP_ENABLE_CLOG` to produce any output on | ||
| the program's console. | ||
|
|
||
| @see google::cloud::LoggingComponentsOption | ||
|
|
||
| `GOOGLE_CLOUD_CPP_TRACING_OPTIONS=...`: modifies the behavior of gRPC tracing, | ||
| including whether messages will be output on multiple lines, or whether | ||
| string/bytes fields will be truncated. | ||
|
|
||
| @see google::cloud::GrpcTracingOptionsOption | ||
|
|
||
| `GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes`: turns on logging in the library, basically | ||
| the library always "logs" but the logging infrastructure has no backend to | ||
| actually print anything until the application sets a backend or they set this | ||
| environment variable. | ||
|
|
||
| @see google::cloud::LogBackend | ||
| @see google::cloud::LogSink | ||
|
|
||
| @section vectorsearch-env-project Setting the Default Project | ||
|
|
||
| `GOOGLE_CLOUD_PROJECT=...`: is used in examples and integration tests to | ||
| configure the GCP project. This has no effect in the library. | ||
|
|
||
| */ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| /*! | ||
|
|
||
| @mainpage Vector Search API C++ Client Library | ||
|
|
||
| An idiomatic C++ client library for the [Vector Search API][cloud-service-docs]. | ||
|
|
||
| The Vector Search API provides a fully-managed, highly performant, and | ||
| scalable vector database designed to power next-generation search, | ||
| recommendation, and generative AI applications. It allows you to store, | ||
| index, and query your data and its corresponding vector embeddings through | ||
| a simple, intuitive interface. With Vector Search, you can define custom | ||
| schemas for your data, insert objects with associated metadata, | ||
| automatically generate embeddings from your data, and perform fast | ||
| approximate nearest neighbor (ANN) searches to find semantically similar | ||
| items at scale. | ||
|
|
||
| While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow | ||
| [Semantic Versioning](https://semver.org/). | ||
|
|
||
| @tableofcontents{HTML:2} | ||
|
|
||
| ## Quickstart | ||
|
|
||
| The following shows the code that you'll run in the | ||
| `google/cloud/vectorsearch/quickstart/` directory, | ||
| which should give you a taste of the Vector Search API C++ client library API. | ||
|
|
||
| @snippet quickstart.cc all | ||
|
|
||
| ## Main classes | ||
|
|
||
| <!-- inject-client-list-start --> | ||
| This library offers multiple `*Client` classes, which are listed below. Each one | ||
| of these classes exposes all the RPCs for a service as member functions of the | ||
| class. This library groups multiple services because they are part of the same | ||
| product or are often used together. A typical example may be the administrative | ||
| and data plane operations for a single product. | ||
|
|
||
| The library also has other classes that provide helpers, configuration | ||
| parameters, and infrastructure to mock the `*Client` classes when testing your | ||
| application. | ||
|
|
||
| - [\c vectorsearch_v1::DataObjectServiceClient](@ref google::cloud::vectorsearch_v1::DataObjectServiceClient) | ||
| - [\c vectorsearch_v1::DataObjectSearchServiceClient](@ref google::cloud::vectorsearch_v1::DataObjectSearchServiceClient) | ||
| - [\c vectorsearch_v1::VectorSearchServiceClient](@ref google::cloud::vectorsearch_v1::VectorSearchServiceClient) | ||
| <!-- inject-client-list-end --> | ||
|
|
||
| ## More Information | ||
|
|
||
| - @ref common-error-handling - describes how the library reports errors. | ||
| - @ref vectorsearch-override-endpoint - describes how to override the default | ||
| endpoint. | ||
| - @ref vectorsearch-override-authentication - describes how to change the | ||
| authentication credentials used by the library. | ||
| - @ref vectorsearch-override-retry - describes how to change the default retry | ||
| policies. | ||
| - @ref vectorsearch-env - describes environment variables that can configure the | ||
| behavior of the library. | ||
| - @ref vectorsearch-override-universe-domain - describes how to override the default universe domain. | ||
|
|
||
| [cloud-service-docs]: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview | ||
|
|
||
| */ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /*! | ||
| @defgroup google-cloud-vectorsearch-options Vector Search API Configuration Options | ||
|
|
||
| This library uses the same mechanism (`google::cloud::Options`) and the common | ||
| [options](@ref options) as all other C++ client libraries for its configuration. | ||
| Some `*Option` classes, which are only used in this library, are documented in | ||
| this page. | ||
|
|
||
| @see @ref options - for an overview of client library configuration. | ||
| */ |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
initial_copyright_yearis set to2026, which is in the future. This is likely a mistake and should be updated to the current year (e.g., 2024). This setting appears to be the root cause for the incorrect copyright year in all newly generated files in this pull request.