This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority
Discovery Engine 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 Discovery Engine API API.
- Set up authentication so you can access the API from your local workstation. ### Installing the client library
npm install @google-cloud/discoveryengine
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| stream assist | source code |
| delete cmek config | source code |
| get cmek config | source code |
| list cmek configs | source code |
| update cmek config | source code |
| complete query | source code |
| import completion suggestions | source code |
| import suggestion deny list entries | source code |
| purge completion suggestions | source code |
| purge suggestion deny list entries | source code |
| create control | source code |
| delete control | source code |
| get control | source code |
| list controls | source code |
| update control | source code |
| answer query | source code |
| converse conversation | source code |
| create conversation | source code |
| create session | source code |
| delete conversation | source code |
| delete session | source code |
| get answer | source code |
| get conversation | source code |
| get session | source code |
| list conversations | source code |
| list sessions | source code |
| stream answer query | source code |
| update conversation | source code |
| update session | source code |
| create data store | source code |
| delete data store | source code |
| get data store | source code |
| list data stores | source code |
| update data store | source code |
| batch get documents metadata | source code |
| create document | source code |
| delete document | source code |
| get document | source code |
| import documents | source code |
| list documents | source code |
| purge documents | source code |
| update document | source code |
| create engine | source code |
| delete engine | source code |
| get engine | source code |
| list engines | source code |
| update engine | source code |
| check grounding | source code |
| generate grounded content | source code |
| stream generate grounded content | source code |
| create identity mapping store | source code |
| delete identity mapping store | source code |
| get identity mapping store | source code |
| import identity mappings | source code |
| list identity mapping stores | source code |
| list identity mappings | source code |
| purge identity mappings | source code |
| provision project | source code |
| rank | source code |
| recommend | source code |
| create schema | source code |
| delete schema | source code |
| get schema | source code |
| list schemas | source code |
| update schema | source code |
| search | source code |
| search lite | source code |
| list custom models | source code |
| train custom model | source code |
| update serving config | source code |
| create session | source code |
| delete session | source code |
| get session | source code |
| list sessions | source code |
| update session | source code |
| batch create target sites | source code |
| batch verify target sites | source code |
| create sitemap | source code |
| create target site | source code |
| delete sitemap | source code |
| delete target site | source code |
| disable advanced site search | source code |
| enable advanced site search | source code |
| fetch domain verification status | source code |
| fetch sitemaps | source code |
| get site search engine | source code |
| get target site | source code |
| list target sites | source code |
| recrawl uris | source code |
| update target site | source code |
| cloud | source code |
| collect user event | source code |
| import user events | source code |
| purge user events | source code |
| write user event | source code |
| batch update user licenses | source code |
| list user licenses | source code |
| get acl config | source code |
| update acl config | source code |
| get chunk | source code |
| list chunks | source code |
| complete query | source code |
| import completion suggestions | source code |
| import suggestion deny list entries | source code |
| purge completion suggestions | source code |
| purge suggestion deny list entries | source code |
| create control | source code |
| delete control | source code |
| get control | source code |
| list controls | source code |
| update control | source code |
| answer query | source code |
| converse conversation | source code |
| create conversation | source code |
| create session | source code |
| delete conversation | source code |
| delete session | source code |
| get answer | source code |
| get conversation | source code |
| get session | source code |
| list conversations | source code |
| list sessions | source code |
| update conversation | source code |
| update session | source code |
| create data store | source code |
| delete data store | source code |
| get data store | source code |
| get document processing config | source code |
| list data stores | source code |
| update data store | source code |
| update document processing config | source code |
| batch get documents metadata | source code |
| create document | source code |
| delete document | source code |
| get document | source code |
| get processed document | source code |
| import documents | source code |
| list documents | source code |
| purge documents | source code |
| update document | source code |
| create engine | source code |
| delete engine | source code |
| get engine | source code |
| list engines | source code |
| pause engine | source code |
| resume engine | source code |
| tune engine | source code |
| update engine | source code |
| estimate data size | source code |
| create evaluation | source code |
| get evaluation | source code |
| list evaluation results | source code |
| list evaluations | source code |
| check grounding | source code |
| get project | source code |
| provision project | source code |
| report consent change | source code |
| rank | source code |
| recommend | source code |
| create sample query | source code |
| delete sample query | source code |
| get sample query | source code |
| import sample queries | source code |
| list sample queries | source code |
| update sample query | source code |
| create sample query set | source code |
| delete sample query set | source code |
| get sample query set | source code |
| list sample query sets | source code |
| update sample query set | source code |
| create schema | source code |
| delete schema | source code |
| get schema | source code |
| list schemas | source code |
| update schema | source code |
| search | source code |
| list custom models | source code |
| train custom model | source code |
| get serving config | source code |
| list serving configs | source code |
| update serving config | source code |
| create session | source code |
| delete session | source code |
| get session | source code |
| list files | source code |
| list sessions | source code |
| update session | source code |
| batch create target sites | source code |
| batch verify target sites | source code |
| create target site | source code |
| delete target site | source code |
| disable advanced site search | source code |
| enable advanced site search | source code |
| fetch domain verification status | source code |
| get site search engine | source code |
| get target site | source code |
| get uri pattern document data | source code |
| list target sites | source code |
| recrawl uris | source code |
| set uri pattern document data | source code |
| update target site | source code |
| cloud | source code |
| collect user event | source code |
| import user events | source code |
| purge user events | source code |
| write user event | source code |
| advanced complete query | source code |
| complete query | source code |
| import completion suggestions | source code |
| import suggestion deny list entries | source code |
| purge completion suggestions | source code |
| purge suggestion deny list entries | source code |
| create control | source code |
| delete control | source code |
| get control | source code |
| list controls | source code |
| update control | source code |
| answer query | source code |
| converse conversation | source code |
| create conversation | source code |
| create session | source code |
| delete conversation | source code |
| delete session | source code |
| get answer | source code |
| get conversation | source code |
| get session | source code |
| list conversations | source code |
| list sessions | source code |
| update conversation | source code |
| update session | source code |
| create data store | source code |
| delete data store | source code |
| get data store | source code |
| list data stores | source code |
| update data store | source code |
| batch get documents metadata | source code |
| create document | source code |
| delete document | source code |
| get document | source code |
| import documents | source code |
| list documents | source code |
| purge documents | source code |
| update document | source code |
| create engine | source code |
| delete engine | source code |
| get engine | source code |
| list engines | source code |
| pause engine | source code |
| resume engine | source code |
| tune engine | source code |
| update engine | source code |
| create evaluation | source code |
| get evaluation | source code |
| list evaluation results | source code |
| list evaluations | source code |
| check grounding | source code |
| generate grounded content | source code |
| stream generate grounded content | source code |
| provision project | source code |
| rank | source code |
| recommend | source code |
| create sample query | source code |
| delete sample query | source code |
| get sample query | source code |
| import sample queries | source code |
| list sample queries | source code |
| update sample query | source code |
| create sample query set | source code |
| delete sample query set | source code |
| get sample query set | source code |
| list sample query sets | source code |
| update sample query set | source code |
| create schema | source code |
| delete schema | source code |
| get schema | source code |
| list schemas | source code |
| update schema | source code |
| search | source code |
| search lite | source code |
| list custom models | source code |
| train custom model | source code |
| get serving config | source code |
| list serving configs | source code |
| update serving config | source code |
| create session | source code |
| delete session | source code |
| get session | source code |
| list sessions | source code |
| update session | source code |
| batch create target sites | source code |
| batch verify target sites | source code |
| create sitemap | source code |
| create target site | source code |
| delete sitemap | source code |
| delete target site | source code |
| disable advanced site search | source code |
| enable advanced site search | source code |
| fetch domain verification status | source code |
| fetch sitemaps | source code |
| get site search engine | source code |
| get target site | source code |
| list target sites | source code |
| recrawl uris | source code |
| update target site | source code |
| cloud | source code |
| collect user event | source code |
| import user events | source code |
| purge user events | source code |
| write user event | 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/discoveryengine@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