@google-cloud/discoveryengine
TypeScript icon, indicating that this package has built-in type declarations

1.10.0 • Public • Published

Google Cloud Platform logo

release level npm version

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

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Discovery Engine API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/discoveryengine

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent branch resource name, such as
 *  `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`.
 *  Use `default_branch` as the branch ID, to list documents under the default
 *  branch.
 *  If the caller does not have permission to list Documents  s under this
 *  branch, regardless of whether or not this branch exists, a
 *  PERMISSION_DENIED error is returned.
 */
// const parent = 'abc123'
/**
 *  Maximum number of Document google.cloud.discoveryengine.v1beta.Document s
 *  to return. If unspecified, defaults to 100. The maximum allowed value is
 *  1000. Values above 1000 will be coerced to 1000.
 *  If this field is negative, an INVALID_ARGUMENT error is returned.
 */
// const pageSize = 1234
/**
 *  A page token
 *  ListDocumentsResponse.next_page_token google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token,
 *  received from a previous
 *  DocumentService.ListDocuments google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments
 *  call. Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to
 *  DocumentService.ListDocuments google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments
 *  must match the call that provided the page token. Otherwise, an
 *  INVALID_ARGUMENT error is returned.
 */
// const pageToken = 'abc123'

// Imports the Discoveryengine library
const {DocumentServiceClient} =
  require('@google-cloud/discoveryengine').v1beta;

// Instantiates a client
const discoveryengineClient = new DocumentServiceClient();

