@google-cloud/discoveryengine

Discovery Engine API: Node.js Client

Discovery Engine API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Discovery Engine API Node.js Client API Reference
• Discovery Engine API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-discoveryengine

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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
Completion_service.import_completion_suggestions	source code
Completion_service.import_suggestion_deny_list_entries	source code
Completion_service.purge_completion_suggestions	source code
Completion_service.purge_suggestion_deny_list_entries	source code
Control_service.create_control	source code
Control_service.delete_control	source code
Control_service.get_control	source code
Control_service.list_controls	source code
Control_service.update_control	source code
Conversational_search_service.answer_query	source code
Conversational_search_service.converse_conversation	source code
Conversational_search_service.create_conversation	source code
Conversational_search_service.create_session	source code
Conversational_search_service.delete_conversation	source code
Conversational_search_service.delete_session	source code
Conversational_search_service.get_answer	source code
Conversational_search_service.get_conversation	source code
Conversational_search_service.get_session	source code
Conversational_search_service.list_conversations	source code
Conversational_search_service.list_sessions	source code
Conversational_search_service.update_conversation	source code
Conversational_search_service.update_session	source code
Data_store_service.create_data_store	source code
Data_store_service.delete_data_store	source code
Data_store_service.get_data_store	source code
Data_store_service.list_data_stores	source code
Data_store_service.update_data_store	source code
Document_service.batch_get_documents_metadata	source code
Document_service.create_document	source code
Document_service.delete_document	source code
Document_service.get_document	source code
Document_service.import_documents	source code
Document_service.list_documents	source code
Document_service.purge_documents	source code
Document_service.update_document	source code
Engine_service.create_engine	source code
Engine_service.delete_engine	source code
Engine_service.get_engine	source code
Engine_service.list_engines	source code
Engine_service.update_engine	source code
Grounded_generation_service.check_grounding	source code
Project_service.provision_project	source code
Rank_service.rank	source code
Recommendation_service.recommend	source code
Schema_service.create_schema	source code
Schema_service.delete_schema	source code
Schema_service.get_schema	source code
Schema_service.list_schemas	source code
Schema_service.update_schema	source code
Search_service.search	source code
Search_tuning_service.list_custom_models	source code
Search_tuning_service.train_custom_model	source code
Site_search_engine_service.batch_create_target_sites	source code
Site_search_engine_service.batch_verify_target_sites	source code
Site_search_engine_service.create_target_site	source code
Site_search_engine_service.delete_target_site	source code
Site_search_engine_service.disable_advanced_site_search	source code
Site_search_engine_service.enable_advanced_site_search	source code
Site_search_engine_service.fetch_domain_verification_status	source code
Site_search_engine_service.get_site_search_engine	source code
Site_search_engine_service.get_target_site	source code
Site_search_engine_service.list_target_sites	source code
Site_search_engine_service.recrawl_uris	source code
Site_search_engine_service.update_target_site	source code
User_event_service.collect_user_event	source code
User_event_service.import_user_events	source code
User_event_service.purge_user_events	source code
User_event_service.write_user_event	source code
Acl_config_service.get_acl_config	source code
Acl_config_service.update_acl_config	source code
Chunk_service.get_chunk	source code
Chunk_service.list_chunks	source code
Completion_service.complete_query	source code
Completion_service.import_completion_suggestions	source code
Completion_service.import_suggestion_deny_list_entries	source code
Completion_service.purge_completion_suggestions	source code
Completion_service.purge_suggestion_deny_list_entries	source code
Control_service.create_control	source code
Control_service.delete_control	source code
Control_service.get_control	source code
Control_service.list_controls	source code
Control_service.update_control	source code
Conversational_search_service.answer_query	source code
Conversational_search_service.converse_conversation	source code
Conversational_search_service.create_conversation	source code
Conversational_search_service.create_session	source code
Conversational_search_service.delete_conversation	source code
Conversational_search_service.delete_session	source code
Conversational_search_service.get_answer	source code
Conversational_search_service.get_conversation	source code
Conversational_search_service.get_session	source code
Conversational_search_service.list_conversations	source code
Conversational_search_service.list_sessions	source code
Conversational_search_service.update_conversation	source code
Conversational_search_service.update_session	source code
Data_store_service.create_data_store	source code
Data_store_service.delete_data_store	source code
Data_store_service.get_data_store	source code
Data_store_service.get_document_processing_config	source code
Data_store_service.list_data_stores	source code
Data_store_service.update_data_store	source code
Data_store_service.update_document_processing_config	source code
Document_service.batch_get_documents_metadata	source code
Document_service.create_document	source code
Document_service.delete_document	source code
Document_service.get_document	source code
Document_service.get_processed_document	source code
Document_service.import_documents	source code
Document_service.list_documents	source code
Document_service.purge_documents	source code
Document_service.update_document	source code
Engine_service.create_engine	source code
Engine_service.delete_engine	source code
Engine_service.get_engine	source code
Engine_service.list_engines	source code
Engine_service.pause_engine	source code
Engine_service.resume_engine	source code
Engine_service.tune_engine	source code
Engine_service.update_engine	source code
Estimate_billing_service.estimate_data_size	source code
Evaluation_service.create_evaluation	source code
Evaluation_service.get_evaluation	source code
Evaluation_service.list_evaluation_results	source code
Evaluation_service.list_evaluations	source code
Grounded_generation_service.check_grounding	source code
Project_service.get_project	source code
Project_service.provision_project	source code
Project_service.report_consent_change	source code
Rank_service.rank	source code
Recommendation_service.recommend	source code
Sample_query_service.create_sample_query	source code
Sample_query_service.delete_sample_query	source code
Sample_query_service.get_sample_query	source code
Sample_query_service.import_sample_queries	source code
Sample_query_service.list_sample_queries	source code
Sample_query_service.update_sample_query	source code
Sample_query_set_service.create_sample_query_set	source code
Sample_query_set_service.delete_sample_query_set	source code
Sample_query_set_service.get_sample_query_set	source code
Sample_query_set_service.list_sample_query_sets	source code
Sample_query_set_service.update_sample_query_set	source code
Schema_service.create_schema	source code
Schema_service.delete_schema	source code
Schema_service.get_schema	source code
Schema_service.list_schemas	source code
Schema_service.update_schema	source code
Search_service.search	source code
Search_tuning_service.list_custom_models	source code
Search_tuning_service.train_custom_model	source code
Serving_config_service.get_serving_config	source code
Serving_config_service.list_serving_configs	source code
Serving_config_service.update_serving_config	source code
Site_search_engine_service.batch_create_target_sites	source code
Site_search_engine_service.batch_verify_target_sites	source code
Site_search_engine_service.create_target_site	source code
Site_search_engine_service.delete_target_site	source code
Site_search_engine_service.disable_advanced_site_search	source code
Site_search_engine_service.enable_advanced_site_search	source code
Site_search_engine_service.fetch_domain_verification_status	source code
Site_search_engine_service.get_site_search_engine	source code
Site_search_engine_service.get_target_site	source code
Site_search_engine_service.get_uri_pattern_document_data	source code
Site_search_engine_service.list_target_sites	source code
Site_search_engine_service.recrawl_uris	source code
Site_search_engine_service.set_uri_pattern_document_data	source code
Site_search_engine_service.update_target_site	source code
User_event_service.collect_user_event	source code
User_event_service.import_user_events	source code
User_event_service.purge_user_events	source code
User_event_service.write_user_event	source code
Completion_service.complete_query	source code
Completion_service.import_completion_suggestions	source code
Completion_service.import_suggestion_deny_list_entries	source code
Completion_service.purge_completion_suggestions	source code
Completion_service.purge_suggestion_deny_list_entries	source code
Control_service.create_control	source code
Control_service.delete_control	source code
Control_service.get_control	source code
Control_service.list_controls	source code
Control_service.update_control	source code
Conversational_search_service.answer_query	source code
Conversational_search_service.converse_conversation	source code
Conversational_search_service.create_conversation	source code
Conversational_search_service.create_session	source code
Conversational_search_service.delete_conversation	source code
Conversational_search_service.delete_session	source code
Conversational_search_service.get_answer	source code
Conversational_search_service.get_conversation	source code
Conversational_search_service.get_session	source code
Conversational_search_service.list_conversations	source code
Conversational_search_service.list_sessions	source code
Conversational_search_service.update_conversation	source code
Conversational_search_service.update_session	source code
Data_store_service.create_data_store	source code
Data_store_service.delete_data_store	source code
Data_store_service.get_data_store	source code
Data_store_service.list_data_stores	source code
Data_store_service.update_data_store	source code
Document_service.batch_get_documents_metadata	source code
Document_service.create_document	source code
Document_service.delete_document	source code
Document_service.get_document	source code
Document_service.import_documents	source code
Document_service.list_documents	source code
Document_service.purge_documents	source code
Document_service.update_document	source code
Engine_service.create_engine	source code
Engine_service.delete_engine	source code
Engine_service.get_engine	source code
Engine_service.list_engines	source code
Engine_service.pause_engine	source code
Engine_service.resume_engine	source code
Engine_service.tune_engine	source code
Engine_service.update_engine	source code
Evaluation_service.create_evaluation	source code
Evaluation_service.get_evaluation	source code
Evaluation_service.list_evaluation_results	source code
Evaluation_service.list_evaluations	source code
Grounded_generation_service.check_grounding	source code
Project_service.provision_project	source code
Rank_service.rank	source code
Recommendation_service.recommend	source code
Sample_query_service.create_sample_query	source code
Sample_query_service.delete_sample_query	source code
Sample_query_service.get_sample_query	source code
Sample_query_service.import_sample_queries	source code
Sample_query_service.list_sample_queries	source code
Sample_query_service.update_sample_query	source code
Sample_query_set_service.create_sample_query_set	source code
Sample_query_set_service.delete_sample_query_set	source code
Sample_query_set_service.get_sample_query_set	source code
Sample_query_set_service.list_sample_query_sets	source code
Sample_query_set_service.update_sample_query_set	source code
Schema_service.create_schema	source code
Schema_service.delete_schema	source code
Schema_service.get_schema	source code
Schema_service.list_schemas	source code
Schema_service.update_schema	source code
Search_service.search	source code
Search_tuning_service.list_custom_models	source code
Search_tuning_service.train_custom_model	source code
Serving_config_service.get_serving_config	source code
Serving_config_service.list_serving_configs	source code
Serving_config_service.update_serving_config	source code
Site_search_engine_service.batch_create_target_sites	source code
Site_search_engine_service.batch_verify_target_sites	source code
Site_search_engine_service.create_target_site	source code
Site_search_engine_service.delete_target_site	source code
Site_search_engine_service.disable_advanced_site_search	source code
Site_search_engine_service.enable_advanced_site_search	source code
Site_search_engine_service.fetch_domain_verification_status	source code
Site_search_engine_service.get_site_search_engine	source code
Site_search_engine_service.get_target_site	source code
Site_search_engine_service.list_target_sites	source code
Site_search_engine_service.recrawl_uris	source code
Site_search_engine_service.update_target_site	source code
User_event_service.collect_user_event	source code
User_event_service.import_user_events	source code
User_event_service.purge_user_events	source code
User_event_service.write_user_event	source code
Quickstart	source code

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