Class v1.ContactCenterInsightsClient (1.1.0)

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

Package

@google-cloud/contact-center-insights!

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.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

contactCenterInsightsStub

contactCenterInsightsStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsResponse, (protos.google.cloud.contactcenterinsights.v1.ICalculateIssueModelStatsRequest | undefined), {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.ICalculateStatsResponse, (protos.google.cloud.contactcenterinsights.v1.ICalculateStatsRequest | undefined), {} | undefined ]>

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.

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.

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IAnalysis, protos.google.cloud.contactcenterinsights.v1.ICreateAnalysisOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IConversation, (protos.google.cloud.contactcenterinsights.v1.ICreateConversationRequest | undefined), {} | undefined ]>

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

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, (protos.google.cloud.contactcenterinsights.v1.ICreatePhraseMatcherRequest | undefined), {} | undefined ]>

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

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest | undefined), {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest | undefined), {} | undefined ]>

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

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contactcenterinsights.v1.IDeletePhraseMatcherRequest | undefined), {} | undefined ]>

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

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataResponse, protos.google.cloud.contactcenterinsights.v1.IExportInsightsDataMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IAnalysis, (protos.google.cloud.contactcenterinsights.v1.IGetAnalysisRequest | undefined), {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IConversation, (protos.google.cloud.contactcenterinsights.v1.IGetConversationRequest | undefined), {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IIssue, protos.google.cloud.contactcenterinsights.v1.IGetIssueRequest | undefined, {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IIssueModel, (protos.google.cloud.contactcenterinsights.v1.IGetIssueModelRequest | undefined), {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher, (protos.google.cloud.contactcenterinsights.v1.IGetPhraseMatcherRequest | undefined), {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.ISettings, (protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest | undefined), {} | undefined ]>

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

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IAnalysis[], protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest | null, protos.google.cloud.contactcenterinsights.v1.IListAnalysesResponse ]>

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.

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IConversation[], protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest | null, protos.google.cloud.contactcenterinsights.v1.IListConversationsResponse ]>

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.

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IListIssueModelsResponse, (protos.google.cloud.contactcenterinsights.v1.IListIssueModelsRequest | undefined), {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IListIssuesResponse, (protos.google.cloud.contactcenterinsights.v1.IListIssuesRequest | undefined), {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IPhraseMatcher[], protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest | null, protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersResponse ]>

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.

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.

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.

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.

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.

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.IConversation, (protos.google.cloud.contactcenterinsights.v1.IUpdateConversationRequest | undefined), {} | undefined ]>

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

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
    ]>;
Parameters
Name Description
request protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.contactcenterinsights.v1.ISettings, (protos.google.cloud.contactcenterinsights.v1.IUpdateSettingsRequest | undefined), {} | undefined ]>

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