search_service.search_lite.js

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **



'use strict';

function main(servingConfig) {
  // [START discoveryengine_v1_generated_SearchService_SearchLite_async]
  /**
   * 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 resource name of the Search serving config, such as
   *  `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
   *  or
   *  `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
   *  This field is used to identify the serving configuration name, set
   *  of models used to make the search.
   */
  // const servingConfig = 'abc123'
  /**
   *  The branch resource name, such as
   *  `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
   *  Use `default_branch` as the branch ID or leave this field empty, to search
   *  documents under the default branch.
   */
  // const branch = 'abc123'
  /**
   *  Raw search query.
   */
  // const query = 'abc123'
  /**
   *  Raw image query.
   */
  // const imageQuery = {}
  /**
   *  Maximum number of Document google.cloud.discoveryengine.v1.Document s to
   *  return. The maximum allowed value depends on the data type. Values above
   *  the maximum value are coerced to the maximum value.
   *  * Websites with basic indexing: Default `10`, Maximum `25`.
   *  * Websites with advanced indexing: Default `25`, Maximum `50`.
   *  * Other: Default `50`, Maximum `100`.
   *  If this field is negative, an  `INVALID_ARGUMENT` is returned.
   */
  // const pageSize = 1234
  /**
   *  A page token received from a previous
   *  SearchService.Search google.cloud.discoveryengine.v1.SearchService.Search 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  SearchService.Search google.cloud.discoveryengine.v1.SearchService.Search 
   *  must match the call that provided the page token. Otherwise, an
   *   `INVALID_ARGUMENT`  error is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  A 0-indexed integer that specifies the current offset (that is, starting
   *  result location, amongst the
   *  Document google.cloud.discoveryengine.v1.Document s deemed by the API as
   *  relevant) in search results. This field is only considered if
   *  page_token google.cloud.discoveryengine.v1.SearchRequest.page_token  is
   *  unset.
   *  If this field is negative, an  `INVALID_ARGUMENT`  is returned.
   */
  // const offset = 1234
  /**
   *  The maximum number of results to return for OneBox.
   *  This applies to each OneBox type individually.
   *  Default number is 10.
   */
  // const oneBoxPageSize = 1234
  /**
   *  Specs defining dataStores to filter on in a search call and configurations
   *  for those dataStores. This is only considered for engines with multiple
   *  dataStores use case. For single dataStore within an engine, they should
   *  use the specs at the top level.
   */
  // const dataStoreSpecs = [1,2,3,4]
  /**
   *  The filter syntax consists of an expression language for constructing a
   *  predicate from one or more fields of the documents being filtered. Filter
   *  expression is case-sensitive.
   *  If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
   *  Filtering in Vertex AI Search is done by mapping the LHS filter key to a
   *  key property defined in the Vertex AI Search backend -- this mapping is
   *  defined by the customer in their schema. For example a media customer might
   *  have a field 'name' in their schema. In this case the filter would look
   *  like this: filter --> name:'ANY("king kong")'
   *  For more information about filtering including syntax and filter
   *  operators, see
   *  Filter (https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
   */
  // const filter = 'abc123'
  /**
   *  The default filter that is applied when a user performs a search without
   *  checking any filters on the search page.
   *  The filter applied to every search request when quality improvement such as
   *  query expansion is needed. In the case a query does not have a sufficient
   *  amount of results this filter will be used to determine whether or not to
   *  enable the query expansion flow. The original filter will still be used for
   *  the query expanded search.
   *  This field is strongly recommended to achieve high search quality.
   *  For more information about filter syntax, see
   *  SearchRequest.filter google.cloud.discoveryengine.v1.SearchRequest.filter.
   */
  // const canonicalFilter = 'abc123'
  /**
   *  The order in which documents are returned. Documents can be ordered by
   *  a field in an Document google.cloud.discoveryengine.v1.Document  object.
   *  Leave it unset if ordered by relevance. `order_by` expression is
   *  case-sensitive.
   *  For more information on ordering the website search results, see
   *  Order web search
   *  results (https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
   *  For more information on ordering the healthcare search results, see
   *  Order healthcare search
   *  results (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
   *  If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   */
  // const orderBy = 'abc123'
  /**
   *  Information about the end user.
   *  Highly recommended for analytics.
   *  UserInfo.user_agent google.cloud.discoveryengine.v1.UserInfo.user_agent 
   *  is used to deduce `device_type` for analytics.
   */
  // const userInfo = {}
  /**
   *  The BCP-47 language code, such as "en-US" or "sr-Latn". For more
   *  information, see Standard
   *  fields (https://cloud.google.com/apis/design/standard_fields). This field
   *  helps to better interpret the query. If a value isn't specified, the query
   *  language code is automatically detected, which may not be accurate.
   */
  // const languageCode = 'abc123'
  /**
   *  Facet specifications for faceted search. If empty, no facets are returned.
   *  A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
   *  error is returned.
   */
  // const facetSpecs = [1,2,3,4]
  /**
   *  Boost specification to boost certain documents.
   *  For more information on boosting, see
   *  Boosting (https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
   */
  // const boostSpec = {}
  /**
   *  Additional search parameters.
   *  For public website search only, supported values are:
   *  * `user_country_code`: string. Default empty. If set to non-empty, results
   *     are restricted or boosted based on the location provided.
   *     For example, `user_country_code: "au"`
   *     For available codes see Country
   *     Codes (https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
   *  * `search_type`: double. Default empty. Enables non-webpage searching
   *     depending on the value. The only valid non-default value is 1,
   *     which enables image searching.
   *     For example, `search_type: 1`
   */
  // const params = [1,2,3,4]
  /**
   *  The query expansion specification that specifies the conditions under which
   *  query expansion occurs.
   */
  // const queryExpansionSpec = {}
  /**
   *  The spell correction specification that specifies the mode under
   *  which spell correction takes effect.
   */
  // const spellCorrectionSpec = {}
  /**
   *  A unique identifier for tracking visitors. For example, this could be
   *  implemented with an HTTP cookie, which should be able to uniquely identify
   *  a visitor on a single device. This unique identifier should not change if
   *  the visitor logs in or out of the website.
   *  This field should NOT have a fixed value such as `unknown_visitor`.
   *  This should be the same identifier as
   *  UserEvent.user_pseudo_id google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id 
   *  and
   *  CompleteQueryRequest.user_pseudo_id google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id 
   *  The field must be a UTF-8 encoded string with a length limit of 128
   *  characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
   */
  // const userPseudoId = 'abc123'
  /**
   *  A specification for configuring the behavior of content search.
   */
  // const contentSearchSpec = {}
  /**
   *  Whether to turn on safe search. This is only supported for
   *  website search.
   */
  // const safeSearch = true
  /**
   *  The user labels applied to a resource must meet the following requirements:
   *  * Each resource can have multiple labels, up to a maximum of 64.
   *  * Each label must be a key-value pair.
   *  * Keys have a minimum length of 1 character and a maximum length of 63
   *    characters and cannot be empty. Values can be empty and have a maximum
   *    length of 63 characters.
   *  * Keys and values can contain only lowercase letters, numeric characters,
   *    underscores, and dashes. All characters must use UTF-8 encoding, and
   *    international characters are allowed.
   *  * The key portion of a label must be unique. However, you can use the same
   *    key with multiple resources.
   *  * Keys must start with a lowercase letter or international character.
   *  See Google Cloud
   *  Document (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
   *  for more details.
   */
  // const userLabels = [1,2,3,4]
  /**
   *  Search as you type configuration. Only supported for the
   *  IndustryVertical.MEDIA google.cloud.discoveryengine.v1.IndustryVertical.MEDIA 
   *  vertical.
   */
  // const searchAsYouTypeSpec = {}
  /**
   *  The session resource name. Optional.
   *  Session allows users to do multi-turn /search API calls or coordination
   *  between /search API calls and /answer API calls.
   *  Example #1 (multi-turn /search API calls):
   *    1. Call /search API with the auto-session mode (see below).
   *    2. Call /search API with the session ID generated in the first call.
   *       Here, the previous search query gets considered in query
   *       standing. I.e., if the first query is "How did Alphabet do in 2022?"
   *       and the current query is "How about 2023?", the current query will
   *       be interpreted as "How did Alphabet do in 2023?".
   *  Example #2 (coordination between /search API calls and /answer API calls):
   *    1. Call /search API with the auto-session mode (see below).
   *    2. Call /answer API with the session ID generated in the first call.
   *       Here, the answer generation happens in the context of the search
   *       results from the first search call.
   *  Auto-session mode: when `projects/.../sessions/-` is used, a new session
   *  gets automatically created. Otherwise, users can use the create-session API
   *  to create a session manually.
   *  Multi-turn Search feature is currently at private GA stage. Please use
   *  v1alpha or v1beta version instead before we launch this feature to public
   *  GA. Or ask for allowlisting through Google Support team.
   */
  // const session = 'abc123'
  /**
   *  Session specification.
   *  Can be used only when `session` is set.
   */
  // const sessionSpec = {}

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

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

  async function callSearchLite() {
    // Construct request
    const request = {
      servingConfig,
    };

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

  callSearchLite();
  // [END discoveryengine_v1_generated_SearchService_SearchLite_async]
}

process.on('unhandledRejection', err => {
  console.error(err.message);
  process.exitCode = 1;
});
main(...process.argv.slice(2));