Vector Search API: Nodejs Client
This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.
Vector Search API client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG.
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
Quickstart
Before you begin
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Vector Search API API.
- Set up authentication so you can access the API from your local workstation. ### Installing the client library
npm install @google-cloud/vectorsearch
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| aggregate data objects | source code |
| batch search data objects | source code |
| query data objects | source code |
| search data objects | source code |
| batch create data objects | source code |
| batch delete data objects | source code |
| batch update data objects | source code |
| create data object | source code |
| delete data object | source code |
| get data object | source code |
| update data object | source code |
| cloud | source code |
| create collection | source code |
| create index | source code |
| delete collection | source code |
| delete index | source code |
| get collection | source code |
| get index | source code |
| import data objects | source code |
| list collections | source code |
| list indexes | source code |
| update collection | source code |
Supported Node.js Versions
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:
- Legacy versions are not tested in continuous integration.
- Some security patches and features cannot be backported.
- Dependencies cannot be kept up-to-date.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm dist-tags.
The dist-tags follow the naming convention legacy-(version).
For example, npm install @google-cloud/vectorsearch@legacy-8 installs client libraries
for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template.
License
Apache Version 2.0
See LICENSE