async function callListDocuments() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = await discoveryengineClient.listDocumentsAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListDocuments();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Completion_service.complete_query source code Open in Cloud Shell
Completion_service.import_completion_suggestions source code Open in Cloud Shell
Completion_service.import_suggestion_deny_list_entries source code Open in Cloud Shell
Completion_service.purge_completion_suggestions source code Open in Cloud Shell
Completion_service.purge_suggestion_deny_list_entries source code Open in Cloud Shell
Control_service.create_control source code Open in Cloud Shell
Control_service.delete_control source code Open in Cloud Shell
Control_service.get_control source code Open in Cloud Shell
Control_service.list_controls source code Open in Cloud Shell
Control_service.update_control source code Open in Cloud Shell
Conversational_search_service.answer_query source code Open in Cloud Shell
Conversational_search_service.converse_conversation source code Open in Cloud Shell
Conversational_search_service.create_conversation source code Open in Cloud Shell
Conversational_search_service.create_session source code Open in Cloud Shell
Conversational_search_service.delete_conversation source code Open in Cloud Shell
Conversational_search_service.delete_session source code Open in Cloud Shell
Conversational_search_service.get_answer source code Open in Cloud Shell
Conversational_search_service.get_conversation source code Open in Cloud Shell
Conversational_search_service.get_session source code Open in Cloud Shell
Conversational_search_service.list_conversations source code Open in Cloud Shell
Conversational_search_service.list_sessions source code Open in Cloud Shell
Conversational_search_service.update_conversation source code Open in Cloud Shell
Conversational_search_service.update_session source code Open in Cloud Shell
Data_store_service.create_data_store source code Open in Cloud Shell
Data_store_service.delete_data_store source code Open in Cloud Shell
Data_store_service.get_data_store source code Open in Cloud Shell
Data_store_service.list_data_stores source code Open in Cloud Shell
Data_store_service.update_data_store source code Open in Cloud Shell
Document_service.create_document source code Open in Cloud Shell
Document_service.delete_document source code Open in Cloud Shell
Document_service.get_document source code Open in Cloud Shell
Document_service.import_documents source code Open in Cloud Shell
Document_service.list_documents source code Open in Cloud Shell
Document_service.purge_documents source code Open in Cloud Shell
Document_service.update_document source code Open in Cloud Shell
Engine_service.create_engine source code Open in Cloud Shell
Engine_service.delete_engine source code Open in Cloud Shell
Engine_service.get_engine source code Open in Cloud Shell
Engine_service.list_engines source code Open in Cloud Shell
Engine_service.update_engine source code Open in Cloud Shell
Grounded_generation_service.check_grounding source code Open in Cloud Shell
Project_service.provision_project source code Open in Cloud Shell
Rank_service.rank source code Open in Cloud Shell
Recommendation_service.recommend source code Open in Cloud Shell
Schema_service.create_schema source code Open in Cloud Shell
Schema_service.delete_schema source code Open in Cloud Shell
Schema_service.get_schema source code Open in Cloud Shell
Schema_service.list_schemas source code Open in Cloud Shell
Schema_service.update_schema source code Open in Cloud Shell
Search_service.search source code Open in Cloud Shell
Site_search_engine_service.batch_create_target_sites source code Open in Cloud Shell
Site_search_engine_service.batch_verify_target_sites source code Open in Cloud Shell
Site_search_engine_service.create_target_site source code Open in Cloud Shell
Site_search_engine_service.delete_target_site source code Open in Cloud Shell
Site_search_engine_service.disable_advanced_site_search source code Open in Cloud Shell
Site_search_engine_service.enable_advanced_site_search source code Open in Cloud Shell
Site_search_engine_service.fetch_domain_verification_status source code Open in Cloud Shell
Site_search_engine_service.get_site_search_engine source code Open in Cloud Shell
Site_search_engine_service.get_target_site source code Open in Cloud Shell
Site_search_engine_service.list_target_sites source code Open in Cloud Shell
Site_search_engine_service.recrawl_uris source code Open in Cloud Shell
Site_search_engine_service.update_target_site source code Open in Cloud Shell
User_event_service.collect_user_event source code Open in Cloud Shell
User_event_service.import_user_events source code Open in Cloud Shell
User_event_service.write_user_event source code Open in Cloud Shell
Acl_config_service.get_acl_config source code Open in Cloud Shell
Acl_config_service.update_acl_config source code Open in Cloud Shell
Chunk_service.get_chunk source code Open in Cloud Shell
Chunk_service.list_chunks source code Open in Cloud Shell
Completion_service.complete_query source code Open in Cloud Shell
Completion_service.import_suggestion_deny_list_entries source code Open in Cloud Shell
Completion_service.purge_suggestion_deny_list_entries source code Open in Cloud Shell
Control_service.create_control source code Open in Cloud Shell
Control_service.delete_control source code Open in Cloud Shell
Control_service.get_control source code Open in Cloud Shell
Control_service.list_controls source code Open in Cloud Shell
Control_service.update_control source code Open in Cloud Shell
Conversational_search_service.answer_query source code Open in Cloud Shell
Conversational_search_service.converse_conversation source code Open in Cloud Shell
Conversational_search_service.create_conversation source code Open in Cloud Shell
Conversational_search_service.create_session source code Open in Cloud Shell
Conversational_search_service.delete_conversation source code Open in Cloud Shell
Conversational_search_service.delete_session source code Open in Cloud Shell
Conversational_search_service.get_answer source code Open in Cloud Shell
Conversational_search_service.get_conversation source code Open in Cloud Shell
Conversational_search_service.get_session source code Open in Cloud Shell
Conversational_search_service.list_conversations source code Open in Cloud Shell
Conversational_search_service.list_sessions source code Open in Cloud Shell
Conversational_search_service.update_conversation source code Open in Cloud Shell
Conversational_search_service.update_session source code Open in Cloud Shell
Data_store_service.create_data_store source code Open in Cloud Shell
Data_store_service.delete_data_store source code Open in Cloud Shell
Data_store_service.get_data_store source code Open in Cloud Shell
Data_store_service.get_document_processing_config source code Open in Cloud Shell
Data_store_service.list_data_stores source code Open in Cloud Shell
Data_store_service.update_data_store source code Open in Cloud Shell
Data_store_service.update_document_processing_config source code Open in Cloud Shell
Document_service.create_document source code Open in Cloud Shell
Document_service.delete_document source code Open in Cloud Shell
Document_service.get_document source code Open in Cloud Shell
Document_service.get_processed_document source code Open in Cloud Shell
Document_service.import_documents source code Open in Cloud Shell
Document_service.list_documents source code Open in Cloud Shell
Document_service.purge_documents source code Open in Cloud Shell
Document_service.update_document source code Open in Cloud Shell
Engine_service.create_engine source code Open in Cloud Shell
Engine_service.delete_engine source code Open in Cloud Shell
Engine_service.get_engine source code Open in Cloud Shell
Engine_service.list_engines source code Open in Cloud Shell
Engine_service.pause_engine source code Open in Cloud Shell
Engine_service.resume_engine source code Open in Cloud Shell
Engine_service.tune_engine source code Open in Cloud Shell
Engine_service.update_engine source code Open in Cloud Shell
Estimate_billing_service.estimate_data_size source code Open in Cloud Shell
Grounded_generation_service.check_grounding source code Open in Cloud Shell
Project_service.get_project source code Open in Cloud Shell
Project_service.provision_project source code Open in Cloud Shell
Project_service.report_consent_change source code Open in Cloud Shell
Rank_service.rank source code Open in Cloud Shell
Recommendation_service.recommend source code Open in Cloud Shell
Schema_service.create_schema source code Open in Cloud Shell
Schema_service.delete_schema source code Open in Cloud Shell
Schema_service.get_schema source code Open in Cloud Shell
Schema_service.list_schemas source code Open in Cloud Shell
Schema_service.update_schema source code Open in Cloud Shell
Search_service.search source code Open in Cloud Shell
Search_tuning_service.list_custom_models source code Open in Cloud Shell
Search_tuning_service.train_custom_model source code Open in Cloud Shell
Serving_config_service.get_serving_config source code Open in Cloud Shell
Serving_config_service.list_serving_configs source code Open in Cloud Shell
Serving_config_service.update_serving_config source code Open in Cloud Shell
Site_search_engine_service.batch_create_target_sites source code Open in Cloud Shell
Site_search_engine_service.batch_verify_target_sites source code Open in Cloud Shell
Site_search_engine_service.create_target_site source code Open in Cloud Shell
Site_search_engine_service.delete_target_site source code Open in Cloud Shell
Site_search_engine_service.disable_advanced_site_search source code Open in Cloud Shell
Site_search_engine_service.enable_advanced_site_search source code Open in Cloud Shell
Site_search_engine_service.fetch_domain_verification_status source code Open in Cloud Shell
Site_search_engine_service.get_site_search_engine source code Open in Cloud Shell
Site_search_engine_service.get_target_site source code Open in Cloud Shell
Site_search_engine_service.list_target_sites source code Open in Cloud Shell
Site_search_engine_service.recrawl_uris source code Open in Cloud Shell
Site_search_engine_service.update_target_site source code Open in Cloud Shell
User_event_service.collect_user_event source code Open in Cloud Shell
User_event_service.import_user_events source code Open in Cloud Shell
User_event_service.purge_user_events source code Open in Cloud Shell
User_event_service.write_user_event source code Open in Cloud Shell
Completion_service.complete_query source code Open in Cloud Shell
Completion_service.import_suggestion_deny_list_entries source code Open in Cloud Shell
Completion_service.purge_suggestion_deny_list_entries source code Open in Cloud Shell
Control_service.create_control source code Open in Cloud Shell
Control_service.delete_control source code Open in Cloud Shell
Control_service.get_control source code Open in Cloud Shell
Control_service.list_controls source code Open in Cloud Shell
Control_service.update_control source code Open in Cloud Shell
Conversational_search_service.answer_query source code Open in Cloud Shell
Conversational_search_service.converse_conversation source code Open in Cloud Shell
Conversational_search_service.create_conversation source code Open in Cloud Shell
Conversational_search_service.create_session source code Open in Cloud Shell
Conversational_search_service.delete_conversation source code Open in Cloud Shell
Conversational_search_service.delete_session source code Open in Cloud Shell
Conversational_search_service.get_answer source code Open in Cloud Shell
Conversational_search_service.get_conversation source code Open in Cloud Shell
Conversational_search_service.get_session source code Open in Cloud Shell
Conversational_search_service.list_conversations source code Open in Cloud Shell
Conversational_search_service.list_sessions source code Open in Cloud Shell
Conversational_search_service.update_conversation source code Open in Cloud Shell
Conversational_search_service.update_session source code Open in Cloud Shell
Data_store_service.create_data_store source code Open in Cloud Shell
Data_store_service.delete_data_store source code Open in Cloud Shell
Data_store_service.get_data_store source code Open in Cloud Shell
Data_store_service.list_data_stores source code Open in Cloud Shell
Data_store_service.update_data_store source code Open in Cloud Shell
Document_service.create_document source code Open in Cloud Shell
Document_service.delete_document source code Open in Cloud Shell
Document_service.get_document source code Open in Cloud Shell
Document_service.import_documents source code Open in Cloud Shell
Document_service.list_documents source code Open in Cloud Shell
Document_service.purge_documents source code Open in Cloud Shell
Document_service.update_document source code Open in Cloud Shell
Engine_service.create_engine source code Open in Cloud Shell
Engine_service.delete_engine source code Open in Cloud Shell
Engine_service.get_engine source code Open in Cloud Shell
Engine_service.list_engines source code Open in Cloud Shell
Engine_service.pause_engine source code Open in Cloud Shell
Engine_service.resume_engine source code Open in Cloud Shell
Engine_service.tune_engine source code Open in Cloud Shell
Engine_service.update_engine source code Open in Cloud Shell
Grounded_generation_service.check_grounding source code Open in Cloud Shell
Project_service.provision_project source code Open in Cloud Shell
Rank_service.rank source code Open in Cloud Shell
Recommendation_service.recommend source code Open in Cloud Shell
Schema_service.create_schema source code Open in Cloud Shell
Schema_service.delete_schema source code Open in Cloud Shell
Schema_service.get_schema source code Open in Cloud Shell
Schema_service.list_schemas source code Open in Cloud Shell
Schema_service.update_schema source code Open in Cloud Shell
Search_service.search source code Open in Cloud Shell
Search_tuning_service.list_custom_models source code Open in Cloud Shell
Search_tuning_service.train_custom_model source code Open in Cloud Shell
Serving_config_service.get_serving_config source code Open in Cloud Shell
Serving_config_service.list_serving_configs source code Open in Cloud Shell
Serving_config_service.update_serving_config source code Open in Cloud Shell
Site_search_engine_service.batch_create_target_sites source code Open in Cloud Shell
Site_search_engine_service.batch_verify_target_sites source code Open in Cloud Shell
Site_search_engine_service.create_target_site source code Open in Cloud Shell
Site_search_engine_service.delete_target_site source code Open in Cloud Shell
Site_search_engine_service.disable_advanced_site_search source code Open in Cloud Shell
Site_search_engine_service.enable_advanced_site_search source code Open in Cloud Shell
Site_search_engine_service.fetch_domain_verification_status source code Open in Cloud Shell
Site_search_engine_service.get_site_search_engine source code Open in Cloud Shell
Site_search_engine_service.get_target_site source code Open in Cloud Shell
Site_search_engine_service.list_target_sites source code Open in Cloud Shell
Site_search_engine_service.recrawl_uris source code Open in Cloud Shell
Site_search_engine_service.update_target_site source code Open in Cloud Shell
User_event_service.collect_user_event source code Open in Cloud Shell
User_event_service.import_user_events source code Open in Cloud Shell
User_event_service.write_user_event source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Discovery Engine API Node.js Client API Reference documentation also contains samples.

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.

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE

Package Sidebar

Install

npm i @google-cloud/discoveryengine

Weekly Downloads

7,098

Version

1.10.0

License

Apache-2.0

Unpacked Size

39.3 MB

Total Files

269

Last publish

Collaborators

  • google-wombot
  • google-admin