Class v2.CompletionServiceClient (1.5.0)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

completionServiceStub

completionServiceStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

catalogPath(project, location, catalog)

catalogPath(project: string, location: string, catalog: string): string;

checkImportCompletionDataProgress(name)

checkImportCompletionDataProgress(name: string): Promise<LROperation<protos.google.cloud.retail.v2.ImportCompletionDataResponse, protos.google.cloud.retail.v2.ImportMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The catalog which the suggestions dataset belongs to.
   *  Format: `projects/1234/locations/global/catalogs/default_catalog`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The desired input location of the data.
   */
  // const inputConfig = {}
  /**
   *  Pub/Sub topic for receiving notification. If this field is set,
   *  when the import is finished, a notification will be sent to
   *  specified Pub/Sub topic. The message data will be JSON string of a
   *  Operation google.longrunning.Operation.
   *  Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
   */
  // const notificationPubsubTopic = 'abc123'

  // Imports the Retail library
  const {CompletionServiceClient} = require('@google-cloud/retail').v2;

  // Instantiates a client
  const retailClient = new CompletionServiceClient();

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

    // Run request
    const [operation] = await retailClient.importCompletionData(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportCompletionData();

close()

close(): Promise<void>;

completeQuery(request, options)

completeQuery(request?: protos.google.cloud.retail.v2.ICompleteQueryRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.ICompleteQueryResponse,
        protos.google.cloud.retail.v2.ICompleteQueryRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Catalog for which the completion is performed.
   *  Full resource name of catalog, such as
   *  `projects/* /locations/global/catalogs/default_catalog`.
   */
  // const catalog = 'abc123'
  /**
   *  Required. The query used to generate suggestions.
   *  The maximum number of allowed characters is 255.
   */
  // const query = 'abc123'
  /**
   *  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.
   *  The field must be a UTF-8 encoded string with a length limit of 128
   *  characters. Otherwise, an INVALID_ARGUMENT error is returned.
   */
  // const visitorId = 'abc123'
  /**
   *  The list of languages of the query. This is
   *  the BCP-47 language code, such as "en-US" or "sr-Latn".
   *  For more information, see
   *  Tags for Identifying Languages (https://tools.ietf.org/html/bcp47).
   *  The maximum number of allowed characters is 255.
   *  Only "en-US" is currently supported.
   */
  // const languageCodes = 'abc123'
  /**
   *  The device type context for completion suggestions.
   *  It is useful to apply different suggestions on different device types, e.g.
   *  `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
   *  types.
   *  Supported formats:
   *  * `UNKNOWN_DEVICE_TYPE`
   *  * `DESKTOP`
   *  * `MOBILE`
   *  * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
   */
  // const deviceType = 'abc123'
  /**
   *  Determines which dataset to use for fetching completion. "user-data" will
   *  use the imported dataset through
   *  CompletionService.ImportCompletionData google.cloud.retail.v2.CompletionService.ImportCompletionData.
   *  "cloud-retail" will use the dataset generated by cloud retail based on user
   *  events. If leave empty, it will use the "user-data".
   *  Current supported values:
   *  * user-data
   *  * cloud-retail
   *    This option requires additional allowlisting. Before using cloud-retail,
   *    contact Cloud Retail support team first.
   */
  // const dataset = 'abc123'
  /**
   *  Completion max suggestions. If left unset or set to 0, then will fallback
   *  to the configured value CompletionConfig.max_suggestions .
   *  The maximum allowed max suggestions is 20. If it is set higher, it will be
   *  capped by 20.
   */
  // const maxSuggestions = 1234

  // Imports the Retail library
  const {CompletionServiceClient} = require('@google-cloud/retail').v2;

  // Instantiates a client
  const retailClient = new CompletionServiceClient();

  async function callCompleteQuery() {
    // Construct request
    const request = {
      catalog,
      query,
    };

    // Run request
    const response = await retailClient.completeQuery(request);
    console.log(response);
  }

  callCompleteQuery();

completeQuery(request, options, callback)

completeQuery(request: protos.google.cloud.retail.v2.ICompleteQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.ICompleteQueryResponse, protos.google.cloud.retail.v2.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;

completeQuery(request, callback)

completeQuery(request: protos.google.cloud.retail.v2.ICompleteQueryRequest, callback: Callback<protos.google.cloud.retail.v2.ICompleteQueryResponse, protos.google.cloud.retail.v2.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

importCompletionData(request, options)

importCompletionData(request?: protos.google.cloud.retail.v2.IImportCompletionDataRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse, protos.google.cloud.retail.v2.IImportMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The catalog which the suggestions dataset belongs to.
   *  Format: `projects/1234/locations/global/catalogs/default_catalog`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The desired input location of the data.
   */
  // const inputConfig = {}
  /**
   *  Pub/Sub topic for receiving notification. If this field is set,
   *  when the import is finished, a notification will be sent to
   *  specified Pub/Sub topic. The message data will be JSON string of a
   *  Operation google.longrunning.Operation.
   *  Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
   */
  // const notificationPubsubTopic = 'abc123'

  // Imports the Retail library
  const {CompletionServiceClient} = require('@google-cloud/retail').v2;

  // Instantiates a client
  const retailClient = new CompletionServiceClient();

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

    // Run request
    const [operation] = await retailClient.importCompletionData(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportCompletionData();

importCompletionData(request, options, callback)

importCompletionData(request: protos.google.cloud.retail.v2.IImportCompletionDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse, protos.google.cloud.retail.v2.IImportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

importCompletionData(request, callback)

importCompletionData(request: protos.google.cloud.retail.v2.IImportCompletionDataRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse, protos.google.cloud.retail.v2.IImportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

matchBranchFromProductName(productName)

matchBranchFromProductName(productName: string): string | number;

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName: string): string | number;

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName: string): string | number;

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName: string): string | number;

matchLocationFromProductName(productName)

matchLocationFromProductName(productName: string): string | number;

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName: string): string | number;

matchProjectFromProductName(productName)

matchProjectFromProductName(productName: string): string | number;

productPath(project, location, catalog, branch, product)

productPath(project: string, location: string, catalog: string, branch: string, product: string): string;