Class v1.ContactCenterInsightsClient (1.10.0)

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

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ContactCenterInsightsClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

contactCenterInsightsStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

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.

warn

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

Methods

analysisPath(project, location, conversation, analysis)

analysisPath(project: string, location: string, conversation: string, analysis: string): string;

Return a fully-qualified analysis resource name string.

Parameters

Name	Description
project	`string`
location	`string`
conversation	`string`
analysis	`string`

Returns

Type	Description
string	{string} Resource name string.

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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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 [CalculateStatsResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.ICalculateStatsResponse, protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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();

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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();

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.

conversationPath(project, location, conversation)

conversationPath(project: string, location: string, conversation: string): string;

Return a fully-qualified conversation resource name string.

Parameters

Name	Description
project	`string`
location	`string`
conversation	`string`

Returns

Type	Description
string	{string} Resource name string.

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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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	`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>`

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	`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>`

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.

Parameters

Name	Description
request	`protos.google.cloud.contactcenterinsights.v1.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 [Conversation]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest \| 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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	`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>`

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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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 [PhraseMatcher]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest \| 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest \| 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest \| 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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	`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>`

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	`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>`

Returns

Type	Description
void

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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest \| 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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	`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>`

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	`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>`

Returns

Type	Description
void

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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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	`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>`

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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest \| 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	`protos.google.cloud.contactcenterinsights.v1.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 [Conversation]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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 [IssueModel]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IIssueModel, protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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	`protos.google.cloud.contactcenterinsights.v1.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 [PhraseMatcher]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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

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	`protos.google.cloud.contactcenterinsights.v1.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 [Settings]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.IGetViewRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IGetViewRequest \| 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.

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.

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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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	`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>`

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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * 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 = await 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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	`protos.google.cloud.contactcenterinsights.v1.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 [Conversation]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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	`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>`

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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Conversation]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * 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 1,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'
  /**
   *  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 = await 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	`protos.google.cloud.contactcenterinsights.v1.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 [Conversation] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IListIssuesResponse, protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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	`protos.google.cloud.contactcenterinsights.v1.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 [PhraseMatcher]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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	`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>`

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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [PhraseMatcher]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * 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 = await 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	`protos.google.cloud.contactcenterinsights.v1.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 [PhraseMatcher] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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	`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>`

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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * 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 = await 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.

matchAnalysisFromAnalysisName(analysisName)

matchAnalysisFromAnalysisName(analysisName: string): string | number;

Parse the analysis from Analysis resource.

Parameter

Name	Description
analysisName	`string` A fully-qualified path representing Analysis resource.

Returns

Type	Description
string \| number	{string} A string representing the analysis.

matchConversationFromAnalysisName(analysisName)

matchConversationFromAnalysisName(analysisName: string): string | number;

Parse the conversation from Analysis resource.

Parameter

Name	Description
analysisName	`string` A fully-qualified path representing Analysis resource.

Returns

Type	Description
string \| number	{string} A string representing the conversation.

matchConversationFromConversationName(conversationName)

matchConversationFromConversationName(conversationName: string): string | number;

Parse the conversation from Conversation resource.

Parameter

Name	Description
conversationName	`string` A fully-qualified path representing Conversation resource.

Returns

Type	Description
string \| number	{string} A string representing the conversation.

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.

matchLocationFromAnalysisName(analysisName)

matchLocationFromAnalysisName(analysisName: string): string | number;

Parse the location from Analysis resource.

Parameter

Name	Description
analysisName	`string` A fully-qualified path representing Analysis resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromConversationName(conversationName)

matchLocationFromConversationName(conversationName: string): string | number;

Parse the location from Conversation resource.

Parameter

Name	Description
conversationName	`string` A fully-qualified path representing Conversation 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.

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.

matchProjectFromAnalysisName(analysisName)

matchProjectFromAnalysisName(analysisName: string): string | number;

Parse the project from Analysis resource.

Parameter

Name	Description
analysisName	`string` A fully-qualified path representing Analysis resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromConversationName(conversationName)

matchProjectFromConversationName(conversationName: string): string | number;

Parse the project from Conversation resource.

Parameter

Name	Description
conversationName	`string` A fully-qualified path representing Conversation 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.

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.

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.

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.

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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * 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	`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>`

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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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 [Conversation]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   */
  // 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest \| 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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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 [IssueModel]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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 [PhraseMatcher]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, protos.google.cloud.contactcenterinsights.v1.IUpdatePhraseMatcherRequest \| 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	`protos.google.cloud.contactcenterinsights.v1.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 [Settings]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.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	`protos.google.cloud.contactcenterinsights.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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	`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>`

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	`protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest`
callback	`Callback<protos.google.cloud.contactcenterinsights.v1.IView, protos.google.cloud.contactcenterinsights.v1.IUpdateViewRequest \| 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