Class v1.ContactCenterInsightsClient (3.9.0)

An API that lets users analyze and explore their business conversation data. v1

Package

@google-cloud/contact-center-insights

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of ContactCenterInsightsClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ContactCenterInsightsClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

contactCenterInsightsStub

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

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

analysisRulePath(project, location, analysisRule)

analysisRulePath(project: string, location: string, analysisRule: string): string;

Return a fully-qualified analysisRule resource name string.

Parameters
Name Description
project string
location string
analysisRule string
Returns
Type Description
string

{string} Resource name string.

bulkAnalyzeConversations(request, options)

bulkAnalyzeConversations(request?: protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Analyzes multiple conversations in a single request.

Parameters
Name Description
request IBulkAnalyzeConversationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource to create analyses in.
   */
  // const parent = 'abc123'
  /**
   *  Required. Filter used to select the subset of conversations to analyze.
   */
  // const filter = 'abc123'
  /**
   *  Required. Percentage of selected conversation to analyze, between
   *  0, 100.
   */
  // const analysisPercentage = 1234
  /**
   *  To select the annotators to run and the phrase matchers to use
   *  (if any). If not specified, all annotators will be run.
   */
  // const annotatorSelector = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callBulkAnalyzeConversations() {
    // Construct request
    const request = {
      parent,
      filter,
      analysisPercentage,
    };

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

  callBulkAnalyzeConversations();

bulkAnalyzeConversations(request, options, callback)

bulkAnalyzeConversations(request: protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IBulkAnalyzeConversationsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

bulkAnalyzeConversations(request, callback)

bulkAnalyzeConversations(request: protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IBulkAnalyzeConversationsRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

bulkDeleteConversations(request, options)

bulkDeleteConversations(request?: protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes multiple conversations in a single request.

Parameters
Name Description
request IBulkDeleteConversationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource to delete conversations from.
   *  Format:
   *  projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Filter used to select the subset of conversations to delete.
   */
  // const filter = 'abc123'
  /**
   *  Maximum number of conversations to delete.
   */
  // const maxDeleteCount = 1234
  /**
   *  If set to true, all of this conversation's analyses will also be deleted.
   *  Otherwise, the request will only succeed if the conversation has no
   *  analyses.
   */
  // const force = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callBulkDeleteConversations();

bulkDeleteConversations(request, options, callback)

bulkDeleteConversations(request: protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IBulkDeleteConversationsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

bulkDeleteConversations(request, callback)

bulkDeleteConversations(request: protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IBulkDeleteConversationsRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

bulkDownloadFeedbackLabels(request, options)

bulkDownloadFeedbackLabels(request?: protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Download feedback labels in bulk.

Parameters
Name Description
request IBulkDownloadFeedbackLabelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  A cloud storage bucket destination.
   */
  // const gcsDestination = {}
  /**
   *  Required. The parent resource for new feedback labels.
   */
  // const parent = 'abc123'
  /**
   *  Optional. A filter to reduce results to a specific subset. Supports
   *  disjunctions (OR) and conjunctions (AND).
   *  Supported fields:
   *  * `issue_model_id`
   *  * `qa_question_id`
   *  * `qa_scorecard_id`
   *  * `min_create_time`
   *  * `max_create_time`
   *  * `min_update_time`
   *  * `max_update_time`
   *  * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
   */
  // const filter = 'abc123'
  /**
   *  Optional. Limits the maximum number of feedback labels that will be
   *  downloaded. The first `N` feedback labels will be downloaded.
   */
  // const maxDownloadCount = 1234
  /**
   *  Optional. The type of feedback labels that will be downloaded.
   */
  // const feedbackLabelType = {}
  /**
   *  Optional. Filter parent conversations to download feedback labels for.
   *  When specified, the feedback labels will be downloaded for the
   *  conversations that match the filter.
   *  If `template_qa_scorecard_id` is set, all the conversations that match the
   *  filter will be paired with the questions under the scorecard for labeling.
   */
  // const conversationFilter = 'abc123'
  /**
   *  Optional. If set, a template for labeling conversations and scorecard
   *  questions will be created from the conversation_filter and the questions
   *  under the scorecard(s). The feedback label `filter` will be ignored.
   */
  // const templateQaScorecardId = ['abc','def']

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callBulkDownloadFeedbackLabels();

bulkDownloadFeedbackLabels(request, options, callback)

bulkDownloadFeedbackLabels(request: protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IBulkDownloadFeedbackLabelsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

bulkDownloadFeedbackLabels(request, callback)

bulkDownloadFeedbackLabels(request: protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IBulkDownloadFeedbackLabelsRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDownloadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

bulkUploadFeedbackLabels(request, options)

bulkUploadFeedbackLabels(request?: protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Upload feedback labels in bulk.

Parameters
Name Description
request IBulkUploadFeedbackLabelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  A cloud storage bucket source.
   */
  // const gcsSource = {}
  /**
   *  Required. The parent resource for new feedback labels.
   */
  // const parent = 'abc123'
  /**
   *  Optional. If set, upload will not happen and the labels will be validated.
   *  If not set, then default behavior will be to upload the labels after
   *  validation is complete.
   */
  // const validateOnly = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callBulkUploadFeedbackLabels();

bulkUploadFeedbackLabels(request, options, callback)

bulkUploadFeedbackLabels(request: protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IBulkUploadFeedbackLabelsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

bulkUploadFeedbackLabels(request, callback)

bulkUploadFeedbackLabels(request: protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IBulkUploadFeedbackLabelsRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkUploadFeedbackLabelsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

calculateIssueModelStats(request, options)

calculateIssueModelStats(request?: protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsResponse,
        (protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest | undefined),
        {} | undefined
    ]>;

Gets an issue model's statistics.

Parameters
Name Description
request ICalculateIssueModelStatsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsResponse, (protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing CalculateIssueModelStatsResponse. Please see the documentation for more details and examples.

Example

  /**
   * 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 issue model to query against.
   */
  // const issueModel = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callCalculateIssueModelStats() {
    // Construct request
    const request = {
      issueModel,
    };

    // Run request
    const response = await contactcenterinsightsClient.calculateIssueModelStats(request);
    console.log(response);
  }

  callCalculateIssueModelStats();

calculateIssueModelStats(request, options, callback)

calculateIssueModelStats(request: protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICalculateIssueModelStatsRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

calculateIssueModelStats(request, callback)

calculateIssueModelStats(request: protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICalculateIssueModelStatsRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

calculateStats(request, options)

calculateStats(request?: protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.ICalculateStatsResponse,
        (protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest | undefined),
        {} | undefined
    ]>;

Gets conversation statistics.

Parameters
Name Description
request ICalculateStatsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.ICalculateStatsResponse, (protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 location of the conversations.
   */
  // const location = 'abc123'
  /**
   *  A filter to reduce results to a specific subset. This field is useful for
   *  getting statistics about conversations with specific properties.
   */
  // const filter = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callCalculateStats() {
    // Construct request
    const request = {
      location,
    };

    // Run request
    const response = await contactcenterinsightsClient.calculateStats(request);
    console.log(response);
  }

  callCalculateStats();

calculateStats(request, options, callback)

calculateStats(request: protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICalculateStatsRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

calculateStats(request, callback)

calculateStats(request: protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICalculateStatsRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkBulkAnalyzeConversationsProgress(name)

checkBulkAnalyzeConversationsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.BulkAnalyzeConversationsMetadata>>;

Check the status of the long running operation returned by bulkAnalyzeConversations().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.BulkAnalyzeConversationsMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource to create analyses in.
   */
  // const parent = 'abc123'
  /**
   *  Required. Filter used to select the subset of conversations to analyze.
   */
  // const filter = 'abc123'
  /**
   *  Required. Percentage of selected conversation to analyze, between
   *  0, 100.
   */
  // const analysisPercentage = 1234
  /**
   *  To select the annotators to run and the phrase matchers to use
   *  (if any). If not specified, all annotators will be run.
   */
  // const annotatorSelector = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callBulkAnalyzeConversations() {
    // Construct request
    const request = {
      parent,
      filter,
      analysisPercentage,
    };

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

  callBulkAnalyzeConversations();

checkBulkDeleteConversationsProgress(name)

checkBulkDeleteConversationsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.BulkDeleteConversationsMetadata>>;

Check the status of the long running operation returned by bulkDeleteConversations().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.BulkDeleteConversationsMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource to delete conversations from.
   *  Format:
   *  projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Filter used to select the subset of conversations to delete.
   */
  // const filter = 'abc123'
  /**
   *  Maximum number of conversations to delete.
   */
  // const maxDeleteCount = 1234
  /**
   *  If set to true, all of this conversation's analyses will also be deleted.
   *  Otherwise, the request will only succeed if the conversation has no
   *  analyses.
   */
  // const force = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callBulkDeleteConversations();

checkBulkDownloadFeedbackLabelsProgress(name)

checkBulkDownloadFeedbackLabelsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkDownloadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.BulkDownloadFeedbackLabelsMetadata>>;

Check the status of the long running operation returned by bulkDownloadFeedbackLabels().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkDownloadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.BulkDownloadFeedbackLabelsMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  A cloud storage bucket destination.
   */
  // const gcsDestination = {}
  /**
   *  Required. The parent resource for new feedback labels.
   */
  // const parent = 'abc123'
  /**
   *  Optional. A filter to reduce results to a specific subset. Supports
   *  disjunctions (OR) and conjunctions (AND).
   *  Supported fields:
   *  * `issue_model_id`
   *  * `qa_question_id`
   *  * `qa_scorecard_id`
   *  * `min_create_time`
   *  * `max_create_time`
   *  * `min_update_time`
   *  * `max_update_time`
   *  * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
   */
  // const filter = 'abc123'
  /**
   *  Optional. Limits the maximum number of feedback labels that will be
   *  downloaded. The first `N` feedback labels will be downloaded.
   */
  // const maxDownloadCount = 1234
  /**
   *  Optional. The type of feedback labels that will be downloaded.
   */
  // const feedbackLabelType = {}
  /**
   *  Optional. Filter parent conversations to download feedback labels for.
   *  When specified, the feedback labels will be downloaded for the
   *  conversations that match the filter.
   *  If `template_qa_scorecard_id` is set, all the conversations that match the
   *  filter will be paired with the questions under the scorecard for labeling.
   */
  // const conversationFilter = 'abc123'
  /**
   *  Optional. If set, a template for labeling conversations and scorecard
   *  questions will be created from the conversation_filter and the questions
   *  under the scorecard(s). The feedback label `filter` will be ignored.
   */
  // const templateQaScorecardId = ['abc','def']

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callBulkDownloadFeedbackLabels();

checkBulkUploadFeedbackLabelsProgress(name)

checkBulkUploadFeedbackLabelsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkUploadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.BulkUploadFeedbackLabelsMetadata>>;

Check the status of the long running operation returned by bulkUploadFeedbackLabels().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkUploadFeedbackLabelsResponse, protos.google.cloud.contactcenterinsights.v1.BulkUploadFeedbackLabelsMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  A cloud storage bucket source.
   */
  // const gcsSource = {}
  /**
   *  Required. The parent resource for new feedback labels.
   */
  // const parent = 'abc123'
  /**
   *  Optional. If set, upload will not happen and the labels will be validated.
   *  If not set, then default behavior will be to upload the labels after
   *  validation is complete.
   */
  // const validateOnly = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callBulkUploadFeedbackLabels();

checkCreateAnalysisProgress(name)

checkCreateAnalysisProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.Analysis, protos.google.cloud.contactcenterinsights.v1.CreateAnalysisOperationMetadata>>;

Check the status of the long running operation returned by createAnalysis().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.Analysis, protos.google.cloud.contactcenterinsights.v1.CreateAnalysisOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the analysis.
   */
  // const parent = 'abc123'
  /**
   *  Required. The analysis to create.
   */
  // const analysis = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callCreateAnalysis();

checkCreateIssueModelProgress(name)

checkCreateIssueModelProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.IssueModel, protos.google.cloud.contactcenterinsights.v1.CreateIssueModelMetadata>>;

Check the status of the long running operation returned by createIssueModel().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.IssueModel, protos.google.cloud.contactcenterinsights.v1.CreateIssueModelMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the issue model.
   */
  // const parent = 'abc123'
  /**
   *  Required. The issue model to create.
   */
  // const issueModel = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callCreateIssueModel();

checkDeleteIssueModelProgress(name)

checkDeleteIssueModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.contactcenterinsights.v1.DeleteIssueModelMetadata>>;

Check the status of the long running operation returned by deleteIssueModel().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.contactcenterinsights.v1.DeleteIssueModelMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the issue model to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteIssueModel() {
    // Construct request
    const request = {
      name,
    };

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

  callDeleteIssueModel();

checkDeployIssueModelProgress(name)

checkDeployIssueModelProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.DeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.DeployIssueModelMetadata>>;

Check the status of the long running operation returned by deployIssueModel().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.DeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.DeployIssueModelMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 issue model to deploy.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeployIssueModel() {
    // Construct request
    const request = {
      name,
    };

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

  callDeployIssueModel();

checkExportInsightsDataProgress(name)

checkExportInsightsDataProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.ExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.ExportInsightsDataMetadata>>;

Check the status of the long running operation returned by exportInsightsData().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.ExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.ExportInsightsDataMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  Specified if sink is a BigQuery table.
   */
  // const bigQueryDestination = {}
  /**
   *  Required. The parent resource to export data from.
   */
  // const parent = 'abc123'
  /**
   *  A filter to reduce results to a specific subset. Useful for exporting
   *  conversations with specific properties.
   */
  // const filter = 'abc123'
  /**
   *  A fully qualified KMS key name for BigQuery tables protected by CMEK.
   *  Format:
   *  projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}
   */
  // const kmsKey = 'abc123'
  /**
   *  Options for what to do if the destination table already exists.
   */
  // const writeDisposition = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callExportInsightsData();

checkExportIssueModelProgress(name)

checkExportIssueModelProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.ExportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.ExportIssueModelMetadata>>;

Check the status of the long running operation returned by exportIssueModel().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.ExportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.ExportIssueModelMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  Google Cloud Storage URI to export the issue model to.
   */
  // const gcsDestination = {}
  /**
   *  Required. The issue model to export.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callExportIssueModel() {
    // Construct request
    const request = {
      name,
    };

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

  callExportIssueModel();

checkImportIssueModelProgress(name)

checkImportIssueModelProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.ImportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.ImportIssueModelMetadata>>;

Check the status of the long running operation returned by importIssueModel().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.ImportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.ImportIssueModelMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  Google Cloud Storage source message.
   */
  // const gcsSource = {}
  /**
   *  Required. The parent resource of the issue model.
   */
  // const parent = 'abc123'
  /**
   *  Optional. If set to true, will create an issue model from the imported file
   *  with randomly generated IDs for the issue model and corresponding issues.
   *  Otherwise, replaces an existing model with the same ID as the file.
   */
  // const createNewModel = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callImportIssueModel();

checkIngestConversationsProgress(name)

checkIngestConversationsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.IngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IngestConversationsMetadata>>;

Check the status of the long running operation returned by ingestConversations().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.IngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IngestConversationsMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  A cloud storage bucket source. Note that any previously ingested objects
   *  from the source will be skipped to avoid duplication.
   */
  // const gcsSource = {}
  /**
   *  Configuration for when `source` contains conversation transcripts.
   */
  // const transcriptObjectConfig = {}
  /**
   *  Required. The parent resource for new conversations.
   */
  // const parent = 'abc123'
  /**
   *  Configuration that applies to all conversations.
   */
  // const conversationConfig = {}
  /**
   *  Optional. DLP settings for transcript redaction. Optional, will default to
   *  the config specified in Settings.
   */
  // const redactionConfig = {}
  /**
   *  Optional. Default Speech-to-Text configuration. Optional, will default to
   *  the config specified in Settings.
   */
  // const speechConfig = {}
  /**
   *  Optional. If set, this fields indicates the number of objects to ingest
   *  from the Cloud Storage bucket. If empty, the entire bucket will be
   *  ingested. Unless they are first deleted, conversations produced through
   *  sampling won't be ingested by subsequent ingest requests.
   */
  // const sampleSize = 1234

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callIngestConversations();

checkInitializeEncryptionSpecProgress(name)

checkInitializeEncryptionSpecProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecResponse, protos.google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecMetadata>>;

Check the status of the long running operation returned by initializeEncryptionSpec().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecResponse, protos.google.cloud.contactcenterinsights.v1.InitializeEncryptionSpecMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 encryption spec used for CMEK encryption. It is required that
   *  the kms key is in the same region as the endpoint. The same key will be
   *  used for all provisioned resources, if encryption is available. If the
   *  `kms_key_name` field is left empty, no encryption will be enforced.
   */
  // const encryptionSpec = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callInitializeEncryptionSpec() {
    // Construct request
    const request = {
      encryptionSpec,
    };

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

  callInitializeEncryptionSpec();

checkQueryMetricsProgress(name)

checkQueryMetricsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.QueryMetricsResponse, protos.google.cloud.contactcenterinsights.v1.QueryMetricsMetadata>>;

Check the status of the long running operation returned by queryMetrics().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.QueryMetricsResponse, protos.google.cloud.contactcenterinsights.v1.QueryMetricsMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 location of the data.
   *  "projects/{project}/locations/{location}"
   */
  // const location = 'abc123'
  /**
   *  Required. Filter to select a subset of conversations to compute the
   *  metrics. Must specify a window of the conversation create time to compute
   *  the metrics. The returned metrics will be from the range DATE(starting
   *  create time), DATE(ending create time)).
   */
  // const filter = 'abc123'
  /**
   *  The time granularity of each data point in the time series.
   *  Defaults to NONE if this field is unspecified.
   */
  // const timeGranularity = {}
  /**
   *  The dimensions that determine the grouping key for the query. Defaults to
   *  no dimension if this field is unspecified. If a dimension is specified,
   *  its key must also be specified. Each dimension's key must be unique.
   *  If a time granularity is also specified, metric values in the dimension
   *  will be bucketed by this granularity.
   *  Up to one dimension is supported for now.
   */
  // const dimensions = [1,2,3,4]
  /**
   *  Measures to return. Defaults to all measures if this field is unspecified.
   *  A valid mask should traverse from the `measure` field from the response.
   *  For example, a path from a measure mask to get the conversation count is
   *  "conversation_measure.count".
   */
  // const measureMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callQueryMetrics() {
    // Construct request
    const request = {
      location,
      filter,
    };

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

  callQueryMetrics();

checkTuneQaScorecardRevisionProgress(name)

checkTuneQaScorecardRevisionProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.TuneQaScorecardRevisionResponse, protos.google.cloud.contactcenterinsights.v1.TuneQaScorecardRevisionMetadata>>;

Check the status of the long running operation returned by tuneQaScorecardRevision().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.TuneQaScorecardRevisionResponse, protos.google.cloud.contactcenterinsights.v1.TuneQaScorecardRevisionMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource for new fine tuning job instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. Filter for selecting the feedback labels that needs to be
   *  used for training.
   *  This filter can be used to limit the feedback labels used for tuning to a
   *  feedback labels created or updated for a specific time-window etc.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Run in validate only mode, no fine tuning will actually run.
   *  Data quality validations like training data distributions will run.
   *  Even when set to false, the data quality validations will still run but
   *  once the validations complete we will proceed with the fine tune, if
   *  applicable.
   */
  // const validateOnly = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callTuneQaScorecardRevision();

checkUndeployIssueModelProgress(name)

checkUndeployIssueModelProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.UndeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.UndeployIssueModelMetadata>>;

Check the status of the long running operation returned by undeployIssueModel().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.UndeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.UndeployIssueModelMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 issue model to undeploy.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUndeployIssueModel() {
    // Construct request
    const request = {
      name,
    };

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

  callUndeployIssueModel();

checkUploadConversationProgress(name)

checkUploadConversationProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.Conversation, protos.google.cloud.contactcenterinsights.v1.UploadConversationMetadata>>;

Check the status of the long running operation returned by uploadConversation().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.Conversation, protos.google.cloud.contactcenterinsights.v1.UploadConversationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the conversation.
   */
  // const parent = 'abc123'
  /**
   *  Required. The conversation resource to create.
   */
  // const conversation = {}
  /**
   *  Optional. A unique ID for the new conversation. This ID will become the
   *  final component of the conversation's resource name. If no ID is specified,
   *  a server-generated ID will be used.
   *  This value should be 4-64 characters and must match the regular
   *  expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
   */
  // const conversationId = 'abc123'
  /**
   *  Optional. DLP settings for transcript redaction. Will default to the config
   *  specified in Settings.
   */
  // const redactionConfig = {}
  /**
   *  Optional. Speech-to-Text configuration. Will default to the config
   *  specified in Settings.
   */
  // const speechConfig = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callUploadConversation();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createAnalysis(request, options)

createAnalysis(request?: protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an analysis. The long running operation is done when the analysis has completed.

Parameters
Name Description
request ICreateAnalysisRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the analysis.
   */
  // const parent = 'abc123'
  /**
   *  Required. The analysis to create.
   */
  // const analysis = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callCreateAnalysis();

createAnalysis(request, options, callback)

createAnalysis(request: protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateAnalysisRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createAnalysis(request, callback)

createAnalysis(request: protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateAnalysisRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createAnalysisRule(request, options)

createAnalysisRule(request?: protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IAnalysisRule,
        (protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest | undefined),
        {} | undefined
    ]>;

Creates a analysis rule.

Parameters
Name Description
request ICreateAnalysisRuleRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, (protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing AnalysisRule. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the analysis rule. Required. The location
   *  to create a analysis rule for. Format: `projects/

createAnalysisRule(request, options, callback)

createAnalysisRule(request: protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateAnalysisRuleRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createAnalysisRule(request, callback)

createAnalysisRule(request: protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateAnalysisRuleRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRuleRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createConversation(request, options)

createConversation(request?: protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IConversation,
        (protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest | undefined),
        {} | undefined
    ]>;

Creates a conversation. Note that this method does not support audio transcription or redaction. Use conversations.upload instead.

Parameters
Name Description
request ICreateConversationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IConversation, (protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the conversation.
   */
  // const parent = 'abc123'
  /**
   *  Required. The conversation resource to create.
   */
  // const conversation = {}
  /**
   *  A unique ID for the new conversation. This ID will become the final
   *  component of the conversation's resource name. If no ID is specified, a
   *  server-generated ID will be used.
   *  This value should be 4-64 characters and must match the regular
   *  expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
   */
  // const conversationId = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

    // Run request
    const response = await contactcenterinsightsClient.createConversation(request);
    console.log(response);
  }

  callCreateConversation();

createConversation(request, options, callback)

createConversation(request: protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateConversationRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createConversation(request, callback)

createConversation(request: protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateConversationRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createFeedbackLabel(request, options)

createFeedbackLabel(request?: protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel,
        (protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest | undefined),
        {} | undefined
    ]>;

Create feedback label.

Parameters
Name Description
request ICreateFeedbackLabelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, (protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing FeedbackLabel. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the feedback label.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The ID of the feedback label to create.
   *  If one is not specified it will be generated by the server.
   */
  // const feedbackLabelId = 'abc123'
  /**
   *  Required. The feedback label to create.
   */
  // const feedbackLabel = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

    // Run request
    const response = await contactcenterinsightsClient.createFeedbackLabel(request);
    console.log(response);
  }

  callCreateFeedbackLabel();

createFeedbackLabel(request, options, callback)

createFeedbackLabel(request: protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateFeedbackLabelRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createFeedbackLabel(request, callback)

createFeedbackLabel(request: protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateFeedbackLabelRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.ICreateFeedbackLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createIssueModel(request, options)

createIssueModel(request?: protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an issue model.

Parameters
Name Description
request ICreateIssueModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the issue model.
   */
  // const parent = 'abc123'
  /**
   *  Required. The issue model to create.
   */
  // const issueModel = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callCreateIssueModel();

createIssueModel(request, options, callback)

createIssueModel(request: protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateIssueModelRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createIssueModel(request, callback)

createIssueModel(request: protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateIssueModelRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.ICreateIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createPhraseMatcher(request, options)

createPhraseMatcher(request?: protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher,
        (protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest | undefined),
        {} | undefined
    ]>;

Creates a phrase matcher.

Parameters
Name Description
request ICreatePhraseMatcherRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, (protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the phrase matcher. Required. The location
   *  to create a phrase matcher for. Format: `projects/

createPhraseMatcher(request, options, callback)

createPhraseMatcher(request: protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreatePhraseMatcherRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createPhraseMatcher(request, callback)

createPhraseMatcher(request: protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreatePhraseMatcherRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createQaQuestion(request, options)

createQaQuestion(request?: protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaQuestion,
        (protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest | undefined),
        {} | undefined
    ]>;

Create a QaQuestion.

Parameters
Name Description
request ICreateQaQuestionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaQuestion, (protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the QaQuestion.
   */
  // const parent = 'abc123'
  /**
   *  Required. The QaQuestion to create.
   */
  // const qaQuestion = {}
  /**
   *  Optional. A unique ID for the new question. This ID will become the final
   *  component of the question's resource name. If no ID is specified, a
   *  server-generated ID will be used.
   *  This value should be 4-64 characters and must match the regular
   *  expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`.
   */
  // const qaQuestionId = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

    // Run request
    const response = await contactcenterinsightsClient.createQaQuestion(request);
    console.log(response);
  }

  callCreateQaQuestion();

createQaQuestion(request, options, callback)

createQaQuestion(request: protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateQaQuestionRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createQaQuestion(request, callback)

createQaQuestion(request: protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateQaQuestionRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.ICreateQaQuestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createQaScorecard(request, options)

createQaScorecard(request?: protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecard,
        (protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest | undefined),
        {} | undefined
    ]>;

Create a QaScorecard.

Parameters
Name Description
request ICreateQaScorecardRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecard, (protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing QaScorecard. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the QaScorecard.
   */
  // const parent = 'abc123'
  /**
   *  Required. The QaScorecard to create.
   */
  // const qaScorecard = {}
  /**
   *  Optional. A unique ID for the new QaScorecard. This ID will become the
   *  final component of the QaScorecard's resource name. If no ID is specified,
   *  a server-generated ID will be used.
   *  This value should be 4-64 characters and must match the regular
   *  expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`.
   */
  // const qaScorecardId = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

    // Run request
    const response = await contactcenterinsightsClient.createQaScorecard(request);
    console.log(response);
  }

  callCreateQaScorecard();

createQaScorecard(request, options, callback)

createQaScorecard(request: protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateQaScorecardRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createQaScorecard(request, callback)

createQaScorecard(request: protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateQaScorecardRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createQaScorecardRevision(request, options)

createQaScorecardRevision(request?: protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision,
        (protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest | undefined),
        {} | undefined
    ]>;

Creates a QaScorecardRevision.

Parameters
Name Description
request ICreateQaScorecardRevisionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, (protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the QaScorecardRevision.
   */
  // const parent = 'abc123'
  /**
   *  Required. The QaScorecardRevision to create.
   */
  // const qaScorecardRevision = {}
  /**
   *  Optional. A unique ID for the new QaScorecardRevision. This ID will become
   *  the final component of the QaScorecardRevision's resource name. If no ID is
   *  specified, a server-generated ID will be used.
   *  This value should be 4-64 characters and must match the regular
   *  expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`.
   */
  // const qaScorecardRevisionId = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

    // Run request
    const response = await contactcenterinsightsClient.createQaScorecardRevision(request);
    console.log(response);
  }

  callCreateQaScorecardRevision();

createQaScorecardRevision(request, options, callback)

createQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateQaScorecardRevisionRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createQaScorecardRevision(request, callback)

createQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateQaScorecardRevisionRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.ICreateQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createView(request, options)

createView(request?: protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IView,
        (protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest | undefined),
        {} | undefined
    ]>;

Creates a view.

Parameters
Name Description
request ICreateViewRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IView, (protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing View. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the view. Required. The location to create
   *  a view for.
   *  Format: `projects/

createView(request, options, callback)

createView(request: protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateViewRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createView(request, callback)

createView(request: protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateViewRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.ICreateViewRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAnalysis(request, options)

deleteAnalysis(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest | undefined),
        {} | undefined
    ]>;

Deletes an analysis.

Parameters
Name Description
request IDeleteAnalysisRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the analysis to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteAnalysis() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteAnalysis(request);
    console.log(response);
  }

  callDeleteAnalysis();

deleteAnalysis(request, options, callback)

deleteAnalysis(request: protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteAnalysisRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAnalysis(request, callback)

deleteAnalysis(request: protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteAnalysisRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAnalysisRule(request, options)

deleteAnalysisRule(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest | undefined),
        {} | undefined
    ]>;

Deletes a analysis rule.

Parameters
Name Description
request IDeleteAnalysisRuleRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the analysis rule to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteAnalysisRule() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteAnalysisRule(request);
    console.log(response);
  }

  callDeleteAnalysisRule();

deleteAnalysisRule(request, options, callback)

deleteAnalysisRule(request: protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteAnalysisRuleRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAnalysisRule(request, callback)

deleteAnalysisRule(request: protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteAnalysisRuleRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRuleRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteConversation(request, options)

deleteConversation(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest | undefined),
        {} | undefined
    ]>;

Deletes a conversation.

Parameters
Name Description
request IDeleteConversationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the conversation to delete.
   */
  // const name = 'abc123'
  /**
   *  If set to true, all of this conversation's analyses will also be deleted.
   *  Otherwise, the request will only succeed if the conversation has no
   *  analyses.
   */
  // const force = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteConversation() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteConversation(request);
    console.log(response);
  }

  callDeleteConversation();

deleteConversation(request, options, callback)

deleteConversation(request: protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteConversationRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteConversation(request, callback)

deleteConversation(request: protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteConversationRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteFeedbackLabel(request, options)

deleteFeedbackLabel(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest | undefined),
        {} | undefined
    ]>;

Delete feedback label.

Parameters
Name Description
request IDeleteFeedbackLabelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the feedback label to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteFeedbackLabel() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteFeedbackLabel(request);
    console.log(response);
  }

  callDeleteFeedbackLabel();

deleteFeedbackLabel(request, options, callback)

deleteFeedbackLabel(request: protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteFeedbackLabelRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteFeedbackLabel(request, callback)

deleteFeedbackLabel(request: protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteFeedbackLabelRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteFeedbackLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteIssue(request, options)

deleteIssue(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | undefined),
        {} | undefined
    ]>;

Deletes an issue.

Parameters
Name Description
request IDeleteIssueRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the issue to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteIssue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteIssue(request);
    console.log(response);
  }

  callDeleteIssue();

deleteIssue(request, options, callback)

deleteIssue(request: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteIssueRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteIssue(request, callback)

deleteIssue(request: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteIssueRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteIssueModel(request, options)

deleteIssueModel(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes an issue model.

Parameters
Name Description
request IDeleteIssueModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the issue model to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteIssueModel() {
    // Construct request
    const request = {
      name,
    };

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

  callDeleteIssueModel();

deleteIssueModel(request, options, callback)

deleteIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteIssueModelRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteIssueModel(request, callback)

deleteIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteIssueModelRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request DeleteOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deletePhraseMatcher(request, options)

deletePhraseMatcher(request?: protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest | undefined),
        {} | undefined
    ]>;

Deletes a phrase matcher.

Parameters
Name Description
request IDeletePhraseMatcherRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the phrase matcher to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeletePhraseMatcher() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deletePhraseMatcher(request);
    console.log(response);
  }

  callDeletePhraseMatcher();

deletePhraseMatcher(request, options, callback)

deletePhraseMatcher(request: protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeletePhraseMatcherRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deletePhraseMatcher(request, callback)

deletePhraseMatcher(request: protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeletePhraseMatcherRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteQaQuestion(request, options)

deleteQaQuestion(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest | undefined),
        {} | undefined
    ]>;

Deletes a QaQuestion.

Parameters
Name Description
request IDeleteQaQuestionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the QaQuestion to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteQaQuestion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteQaQuestion(request);
    console.log(response);
  }

  callDeleteQaQuestion();

deleteQaQuestion(request, options, callback)

deleteQaQuestion(request: protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteQaQuestionRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteQaQuestion(request, callback)

deleteQaQuestion(request: protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteQaQuestionRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaQuestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteQaScorecard(request, options)

deleteQaScorecard(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest | undefined),
        {} | undefined
    ]>;

Deletes a QaScorecard.

Parameters
Name Description
request IDeleteQaScorecardRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the QaScorecard to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. If set to true, all of this QaScorecard's child resources will
   *  also be deleted. Otherwise, the request will only succeed if it has none.
   */
  // const force = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteQaScorecard() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteQaScorecard(request);
    console.log(response);
  }

  callDeleteQaScorecard();

deleteQaScorecard(request, options, callback)

deleteQaScorecard(request: protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteQaScorecardRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteQaScorecard(request, callback)

deleteQaScorecard(request: protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteQaScorecardRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteQaScorecardRevision(request, options)

deleteQaScorecardRevision(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest | undefined),
        {} | undefined
    ]>;

Deletes a QaScorecardRevision.

Parameters
Name Description
request IDeleteQaScorecardRevisionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the QaScorecardRevision to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. If set to true, all of this QaScorecardRevision's child resources
   *  will also be deleted. Otherwise, the request will only succeed if it has
   *  none.
   */
  // const force = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteQaScorecardRevision() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteQaScorecardRevision(request);
    console.log(response);
  }

  callDeleteQaScorecardRevision();

deleteQaScorecardRevision(request, options, callback)

deleteQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteQaScorecardRevisionRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteQaScorecardRevision(request, callback)

deleteQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteQaScorecardRevisionRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteView(request, options)

deleteView(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest | undefined),
        {} | undefined
    ]>;

Deletes a view.

Parameters
Name Description
request IDeleteViewRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the view to delete.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeleteView() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deleteView(request);
    console.log(response);
  }

  callDeleteView();

deleteView(request, options, callback)

deleteView(request: protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteViewRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteView(request, callback)

deleteView(request: protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteViewRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deployIssueModel(request, options)

deployIssueModel(request?: protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.

Parameters
Name Description
request IDeployIssueModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 issue model to deploy.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeployIssueModel() {
    // Construct request
    const request = {
      name,
    };

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

  callDeployIssueModel();

deployIssueModel(request, options, callback)

deployIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeployIssueModelRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deployIssueModel(request, callback)

deployIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeployIssueModelRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IDeployIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deployQaScorecardRevision(request, options)

deployQaScorecardRevision(request?: protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision,
        (protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest | undefined),
        {} | undefined
    ]>;

Deploy a QaScorecardRevision.

Parameters
Name Description
request IDeployQaScorecardRevisionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, (protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the QaScorecardRevision to deploy.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callDeployQaScorecardRevision() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.deployQaScorecardRevision(request);
    console.log(response);
  }

  callDeployQaScorecardRevision();

deployQaScorecardRevision(request, options, callback)

deployQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeployQaScorecardRevisionRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deployQaScorecardRevision(request, callback)

deployQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeployQaScorecardRevisionRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IDeployQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

encryptionSpecPath(project, location)

encryptionSpecPath(project: string, location: string): string;

Return a fully-qualified encryptionSpec resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

exportInsightsData(request, options)

exportInsightsData(request?: protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Export insights data to a destination defined in the request body.

Parameters
Name Description
request IExportInsightsDataRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  Specified if sink is a BigQuery table.
   */
  // const bigQueryDestination = {}
  /**
   *  Required. The parent resource to export data from.
   */
  // const parent = 'abc123'
  /**
   *  A filter to reduce results to a specific subset. Useful for exporting
   *  conversations with specific properties.
   */
  // const filter = 'abc123'
  /**
   *  A fully qualified KMS key name for BigQuery tables protected by CMEK.
   *  Format:
   *  projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}
   */
  // const kmsKey = 'abc123'
  /**
   *  Options for what to do if the destination table already exists.
   */
  // const writeDisposition = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callExportInsightsData();

exportInsightsData(request, options, callback)

exportInsightsData(request: protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportInsightsDataRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportInsightsData(request, callback)

exportInsightsData(request: protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportInsightsDataRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportIssueModel(request, options)

exportIssueModel(request?: protos.google.cloud.contactcenterinsights.v1.IExportIssueModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IExportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IExportIssueModelMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Exports an issue model to the provided destination.

Parameters
Name Description
request IExportIssueModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IExportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IExportIssueModelMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  Google Cloud Storage URI to export the issue model to.
   */
  // const gcsDestination = {}
  /**
   *  Required. The issue model to export.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callExportIssueModel() {
    // Construct request
    const request = {
      name,
    };

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

  callExportIssueModel();

exportIssueModel(request, options, callback)

exportIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IExportIssueModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IExportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IExportIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportIssueModelRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IExportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IExportIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportIssueModel(request, callback)

exportIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IExportIssueModelRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IExportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IExportIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportIssueModelRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IExportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IExportIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAnalysis(request, options)

getAnalysis(request?: protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IAnalysis,
        (protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest | undefined),
        {} | undefined
    ]>;

Gets an analysis.

Parameters
Name Description
request IGetAnalysisRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IAnalysis, (protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Analysis. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the analysis to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetAnalysis() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getAnalysis(request);
    console.log(response);
  }

  callGetAnalysis();

getAnalysis(request, options, callback)

getAnalysis(request: protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAnalysisRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAnalysis(request, callback)

getAnalysis(request: protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAnalysisRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAnalysisRule(request, options)

getAnalysisRule(request?: protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IAnalysisRule,
        (protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest | undefined),
        {} | undefined
    ]>;

Get a analysis rule.

Parameters
Name Description
request IGetAnalysisRuleRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, (protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing AnalysisRule. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the AnalysisRule to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetAnalysisRule() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getAnalysisRule(request);
    console.log(response);
  }

  callGetAnalysisRule();

getAnalysisRule(request, options, callback)

getAnalysisRule(request: protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAnalysisRuleRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAnalysisRule(request, callback)

getAnalysisRule(request: protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAnalysisRuleRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRuleRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getConversation(request, options)

getConversation(request?: protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IConversation,
        (protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest | undefined),
        {} | undefined
    ]>;

Gets a conversation.

Parameters
Name Description
request IGetConversationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IConversation, (protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the conversation to get.
   */
  // const name = 'abc123'
  /**
   *  The level of details of the conversation. Default is `FULL`.
   */
  // const view = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetConversation() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getConversation(request);
    console.log(response);
  }

  callGetConversation();

getConversation(request, options, callback)

getConversation(request: protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetConversationRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getConversation(request, callback)

getConversation(request: protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetConversationRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEncryptionSpec(request, options)

getEncryptionSpec(request?: protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IEncryptionSpec,
        (protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest | undefined),
        {} | undefined
    ]>;

Gets location-level encryption key specification.

Parameters
Name Description
request IGetEncryptionSpecRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IEncryptionSpec, (protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing EncryptionSpec. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the encryption spec resource to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetEncryptionSpec() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getEncryptionSpec(request);
    console.log(response);
  }

  callGetEncryptionSpec();

getEncryptionSpec(request, options, callback)

getEncryptionSpec(request: protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IEncryptionSpec, protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEncryptionSpecRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IEncryptionSpec, protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEncryptionSpec(request, callback)

getEncryptionSpec(request: protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IEncryptionSpec, protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEncryptionSpecRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IEncryptionSpec, protos.google.cloud.contactcenterinsights.v1.IGetEncryptionSpecRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getFeedbackLabel(request, options)

getFeedbackLabel(request?: protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel,
        (protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest | undefined),
        {} | undefined
    ]>;

Get feedback label.

Parameters
Name Description
request IGetFeedbackLabelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, (protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing FeedbackLabel. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the feedback label to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetFeedbackLabel() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getFeedbackLabel(request);
    console.log(response);
  }

  callGetFeedbackLabel();

getFeedbackLabel(request, options, callback)

getFeedbackLabel(request: protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetFeedbackLabelRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getFeedbackLabel(request, callback)

getFeedbackLabel(request: protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetFeedbackLabelRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.IGetFeedbackLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
Type Description
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getIssue(request, options)

getIssue(request?: protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IIssue,
        protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest | undefined,
        {} | undefined
    ]>;

Gets an issue.

Parameters
Name Description
request IGetIssueRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Issue. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the issue to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetIssue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getIssue(request);
    console.log(response);
  }

  callGetIssue();

getIssue(request, options, callback)

getIssue(request: protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetIssueRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIssue(request, callback)

getIssue(request: protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetIssueRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIssueModel(request, options)

getIssueModel(request?: protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IIssueModel,
        (protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest | undefined),
        {} | undefined
    ]>;

Gets an issue model.

Parameters
Name Description
request IGetIssueModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IIssueModel, (protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the issue model to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetIssueModel() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getIssueModel(request);
    console.log(response);
  }

  callGetIssueModel();

getIssueModel(request, options, callback)

getIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetIssueModelRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIssueModel(request, callback)

getIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetIssueModelRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request GetOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getPhraseMatcher(request, options)

getPhraseMatcher(request?: protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher,
        (protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest | undefined),
        {} | undefined
    ]>;

Gets a phrase matcher.

Parameters
Name Description
request IGetPhraseMatcherRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, (protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the phrase matcher to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetPhraseMatcher() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getPhraseMatcher(request);
    console.log(response);
  }

  callGetPhraseMatcher();

getPhraseMatcher(request, options, callback)

getPhraseMatcher(request: protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetPhraseMatcherRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPhraseMatcher(request, callback)

getPhraseMatcher(request: protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetPhraseMatcherRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getQaQuestion(request, options)

getQaQuestion(request?: protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaQuestion,
        (protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest | undefined),
        {} | undefined
    ]>;

Gets a QaQuestion.

Parameters
Name Description
request IGetQaQuestionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaQuestion, (protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the QaQuestion to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetQaQuestion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getQaQuestion(request);
    console.log(response);
  }

  callGetQaQuestion();

getQaQuestion(request, options, callback)

getQaQuestion(request: protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetQaQuestionRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getQaQuestion(request, callback)

getQaQuestion(request: protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetQaQuestionRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.IGetQaQuestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getQaScorecard(request, options)

getQaScorecard(request?: protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecard,
        (protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest | undefined),
        {} | undefined
    ]>;

Gets a QaScorecard.

Parameters
Name Description
request IGetQaScorecardRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecard, (protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing QaScorecard. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the QaScorecard to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetQaScorecard() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getQaScorecard(request);
    console.log(response);
  }

  callGetQaScorecard();

getQaScorecard(request, options, callback)

getQaScorecard(request: protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetQaScorecardRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getQaScorecard(request, callback)

getQaScorecard(request: protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetQaScorecardRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getQaScorecardRevision(request, options)

getQaScorecardRevision(request?: protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision,
        (protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest | undefined),
        {} | undefined
    ]>;

Gets a QaScorecardRevision.

Parameters
Name Description
request IGetQaScorecardRevisionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, (protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the QaScorecardRevision to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetQaScorecardRevision() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getQaScorecardRevision(request);
    console.log(response);
  }

  callGetQaScorecardRevision();

getQaScorecardRevision(request, options, callback)

getQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetQaScorecardRevisionRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getQaScorecardRevision(request, callback)

getQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetQaScorecardRevisionRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IGetQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getSettings(request, options)

getSettings(request?: protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.ISettings,
        (protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest | undefined),
        {} | undefined
    ]>;

Gets project-level settings.

Parameters
Name Description
request IGetSettingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.ISettings, (protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the settings resource to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetSettings() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getSettings(request);
    console.log(response);
  }

  callGetSettings();

getSettings(request, options, callback)

getSettings(request: protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.ISettings, protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetSettingsRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.ISettings, protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getSettings(request, callback)

getSettings(request: protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.ISettings, protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetSettingsRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.ISettings, protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getView(request, options)

getView(request?: protos.google.cloud.contactcenterinsights.v1.IGetViewRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IView,
        protos.google.cloud.contactcenterinsights.v1.IGetViewRequest | undefined,
        {} | undefined
    ]>;

Gets a view.

Parameters
Name Description
request IGetViewRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IGetViewRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing View. Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the view to get.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callGetView() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.getView(request);
    console.log(response);
  }

  callGetView();

getView(request, options, callback)

getView(request: protos.google.cloud.contactcenterinsights.v1.IGetViewRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IGetViewRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetViewRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IGetViewRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getView(request, callback)

getView(request: protos.google.cloud.contactcenterinsights.v1.IGetViewRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IGetViewRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetViewRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IGetViewRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

importIssueModel(request, options)

importIssueModel(request?: protos.google.cloud.contactcenterinsights.v1.IImportIssueModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IImportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IImportIssueModelMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Imports an issue model from a Cloud Storage bucket.

Parameters
Name Description
request IImportIssueModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IImportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IImportIssueModelMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  Google Cloud Storage source message.
   */
  // const gcsSource = {}
  /**
   *  Required. The parent resource of the issue model.
   */
  // const parent = 'abc123'
  /**
   *  Optional. If set to true, will create an issue model from the imported file
   *  with randomly generated IDs for the issue model and corresponding issues.
   *  Otherwise, replaces an existing model with the same ID as the file.
   */
  // const createNewModel = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callImportIssueModel();

importIssueModel(request, options, callback)

importIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IImportIssueModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IImportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IImportIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IImportIssueModelRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IImportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IImportIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

importIssueModel(request, callback)

importIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IImportIssueModelRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IImportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IImportIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IImportIssueModelRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IImportIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IImportIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

ingestConversations(request, options)

ingestConversations(request?: protos.google.cloud.contactcenterinsights.v1.IIngestConversationsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Imports conversations and processes them according to the user's configuration.

Parameters
Name Description
request IIngestConversationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   */
  /**
   *  A cloud storage bucket source. Note that any previously ingested objects
   *  from the source will be skipped to avoid duplication.
   */
  // const gcsSource = {}
  /**
   *  Configuration for when `source` contains conversation transcripts.
   */
  // const transcriptObjectConfig = {}
  /**
   *  Required. The parent resource for new conversations.
   */
  // const parent = 'abc123'
  /**
   *  Configuration that applies to all conversations.
   */
  // const conversationConfig = {}
  /**
   *  Optional. DLP settings for transcript redaction. Optional, will default to
   *  the config specified in Settings.
   */
  // const redactionConfig = {}
  /**
   *  Optional. Default Speech-to-Text configuration. Optional, will default to
   *  the config specified in Settings.
   */
  // const speechConfig = {}
  /**
   *  Optional. If set, this fields indicates the number of objects to ingest
   *  from the Cloud Storage bucket. If empty, the entire bucket will be
   *  ingested. Unless they are first deleted, conversations produced through
   *  sampling won't be ingested by subsequent ingest requests.
   */
  // const sampleSize = 1234

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callIngestConversations();

ingestConversations(request, options, callback)

ingestConversations(request: protos.google.cloud.contactcenterinsights.v1.IIngestConversationsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IIngestConversationsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

ingestConversations(request, callback)

ingestConversations(request: protos.google.cloud.contactcenterinsights.v1.IIngestConversationsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IIngestConversationsRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

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

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

initializeEncryptionSpec(request, options)

initializeEncryptionSpec(request?: protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecResponse, protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

Parameters
Name Description
request IInitializeEncryptionSpecRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecResponse, protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 encryption spec used for CMEK encryption. It is required that
   *  the kms key is in the same region as the endpoint. The same key will be
   *  used for all provisioned resources, if encryption is available. If the
   *  `kms_key_name` field is left empty, no encryption will be enforced.
   */
  // const encryptionSpec = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callInitializeEncryptionSpec() {
    // Construct request
    const request = {
      encryptionSpec,
    };

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

  callInitializeEncryptionSpec();

initializeEncryptionSpec(request, options, callback)

initializeEncryptionSpec(request: protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecResponse, protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IInitializeEncryptionSpecRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecResponse, protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

initializeEncryptionSpec(request, callback)

initializeEncryptionSpec(request: protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecResponse, protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IInitializeEncryptionSpecRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecResponse, protos.google.cloud.contactcenterinsights.v1.IInitializeEncryptionSpecMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

issueModelPath(project, location, issueModel)

issueModelPath(project: string, location: string, issueModel: string): string;

Return a fully-qualified issueModel resource name string.

Parameters
Name Description
project string
location string
issueModel string
Returns
Type Description
string

{string} Resource name string.

issuePath(project, location, issueModel, issue)

issuePath(project: string, location: string, issueModel: string, issue: string): string;

Return a fully-qualified issue resource name string.

Parameters
Name Description
project string
location string
issueModel string
issue string
Returns
Type Description
string

{string} Resource name string.

listAllFeedbackLabels(request, options)

listAllFeedbackLabels(request?: protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel[],
        protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsResponse
    ]>;

List all feedback labels by project number.

Parameters
Name Description
request IListAllFeedbackLabelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel[], protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest | null, protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of FeedbackLabel. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAllFeedbackLabelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAllFeedbackLabels(request, options, callback)

listAllFeedbackLabels(request: protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>): void;
Parameters
Name Description
request IListAllFeedbackLabelsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>
Returns
Type Description
void

listAllFeedbackLabels(request, callback)

listAllFeedbackLabels(request: protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>): void;
Parameters
Name Description
request IListAllFeedbackLabelsRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>
Returns
Type Description
void

listAllFeedbackLabelsAsync(request, options)

listAllFeedbackLabelsAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>;

Equivalent to listAllFeedbackLabels, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListAllFeedbackLabelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing FeedbackLabel. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of all feedback labels per project.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of feedback labels to return in the response.
   *  A valid page size ranges from 0 to 100,000 inclusive. If the page size is
   *  zero or unspecified, a default page size of 100 will be chosen. Note that a
   *  call might return fewer results than the requested page size.
   */
  // const pageSize = 1234
  /**
   *  Optional. The value returned by the last `ListAllFeedbackLabelsResponse`.
   *  This value indicates that this is a continuation of a prior
   *  `ListAllFeedbackLabels` call and that the system should return the next
   *  page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter to reduce results to a specific subset in the entire
   *  project. Supports disjunctions (OR) and conjunctions (AND).
   *  Supported fields:
   *  * `issue_model_id`
   *  * `qa_question_id`
   *  * `min_create_time`
   *  * `max_create_time`
   *  * `min_update_time`
   *  * `max_update_time`
   *  * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
   */
  // const filter = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListAllFeedbackLabels();

listAllFeedbackLabelsStream(request, options)

listAllFeedbackLabelsStream(request?: protos.google.cloud.contactcenterinsights.v1.IListAllFeedbackLabelsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListAllFeedbackLabelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing FeedbackLabel on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAllFeedbackLabelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAnalyses(request, options)

listAnalyses(request?: protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IAnalysis[],
        protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListAnalysesResponse
    ]>;

Lists analyses.

Parameters
Name Description
request IListAnalysesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IAnalysis[], protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest | null, protos.google.cloud.contactcenterinsights.v1.IListAnalysesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Analysis. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAnalysesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAnalyses(request, options, callback)

listAnalyses(request: protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, protos.google.cloud.contactcenterinsights.v1.IListAnalysesResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IAnalysis>): void;
Parameters
Name Description
request IListAnalysesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, protos.google.cloud.contactcenterinsights.v1.IListAnalysesResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IAnalysis>
Returns
Type Description
void

listAnalyses(request, callback)

listAnalyses(request: protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, protos.google.cloud.contactcenterinsights.v1.IListAnalysesResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IAnalysis>): void;
Parameters
Name Description
request IListAnalysesRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, protos.google.cloud.contactcenterinsights.v1.IListAnalysesResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IAnalysis>
Returns
Type Description
void

listAnalysesAsync(request, options)

listAnalysesAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IAnalysis>;

Equivalent to listAnalyses, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListAnalysesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IAnalysis>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Analysis. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the analyses.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of analyses to return in the response. If this
   *  value is zero, the service will select a default size. A call might return
   *  fewer objects than requested. A non-empty `next_page_token` in the response
   *  indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListAnalysesResponse`; indicates
   *  that this is a continuation of a prior `ListAnalyses` call and
   *  the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter to reduce results to a specific subset. Useful for querying
   *  conversations with specific properties.
   */
  // const filter = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListAnalyses();

listAnalysesStream(request, options)

listAnalysesStream(request?: protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListAnalysesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing Analysis on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAnalysesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAnalysisRules(request, options)

listAnalysisRules(request?: protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IAnalysisRule[],
        protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesResponse
    ]>;

Lists analysis rules.

Parameters
Name Description
request IListAnalysisRulesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IAnalysisRule[], protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest | null, protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of AnalysisRule. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAnalysisRulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAnalysisRules(request, options, callback)

listAnalysisRules(request: protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IAnalysisRule>): void;
Parameters
Name Description
request IListAnalysisRulesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IAnalysisRule>
Returns
Type Description
void

listAnalysisRules(request, callback)

listAnalysisRules(request: protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IAnalysisRule>): void;
Parameters
Name Description
request IListAnalysisRulesRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IAnalysisRule>
Returns
Type Description
void

listAnalysisRulesAsync(request, options)

listAnalysisRulesAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule>;

Equivalent to listAnalysisRules, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListAnalysisRulesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AnalysisRule. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the analysis rules.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of analysis rule to return in the response. If
   *  this value is zero, the service will select a default size. A call may
   *  return fewer objects than requested. A non-empty `next_page_token` in the
   *  response indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  Optional. The value returned by the last `ListAnalysisRulesResponse`;
   *  indicates that this is a continuation of a prior `ListAnalysisRules` call
   *  and the system should return the next page of data.
   */
  // const pageToken = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListAnalysisRules();

listAnalysisRulesStream(request, options)

listAnalysisRulesStream(request?: protos.google.cloud.contactcenterinsights.v1.IListAnalysisRulesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListAnalysisRulesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing AnalysisRule on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAnalysisRulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listConversations(request, options)

listConversations(request?: protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IConversation[],
        protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListConversationsResponse
    ]>;

Lists conversations.

Parameters
Name Description
request IListConversationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IConversation[], protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest | null, protos.google.cloud.contactcenterinsights.v1.IListConversationsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listConversationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listConversations(request, options, callback)

listConversations(request: protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, protos.google.cloud.contactcenterinsights.v1.IListConversationsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IConversation>): void;
Parameters
Name Description
request IListConversationsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, protos.google.cloud.contactcenterinsights.v1.IListConversationsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IConversation>
Returns
Type Description
void

listConversations(request, callback)

listConversations(request: protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, protos.google.cloud.contactcenterinsights.v1.IListConversationsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IConversation>): void;
Parameters
Name Description
request IListConversationsRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, protos.google.cloud.contactcenterinsights.v1.IListConversationsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IConversation>
Returns
Type Description
void

listConversationsAsync(request, options)

listConversationsAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IConversation>;

Equivalent to listConversations, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListConversationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IConversation>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the conversation.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of conversations to return in the response. A valid page
   *  size ranges from 0 to 100,000 inclusive. If the page size is zero or
   *  unspecified, a default page size of 100 will be chosen. Note that a call
   *  might return fewer results than the requested page size.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListConversationsResponse`. This value
   *  indicates that this is a continuation of a prior `ListConversations` call
   *  and that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter to reduce results to a specific subset. Useful for querying
   *  conversations with specific properties.
   */
  // const filter = 'abc123'
  /**
   *  Optional. The attribute by which to order conversations in the response.
   *  If empty, conversations will be ordered by descending creation time.
   *  Supported values are one of the following:
   *  * create_time
   *  * customer_satisfaction_rating
   *  * duration
   *  * latest_analysis
   *  * start_time
   *  * turn_count
   *  The default sort order is ascending. To specify order, append `asc` or
   *  `desc` (`create_time desc`).
   *  For more details, see Google AIPs
   *  Ordering (https://google.aip.dev/132#ordering).
   */
  // const orderBy = 'abc123'
  /**
   *  The level of details of the conversation. Default is `BASIC`.
   */
  // const view = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListConversations();

listConversationsStream(request, options)

listConversationsStream(request?: protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListConversationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listConversationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeedbackLabels(request, options)

listFeedbackLabels(request?: protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel[],
        protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsResponse
    ]>;

List feedback labels.

Parameters
Name Description
request IListFeedbackLabelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel[], protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest | null, protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of FeedbackLabel. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listFeedbackLabelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeedbackLabels(request, options, callback)

listFeedbackLabels(request: protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>): void;
Parameters
Name Description
request IListFeedbackLabelsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>
Returns
Type Description
void

listFeedbackLabels(request, callback)

listFeedbackLabels(request: protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>): void;
Parameters
Name Description
request IListFeedbackLabelsRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>
Returns
Type Description
void

listFeedbackLabelsAsync(request, options)

listFeedbackLabelsAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>;

Equivalent to listFeedbackLabels, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListFeedbackLabelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing FeedbackLabel. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the feedback labels.
   */
  // const parent = 'abc123'
  /**
   *  Optional. A filter to reduce results to a specific subset. Supports
   *  disjunctions (OR) and conjunctions (AND). Automatically sorts by
   *  conversation ID. To sort by all feedback labels in a project see
   *  ListAllFeedbackLabels.
   *  Supported fields:
   *  * `issue_model_id`
   *  * `qa_question_id`
   *  * `qa_scorecard_id`
   *  * `min_create_time`
   *  * `max_create_time`
   *  * `min_update_time`
   *  * `max_update_time`
   *  * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
   */
  // const filter = 'abc123'
  /**
   *  Optional. The maximum number of feedback labels to return in the response.
   *  A valid page size ranges from 0 to 100,000 inclusive. If the page size is
   *  zero or unspecified, a default page size of 100 will be chosen. Note that a
   *  call might return fewer results than the requested page size.
   */
  // const pageSize = 1234
  /**
   *  Optional. The value returned by the last `ListFeedbackLabelsResponse`. This
   *  value indicates that this is a continuation of a prior `ListFeedbackLabels`
   *  call and that the system should return the next page of data.
   */
  // const pageToken = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListFeedbackLabels();

listFeedbackLabelsStream(request, options)

listFeedbackLabelsStream(request?: protos.google.cloud.contactcenterinsights.v1.IListFeedbackLabelsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListFeedbackLabelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing FeedbackLabel on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listFeedbackLabelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listIssueModels(request, options)

listIssueModels(request?: protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IListIssueModelsResponse,
        (protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest | undefined),
        {} | undefined
    ]>;

Lists issue models.

Parameters
Name Description
request IListIssueModelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IListIssueModelsResponse, (protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ListIssueModelsResponse. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the issue model.
   */
  // const parent = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

    // Run request
    const response = await contactcenterinsightsClient.listIssueModels(request);
    console.log(response);
  }

  callListIssueModels();

listIssueModels(request, options, callback)

listIssueModels(request: protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IListIssueModelsResponse, protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IListIssueModelsRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IListIssueModelsResponse, protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listIssueModels(request, callback)

listIssueModels(request: protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IListIssueModelsResponse, protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IListIssueModelsRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IListIssueModelsResponse, protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listIssues(request, options)

listIssues(request?: protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IListIssuesResponse,
        (protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest | undefined),
        {} | undefined
    ]>;

Lists issues.

Parameters
Name Description
request IListIssuesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IListIssuesResponse, (protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ListIssuesResponse. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the issue.
   */
  // const parent = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

    // Run request
    const response = await contactcenterinsightsClient.listIssues(request);
    console.log(response);
  }

  callListIssues();

listIssues(request, options, callback)

listIssues(request: protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IListIssuesResponse, protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IListIssuesRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IListIssuesResponse, protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listIssues(request, callback)

listIssues(request: protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IListIssuesResponse, protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IListIssuesRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IListIssuesResponse, protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name Description
request ListOperationsRequest

The request object that will be sent.

options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type Description
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listPhraseMatchers(request, options)

listPhraseMatchers(request?: protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher[],
        protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersResponse
    ]>;

Lists phrase matchers.

Parameters
Name Description
request IListPhraseMatchersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher[], protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest | null, protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listPhraseMatchersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPhraseMatchers(request, options, callback)

listPhraseMatchers(request: protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher>): void;
Parameters
Name Description
request IListPhraseMatchersRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher>
Returns
Type Description
void

listPhraseMatchers(request, callback)

listPhraseMatchers(request: protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher>): void;
Parameters
Name Description
request IListPhraseMatchersRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher>
Returns
Type Description
void

listPhraseMatchersAsync(request, options)

listPhraseMatchersAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher>;

Equivalent to listPhraseMatchers, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListPhraseMatchersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the phrase matcher.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of phrase matchers to return in the response. If this
   *  value is zero, the service will select a default size. A call might return
   *  fewer objects than requested. A non-empty `next_page_token` in the response
   *  indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListPhraseMatchersResponse`. This value
   *  indicates that this is a continuation of a prior `ListPhraseMatchers` call
   *  and that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter to reduce results to a specific subset. Useful for querying
   *  phrase matchers with specific properties.
   */
  // const filter = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListPhraseMatchers();

listPhraseMatchersStream(request, options)

listPhraseMatchersStream(request?: protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListPhraseMatchersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPhraseMatchersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listQaQuestions(request, options)

listQaQuestions(request?: protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaQuestion[],
        protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsResponse
    ]>;

Lists QaQuestions.

Parameters
Name Description
request IListQaQuestionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaQuestion[], protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest | null, protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listQaQuestionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listQaQuestions(request, options, callback)

listQaQuestions(request: protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaQuestion>): void;
Parameters
Name Description
request IListQaQuestionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaQuestion>
Returns
Type Description
void

listQaQuestions(request, callback)

listQaQuestions(request: protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaQuestion>): void;
Parameters
Name Description
request IListQaQuestionsRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaQuestion>
Returns
Type Description
void

listQaQuestionsAsync(request, options)

listQaQuestionsAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IQaQuestion>;

Equivalent to listQaQuestions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListQaQuestionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IQaQuestion>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the questions.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of questions to return in the response. If the
   *  value is zero, the service will select a default size. A call might return
   *  fewer objects than requested. A non-empty `next_page_token` in the response
   *  indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  Optional. The value returned by the last `ListQaQuestionsResponse`. This
   *  value indicates that this is a continuation of a prior `ListQaQuestions`
   *  call and that the system should return the next page of data.
   */
  // const pageToken = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListQaQuestions();

listQaQuestionsStream(request, options)

listQaQuestionsStream(request?: protos.google.cloud.contactcenterinsights.v1.IListQaQuestionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListQaQuestionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listQaQuestionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listQaScorecardRevisions(request, options)

listQaScorecardRevisions(request?: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision[],
        protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsResponse
    ]>;

Lists all revisions under the parent QaScorecard.

Parameters
Name Description
request IListQaScorecardRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision[], protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest | null, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listQaScorecardRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listQaScorecardRevisions(request, options, callback)

listQaScorecardRevisions(request: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision>): void;
Parameters
Name Description
request IListQaScorecardRevisionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision>
Returns
Type Description
void

listQaScorecardRevisions(request, callback)

listQaScorecardRevisions(request: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision>): void;
Parameters
Name Description
request IListQaScorecardRevisionsRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision>
Returns
Type Description
void

listQaScorecardRevisionsAsync(request, options)

listQaScorecardRevisionsAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision>;

Equivalent to listQaScorecardRevisions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListQaScorecardRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the scorecard revisions. To list all
   *  revisions of all scorecards, substitute the QaScorecard ID with a '-'
   *  character.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of scorecard revisions to return in the
   *  response. If the value is zero, the service will select a default size. A
   *  call might return fewer objects than requested. A non-empty
   *  `next_page_token` in the response indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  Optional. The value returned by the last
   *  `ListQaScorecardRevisionsResponse`. This value indicates that this is a
   *  continuation of a prior `ListQaScorecardRevisions` call and that the system
   *  should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter to reduce results to a specific subset. Useful for
   *  querying scorecard revisions with specific properties.
   */
  // const filter = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListQaScorecardRevisions();

listQaScorecardRevisionsStream(request, options)

listQaScorecardRevisionsStream(request?: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardRevisionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListQaScorecardRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listQaScorecardRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listQaScorecards(request, options)

listQaScorecards(request?: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecard[],
        protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsResponse
    ]>;

Lists QaScorecards.

Parameters
Name Description
request IListQaScorecardsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecard[], protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest | null, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of QaScorecard. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listQaScorecardsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listQaScorecards(request, options, callback)

listQaScorecards(request: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaScorecard>): void;
Parameters
Name Description
request IListQaScorecardsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaScorecard>
Returns
Type Description
void

listQaScorecards(request, callback)

listQaScorecards(request: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaScorecard>): void;
Parameters
Name Description
request IListQaScorecardsRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IQaScorecard>
Returns
Type Description
void

listQaScorecardsAsync(request, options)

listQaScorecardsAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IQaScorecard>;

Equivalent to listQaScorecards, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListQaScorecardsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IQaScorecard>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing QaScorecard. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the scorecards.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of scorecards to return in the response. If
   *  the value is zero, the service will select a default size. A call might
   *  return fewer objects than requested. A non-empty `next_page_token` in the
   *  response indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  Optional. The value returned by the last `ListQaScorecardsResponse`. This
   *  value indicates that this is a continuation of a prior `ListQaScorecards`
   *  call and that the system should return the next page of data.
   */
  // const pageToken = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListQaScorecards();

listQaScorecardsStream(request, options)

listQaScorecardsStream(request?: protos.google.cloud.contactcenterinsights.v1.IListQaScorecardsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListQaScorecardsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing QaScorecard on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listQaScorecardsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listViews(request, options)

listViews(request?: protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IView[],
        protos.google.cloud.contactcenterinsights.v1.IListViewsRequest | null,
        protos.google.cloud.contactcenterinsights.v1.IListViewsResponse
    ]>;

Lists views.

Parameters
Name Description
request IListViewsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IView[], protos.google.cloud.contactcenterinsights.v1.IListViewsRequest | null, protos.google.cloud.contactcenterinsights.v1.IListViewsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of View. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listViewsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listViews(request, options, callback)

listViews(request: protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, protos.google.cloud.contactcenterinsights.v1.IListViewsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IView>): void;
Parameters
Name Description
request IListViewsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, protos.google.cloud.contactcenterinsights.v1.IListViewsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IView>
Returns
Type Description
void

listViews(request, callback)

listViews(request: protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, callback: PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, protos.google.cloud.contactcenterinsights.v1.IListViewsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IView>): void;
Parameters
Name Description
request IListViewsRequest
callback PaginationCallback<protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, protos.google.cloud.contactcenterinsights.v1.IListViewsResponse | null | undefined, protos.google.cloud.contactcenterinsights.v1.IView>
Returns
Type Description
void

listViewsAsync(request, options)

listViewsAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IView>;

Equivalent to listViews, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListViewsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IView>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing View. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the views.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of views to return in the response. If this
   *  value is zero, the service will select a default size. A call may return
   *  fewer objects than requested. A non-empty `next_page_token` in the response
   *  indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListViewsResponse`; indicates
   *  that this is a continuation of a prior `ListViews` call and
   *  the system should return the next page of data.
   */
  // const pageToken = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callListViews();

listViewsStream(request, options)

listViewsStream(request?: protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListViewsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing View on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listViewsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchAnalysisFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName)

matchAnalysisFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName: string): string | number;

Parse the analysis from ProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysis resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the analysis.

matchAnalysisFromProjectLocationConversationAnalysisName(projectLocationConversationAnalysisName)

matchAnalysisFromProjectLocationConversationAnalysisName(projectLocationConversationAnalysisName: string): string | number;

Parse the analysis from ProjectLocationConversationAnalysis resource.

Parameter
Name Description
projectLocationConversationAnalysisName string

A fully-qualified path representing project_location_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the analysis.

matchAnalysisRuleFromAnalysisRuleName(analysisRuleName)

matchAnalysisRuleFromAnalysisRuleName(analysisRuleName: string): string | number;

Parse the analysis_rule from AnalysisRule resource.

Parameter
Name Description
analysisRuleName string

A fully-qualified path representing AnalysisRule resource.

Returns
Type Description
string | number

{string} A string representing the analysis_rule.

matchAuthorizedViewFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName)

matchAuthorizedViewFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName: string): string | number;

Parse the authorized_view from ProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysis resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the authorized_view.

matchAuthorizedViewFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName)

matchAuthorizedViewFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName: string): string | number;

Parse the authorized_view from ProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the authorized_view.

matchAuthorizedViewFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName)

matchAuthorizedViewFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName: string): string | number;

Parse the authorized_view from ProjectLocationAuthorizedViewSetAuthorizedViewConversation resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation resource.

Returns
Type Description
string | number

{string} A string representing the authorized_view.

matchAuthorizedViewSetFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName)

matchAuthorizedViewSetFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName: string): string | number;

Parse the authorized_view_set from ProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysis resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the authorized_view_set.

matchAuthorizedViewSetFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName)

matchAuthorizedViewSetFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName: string): string | number;

Parse the authorized_view_set from ProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the authorized_view_set.

matchAuthorizedViewSetFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName)

matchAuthorizedViewSetFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName: string): string | number;

Parse the authorized_view_set from ProjectLocationAuthorizedViewSetAuthorizedViewConversation resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation resource.

Returns
Type Description
string | number

{string} A string representing the authorized_view_set.

matchConversationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName)

matchConversationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName: string): string | number;

Parse the conversation from ProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysis resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName)

matchConversationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName: string): string | number;

Parse the conversation from ProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName)

matchConversationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName: string): string | number;

Parse the conversation from ProjectLocationAuthorizedViewSetAuthorizedViewConversation resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation resource.

Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectLocationConversationAnalysisName(projectLocationConversationAnalysisName)

matchConversationFromProjectLocationConversationAnalysisName(projectLocationConversationAnalysisName: string): string | number;

Parse the conversation from ProjectLocationConversationAnalysis resource.

Parameter
Name Description
projectLocationConversationAnalysisName string

A fully-qualified path representing project_location_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectLocationConversationFeedbackLabelName(projectLocationConversationFeedbackLabelName)

matchConversationFromProjectLocationConversationFeedbackLabelName(projectLocationConversationFeedbackLabelName: string): string | number;

Parse the conversation from ProjectLocationConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationConversationFeedbackLabelName string

A fully-qualified path representing project_location_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectLocationConversationName(projectLocationConversationName)

matchConversationFromProjectLocationConversationName(projectLocationConversationName: string): string | number;

Parse the conversation from ProjectLocationConversation resource.

Parameter
Name Description
projectLocationConversationName string

A fully-qualified path representing project_location_conversation resource.

Returns
Type Description
string | number

{string} A string representing the conversation.

matchFeedbackLabelFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName)

matchFeedbackLabelFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName: string): string | number;

Parse the feedback_label from ProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the feedback_label.

matchFeedbackLabelFromProjectLocationConversationFeedbackLabelName(projectLocationConversationFeedbackLabelName)

matchFeedbackLabelFromProjectLocationConversationFeedbackLabelName(projectLocationConversationFeedbackLabelName: string): string | number;

Parse the feedback_label from ProjectLocationConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationConversationFeedbackLabelName string

A fully-qualified path representing project_location_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the feedback_label.

matchIssueFromIssueName(issueName)

matchIssueFromIssueName(issueName: string): string | number;

Parse the issue from Issue resource.

Parameter
Name Description
issueName string

A fully-qualified path representing Issue resource.

Returns
Type Description
string | number

{string} A string representing the issue.

matchIssueModelFromIssueModelName(issueModelName)

matchIssueModelFromIssueModelName(issueModelName: string): string | number;

Parse the issue_model from IssueModel resource.

Parameter
Name Description
issueModelName string

A fully-qualified path representing IssueModel resource.

Returns
Type Description
string | number

{string} A string representing the issue_model.

matchIssueModelFromIssueName(issueName)

matchIssueModelFromIssueName(issueName: string): string | number;

Parse the issue_model from Issue resource.

Parameter
Name Description
issueName string

A fully-qualified path representing Issue resource.

Returns
Type Description
string | number

{string} A string representing the issue_model.

matchLocationFromAnalysisRuleName(analysisRuleName)

matchLocationFromAnalysisRuleName(analysisRuleName: string): string | number;

Parse the location from AnalysisRule resource.

Parameter
Name Description
analysisRuleName string

A fully-qualified path representing AnalysisRule resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEncryptionSpecName(encryptionSpecName)

matchLocationFromEncryptionSpecName(encryptionSpecName: string): string | number;

Parse the location from EncryptionSpec resource.

Parameter
Name Description
encryptionSpecName string

A fully-qualified path representing EncryptionSpec resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromIssueModelName(issueModelName)

matchLocationFromIssueModelName(issueModelName: string): string | number;

Parse the location from IssueModel resource.

Parameter
Name Description
issueModelName string

A fully-qualified path representing IssueModel resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromIssueName(issueName)

matchLocationFromIssueName(issueName: string): string | number;

Parse the location from Issue resource.

Parameter
Name Description
issueName string

A fully-qualified path representing Issue resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromPhraseMatcherName(phraseMatcherName)

matchLocationFromPhraseMatcherName(phraseMatcherName: string): string | number;

Parse the location from PhraseMatcher resource.

Parameter
Name Description
phraseMatcherName string

A fully-qualified path representing PhraseMatcher resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName)

matchLocationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName: string): string | number;

Parse the location from ProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysis resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName)

matchLocationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName: string): string | number;

Parse the location from ProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName)

matchLocationFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName: string): string | number;

Parse the location from ProjectLocationAuthorizedViewSetAuthorizedViewConversation resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationAnalysisName(projectLocationConversationAnalysisName)

matchLocationFromProjectLocationConversationAnalysisName(projectLocationConversationAnalysisName: string): string | number;

Parse the location from ProjectLocationConversationAnalysis resource.

Parameter
Name Description
projectLocationConversationAnalysisName string

A fully-qualified path representing project_location_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationFeedbackLabelName(projectLocationConversationFeedbackLabelName)

matchLocationFromProjectLocationConversationFeedbackLabelName(projectLocationConversationFeedbackLabelName: string): string | number;

Parse the location from ProjectLocationConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationConversationFeedbackLabelName string

A fully-qualified path representing project_location_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationName(projectLocationConversationName)

matchLocationFromProjectLocationConversationName(projectLocationConversationName: string): string | number;

Parse the location from ProjectLocationConversation resource.

Parameter
Name Description
projectLocationConversationName string

A fully-qualified path representing project_location_conversation resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromQaQuestionName(qaQuestionName)

matchLocationFromQaQuestionName(qaQuestionName: string): string | number;

Parse the location from QaQuestion resource.

Parameter
Name Description
qaQuestionName string

A fully-qualified path representing QaQuestion resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromQaScorecardName(qaScorecardName)

matchLocationFromQaScorecardName(qaScorecardName: string): string | number;

Parse the location from QaScorecard resource.

Parameter
Name Description
qaScorecardName string

A fully-qualified path representing QaScorecard resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromQaScorecardResultName(qaScorecardResultName)

matchLocationFromQaScorecardResultName(qaScorecardResultName: string): string | number;

Parse the location from QaScorecardResult resource.

Parameter
Name Description
qaScorecardResultName string

A fully-qualified path representing QaScorecardResult resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromQaScorecardRevisionName(qaScorecardRevisionName)

matchLocationFromQaScorecardRevisionName(qaScorecardRevisionName: string): string | number;

Parse the location from QaScorecardRevision resource.

Parameter
Name Description
qaScorecardRevisionName string

A fully-qualified path representing QaScorecardRevision resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromSettingsName(settingsName)

matchLocationFromSettingsName(settingsName: string): string | number;

Parse the location from Settings resource.

Parameter
Name Description
settingsName string

A fully-qualified path representing Settings resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromViewName(viewName)

matchLocationFromViewName(viewName: string): string | number;

Parse the location from View resource.

Parameter
Name Description
viewName string

A fully-qualified path representing View resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchPhraseMatcherFromPhraseMatcherName(phraseMatcherName)

matchPhraseMatcherFromPhraseMatcherName(phraseMatcherName: string): string | number;

Parse the phrase_matcher from PhraseMatcher resource.

Parameter
Name Description
phraseMatcherName string

A fully-qualified path representing PhraseMatcher resource.

Returns
Type Description
string | number

{string} A string representing the phrase_matcher.

matchProjectFromAnalysisRuleName(analysisRuleName)

matchProjectFromAnalysisRuleName(analysisRuleName: string): string | number;

Parse the project from AnalysisRule resource.

Parameter
Name Description
analysisRuleName string

A fully-qualified path representing AnalysisRule resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEncryptionSpecName(encryptionSpecName)

matchProjectFromEncryptionSpecName(encryptionSpecName: string): string | number;

Parse the project from EncryptionSpec resource.

Parameter
Name Description
encryptionSpecName string

A fully-qualified path representing EncryptionSpec resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromIssueModelName(issueModelName)

matchProjectFromIssueModelName(issueModelName: string): string | number;

Parse the project from IssueModel resource.

Parameter
Name Description
issueModelName string

A fully-qualified path representing IssueModel resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromIssueName(issueName)

matchProjectFromIssueName(issueName: string): string | number;

Parse the project from Issue resource.

Parameter
Name Description
issueName string

A fully-qualified path representing Issue resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromPhraseMatcherName(phraseMatcherName)

matchProjectFromPhraseMatcherName(phraseMatcherName: string): string | number;

Parse the project from PhraseMatcher resource.

Parameter
Name Description
phraseMatcherName string

A fully-qualified path representing PhraseMatcher resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName)

matchProjectFromProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName(projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName: string): string | number;

Parse the project from ProjectLocationAuthorizedViewSetAuthorizedViewConversationAnalysis resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName)

matchProjectFromProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName(projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName: string): string | number;

Parse the project from ProjectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName)

matchProjectFromProjectLocationAuthorizedViewSetAuthorizedViewConversationName(projectLocationAuthorizedViewSetAuthorizedViewConversationName: string): string | number;

Parse the project from ProjectLocationAuthorizedViewSetAuthorizedViewConversation resource.

Parameter
Name Description
projectLocationAuthorizedViewSetAuthorizedViewConversationName string

A fully-qualified path representing project_location_authorized_view_set_authorized_view_conversation resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationAnalysisName(projectLocationConversationAnalysisName)

matchProjectFromProjectLocationConversationAnalysisName(projectLocationConversationAnalysisName: string): string | number;

Parse the project from ProjectLocationConversationAnalysis resource.

Parameter
Name Description
projectLocationConversationAnalysisName string

A fully-qualified path representing project_location_conversation_analysis resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationFeedbackLabelName(projectLocationConversationFeedbackLabelName)

matchProjectFromProjectLocationConversationFeedbackLabelName(projectLocationConversationFeedbackLabelName: string): string | number;

Parse the project from ProjectLocationConversationFeedbackLabel resource.

Parameter
Name Description
projectLocationConversationFeedbackLabelName string

A fully-qualified path representing project_location_conversation_feedback_label resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationName(projectLocationConversationName)

matchProjectFromProjectLocationConversationName(projectLocationConversationName: string): string | number;

Parse the project from ProjectLocationConversation resource.

Parameter
Name Description
projectLocationConversationName string

A fully-qualified path representing project_location_conversation resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromQaQuestionName(qaQuestionName)

matchProjectFromQaQuestionName(qaQuestionName: string): string | number;

Parse the project from QaQuestion resource.

Parameter
Name Description
qaQuestionName string

A fully-qualified path representing QaQuestion resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromQaScorecardName(qaScorecardName)

matchProjectFromQaScorecardName(qaScorecardName: string): string | number;

Parse the project from QaScorecard resource.

Parameter
Name Description
qaScorecardName string

A fully-qualified path representing QaScorecard resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromQaScorecardResultName(qaScorecardResultName)

matchProjectFromQaScorecardResultName(qaScorecardResultName: string): string | number;

Parse the project from QaScorecardResult resource.

Parameter
Name Description
qaScorecardResultName string

A fully-qualified path representing QaScorecardResult resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromQaScorecardRevisionName(qaScorecardRevisionName)

matchProjectFromQaScorecardRevisionName(qaScorecardRevisionName: string): string | number;

Parse the project from QaScorecardRevision resource.

Parameter
Name Description
qaScorecardRevisionName string

A fully-qualified path representing QaScorecardRevision resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromSettingsName(settingsName)

matchProjectFromSettingsName(settingsName: string): string | number;

Parse the project from Settings resource.

Parameter
Name Description
settingsName string

A fully-qualified path representing Settings resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromViewName(viewName)

matchProjectFromViewName(viewName: string): string | number;

Parse the project from View resource.

Parameter
Name Description
viewName string

A fully-qualified path representing View resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchQaQuestionFromQaQuestionName(qaQuestionName)

matchQaQuestionFromQaQuestionName(qaQuestionName: string): string | number;

Parse the qa_question from QaQuestion resource.

Parameter
Name Description
qaQuestionName string

A fully-qualified path representing QaQuestion resource.

Returns
Type Description
string | number

{string} A string representing the qa_question.

matchQaScorecardFromQaQuestionName(qaQuestionName)

matchQaScorecardFromQaQuestionName(qaQuestionName: string): string | number;

Parse the qa_scorecard from QaQuestion resource.

Parameter
Name Description
qaQuestionName string

A fully-qualified path representing QaQuestion resource.

Returns
Type Description
string | number

{string} A string representing the qa_scorecard.

matchQaScorecardFromQaScorecardName(qaScorecardName)

matchQaScorecardFromQaScorecardName(qaScorecardName: string): string | number;

Parse the qa_scorecard from QaScorecard resource.

Parameter
Name Description
qaScorecardName string

A fully-qualified path representing QaScorecard resource.

Returns
Type Description
string | number

{string} A string representing the qa_scorecard.

matchQaScorecardFromQaScorecardRevisionName(qaScorecardRevisionName)

matchQaScorecardFromQaScorecardRevisionName(qaScorecardRevisionName: string): string | number;

Parse the qa_scorecard from QaScorecardRevision resource.

Parameter
Name Description
qaScorecardRevisionName string

A fully-qualified path representing QaScorecardRevision resource.

Returns
Type Description
string | number

{string} A string representing the qa_scorecard.

matchQaScorecardResultFromQaScorecardResultName(qaScorecardResultName)

matchQaScorecardResultFromQaScorecardResultName(qaScorecardResultName: string): string | number;

Parse the qa_scorecard_result from QaScorecardResult resource.

Parameter
Name Description
qaScorecardResultName string

A fully-qualified path representing QaScorecardResult resource.

Returns
Type Description
string | number

{string} A string representing the qa_scorecard_result.

matchRevisionFromQaQuestionName(qaQuestionName)

matchRevisionFromQaQuestionName(qaQuestionName: string): string | number;

Parse the revision from QaQuestion resource.

Parameter
Name Description
qaQuestionName string

A fully-qualified path representing QaQuestion resource.

Returns
Type Description
string | number

{string} A string representing the revision.

matchRevisionFromQaScorecardRevisionName(qaScorecardRevisionName)

matchRevisionFromQaScorecardRevisionName(qaScorecardRevisionName: string): string | number;

Parse the revision from QaScorecardRevision resource.

Parameter
Name Description
qaScorecardRevisionName string

A fully-qualified path representing QaScorecardRevision resource.

Returns
Type Description
string | number

{string} A string representing the revision.

matchViewFromViewName(viewName)

matchViewFromViewName(viewName: string): string | number;

Parse the view from View resource.

Parameter
Name Description
viewName string

A fully-qualified path representing View resource.

Returns
Type Description
string | number

{string} A string representing the view.

phraseMatcherPath(project, location, phraseMatcher)

phraseMatcherPath(project: string, location: string, phraseMatcher: string): string;

Return a fully-qualified phraseMatcher resource name string.

Parameters
Name Description
project string
location string
phraseMatcher string
Returns
Type Description
string

{string} Resource name string.

projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisPath(project, location, authorizedViewSet, authorizedView, conversation, analysis)

projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysisPath(project: string, location: string, authorizedViewSet: string, authorizedView: string, conversation: string, analysis: string): string;

Return a fully-qualified projectLocationAuthorizedViewSetAuthorizedViewConversationAnalysis resource name string.

Parameters
Name Description
project string
location string
authorizedViewSet string
authorizedView string
conversation string
analysis string
Returns
Type Description
string

{string} Resource name string.

projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelPath(project, location, authorizedViewSet, authorizedView, conversation, feedbackLabel)

projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabelPath(project: string, location: string, authorizedViewSet: string, authorizedView: string, conversation: string, feedbackLabel: string): string;

Return a fully-qualified projectLocationAuthorizedViewSetAuthorizedViewConversationFeedbackLabel resource name string.

Parameters
Name Description
project string
location string
authorizedViewSet string
authorizedView string
conversation string
feedbackLabel string
Returns
Type Description
string

{string} Resource name string.

projectLocationAuthorizedViewSetAuthorizedViewConversationPath(project, location, authorizedViewSet, authorizedView, conversation)

projectLocationAuthorizedViewSetAuthorizedViewConversationPath(project: string, location: string, authorizedViewSet: string, authorizedView: string, conversation: string): string;

Return a fully-qualified projectLocationAuthorizedViewSetAuthorizedViewConversation resource name string.

Parameters
Name Description
project string
location string
authorizedViewSet string
authorizedView string
conversation string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationAnalysisPath(project, location, conversation, analysis)

projectLocationConversationAnalysisPath(project: string, location: string, conversation: string, analysis: string): string;

Return a fully-qualified projectLocationConversationAnalysis resource name string.

Parameters
Name Description
project string
location string
conversation string
analysis string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationFeedbackLabelPath(project, location, conversation, feedbackLabel)

projectLocationConversationFeedbackLabelPath(project: string, location: string, conversation: string, feedbackLabel: string): string;

Return a fully-qualified projectLocationConversationFeedbackLabel resource name string.

Parameters
Name Description
project string
location string
conversation string
feedbackLabel string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationPath(project, location, conversation)

projectLocationConversationPath(project: string, location: string, conversation: string): string;

Return a fully-qualified projectLocationConversation resource name string.

Parameters
Name Description
project string
location string
conversation string
Returns
Type Description
string

{string} Resource name string.

qaQuestionPath(project, location, qaScorecard, revision, qaQuestion)

qaQuestionPath(project: string, location: string, qaScorecard: string, revision: string, qaQuestion: string): string;

Return a fully-qualified qaQuestion resource name string.

Parameters
Name Description
project string
location string
qaScorecard string
revision string
qaQuestion string
Returns
Type Description
string

{string} Resource name string.

qaScorecardPath(project, location, qaScorecard)

qaScorecardPath(project: string, location: string, qaScorecard: string): string;

Return a fully-qualified qaScorecard resource name string.

Parameters
Name Description
project string
location string
qaScorecard string
Returns
Type Description
string

{string} Resource name string.

qaScorecardResultPath(project, location, qaScorecardResult)

qaScorecardResultPath(project: string, location: string, qaScorecardResult: string): string;

Return a fully-qualified qaScorecardResult resource name string.

Parameters
Name Description
project string
location string
qaScorecardResult string
Returns
Type Description
string

{string} Resource name string.

qaScorecardRevisionPath(project, location, qaScorecard, revision)

qaScorecardRevisionPath(project: string, location: string, qaScorecard: string, revision: string): string;

Return a fully-qualified qaScorecardRevision resource name string.

Parameters
Name Description
project string
location string
qaScorecard string
revision string
Returns
Type Description
string

{string} Resource name string.

queryMetrics(request, options)

queryMetrics(request?: protos.google.cloud.contactcenterinsights.v1.IQueryMetricsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IQueryMetricsResponse, protos.google.cloud.contactcenterinsights.v1.IQueryMetricsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Query metrics.

Parameters
Name Description
request IQueryMetricsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IQueryMetricsResponse, protos.google.cloud.contactcenterinsights.v1.IQueryMetricsMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 location of the data.
   *  "projects/{project}/locations/{location}"
   */
  // const location = 'abc123'
  /**
   *  Required. Filter to select a subset of conversations to compute the
   *  metrics. Must specify a window of the conversation create time to compute
   *  the metrics. The returned metrics will be from the range DATE(starting
   *  create time), DATE(ending create time)).
   */
  // const filter = 'abc123'
  /**
   *  The time granularity of each data point in the time series.
   *  Defaults to NONE if this field is unspecified.
   */
  // const timeGranularity = {}
  /**
   *  The dimensions that determine the grouping key for the query. Defaults to
   *  no dimension if this field is unspecified. If a dimension is specified,
   *  its key must also be specified. Each dimension's key must be unique.
   *  If a time granularity is also specified, metric values in the dimension
   *  will be bucketed by this granularity.
   *  Up to one dimension is supported for now.
   */
  // const dimensions = [1,2,3,4]
  /**
   *  Measures to return. Defaults to all measures if this field is unspecified.
   *  A valid mask should traverse from the `measure` field from the response.
   *  For example, a path from a measure mask to get the conversation count is
   *  "conversation_measure.count".
   */
  // const measureMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callQueryMetrics() {
    // Construct request
    const request = {
      location,
      filter,
    };

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

  callQueryMetrics();

queryMetrics(request, options, callback)

queryMetrics(request: protos.google.cloud.contactcenterinsights.v1.IQueryMetricsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IQueryMetricsResponse, protos.google.cloud.contactcenterinsights.v1.IQueryMetricsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IQueryMetricsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IQueryMetricsResponse, protos.google.cloud.contactcenterinsights.v1.IQueryMetricsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

queryMetrics(request, callback)

queryMetrics(request: protos.google.cloud.contactcenterinsights.v1.IQueryMetricsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IQueryMetricsResponse, protos.google.cloud.contactcenterinsights.v1.IQueryMetricsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IQueryMetricsRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IQueryMetricsResponse, protos.google.cloud.contactcenterinsights.v1.IQueryMetricsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request IamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
Type Description
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

settingsPath(project, location)

settingsPath(project: string, location: string): string;

Return a fully-qualified settings resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request IamProtos.google.iam.v1.TestIamPermissionsRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
Type Description
Promise<[google.iam.v1.TestIamPermissionsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

tuneQaScorecardRevision(request, options)

tuneQaScorecardRevision(request?: protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionResponse, protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Fine tune one or more QaModels.

Parameters
Name Description
request ITuneQaScorecardRevisionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionResponse, protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource for new fine tuning job instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. Filter for selecting the feedback labels that needs to be
   *  used for training.
   *  This filter can be used to limit the feedback labels used for tuning to a
   *  feedback labels created or updated for a specific time-window etc.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Run in validate only mode, no fine tuning will actually run.
   *  Data quality validations like training data distributions will run.
   *  Even when set to false, the data quality validations will still run but
   *  once the validations complete we will proceed with the fine tune, if
   *  applicable.
   */
  // const validateOnly = true

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callTuneQaScorecardRevision();

tuneQaScorecardRevision(request, options, callback)

tuneQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionResponse, protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ITuneQaScorecardRevisionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionResponse, protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

tuneQaScorecardRevision(request, callback)

tuneQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionResponse, protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ITuneQaScorecardRevisionRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionResponse, protos.google.cloud.contactcenterinsights.v1.ITuneQaScorecardRevisionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

undeployIssueModel(request, options)

undeployIssueModel(request?: protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.

Parameters
Name Description
request IUndeployIssueModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 issue model to undeploy.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUndeployIssueModel() {
    // Construct request
    const request = {
      name,
    };

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

  callUndeployIssueModel();

undeployIssueModel(request, options, callback)

undeployIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUndeployIssueModelRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

undeployIssueModel(request, callback)

undeployIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUndeployIssueModelRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelResponse, protos.google.cloud.contactcenterinsights.v1.IUndeployIssueModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

undeployQaScorecardRevision(request, options)

undeployQaScorecardRevision(request?: protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision,
        (protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest | undefined),
        {} | undefined
    ]>;

Undeploy a QaScorecardRevision.

Parameters
Name Description
request IUndeployQaScorecardRevisionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, (protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 name of the QaScorecardRevision to undeploy.
   */
  // const name = 'abc123'

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUndeployQaScorecardRevision() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contactcenterinsightsClient.undeployQaScorecardRevision(request);
    console.log(response);
  }

  callUndeployQaScorecardRevision();

undeployQaScorecardRevision(request, options, callback)

undeployQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUndeployQaScorecardRevisionRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

undeployQaScorecardRevision(request, callback)

undeployQaScorecardRevision(request: protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUndeployQaScorecardRevisionRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecardRevision, protos.google.cloud.contactcenterinsights.v1.IUndeployQaScorecardRevisionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateAnalysisRule(request, options)

updateAnalysisRule(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IAnalysisRule,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest | undefined),
        {} | undefined
    ]>;

Updates a analysis rule.

Parameters
Name Description
request IUpdateAnalysisRuleRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, (protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing AnalysisRule. Please see the documentation for more details and examples.

Example

  /**
   * 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 new analysis rule.
   */
  // const analysisRule = {}
  /**
   *  Optional. The list of fields to be updated.
   *  If the update_mask is not provided, the update will be applied to all
   *  fields.
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateAnalysisRule() {
    // Construct request
    const request = {
      analysisRule,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateAnalysisRule(request);
    console.log(response);
  }

  callUpdateAnalysisRule();

updateAnalysisRule(request, options, callback)

updateAnalysisRule(request: protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateAnalysisRuleRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateAnalysisRule(request, callback)

updateAnalysisRule(request: protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateAnalysisRuleRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysisRule, protos.google.cloud.contactcenterinsights.v1.IUpdateAnalysisRuleRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateConversation(request, options)

updateConversation(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IConversation,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest | undefined),
        {} | undefined
    ]>;

Updates a conversation.

Parameters
Name Description
request IUpdateConversationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IConversation, (protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 new values for the conversation.
   */
  // const conversation = {}
  /**
   *  The list of fields to be updated. All possible fields can be updated by
   *  passing `*`, or a subset of the following updateable fields can be
   *  provided:
   *  * `agent_id`
   *  * `language_code`
   *  * `labels`
   *  * `metadata`
   *  * `quality_metadata`
   *  * `call_metadata`
   *  * `start_time`
   *  * `expire_time` or `ttl`
   *  * `data_source.gcs_source.audio_uri` or
   *  `data_source.dialogflow_source.audio_uri`
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateConversation() {
    // Construct request
    const request = {
      conversation,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateConversation(request);
    console.log(response);
  }

  callUpdateConversation();

updateConversation(request, options, callback)

updateConversation(request: protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateConversationRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateConversation(request, callback)

updateConversation(request: protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateConversationRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateFeedbackLabel(request, options)

updateFeedbackLabel(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest | undefined),
        {} | undefined
    ]>;

Update feedback label.

Parameters
Name Description
request IUpdateFeedbackLabelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, (protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing FeedbackLabel. Please see the documentation for more details and examples.

Example

  /**
   * 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 feedback label to update.
   */
  // const feedbackLabel = {}
  /**
   *  Required. The list of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateFeedbackLabel() {
    // Construct request
    const request = {
      feedbackLabel,
      updateMask,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateFeedbackLabel(request);
    console.log(response);
  }

  callUpdateFeedbackLabel();

updateFeedbackLabel(request, options, callback)

updateFeedbackLabel(request: protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateFeedbackLabelRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateFeedbackLabel(request, callback)

updateFeedbackLabel(request: protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateFeedbackLabelRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IFeedbackLabel, protos.google.cloud.contactcenterinsights.v1.IUpdateFeedbackLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateIssue(request, options)

updateIssue(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IIssue,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest | undefined),
        {} | undefined
    ]>;

Updates an issue.

Parameters
Name Description
request IUpdateIssueRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IIssue, (protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Issue. Please see the documentation for more details and examples.

Example

  /**
   * 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 new values for the issue.
   */
  // const issue = {}
  /**
   *  The list of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateIssue() {
    // Construct request
    const request = {
      issue,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateIssue(request);
    console.log(response);
  }

  callUpdateIssue();

updateIssue(request, options, callback)

updateIssue(request: protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateIssueRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateIssue(request, callback)

updateIssue(request: protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateIssueRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IUpdateIssueRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateIssueModel(request, options)

updateIssueModel(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IIssueModel,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest | undefined),
        {} | undefined
    ]>;

Updates an issue model.

Parameters
Name Description
request IUpdateIssueModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IIssueModel, (protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 new values for the issue model.
   */
  // const issueModel = {}
  /**
   *  The list of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateIssueModel() {
    // Construct request
    const request = {
      issueModel,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateIssueModel(request);
    console.log(response);
  }

  callUpdateIssueModel();

updateIssueModel(request, options, callback)

updateIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateIssueModelRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateIssueModel(request, callback)

updateIssueModel(request: protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateIssueModelRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IUpdateIssueModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePhraseMatcher(request, options)

updatePhraseMatcher(request?: protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher,
        (protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest | undefined),
        {} | undefined
    ]>;

Updates a phrase matcher.

Parameters
Name Description
request IUpdatePhraseMatcherRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, (protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 new values for the phrase matcher.
   */
  // const phraseMatcher = {}
  /**
   *  The list of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdatePhraseMatcher() {
    // Construct request
    const request = {
      phraseMatcher,
    };

    // Run request
    const response = await contactcenterinsightsClient.updatePhraseMatcher(request);
    console.log(response);
  }

  callUpdatePhraseMatcher();

updatePhraseMatcher(request, options, callback)

updatePhraseMatcher(request: protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdatePhraseMatcherRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePhraseMatcher(request, callback)

updatePhraseMatcher(request: protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdatePhraseMatcherRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateQaQuestion(request, options)

updateQaQuestion(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaQuestion,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest | undefined),
        {} | undefined
    ]>;

Updates a QaQuestion.

Parameters
Name Description
request IUpdateQaQuestionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaQuestion, (protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 QaQuestion to update.
   */
  // const qaQuestion = {}
  /**
   *  Required. The list of fields to be updated. All possible fields can be
   *  updated by passing `*`, or a subset of the following updateable fields can
   *  be provided:
   *  * `abbreviation`
   *  * `answer_choices`
   *  * `answer_instructions`
   *  * `order`
   *  * `question_body`
   *  * `tags`
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateQaQuestion() {
    // Construct request
    const request = {
      qaQuestion,
      updateMask,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateQaQuestion(request);
    console.log(response);
  }

  callUpdateQaQuestion();

updateQaQuestion(request, options, callback)

updateQaQuestion(request: protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateQaQuestionRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateQaQuestion(request, callback)

updateQaQuestion(request: protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateQaQuestionRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaQuestion, protos.google.cloud.contactcenterinsights.v1.IUpdateQaQuestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateQaScorecard(request, options)

updateQaScorecard(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IQaScorecard,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest | undefined),
        {} | undefined
    ]>;

Updates a QaScorecard.

Parameters
Name Description
request IUpdateQaScorecardRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IQaScorecard, (protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing QaScorecard. Please see the documentation for more details and examples.

Example

  /**
   * 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 QaScorecard to update.
   */
  // const qaScorecard = {}
  /**
   *  Required. The list of fields to be updated. All possible fields can be
   *  updated by passing `*`, or a subset of the following updateable fields can
   *  be provided:
   *  * `description`
   *  * `display_name`
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateQaScorecard() {
    // Construct request
    const request = {
      qaScorecard,
      updateMask,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateQaScorecard(request);
    console.log(response);
  }

  callUpdateQaScorecard();

updateQaScorecard(request, options, callback)

updateQaScorecard(request: protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateQaScorecardRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateQaScorecard(request, callback)

updateQaScorecard(request: protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateQaScorecardRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IQaScorecard, protos.google.cloud.contactcenterinsights.v1.IUpdateQaScorecardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateSettings(request, options)

updateSettings(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.ISettings,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest | undefined),
        {} | undefined
    ]>;

Updates project-level settings.

Parameters
Name Description
request IUpdateSettingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.ISettings, (protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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 new settings values.
   */
  // const settings = {}
  /**
   *  Required. The list of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateSettings() {
    // Construct request
    const request = {
      settings,
      updateMask,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateSettings(request);
    console.log(response);
  }

  callUpdateSettings();

updateSettings(request, options, callback)

updateSettings(request: protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.ISettings, protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateSettingsRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.ISettings, protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateSettings(request, callback)

updateSettings(request: protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.ISettings, protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateSettingsRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.ISettings, protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateView(request, options)

updateView(request?: protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest, options?: CallOptions): Promise<[
        protos.google.cloud.contactcenterinsights.v1.IView,
        (protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest | undefined),
        {} | undefined
    ]>;

Updates a view.

Parameters
Name Description
request IUpdateViewRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IView, (protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing View. Please see the documentation for more details and examples.

Example

  /**
   * 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 new view.
   */
  // const view = {}
  /**
   *  The list of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

  async function callUpdateView() {
    // Construct request
    const request = {
      view,
    };

    // Run request
    const response = await contactcenterinsightsClient.updateView(request);
    console.log(response);
  }

  callUpdateView();

updateView(request, options, callback)

updateView(request: protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest, options: CallOptions, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateViewRequest
options CallOptions
callback Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateView(request, callback)

updateView(request: protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest, callback: Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateViewRequest
callback Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

uploadConversation(request, options)

uploadConversation(request?: protos.google.cloud.contactcenterinsights.v1.IUploadConversationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Create a long-running conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction.

Parameters
Name Description
request IUploadConversationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * 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 resource of the conversation.
   */
  // const parent = 'abc123'
  /**
   *  Required. The conversation resource to create.
   */
  // const conversation = {}
  /**
   *  Optional. A unique ID for the new conversation. This ID will become the
   *  final component of the conversation's resource name. If no ID is specified,
   *  a server-generated ID will be used.
   *  This value should be 4-64 characters and must match the regular
   *  expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
   */
  // const conversationId = 'abc123'
  /**
   *  Optional. DLP settings for transcript redaction. Will default to the config
   *  specified in Settings.
   */
  // const redactionConfig = {}
  /**
   *  Optional. Speech-to-Text configuration. Will default to the config
   *  specified in Settings.
   */
  // const speechConfig = {}

  // Imports the Contactcenterinsights library
  const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;

  // Instantiates a client
  const contactcenterinsightsClient = new ContactCenterInsightsClient();

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

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

  callUploadConversation();

uploadConversation(request, options, callback)

uploadConversation(request: protos.google.cloud.contactcenterinsights.v1.IUploadConversationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUploadConversationRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

uploadConversation(request, callback)

uploadConversation(request: protos.google.cloud.contactcenterinsights.v1.IUploadConversationRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUploadConversationRequest
callback Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

viewPath(project, location, view)

viewPath(project: string, location: string, view: string): string;

Return a fully-qualified view resource name string.

Parameters
Name Description
project string
location string
view string
Returns
Type Description
string

{string} Resource name string.