An API that lets users analyze and explore their business conversation data. v1
Package
@google-cloud/contact-center-insights
Constructors
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of ContactCenterInsightsClient.
Parameters |
---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of google-gax . Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ContactCenterInsightsClient({fallback: true}, gax); ```
|
Properties
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
contactCenterInsightsStub?: Promise<{
[name: string]: Function;
}>;
descriptors: Descriptors;
innerApiCalls: {
[name: string]: Function;
};
operationsClient: gax.OperationsClient;
pathTemplates: {
[name: string]: gax.PathTemplate;
};
static get port(): number;
The port for this API service.
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
static get servicePath(): string;
The DNS address for this API service.
warn: (code: string, message: string, warnType?: string) => void;
Methods
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.
|
bulkAnalyzeConversations(request?: protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Analyzes multiple conversations in a single request.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource to create analyses in.
*/
// const parent = 'abc123'
/**
* Required. Filter used to select the subset of conversations to analyze.
*/
// const filter = 'abc123'
/**
* Required. Percentage of selected conversation to analyze, between
* 0, 100.
*/
// const analysisPercentage = 1234
/**
* To select the annotators to run and the phrase matchers to use
* (if any). If not specified, all annotators will be run.
*/
// const annotatorSelector = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callBulkAnalyzeConversations() {
// Construct request
const request = {
parent,
filter,
analysisPercentage,
};
// Run request
const [operation] = await contactcenterinsightsClient.bulkAnalyzeConversations(request);
const [response] = await operation.promise();
console.log(response);
}
callBulkAnalyzeConversations();
bulkAnalyzeConversations(request: protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
bulkAnalyzeConversations(request: protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkAnalyzeConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
bulkDeleteConversations(request?: protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes multiple conversations in a single request.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource to delete conversations from.
* Format:
* projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Filter used to select the subset of conversations to delete.
*/
// const filter = 'abc123'
/**
* Maximum number of conversations to delete.
*/
// const maxDeleteCount = 1234
/**
* If set to true, all of this conversation's analyses will also be deleted.
* Otherwise, the request will only succeed if the conversation has no
* analyses.
*/
// const force = true
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callBulkDeleteConversations() {
// Construct request
const request = {
parent,
};
// Run request
const [operation] = await contactcenterinsightsClient.bulkDeleteConversations(request);
const [response] = await operation.promise();
console.log(response);
}
callBulkDeleteConversations();
bulkDeleteConversations(request: protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
bulkDeleteConversations(request: protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IBulkDeleteConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the issue model to query against.
*/
// const issueModel = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callCalculateIssueModelStats() {
// Construct request
const request = {
issueModel,
};
// Run request
const response = await contactcenterinsightsClient.calculateIssueModelStats(request);
console.log(response);
}
callCalculateIssueModelStats();
calculateIssueModelStats(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The location of the conversations.
*/
// const location = 'abc123'
/**
* A filter to reduce results to a specific subset. This field is useful for
* getting statistics about conversations with specific properties.
*/
// const filter = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callCalculateStats() {
// Construct request
const request = {
location,
};
// Run request
const response = await contactcenterinsightsClient.calculateStats(request);
console.log(response);
}
callCalculateStats();
calculateStats(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Example
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkBulkAnalyzeConversationsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkAnalyzeConversationsResponse, protos.google.cloud.contactcenterinsights.v1.BulkAnalyzeConversationsMetadata>>;
Check the status of the long running operation returned by bulkAnalyzeConversations()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource to create analyses in.
*/
// const parent = 'abc123'
/**
* Required. Filter used to select the subset of conversations to analyze.
*/
// const filter = 'abc123'
/**
* Required. Percentage of selected conversation to analyze, between
* 0, 100.
*/
// const analysisPercentage = 1234
/**
* To select the annotators to run and the phrase matchers to use
* (if any). If not specified, all annotators will be run.
*/
// const annotatorSelector = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callBulkAnalyzeConversations() {
// Construct request
const request = {
parent,
filter,
analysisPercentage,
};
// Run request
const [operation] = await contactcenterinsightsClient.bulkAnalyzeConversations(request);
const [response] = await operation.promise();
console.log(response);
}
callBulkAnalyzeConversations();
checkBulkDeleteConversationsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.BulkDeleteConversationsResponse, protos.google.cloud.contactcenterinsights.v1.BulkDeleteConversationsMetadata>>;
Check the status of the long running operation returned by bulkDeleteConversations()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource to delete conversations from.
* Format:
* projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Filter used to select the subset of conversations to delete.
*/
// const filter = 'abc123'
/**
* Maximum number of conversations to delete.
*/
// const maxDeleteCount = 1234
/**
* If set to true, all of this conversation's analyses will also be deleted.
* Otherwise, the request will only succeed if the conversation has no
* analyses.
*/
// const force = true
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callBulkDeleteConversations() {
// Construct request
const request = {
parent,
};
// Run request
const [operation] = await contactcenterinsightsClient.bulkDeleteConversations(request);
const [response] = await operation.promise();
console.log(response);
}
callBulkDeleteConversations();
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.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the analysis.
*/
// const parent = 'abc123'
/**
* Required. The analysis to create.
*/
// const analysis = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callCreateAnalysis() {
// Construct request
const request = {
parent,
analysis,
};
// Run request
const [operation] = await contactcenterinsightsClient.createAnalysis(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateAnalysis();
checkCreateIssueModelProgress(name: 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.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the issue model.
*/
// const parent = 'abc123'
/**
* Required. The issue model to create.
*/
// const issueModel = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callCreateIssueModel() {
// Construct request
const request = {
parent,
issueModel,
};
// Run request
const [operation] = await contactcenterinsightsClient.createIssueModel(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateIssueModel();
checkDeleteIssueModelProgress(name: 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.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the issue model to delete.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeleteIssueModel() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await contactcenterinsightsClient.deleteIssueModel(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteIssueModel();
checkDeployIssueModelProgress(name: 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.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The issue model to deploy.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeployIssueModel() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await contactcenterinsightsClient.deployIssueModel(request);
const [response] = await operation.promise();
console.log(response);
}
callDeployIssueModel();
checkExportInsightsDataProgress(name: 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.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Specified if sink is a BigQuery table.
*/
// const bigQueryDestination = {}
/**
* Required. The parent resource to export data from.
*/
// const parent = 'abc123'
/**
* A filter to reduce results to a specific subset. Useful for exporting
* conversations with specific properties.
*/
// const filter = 'abc123'
/**
* A fully qualified KMS key name for BigQuery tables protected by CMEK.
* Format:
* projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}
*/
// const kmsKey = 'abc123'
/**
* Options for what to do if the destination table already exists.
*/
// const writeDisposition = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callExportInsightsData() {
// Construct request
const request = {
parent,
};
// Run request
const [operation] = await contactcenterinsightsClient.exportInsightsData(request);
const [response] = await operation.promise();
console.log(response);
}
callExportInsightsData();
checkIngestConversationsProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.IngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IngestConversationsMetadata>>;
Check the status of the long running operation returned by ingestConversations()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* A cloud storage bucket source. Note that any previously ingested objects
* from the source will be skipped to avoid duplication.
*/
// const gcsSource = {}
/**
* Configuration for when `source` contains conversation transcripts.
*/
// const transcriptObjectConfig = {}
/**
* Required. The parent resource for new conversations.
*/
// const parent = 'abc123'
/**
* Configuration that applies to all conversations.
*/
// const conversationConfig = {}
/**
* Optional. DLP settings for transcript redaction. Optional, will default to
* the config specified in Settings.
*/
// const redactionConfig = {}
/**
* Optional. Default Speech-to-Text configuration. Optional, will default to
* the config specified in Settings.
*/
// const speechConfig = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callIngestConversations() {
// Construct request
const request = {
parent,
};
// Run request
const [operation] = await contactcenterinsightsClient.ingestConversations(request);
const [response] = await operation.promise();
console.log(response);
}
callIngestConversations();
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.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The issue model to undeploy.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUndeployIssueModel() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await contactcenterinsightsClient.undeployIssueModel(request);
const [response] = await operation.promise();
console.log(response);
}
callUndeployIssueModel();
checkUploadConversationProgress(name: string): Promise<LROperation<protos.google.cloud.contactcenterinsights.v1.Conversation, protos.google.cloud.contactcenterinsights.v1.UploadConversationMetadata>>;
Check the status of the long running operation returned by uploadConversation()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the conversation.
*/
// const parent = 'abc123'
/**
* Required. The conversation resource to create.
*/
// const conversation = {}
/**
* Optional. A unique ID for the new conversation. This ID will become the
* final component of the conversation's resource name. If no ID is specified,
* a server-generated ID will be used.
* This value should be 4-64 characters and must match the regular
* expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
*/
// const conversationId = 'abc123'
/**
* Optional. DLP settings for transcript redaction. Will default to the config
* specified in Settings.
*/
// const redactionConfig = {}
/**
* Optional. Speech-to-Text configuration. Will default to the config
* specified in Settings.
*/
// const speechConfig = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUploadConversation() {
// Construct request
const request = {
parent,
conversation,
};
// Run request
const [operation] = await contactcenterinsightsClient.uploadConversation(request);
const [response] = await operation.promise();
console.log(response);
}
callUploadConversation();
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: 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?: 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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the analysis.
*/
// const parent = 'abc123'
/**
* Required. The analysis to create.
*/
// const analysis = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callCreateAnalysis() {
// Construct request
const request = {
parent,
analysis,
};
// Run request
const [operation] = await contactcenterinsightsClient.createAnalysis(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateAnalysis();
createAnalysis(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the conversation.
*/
// const parent = 'abc123'
/**
* Required. The conversation resource to create.
*/
// const conversation = {}
/**
* A unique ID for the new conversation. This ID will become the final
* component of the conversation's resource name. If no ID is specified, a
* server-generated ID will be used.
* This value should be 4-64 characters and must match the regular
* expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
*/
// const conversationId = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callCreateConversation() {
// Construct request
const request = {
parent,
conversation,
};
// Run request
const response = await contactcenterinsightsClient.createConversation(request);
console.log(response);
}
callCreateConversation();
createConversation(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the issue model.
*/
// const parent = 'abc123'
/**
* Required. The issue model to create.
*/
// const issueModel = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callCreateIssueModel() {
// Construct request
const request = {
parent,
issueModel,
};
// Run request
const [operation] = await contactcenterinsightsClient.createIssueModel(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateIssueModel();
createIssueModel(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the phrase matcher. Required. The location
* to create a phrase matcher for. Format: `projects/
createPhraseMatcher(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Parameters |
---|
Name | Description |
request |
ICreateViewRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the view. Required. The location to create
* a view for.
* Format: `projects/
createView(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
deleteAnalysis(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.contactcenterinsights.v1.IDeleteAnalysisRequest | undefined),
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the analysis to delete.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeleteAnalysis() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.deleteAnalysis(request);
console.log(response);
}
callDeleteAnalysis();
deleteAnalysis(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
deleteConversation(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.contactcenterinsights.v1.IDeleteConversationRequest | undefined),
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the conversation to delete.
*/
// const name = 'abc123'
/**
* If set to true, all of this conversation's analyses will also be deleted.
* Otherwise, the request will only succeed if the conversation has no
* analyses.
*/
// const force = true
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeleteConversation() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.deleteConversation(request);
console.log(response);
}
callDeleteConversation();
deleteConversation(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
deleteIssue(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | undefined),
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
IDeleteIssueRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the issue to delete.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeleteIssue() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.deleteIssue(request);
console.log(response);
}
callDeleteIssue();
deleteIssue(request: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteIssue(request: protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contactcenterinsights.v1.IDeleteIssueRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
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
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the issue model to delete.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeleteIssueModel() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await contactcenterinsightsClient.deleteIssueModel(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteIssueModel();
deleteIssueModel(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Example
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the phrase matcher to delete.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeletePhraseMatcher() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.deletePhraseMatcher(request);
console.log(response);
}
callDeletePhraseMatcher();
deletePhraseMatcher(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
deleteView(request?: protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.contactcenterinsights.v1.IDeleteViewRequest | undefined),
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
IDeleteViewRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the view to delete.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeleteView() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.deleteView(request);
console.log(response);
}
callDeleteView();
deleteView(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The issue model to deploy.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callDeployIssueModel() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await contactcenterinsightsClient.deployIssueModel(request);
const [response] = await operation.promise();
console.log(response);
}
callDeployIssueModel();
deployIssueModel(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Specified if sink is a BigQuery table.
*/
// const bigQueryDestination = {}
/**
* Required. The parent resource to export data from.
*/
// const parent = 'abc123'
/**
* A filter to reduce results to a specific subset. Useful for exporting
* conversations with specific properties.
*/
// const filter = 'abc123'
/**
* A fully qualified KMS key name for BigQuery tables protected by CMEK.
* Format:
* projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}
*/
// const kmsKey = 'abc123'
/**
* Options for what to do if the destination table already exists.
*/
// const writeDisposition = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callExportInsightsData() {
// Construct request
const request = {
parent,
};
// Run request
const [operation] = await contactcenterinsightsClient.exportInsightsData(request);
const [response] = await operation.promise();
console.log(response);
}
callExportInsightsData();
exportInsightsData(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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 |
IGetAnalysisRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the analysis to get.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callGetAnalysis() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.getAnalysis(request);
console.log(response);
}
callGetAnalysis();
getAnalysis(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the conversation to get.
*/
// const name = 'abc123'
/**
* The level of details of the conversation. Default is `FULL`.
*/
// const view = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callGetConversation() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.getConversation(request);
console.log(response);
}
callGetConversation();
getConversation(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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 |
IGetIssueRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the issue to get.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callGetIssue() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.getIssue(request);
console.log(response);
}
callGetIssue();
getIssue(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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 |
IGetIssueModelRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the issue model to get.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callGetIssueModel() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.getIssueModel(request);
console.log(response);
}
callGetIssueModel();
getIssueModel(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Example
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
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
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the phrase matcher to get.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callGetPhraseMatcher() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.getPhraseMatcher(request);
console.log(response);
}
callGetPhraseMatcher();
getPhraseMatcher(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
getProjectId(): Promise<string>;
Returns |
---|
Type | Description |
Promise<string> | |
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter |
---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns |
---|
Type | Description |
void | |
getSettings(request?: protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest, options?: CallOptions): Promise<[
protos.google.cloud.contactcenterinsights.v1.ISettings,
(protos.google.cloud.contactcenterinsights.v1.IGetSettingsRequest | undefined),
{} | undefined
]>;
Gets project-level settings.
Parameters |
---|
Name | Description |
request |
IGetSettingsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the settings resource to get.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callGetSettings() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.getSettings(request);
console.log(response);
}
callGetSettings();
getSettings(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Parameters |
---|
Name | Description |
request |
IGetViewRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the view to get.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callGetView() {
// Construct request
const request = {
name,
};
// Run request
const response = await contactcenterinsightsClient.getView(request);
console.log(response);
}
callGetView();
getView(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
ingestConversations(request?: protos.google.cloud.contactcenterinsights.v1.IIngestConversationsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Imports conversations and processes them according to the user's configuration.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* A cloud storage bucket source. Note that any previously ingested objects
* from the source will be skipped to avoid duplication.
*/
// const gcsSource = {}
/**
* Configuration for when `source` contains conversation transcripts.
*/
// const transcriptObjectConfig = {}
/**
* Required. The parent resource for new conversations.
*/
// const parent = 'abc123'
/**
* Configuration that applies to all conversations.
*/
// const conversationConfig = {}
/**
* Optional. DLP settings for transcript redaction. Optional, will default to
* the config specified in Settings.
*/
// const redactionConfig = {}
/**
* Optional. Default Speech-to-Text configuration. Optional, will default to
* the config specified in Settings.
*/
// const speechConfig = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callIngestConversations() {
// Construct request
const request = {
parent,
};
// Run request
const [operation] = await contactcenterinsightsClient.ingestConversations(request);
const [response] = await operation.promise();
console.log(response);
}
callIngestConversations();
ingestConversations(request: protos.google.cloud.contactcenterinsights.v1.IIngestConversationsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
ingestConversations(request: protos.google.cloud.contactcenterinsights.v1.IIngestConversationsRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IIngestConversationsResponse, protos.google.cloud.contactcenterinsights.v1.IIngestConversationsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
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: 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: 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?: 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 |
IListAnalysesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
listAnalysesAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IAnalysis>;
Equivalent to listAnalyses
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
IListAnalysesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the analyses.
*/
// const parent = 'abc123'
/**
* The maximum number of analyses to return in the response. If this
* value is zero, the service will select a default size. A call might return
* fewer objects than requested. A non-empty `next_page_token` in the response
* indicates that more data is available.
*/
// const pageSize = 1234
/**
* The value returned by the last `ListAnalysesResponse`; indicates
* that this is a continuation of a prior `ListAnalyses` call and
* the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* A filter to reduce results to a specific subset. Useful for querying
* conversations with specific properties.
*/
// const filter = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callListAnalyses() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await contactcenterinsightsClient.listAnalysesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAnalyses();
listAnalysesStream(request?: protos.google.cloud.contactcenterinsights.v1.IListAnalysesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
IListAnalysesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing Analysis on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAnalysesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
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
]>;
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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the conversation.
*/
// const parent = 'abc123'
/**
* The maximum number of conversations to return in the response. A valid page
* size ranges from 0 to 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?: protos.google.cloud.contactcenterinsights.v1.IListConversationsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listConversationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
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
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the issue model.
*/
// const parent = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callListIssueModels() {
// Construct request
const request = {
parent,
};
// Run request
const response = await contactcenterinsightsClient.listIssueModels(request);
console.log(response);
}
callListIssueModels();
listIssueModels(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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 |
IListIssuesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the issue.
*/
// const parent = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callListIssues() {
// Construct request
const request = {
parent,
};
// Run request
const response = await contactcenterinsightsClient.listIssues(request);
console.log(response);
}
callListIssues();
listIssues(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters |
---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent.
|
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
|
Example
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
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
]>;
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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the phrase matcher.
*/
// const parent = 'abc123'
/**
* The maximum number of phrase matchers to return in the response. If this
* value is zero, the service will select a default size. A call might return
* fewer objects than requested. A non-empty `next_page_token` in the response
* indicates that more data is available.
*/
// const pageSize = 1234
/**
* The value returned by the last `ListPhraseMatchersResponse`. This value
* indicates that this is a continuation of a prior `ListPhraseMatchers` call
* and that the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* A filter to reduce results to a specific subset. Useful for querying
* phrase matchers with specific properties.
*/
// const filter = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callListPhraseMatchers() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await contactcenterinsightsClient.listPhraseMatchersAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPhraseMatchers();
listPhraseMatchersStream(request?: protos.google.cloud.contactcenterinsights.v1.IListPhraseMatchersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPhraseMatchersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
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
]>;
Parameters |
---|
Name | Description |
request |
IListViewsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
listViewsAsync(request?: protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IView>;
Equivalent to listViews
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
IListViewsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.cloud.contactcenterinsights.v1.IView> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing View. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the views.
*/
// const parent = 'abc123'
/**
* The maximum number of views to return in the response. If this
* value is zero, the service will select a default size. A call may return
* fewer objects than requested. A non-empty `next_page_token` in the response
* indicates that more data is available.
*/
// const pageSize = 1234
/**
* The value returned by the last `ListViewsResponse`; indicates
* that this is a continuation of a prior `ListViews` call and
* the system should return the next page of data.
*/
// const pageToken = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callListViews() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await contactcenterinsightsClient.listViewsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListViews();
listViewsStream(request?: protos.google.cloud.contactcenterinsights.v1.IListViewsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
IListViewsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing View on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listViewsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
locationPath(project: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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?: 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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The issue model to undeploy.
*/
// const name = 'abc123'
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUndeployIssueModel() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await contactcenterinsightsClient.undeployIssueModel(request);
const [response] = await operation.promise();
console.log(response);
}
callUndeployIssueModel();
undeployIssueModel(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The new values for the conversation.
*/
// const conversation = {}
/**
* The list of fields to be updated.
*/
// 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: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Parameters |
---|
Name | Description |
request |
IUpdateIssueRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The new values for the issue.
*/
// const issue = {}
/**
* The list of fields to be updated.
*/
// const updateMask = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUpdateIssue() {
// Construct request
const request = {
issue,
};
// Run request
const response = await contactcenterinsightsClient.updateIssue(request);
console.log(response);
}
callUpdateIssue();
updateIssue(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The new values for the issue model.
*/
// const issueModel = {}
/**
* The list of fields to be updated.
*/
// const updateMask = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUpdateIssueModel() {
// Construct request
const request = {
issueModel,
};
// Run request
const response = await contactcenterinsightsClient.updateIssueModel(request);
console.log(response);
}
callUpdateIssueModel();
updateIssueModel(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The new values for the phrase matcher.
*/
// const phraseMatcher = {}
/**
* The list of fields to be updated.
*/
// const updateMask = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUpdatePhraseMatcher() {
// Construct request
const request = {
phraseMatcher,
};
// Run request
const response = await contactcenterinsightsClient.updatePhraseMatcher(request);
console.log(response);
}
callUpdatePhraseMatcher();
updatePhraseMatcher(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The new settings values.
*/
// const settings = {}
/**
* Required. The list of fields to be updated.
*/
// const updateMask = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUpdateSettings() {
// Construct request
const request = {
settings,
updateMask,
};
// Run request
const response = await contactcenterinsightsClient.updateSettings(request);
console.log(response);
}
callUpdateSettings();
updateSettings(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
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
]>;
Parameters |
---|
Name | Description |
request |
IUpdateViewRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The new view.
*/
// const view = {}
/**
* The list of fields to be updated.
*/
// const updateMask = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUpdateView() {
// Construct request
const request = {
view,
};
// Run request
const response = await contactcenterinsightsClient.updateView(request);
console.log(response);
}
callUpdateView();
updateView(request: 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;
Returns |
---|
Type | Description |
void | |
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;
Returns |
---|
Type | Description |
void | |
uploadConversation(request?: protos.google.cloud.contactcenterinsights.v1.IUploadConversationRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Create a longrunning conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the conversation.
*/
// const parent = 'abc123'
/**
* Required. The conversation resource to create.
*/
// const conversation = {}
/**
* Optional. A unique ID for the new conversation. This ID will become the
* final component of the conversation's resource name. If no ID is specified,
* a server-generated ID will be used.
* This value should be 4-64 characters and must match the regular
* expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
*/
// const conversationId = 'abc123'
/**
* Optional. DLP settings for transcript redaction. Will default to the config
* specified in Settings.
*/
// const redactionConfig = {}
/**
* Optional. Speech-to-Text configuration. Will default to the config
* specified in Settings.
*/
// const speechConfig = {}
// Imports the Contactcenterinsights library
const {ContactCenterInsightsClient} = require('@google-cloud/contact-center-insights').v1;
// Instantiates a client
const contactcenterinsightsClient = new ContactCenterInsightsClient();
async function callUploadConversation() {
// Construct request
const request = {
parent,
conversation,
};
// Run request
const [operation] = await contactcenterinsightsClient.uploadConversation(request);
const [response] = await operation.promise();
console.log(response);
}
callUploadConversation();
uploadConversation(request: protos.google.cloud.contactcenterinsights.v1.IUploadConversationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
uploadConversation(request: protos.google.cloud.contactcenterinsights.v1.IUploadConversationRequest, callback: Callback<LROperation<protos.google.cloud.contactcenterinsights.v1.IConversation, protos.google.cloud.contactcenterinsights.v1.IUploadConversationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
viewPath(project: string, location: string, view: string): string;
Return a fully-qualified view resource name string.
Parameters |
---|
Name | Description |
project |
string
|
location |
string
|
view |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|