@maxim_mazurok/gapi.client.contactcenterinsights-v1 0.0.20230326 → 0.0.20230402

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +475 -1
  2. package/package.json +1 -1
  3. package/tests.ts +259 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://contactcenterinsights.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230326
12
+ // Revision: 20230402
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -22,6 +22,44 @@ declare namespace gapi.client {
22
22
  function load(name: "contactcenterinsights", version: "v1", callback: () => any): void;
23
23
 
24
24
  namespace contactcenterinsights {
25
+ interface GoogleCloudContactcenterinsightsV1alpha1Analysis {
26
+ /** Output only. The result of the analysis, which is populated when the analysis finishes. */
27
+ analysisResult?: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult;
28
+ /** To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run. */
29
+ annotatorSelector?: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector;
30
+ /** Output only. The time at which the analysis was created, which occurs when the long-running operation completes. */
31
+ createTime?: string;
32
+ /** Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} */
33
+ name?: string;
34
+ /** Output only. The time at which the analysis was requested. */
35
+ requestTime?: string;
36
+ }
37
+ interface GoogleCloudContactcenterinsightsV1alpha1AnalysisResult {
38
+ /** Call-specific metadata created by the analysis. */
39
+ callAnalysisMetadata?: GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata;
40
+ /** The time at which the analysis ended. */
41
+ endTime?: string;
42
+ }
43
+ interface GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata {
44
+ /** A list of call annotations that apply to this call. */
45
+ annotations?: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation[];
46
+ /** All the entities in the call. */
47
+ entities?: { [P in string]: GoogleCloudContactcenterinsightsV1alpha1Entity };
48
+ /** All the matched intents in the call. */
49
+ intents?: { [P in string]: GoogleCloudContactcenterinsightsV1alpha1Intent };
50
+ /** Overall conversation-level issue modeling result. */
51
+ issueModelResult?: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult;
52
+ /** All the matched phrase matchers in the call. */
53
+ phraseMatchers?: { [P in string]: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData };
54
+ /** Overall conversation-level sentiment for each channel of the call. */
55
+ sentiments?: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment[];
56
+ }
57
+ interface GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary {
58
+ /** The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. */
59
+ transcriptIndex?: number;
60
+ /** The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. */
61
+ wordIndex?: number;
62
+ }
25
63
  interface GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector {
26
64
  /**
27
65
  * The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed
@@ -48,6 +86,28 @@ declare namespace gapi.client {
48
86
  /** Whether to run the silence annotator. */
49
87
  runSilenceAnnotator?: boolean;
50
88
  }
89
+ interface GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback {
90
+ /** Indicates whether an answer or item was clicked by the human agent. */
91
+ clicked?: boolean;
92
+ /** The correctness level of an answer. */
93
+ correctnessLevel?: string;
94
+ /** Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. */
95
+ displayed?: boolean;
96
+ }
97
+ interface GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData {
98
+ /** The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). */
99
+ confidenceScore?: number;
100
+ /** Map that contains metadata about the Article Suggestion and the document that it originates from. */
101
+ metadata?: { [P in string]: string };
102
+ /** The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} */
103
+ queryRecord?: string;
104
+ /** The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} */
105
+ source?: string;
106
+ /** Article title. */
107
+ title?: string;
108
+ /** Article URI. */
109
+ uri?: string;
110
+ }
51
111
  interface GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata {
52
112
  /** The number of requested analyses that have completed successfully so far. */
53
113
  completedAnalysesCount?: number;
@@ -78,6 +138,144 @@ declare namespace gapi.client {
78
138
  /** Count of successful analyses. */
79
139
  successfulAnalysisCount?: number;
80
140
  }
141
+ interface GoogleCloudContactcenterinsightsV1alpha1CallAnnotation {
142
+ /** The boundary in the conversation where the annotation ends, inclusive. */
143
+ annotationEndBoundary?: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary;
144
+ /** The boundary in the conversation where the annotation starts, inclusive. */
145
+ annotationStartBoundary?: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary;
146
+ /** The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. */
147
+ channelTag?: number;
148
+ /** Data specifying an entity mention. */
149
+ entityMentionData?: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData;
150
+ /** Data specifying a hold. */
151
+ holdData?: any;
152
+ /** Data specifying an intent match. */
153
+ intentMatchData?: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData;
154
+ /** Data specifying an interruption. */
155
+ interruptionData?: any;
156
+ /** Data specifying an issue match. */
157
+ issueMatchData?: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData;
158
+ /** Data specifying a phrase match. */
159
+ phraseMatchData?: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData;
160
+ /** Data specifying sentiment. */
161
+ sentimentData?: GoogleCloudContactcenterinsightsV1alpha1SentimentData;
162
+ /** Data specifying silence. */
163
+ silenceData?: any;
164
+ }
165
+ interface GoogleCloudContactcenterinsightsV1alpha1Conversation {
166
+ /** An opaque, user-specified string representing the human agent who handled the conversation. */
167
+ agentId?: string;
168
+ /** Call-specific metadata. */
169
+ callMetadata?: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata;
170
+ /** Output only. The time at which the conversation was created. */
171
+ createTime?: string;
172
+ /** The source of the audio and transcription for the conversation. */
173
+ dataSource?: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource;
174
+ /** Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} */
175
+ dialogflowIntents?: { [P in string]: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent };
176
+ /** Output only. The duration of the conversation. */
177
+ duration?: string;
178
+ /** The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. */
179
+ expireTime?: string;
180
+ /** A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. */
181
+ labels?: { [P in string]: string };
182
+ /** A user-specified language code for the conversation. */
183
+ languageCode?: string;
184
+ /** Output only. The conversation's latest analysis, if one exists. */
185
+ latestAnalysis?: GoogleCloudContactcenterinsightsV1alpha1Analysis;
186
+ /** Immutable. The conversation medium, if unspecified will default to PHONE_CALL. */
187
+ medium?: string;
188
+ /** Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} */
189
+ name?: string;
190
+ /** Obfuscated user ID which the customer sent to us. */
191
+ obfuscatedUserId?: string;
192
+ /** Output only. The annotations that were generated during the customer and agent interaction. */
193
+ runtimeAnnotations?: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation[];
194
+ /** The time at which the conversation started. */
195
+ startTime?: string;
196
+ /** Output only. The conversation transcript. */
197
+ transcript?: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript;
198
+ /** Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. */
199
+ ttl?: string;
200
+ /** Output only. The number of turns in the conversation. */
201
+ turnCount?: number;
202
+ /** Output only. The most recent time at which the conversation was updated. */
203
+ updateTime?: string;
204
+ }
205
+ interface GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata {
206
+ /** The audio channel that contains the agent. */
207
+ agentChannel?: number;
208
+ /** The audio channel that contains the customer. */
209
+ customerChannel?: number;
210
+ }
211
+ interface GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource {
212
+ /** The source when the conversation comes from Dialogflow. */
213
+ dialogflowSource?: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource;
214
+ /** A Cloud Storage location specification for the audio and transcript. */
215
+ gcsSource?: GoogleCloudContactcenterinsightsV1alpha1GcsSource;
216
+ }
217
+ interface GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment {
218
+ /** The channel of the audio that the data applies to. */
219
+ channelTag?: number;
220
+ /** Data specifying sentiment. */
221
+ sentimentData?: GoogleCloudContactcenterinsightsV1alpha1SentimentData;
222
+ }
223
+ interface GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant {
224
+ /**
225
+ * Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format:
226
+ * projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
227
+ */
228
+ dialogflowParticipant?: string;
229
+ /** The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} */
230
+ dialogflowParticipantName?: string;
231
+ /** Obfuscated user ID from Dialogflow. */
232
+ obfuscatedExternalUserId?: string;
233
+ /** The role of the participant. */
234
+ role?: string;
235
+ /** A user-specified ID representing the participant. */
236
+ userId?: string;
237
+ }
238
+ interface GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript {
239
+ /** A list of sequential transcript segments that comprise the conversation. */
240
+ transcriptSegments?: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment[];
241
+ }
242
+ interface GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment {
243
+ /**
244
+ * For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range
245
+ * from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
246
+ */
247
+ channelTag?: number;
248
+ /** A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset. */
249
+ confidence?: number;
250
+ /** CCAI metadata relating to the current transcript segment. */
251
+ dialogflowSegmentMetadata?: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata;
252
+ /** The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". */
253
+ languageCode?: string;
254
+ /** The time that the message occurred, if provided. */
255
+ messageTime?: string;
256
+ /** The participant of this segment. */
257
+ segmentParticipant?: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant;
258
+ /** The sentiment for this transcript segment. */
259
+ sentiment?: GoogleCloudContactcenterinsightsV1alpha1SentimentData;
260
+ /** The text of this segment. */
261
+ text?: string;
262
+ /** A list of the word-specific information for each word in the segment. */
263
+ words?: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo[];
264
+ }
265
+ interface GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata {
266
+ /** Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. */
267
+ smartReplyAllowlistCovered?: boolean;
268
+ }
269
+ interface GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo {
270
+ /** A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. */
271
+ confidence?: number;
272
+ /** Time offset of the end of this word relative to the beginning of the total conversation. */
273
+ endOffset?: string;
274
+ /** Time offset of the start of this word relative to the beginning of the total conversation. */
275
+ startOffset?: string;
276
+ /** The word itself. Includes punctuation marks that surround the word. */
277
+ word?: string;
278
+ }
81
279
  interface GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata {
82
280
  /** Output only. The annotator selector used for the analysis (if any). */
83
281
  annotatorSelector?: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector;
@@ -129,6 +327,48 @@ declare namespace gapi.client {
129
327
  // tslint:disable-next-line:no-empty-interface
130
328
  interface GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse {
131
329
  }
330
+ interface GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent {
331
+ /** The human-readable name of the intent. */
332
+ displayName?: string;
333
+ }
334
+ interface GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData {
335
+ /** The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). */
336
+ confidence?: number;
337
+ /** The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} */
338
+ dialogflowIntentId?: string;
339
+ }
340
+ interface GoogleCloudContactcenterinsightsV1alpha1DialogflowSource {
341
+ /** Cloud Storage URI that points to a file that contains the conversation audio. */
342
+ audioUri?: string;
343
+ /** Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} */
344
+ dialogflowConversation?: string;
345
+ }
346
+ interface GoogleCloudContactcenterinsightsV1alpha1Entity {
347
+ /** The representative name for the entity. */
348
+ displayName?: string;
349
+ /**
350
+ * Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the
351
+ * metadata associated with other entity types, see the Type table below.
352
+ */
353
+ metadata?: { [P in string]: string };
354
+ /**
355
+ * The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the
356
+ * entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
357
+ */
358
+ salience?: number;
359
+ /** The aggregate sentiment expressed for this entity in the conversation. */
360
+ sentiment?: GoogleCloudContactcenterinsightsV1alpha1SentimentData;
361
+ /** The entity type. */
362
+ type?: string;
363
+ }
364
+ interface GoogleCloudContactcenterinsightsV1alpha1EntityMentionData {
365
+ /** The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. */
366
+ entityUniqueId?: string;
367
+ /** Sentiment expressed for this mention of the entity. */
368
+ sentiment?: GoogleCloudContactcenterinsightsV1alpha1SentimentData;
369
+ /** The type of the entity mention. */
370
+ type?: string;
371
+ }
132
372
  interface GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata {
133
373
  /** Output only. The time the operation was created. */
134
374
  createTime?: string;
@@ -162,6 +402,29 @@ declare namespace gapi.client {
162
402
  // tslint:disable-next-line:no-empty-interface
163
403
  interface GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse {
164
404
  }
405
+ interface GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData {
406
+ /** The piece of text from the `source` knowledge base document. */
407
+ answer?: string;
408
+ /** The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). */
409
+ confidenceScore?: number;
410
+ /** Map that contains metadata about the FAQ answer and the document that it originates from. */
411
+ metadata?: { [P in string]: string };
412
+ /** The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} */
413
+ queryRecord?: string;
414
+ /** The corresponding FAQ question. */
415
+ question?: string;
416
+ /** The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. */
417
+ source?: string;
418
+ }
419
+ interface GoogleCloudContactcenterinsightsV1alpha1GcsSource {
420
+ /** Cloud Storage URI that points to a file that contains the conversation audio. */
421
+ audioUri?: string;
422
+ /** Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. */
423
+ transcriptUri?: string;
424
+ }
425
+ // tslint:disable-next-line:no-empty-interface
426
+ interface GoogleCloudContactcenterinsightsV1alpha1HoldData {
427
+ }
165
428
  interface GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata {
166
429
  /** Output only. The time the operation was created. */
167
430
  createTime?: string;
@@ -209,6 +472,31 @@ declare namespace gapi.client {
209
472
  // tslint:disable-next-line:no-empty-interface
210
473
  interface GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse {
211
474
  }
475
+ interface GoogleCloudContactcenterinsightsV1alpha1Intent {
476
+ /** The human-readable name of the intent. */
477
+ displayName?: string;
478
+ /** The unique identifier of the intent. */
479
+ id?: string;
480
+ }
481
+ interface GoogleCloudContactcenterinsightsV1alpha1IntentMatchData {
482
+ /** The id of the matched intent. Can be used to retrieve the corresponding intent information. */
483
+ intentUniqueId?: string;
484
+ }
485
+ // tslint:disable-next-line:no-empty-interface
486
+ interface GoogleCloudContactcenterinsightsV1alpha1InterruptionData {
487
+ }
488
+ interface GoogleCloudContactcenterinsightsV1alpha1IssueAssignment {
489
+ /** Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. */
490
+ displayName?: string;
491
+ /** Resource name of the assigned issue. */
492
+ issue?: string;
493
+ /** Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. */
494
+ score?: number;
495
+ }
496
+ interface GoogleCloudContactcenterinsightsV1alpha1IssueMatchData {
497
+ /** Information about the issue's assignment. */
498
+ issueAssignment?: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment;
499
+ }
212
500
  interface GoogleCloudContactcenterinsightsV1alpha1IssueModel {
213
501
  /** Output only. The time at which this issue model was created. */
214
502
  createTime?: string;
@@ -251,6 +539,78 @@ declare namespace gapi.client {
251
539
  /** Number of conversations attached to the issue at this point in time. */
252
540
  labeledConversationsCount?: string;
253
541
  }
542
+ interface GoogleCloudContactcenterinsightsV1alpha1IssueModelResult {
543
+ /** Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} */
544
+ issueModel?: string;
545
+ /** All the matched issues. */
546
+ issues?: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment[];
547
+ }
548
+ interface GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData {
549
+ /** The human-readable name of the phrase matcher. */
550
+ displayName?: string;
551
+ /** The unique identifier (the resource name) of the phrase matcher. */
552
+ phraseMatcher?: string;
553
+ }
554
+ interface GoogleCloudContactcenterinsightsV1alpha1RedactionConfig {
555
+ /** The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}` */
556
+ deidentifyTemplate?: string;
557
+ /** The fully-qualified DLP inspect template resource name. Format: `projects/{project}/inspectTemplates/{template}` */
558
+ inspectTemplate?: string;
559
+ }
560
+ interface GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation {
561
+ /**
562
+ * The unique identifier of the annotation. Format:
563
+ * projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
564
+ */
565
+ annotationId?: string;
566
+ /** The feedback that the customer has about the answer in `data`. */
567
+ answerFeedback?: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback;
568
+ /** Agent Assist Article Suggestion data. */
569
+ articleSuggestion?: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData;
570
+ /** The time at which this annotation was created. */
571
+ createTime?: string;
572
+ /** Dialogflow interaction data. */
573
+ dialogflowInteraction?: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData;
574
+ /** The boundary in the conversation where the annotation ends, inclusive. */
575
+ endBoundary?: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary;
576
+ /** Agent Assist FAQ answer data. */
577
+ faqAnswer?: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData;
578
+ /** Agent Assist Smart Compose suggestion data. */
579
+ smartComposeSuggestion?: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData;
580
+ /** Agent Assist Smart Reply data. */
581
+ smartReply?: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData;
582
+ /** The boundary in the conversation where the annotation starts, inclusive. */
583
+ startBoundary?: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary;
584
+ }
585
+ interface GoogleCloudContactcenterinsightsV1alpha1SentimentData {
586
+ /** A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. */
587
+ magnitude?: number;
588
+ /** The sentiment score between -1.0 (negative) and 1.0 (positive). */
589
+ score?: number;
590
+ }
591
+ // tslint:disable-next-line:no-empty-interface
592
+ interface GoogleCloudContactcenterinsightsV1alpha1SilenceData {
593
+ }
594
+ interface GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData {
595
+ /** The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). */
596
+ confidenceScore?: number;
597
+ /** Map that contains metadata about the Smart Compose suggestion and the document from which it originates. */
598
+ metadata?: { [P in string]: string };
599
+ /** The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} */
600
+ queryRecord?: string;
601
+ /** The content of the suggestion. */
602
+ suggestion?: string;
603
+ }
604
+ interface GoogleCloudContactcenterinsightsV1alpha1SmartReplyData {
605
+ /** The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). */
606
+ confidenceScore?: number;
607
+ /** Map that contains metadata about the Smart Reply and the document from which it originates. */
608
+ metadata?: { [P in string]: string };
609
+ /** The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} */
610
+ queryRecord?: string;
611
+ /** The content of the reply. */
612
+ reply?: string;
613
+ }
254
614
  interface GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata {
255
615
  /** Output only. The time the operation was created. */
256
616
  createTime?: string;
@@ -266,6 +626,31 @@ declare namespace gapi.client {
266
626
  // tslint:disable-next-line:no-empty-interface
267
627
  interface GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse {
268
628
  }
629
+ interface GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata {
630
+ /** Output only. The operation name for a successfully created analysis operation, if any. */
631
+ analysisOperation?: string;
632
+ /** Output only. The redaction config applied to the uploaded conversation. */
633
+ appliedRedactionConfig?: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig;
634
+ /** Output only. The time the operation was created. */
635
+ createTime?: string;
636
+ /** Output only. The time the operation finished running. */
637
+ endTime?: string;
638
+ /** Output only. The original request. */
639
+ request?: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest;
640
+ }
641
+ interface GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest {
642
+ /** Required. The conversation resource to create. */
643
+ conversation?: GoogleCloudContactcenterinsightsV1alpha1Conversation;
644
+ /**
645
+ * 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
646
+ * used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
647
+ */
648
+ conversationId?: string;
649
+ /** Required. The parent resource of the conversation. */
650
+ parent?: string;
651
+ /** Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings. */
652
+ redactionConfig?: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig;
653
+ }
269
654
  interface GoogleCloudContactcenterinsightsV1Analysis {
270
655
  /** Output only. The result of the analysis, which is populated when the analysis finishes. */
271
656
  analysisResult?: GoogleCloudContactcenterinsightsV1AnalysisResult;
@@ -928,6 +1313,12 @@ declare namespace gapi.client {
928
1313
  /** Required. The type of this phrase match rule group. */
929
1314
  type?: string;
930
1315
  }
1316
+ interface GoogleCloudContactcenterinsightsV1RedactionConfig {
1317
+ /** The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}` */
1318
+ deidentifyTemplate?: string;
1319
+ /** The fully-qualified DLP inspect template resource name. Format: `projects/{project}/inspectTemplates/{template}` */
1320
+ inspectTemplate?: string;
1321
+ }
931
1322
  interface GoogleCloudContactcenterinsightsV1RuntimeAnnotation {
932
1323
  /**
933
1324
  * The unique identifier of the annotation. Format:
@@ -983,6 +1374,8 @@ declare namespace gapi.client {
983
1374
  * conversation is updated via UpdateConversation. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}
984
1375
  */
985
1376
  pubsubNotificationSettings?: { [P in string]: string };
1377
+ /** Default DLP redaction resources to be applied while ingesting conversations. */
1378
+ redactionConfig?: GoogleCloudContactcenterinsightsV1RedactionConfig;
986
1379
  /** Output only. The time at which the settings were last updated. */
987
1380
  updateTime?: string;
988
1381
  }
@@ -1032,6 +1425,31 @@ declare namespace gapi.client {
1032
1425
  // tslint:disable-next-line:no-empty-interface
1033
1426
  interface GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse {
1034
1427
  }
1428
+ interface GoogleCloudContactcenterinsightsV1UploadConversationMetadata {
1429
+ /** Output only. The operation name for a successfully created analysis operation, if any. */
1430
+ analysisOperation?: string;
1431
+ /** Output only. The redaction config applied to the uploaded conversation. */
1432
+ appliedRedactionConfig?: GoogleCloudContactcenterinsightsV1RedactionConfig;
1433
+ /** Output only. The time the operation was created. */
1434
+ createTime?: string;
1435
+ /** Output only. The time the operation finished running. */
1436
+ endTime?: string;
1437
+ /** Output only. The original request. */
1438
+ request?: GoogleCloudContactcenterinsightsV1UploadConversationRequest;
1439
+ }
1440
+ interface GoogleCloudContactcenterinsightsV1UploadConversationRequest {
1441
+ /** Required. The conversation resource to create. */
1442
+ conversation?: GoogleCloudContactcenterinsightsV1Conversation;
1443
+ /**
1444
+ * 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
1445
+ * used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
1446
+ */
1447
+ conversationId?: string;
1448
+ /** Required. The parent resource of the conversation. */
1449
+ parent?: string;
1450
+ /** Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings. */
1451
+ redactionConfig?: GoogleCloudContactcenterinsightsV1RedactionConfig;
1452
+ }
1035
1453
  interface GoogleCloudContactcenterinsightsV1View {
1036
1454
  /** Output only. The time at which this view was created. */
1037
1455
  createTime?: string;
@@ -1601,6 +2019,62 @@ declare namespace gapi.client {
1601
2019
  uploadType?: string;
1602
2020
  },
1603
2021
  body: GoogleCloudContactcenterinsightsV1Conversation): Request<GoogleCloudContactcenterinsightsV1Conversation>;
2022
+ /** Create a longrunning conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction. */
2023
+ upload(request: {
2024
+ /** V1 error format. */
2025
+ "$.xgafv"?: string;
2026
+ /** OAuth access token. */
2027
+ access_token?: string;
2028
+ /** Data format for response. */
2029
+ alt?: string;
2030
+ /** JSONP */
2031
+ callback?: string;
2032
+ /** Selector specifying which fields to include in a partial response. */
2033
+ fields?: string;
2034
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2035
+ key?: string;
2036
+ /** OAuth 2.0 token for the current user. */
2037
+ oauth_token?: string;
2038
+ /** Required. The parent resource of the conversation. */
2039
+ parent: string;
2040
+ /** Returns response with indentations and line breaks. */
2041
+ prettyPrint?: boolean;
2042
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2043
+ quotaUser?: string;
2044
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2045
+ upload_protocol?: string;
2046
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2047
+ uploadType?: string;
2048
+ /** Request body */
2049
+ resource: GoogleCloudContactcenterinsightsV1UploadConversationRequest;
2050
+ }): Request<GoogleLongrunningOperation>;
2051
+ upload(request: {
2052
+ /** V1 error format. */
2053
+ "$.xgafv"?: string;
2054
+ /** OAuth access token. */
2055
+ access_token?: string;
2056
+ /** Data format for response. */
2057
+ alt?: string;
2058
+ /** JSONP */
2059
+ callback?: string;
2060
+ /** Selector specifying which fields to include in a partial response. */
2061
+ fields?: string;
2062
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2063
+ key?: string;
2064
+ /** OAuth 2.0 token for the current user. */
2065
+ oauth_token?: string;
2066
+ /** Required. The parent resource of the conversation. */
2067
+ parent: string;
2068
+ /** Returns response with indentations and line breaks. */
2069
+ prettyPrint?: boolean;
2070
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2071
+ quotaUser?: string;
2072
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2073
+ upload_protocol?: string;
2074
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2075
+ uploadType?: string;
2076
+ },
2077
+ body: GoogleCloudContactcenterinsightsV1UploadConversationRequest): Request<GoogleLongrunningOperation>;
1604
2078
  analyses: AnalysesResource;
1605
2079
  }
1606
2080
  interface InsightsdataResource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.contactcenterinsights-v1",
3
- "version": "0.0.20230326",
3
+ "version": "0.0.20230402",
4
4
  "description": "TypeScript typings for Contact Center AI Insights API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230326
6
+ // Revision: 20230402
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -64,6 +64,10 @@ gapi.load('client', async () => {
64
64
  pubsubNotificationSettings: {
65
65
  A: "Test string"
66
66
  },
67
+ redactionConfig: {
68
+ deidentifyTemplate: "Test string",
69
+ inspectTemplate: "Test string",
70
+ },
67
71
  updateTime: "Test string",
68
72
  });
69
73
  /** Analyzes multiple conversations in a single request. */
@@ -621,6 +625,260 @@ gapi.load('client', async () => {
621
625
  turnCount: 42,
622
626
  updateTime: "Test string",
623
627
  });
628
+ /** Create a longrunning conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction. */
629
+ await gapi.client.contactcenterinsights.projects.locations.conversations.upload({
630
+ parent: "Test string",
631
+ }, {
632
+ conversation: {
633
+ agentId: "Test string",
634
+ callMetadata: {
635
+ agentChannel: 42,
636
+ customerChannel: 42,
637
+ },
638
+ createTime: "Test string",
639
+ dataSource: {
640
+ dialogflowSource: {
641
+ audioUri: "Test string",
642
+ dialogflowConversation: "Test string",
643
+ },
644
+ gcsSource: {
645
+ audioUri: "Test string",
646
+ transcriptUri: "Test string",
647
+ },
648
+ },
649
+ dialogflowIntents: {
650
+ A: {
651
+ displayName: "Test string",
652
+ }
653
+ },
654
+ duration: "Test string",
655
+ expireTime: "Test string",
656
+ labels: {
657
+ A: "Test string"
658
+ },
659
+ languageCode: "Test string",
660
+ latestAnalysis: {
661
+ analysisResult: {
662
+ callAnalysisMetadata: {
663
+ annotations: [
664
+ {
665
+ annotationEndBoundary: {
666
+ transcriptIndex: 42,
667
+ wordIndex: 42,
668
+ },
669
+ annotationStartBoundary: {
670
+ transcriptIndex: 42,
671
+ wordIndex: 42,
672
+ },
673
+ channelTag: 42,
674
+ entityMentionData: {
675
+ entityUniqueId: "Test string",
676
+ sentiment: {
677
+ magnitude: 42,
678
+ score: 42,
679
+ },
680
+ type: "Test string",
681
+ },
682
+ holdData: {
683
+ },
684
+ intentMatchData: {
685
+ intentUniqueId: "Test string",
686
+ },
687
+ interruptionData: {
688
+ },
689
+ issueMatchData: {
690
+ issueAssignment: {
691
+ displayName: "Test string",
692
+ issue: "Test string",
693
+ score: 42,
694
+ },
695
+ },
696
+ phraseMatchData: {
697
+ displayName: "Test string",
698
+ phraseMatcher: "Test string",
699
+ },
700
+ sentimentData: {
701
+ magnitude: 42,
702
+ score: 42,
703
+ },
704
+ silenceData: {
705
+ },
706
+ }
707
+ ],
708
+ entities: {
709
+ A: {
710
+ displayName: "Test string",
711
+ metadata: {
712
+ A: "Test string"
713
+ },
714
+ salience: 42,
715
+ sentiment: {
716
+ magnitude: 42,
717
+ score: 42,
718
+ },
719
+ type: "Test string",
720
+ }
721
+ },
722
+ intents: {
723
+ A: {
724
+ displayName: "Test string",
725
+ id: "Test string",
726
+ }
727
+ },
728
+ issueModelResult: {
729
+ issueModel: "Test string",
730
+ issues: [
731
+ {
732
+ displayName: "Test string",
733
+ issue: "Test string",
734
+ score: 42,
735
+ }
736
+ ],
737
+ },
738
+ phraseMatchers: {
739
+ A: {
740
+ displayName: "Test string",
741
+ phraseMatcher: "Test string",
742
+ }
743
+ },
744
+ sentiments: [
745
+ {
746
+ channelTag: 42,
747
+ sentimentData: {
748
+ magnitude: 42,
749
+ score: 42,
750
+ },
751
+ }
752
+ ],
753
+ },
754
+ endTime: "Test string",
755
+ },
756
+ annotatorSelector: {
757
+ issueModels: [
758
+ "Test string"
759
+ ],
760
+ phraseMatchers: [
761
+ "Test string"
762
+ ],
763
+ runEntityAnnotator: true,
764
+ runIntentAnnotator: true,
765
+ runInterruptionAnnotator: true,
766
+ runIssueModelAnnotator: true,
767
+ runPhraseMatcherAnnotator: true,
768
+ runSentimentAnnotator: true,
769
+ runSilenceAnnotator: true,
770
+ },
771
+ createTime: "Test string",
772
+ name: "Test string",
773
+ requestTime: "Test string",
774
+ },
775
+ medium: "Test string",
776
+ name: "Test string",
777
+ obfuscatedUserId: "Test string",
778
+ runtimeAnnotations: [
779
+ {
780
+ annotationId: "Test string",
781
+ answerFeedback: {
782
+ clicked: true,
783
+ correctnessLevel: "Test string",
784
+ displayed: true,
785
+ },
786
+ articleSuggestion: {
787
+ confidenceScore: 42,
788
+ metadata: {
789
+ A: "Test string"
790
+ },
791
+ queryRecord: "Test string",
792
+ source: "Test string",
793
+ title: "Test string",
794
+ uri: "Test string",
795
+ },
796
+ createTime: "Test string",
797
+ dialogflowInteraction: {
798
+ confidence: 42,
799
+ dialogflowIntentId: "Test string",
800
+ },
801
+ endBoundary: {
802
+ transcriptIndex: 42,
803
+ wordIndex: 42,
804
+ },
805
+ faqAnswer: {
806
+ answer: "Test string",
807
+ confidenceScore: 42,
808
+ metadata: {
809
+ A: "Test string"
810
+ },
811
+ queryRecord: "Test string",
812
+ question: "Test string",
813
+ source: "Test string",
814
+ },
815
+ smartComposeSuggestion: {
816
+ confidenceScore: 42,
817
+ metadata: {
818
+ A: "Test string"
819
+ },
820
+ queryRecord: "Test string",
821
+ suggestion: "Test string",
822
+ },
823
+ smartReply: {
824
+ confidenceScore: 42,
825
+ metadata: {
826
+ A: "Test string"
827
+ },
828
+ queryRecord: "Test string",
829
+ reply: "Test string",
830
+ },
831
+ startBoundary: {
832
+ transcriptIndex: 42,
833
+ wordIndex: 42,
834
+ },
835
+ }
836
+ ],
837
+ startTime: "Test string",
838
+ transcript: {
839
+ transcriptSegments: [
840
+ {
841
+ channelTag: 42,
842
+ confidence: 42,
843
+ dialogflowSegmentMetadata: {
844
+ smartReplyAllowlistCovered: true,
845
+ },
846
+ languageCode: "Test string",
847
+ messageTime: "Test string",
848
+ segmentParticipant: {
849
+ dialogflowParticipant: "Test string",
850
+ dialogflowParticipantName: "Test string",
851
+ obfuscatedExternalUserId: "Test string",
852
+ role: "Test string",
853
+ userId: "Test string",
854
+ },
855
+ sentiment: {
856
+ magnitude: 42,
857
+ score: 42,
858
+ },
859
+ text: "Test string",
860
+ words: [
861
+ {
862
+ confidence: 42,
863
+ endOffset: "Test string",
864
+ startOffset: "Test string",
865
+ word: "Test string",
866
+ }
867
+ ],
868
+ }
869
+ ],
870
+ },
871
+ ttl: "Test string",
872
+ turnCount: 42,
873
+ updateTime: "Test string",
874
+ },
875
+ conversationId: "Test string",
876
+ parent: "Test string",
877
+ redactionConfig: {
878
+ deidentifyTemplate: "Test string",
879
+ inspectTemplate: "Test string",
880
+ },
881
+ });
624
882
  /** Creates an analysis. The long running operation is done when the analysis has completed. */
625
883
  await gapi.client.contactcenterinsights.projects.locations.conversations.analyses.create({
626
884
  parent: "Test string",