@google-cloud/discoveryengine

中文文档
3.5.0发布于 2026/11/10Apache-2.0TypeScriptCommonJS近 30 天下载 65.5万

Discovery Engine API client for Node.js

原始使用文档
文档目录7 节
  1. Quickstart
  2. Before you begin
  3. Installing the client library
  4. Samples
  5. Supported Node.js Versions
  6. Versioning
  7. Contributing

Google Cloud Platform logo

[Discovery Engine API: Nodejs Client][homepage]

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

npm version

Discovery Engine API client for Node.js

A comprehensive list of changes in each version may be found in [the CHANGELOG][homepage_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

  1. [Select or create a Cloud Platform project][projects].
  2. [Enable billing for your project][billing].
  3. [Enable the Discovery Engine API API][enable_api].
  4. [Set up authentication][auth] 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/][homepage_samples] directory. Each sample's README.md has instructions for running its sample.

SampleSource Code
stream assistsource code
delete cmek configsource code
get cmek configsource code
list cmek configssource code
update cmek configsource code
complete querysource code
import completion suggestionssource code
import suggestion deny list entriessource code
purge completion suggestionssource code
purge suggestion deny list entriessource code
create controlsource code
delete controlsource code
get controlsource code
list controlssource code
update controlsource code
answer querysource code
converse conversationsource code
create conversationsource code
create sessionsource code
delete conversationsource code
delete sessionsource code
get answersource code
get conversationsource code
get sessionsource code
list conversationssource code
list sessionssource code
stream answer querysource code
update conversationsource code
update sessionsource code
create data storesource code
delete data storesource code
get data storesource code
list data storessource code
update data storesource code
batch get documents metadatasource code
create documentsource code
delete documentsource code
get documentsource code
import documentssource code
list documentssource code
purge documentssource code
update documentsource code
create enginesource code
delete enginesource code
get enginesource code
list enginessource code
update enginesource code
check groundingsource code
generate grounded contentsource code
stream generate grounded contentsource code
create identity mapping storesource code
delete identity mapping storesource code
get identity mapping storesource code
import identity mappingssource code
list identity mapping storessource code
list identity mappingssource code
purge identity mappingssource code
provision projectsource code
ranksource code
recommendsource code
create schemasource code
delete schemasource code
get schemasource code
list schemassource code
update schemasource code
searchsource code
search litesource code
list custom modelssource code
train custom modelsource code
update serving configsource code
create sessionsource code
delete sessionsource code
get sessionsource code
list sessionssource code
update sessionsource code
batch create target sitessource code
batch verify target sitessource code
create sitemapsource code
create target sitesource code
delete sitemapsource code
delete target sitesource code
disable advanced site searchsource code
enable advanced site searchsource code
fetch domain verification statussource code
fetch sitemapssource code
get site search enginesource code
get target sitesource code
list target sitessource code
recrawl urissource code
update target sitesource code
collect user eventsource code
import user eventssource code
purge user eventssource code
write user eventsource code
batch update user licensessource code
list user licensessource code
get acl configsource code
update acl configsource code
get chunksource code
list chunkssource code
complete querysource code
import completion suggestionssource code
import suggestion deny list entriessource code
purge completion suggestionssource code
purge suggestion deny list entriessource code
create controlsource code
delete controlsource code
get controlsource code
list controlssource code
update controlsource code
answer querysource code
converse conversationsource code
create conversationsource code
create sessionsource code
delete conversationsource code
delete sessionsource code
get answersource code
get conversationsource code
get sessionsource code
list conversationssource code
list sessionssource code
update conversationsource code
update sessionsource code
create data storesource code
delete data storesource code
get data storesource code
get document processing configsource code
list data storessource code
update data storesource code
update document processing configsource code
batch get documents metadatasource code
create documentsource code
delete documentsource code
get documentsource code
get processed documentsource code
import documentssource code
list documentssource code
purge documentssource code
update documentsource code
create enginesource code
delete enginesource code
get enginesource code
list enginessource code
pause enginesource code
resume enginesource code
tune enginesource code
update enginesource code
estimate data sizesource code
create evaluationsource code
get evaluationsource code
list evaluation resultssource code
list evaluationssource code
check groundingsource code
get projectsource code
provision projectsource code
report consent changesource code
ranksource code
recommendsource code
create sample querysource code
delete sample querysource code
get sample querysource code
import sample queriessource code
list sample queriessource code
update sample querysource code
create sample query setsource code
delete sample query setsource code
get sample query setsource code
list sample query setssource code
update sample query setsource code
create schemasource code
delete schemasource code
get schemasource code
list schemassource code
update schemasource code
searchsource code
list custom modelssource code
train custom modelsource code
get serving configsource code
list serving configssource code
update serving configsource code
create sessionsource code
delete sessionsource code
get sessionsource code
list filessource code
list sessionssource code
update sessionsource code
batch create target sitessource code
batch verify target sitessource code
create target sitesource code
delete target sitesource code
disable advanced site searchsource code
enable advanced site searchsource code
fetch domain verification statussource code
get site search enginesource code
get target sitesource code
get uri pattern document datasource code
list target sitessource code
recrawl urissource code
set uri pattern document datasource code
update target sitesource code
collect user eventsource code
import user eventssource code
purge user eventssource code
write user eventsource code
advanced complete querysource code
complete querysource code
import completion suggestionssource code
import suggestion deny list entriessource code
purge completion suggestionssource code
purge suggestion deny list entriessource code
create controlsource code
delete controlsource code
get controlsource code
list controlssource code
update controlsource code
answer querysource code
converse conversationsource code
create conversationsource code
create sessionsource code
delete conversationsource code
delete sessionsource code
get answersource code
get conversationsource code
get sessionsource code
list conversationssource code
list sessionssource code
update conversationsource code
update sessionsource code
create data storesource code
delete data storesource code
get data storesource code
list data storessource code
update data storesource code
batch get documents metadatasource code
create documentsource code
delete documentsource code
get documentsource code
import documentssource code
list documentssource code
purge documentssource code
update documentsource code
create enginesource code
delete enginesource code
get enginesource code
list enginessource code
pause enginesource code
resume enginesource code
tune enginesource code
update enginesource code
create evaluationsource code
get evaluationsource code
list evaluation resultssource code
list evaluationssource code
check groundingsource code
generate grounded contentsource code
stream generate grounded contentsource code
provision projectsource code
ranksource code
recommendsource code
create sample querysource code
delete sample querysource code
get sample querysource code
import sample queriessource code
list sample queriessource code
update sample querysource code
create sample query setsource code
delete sample query setsource code
get sample query setsource code
list sample query setssource code
update sample query setsource code
create schemasource code
delete schemasource code
get schemasource code
list schemassource code
update schemasource code
searchsource code
search litesource code
list custom modelssource code
train custom modelsource code
get serving configsource code
list serving configssource code
update serving configsource code
create sessionsource code
delete sessionsource code
get sessionsource code
list sessionssource code
update sessionsource code
batch create target sitessource code
batch verify target sitessource code
create sitemapsource code
create target sitesource code
delete sitemapsource code
delete target sitesource code
disable advanced site searchsource code
enable advanced site searchsource code
fetch domain verification statussource code
fetch sitemapssource code
get site search enginesource code
get target sitesource code
list target sitessource code
recrawl urissource code
update target sitesource code
collect user eventsource code
import user eventssource code
purge user eventssource code
write user eventsource 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](h

版本与发布记录

@google-cloud/discoveryengine 共发布 49 个版本,首次发布于 2022/10/20;过去 12 个月发布了 12 个版本。

版本发布日期距今
3.5.0latest2026/11/107 天前
3.4.02026/10/131 个月前
3.3.12026/09/291 个月前
3.3.02026/09/231 个月前
3.2.02026/09/092 个月前
3.1.02026/09/032 个月前

其他发布通道:legacy-12 → 0.8.0,legacy-18 → 2.9.0。

关于 @google-cloud/discoveryengine 的常见问题

@google-cloud/discoveryengine 是什么?

Discovery Engine API client for Node.js

如何安装 @google-cloud/discoveryengine?

在项目目录运行 npm install @google-cloud/discoveryengine,或使用 pnpm add / yarn add / bun add。

@google-cloud/discoveryengine 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@google-cloud/discoveryengine 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@google-cloud/discoveryengine 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@google-cloud/discoveryengine 可以商用吗?

@google-cloud/discoveryengine 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@google-cloud/discoveryengine 的下载量有多少?

根据 npm 官方下载统计,@google-cloud/discoveryengine 在 2026/10/17 – 2026/11/15 这 30 天内被下载 655,071 次,日均约 21,836 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@google-cloud/discoveryengine 还在维护吗?

最新版本 3.5.0 发布于 2026/11/10(7 天前);至今共发布 49 个版本,其中过去 12 个月发布了 12 个;首次发布于 2022/10/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。