@maxim_mazurok/gapi.client.contactcenterinsights-v1 0.1.20250923 → 0.1.20251007
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.
- package/index.d.ts +49 -21
- package/package.json +1 -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:
|
|
12
|
+
// Revision: 20251007
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -333,6 +333,10 @@ declare namespace gapi.client {
|
|
|
333
333
|
agentId?: string;
|
|
334
334
|
/** The agent type, e.g. HUMAN_AGENT. */
|
|
335
335
|
agentType?: string;
|
|
336
|
+
/** The agent's deployment display name. Only applicable to automated agents. */
|
|
337
|
+
deploymentDisplayName?: string;
|
|
338
|
+
/** The agent's deployment ID. Only applicable to automated agents. */
|
|
339
|
+
deploymentId?: string;
|
|
336
340
|
/** The agent's name. */
|
|
337
341
|
displayName?: string;
|
|
338
342
|
/** A user-provided string indicating the outcome of the agent's segment of the call. */
|
|
@@ -343,6 +347,10 @@ declare namespace gapi.client {
|
|
|
343
347
|
team?: string;
|
|
344
348
|
/** User-specified strings representing the agent's teams. */
|
|
345
349
|
teams?: string[];
|
|
350
|
+
/** The agent's version display name. Only applicable to automated agents. */
|
|
351
|
+
versionDisplayName?: string;
|
|
352
|
+
/** The agent's version ID. Only applicable to automated agents. */
|
|
353
|
+
versionId?: string;
|
|
346
354
|
}
|
|
347
355
|
interface GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData {
|
|
348
356
|
/** The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} */
|
|
@@ -520,12 +528,20 @@ declare namespace gapi.client {
|
|
|
520
528
|
qaScorecardDimensionMetadata?: GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata;
|
|
521
529
|
}
|
|
522
530
|
interface GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata {
|
|
523
|
-
/** Optional. The agent's name */
|
|
531
|
+
/** Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions. */
|
|
532
|
+
agentDeploymentDisplayName?: string;
|
|
533
|
+
/** Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions. */
|
|
534
|
+
agentDeploymentId?: string;
|
|
535
|
+
/** Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */
|
|
524
536
|
agentDisplayName?: string;
|
|
525
|
-
/** Optional. A user-specified string representing the agent. */
|
|
537
|
+
/** Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */
|
|
526
538
|
agentId?: string;
|
|
527
539
|
/** Optional. A user-specified string representing the agent's team. */
|
|
528
540
|
agentTeam?: string;
|
|
541
|
+
/** Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */
|
|
542
|
+
agentVersionDisplayName?: string;
|
|
543
|
+
/** Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */
|
|
544
|
+
agentVersionId?: string;
|
|
529
545
|
}
|
|
530
546
|
interface GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata {
|
|
531
547
|
/** The issue display name. */
|
|
@@ -922,8 +938,6 @@ declare namespace gapi.client {
|
|
|
922
938
|
numValue?: number;
|
|
923
939
|
/** Output only. The maximum potential score of the question. */
|
|
924
940
|
potentialScore?: number;
|
|
925
|
-
/** Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. */
|
|
926
|
-
rationale?: GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale;
|
|
927
941
|
/** Output only. Numerical score of the answer. */
|
|
928
942
|
score?: number;
|
|
929
943
|
/** Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. */
|
|
@@ -931,10 +945,6 @@ declare namespace gapi.client {
|
|
|
931
945
|
/** String value. */
|
|
932
946
|
strValue?: string;
|
|
933
947
|
}
|
|
934
|
-
interface GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale {
|
|
935
|
-
/** The rationale string for the answer. */
|
|
936
|
-
rationale?: string;
|
|
937
|
-
}
|
|
938
948
|
interface GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag {
|
|
939
949
|
/** Output only. The time at which the question tag was created. */
|
|
940
950
|
createTime?: string;
|
|
@@ -1030,7 +1040,7 @@ declare namespace gapi.client {
|
|
|
1030
1040
|
averageCustomerSatisfactionRating?: number;
|
|
1031
1041
|
/** The average duration. */
|
|
1032
1042
|
averageDuration?: string;
|
|
1033
|
-
/**
|
|
1043
|
+
/** The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID. */
|
|
1034
1044
|
averageQaNormalizedScore?: number;
|
|
1035
1045
|
/** Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID. */
|
|
1036
1046
|
averageQaQuestionNormalizedScore?: number;
|
|
@@ -1706,6 +1716,10 @@ declare namespace gapi.client {
|
|
|
1706
1716
|
agentId?: string;
|
|
1707
1717
|
/** The agent type, e.g. HUMAN_AGENT. */
|
|
1708
1718
|
agentType?: string;
|
|
1719
|
+
/** The agent's deployment display name. Only applicable to automated agents. */
|
|
1720
|
+
deploymentDisplayName?: string;
|
|
1721
|
+
/** The agent's deployment ID. Only applicable to automated agents. */
|
|
1722
|
+
deploymentId?: string;
|
|
1709
1723
|
/** The agent's name. */
|
|
1710
1724
|
displayName?: string;
|
|
1711
1725
|
/** A user-provided string indicating the outcome of the agent's segment of the call. */
|
|
@@ -1716,6 +1730,10 @@ declare namespace gapi.client {
|
|
|
1716
1730
|
team?: string;
|
|
1717
1731
|
/** User-specified strings representing the agent's teams. */
|
|
1718
1732
|
teams?: string[];
|
|
1733
|
+
/** The agent's version display name. Only applicable to automated agents. */
|
|
1734
|
+
versionDisplayName?: string;
|
|
1735
|
+
/** The agent's version ID. Only applicable to automated agents. */
|
|
1736
|
+
versionId?: string;
|
|
1719
1737
|
}
|
|
1720
1738
|
interface GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData {
|
|
1721
1739
|
/** The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} */
|
|
@@ -1894,12 +1912,20 @@ declare namespace gapi.client {
|
|
|
1894
1912
|
qaScorecardDimensionMetadata?: GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata;
|
|
1895
1913
|
}
|
|
1896
1914
|
interface GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata {
|
|
1897
|
-
/** Optional. The agent's name */
|
|
1915
|
+
/** Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions. */
|
|
1916
|
+
agentDeploymentDisplayName?: string;
|
|
1917
|
+
/** Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions. */
|
|
1918
|
+
agentDeploymentId?: string;
|
|
1919
|
+
/** Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */
|
|
1898
1920
|
agentDisplayName?: string;
|
|
1899
|
-
/** Optional. A user-specified string representing the agent. */
|
|
1921
|
+
/** Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */
|
|
1900
1922
|
agentId?: string;
|
|
1901
1923
|
/** Optional. A user-specified string representing the agent's team. */
|
|
1902
1924
|
agentTeam?: string;
|
|
1925
|
+
/** Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */
|
|
1926
|
+
agentVersionDisplayName?: string;
|
|
1927
|
+
/** Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. */
|
|
1928
|
+
agentVersionId?: string;
|
|
1903
1929
|
}
|
|
1904
1930
|
interface GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata {
|
|
1905
1931
|
/** The issue display name. */
|
|
@@ -2469,8 +2495,6 @@ declare namespace gapi.client {
|
|
|
2469
2495
|
numValue?: number;
|
|
2470
2496
|
/** Output only. The maximum potential score of the question. */
|
|
2471
2497
|
potentialScore?: number;
|
|
2472
|
-
/** Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. */
|
|
2473
|
-
rationale?: GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale;
|
|
2474
2498
|
/** Output only. Numerical score of the answer. */
|
|
2475
2499
|
score?: number;
|
|
2476
2500
|
/** Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. */
|
|
@@ -2478,10 +2502,6 @@ declare namespace gapi.client {
|
|
|
2478
2502
|
/** String value. */
|
|
2479
2503
|
strValue?: string;
|
|
2480
2504
|
}
|
|
2481
|
-
interface GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale {
|
|
2482
|
-
/** The rationale string for the answer. */
|
|
2483
|
-
rationale?: string;
|
|
2484
|
-
}
|
|
2485
2505
|
interface GoogleCloudContactcenterinsightsV1QaQuestion {
|
|
2486
2506
|
/** Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting". */
|
|
2487
2507
|
abbreviation?: string;
|
|
@@ -2679,7 +2699,7 @@ declare namespace gapi.client {
|
|
|
2679
2699
|
averageCustomerSatisfactionRating?: number;
|
|
2680
2700
|
/** The average duration. */
|
|
2681
2701
|
averageDuration?: string;
|
|
2682
|
-
/**
|
|
2702
|
+
/** The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID. */
|
|
2683
2703
|
averageQaNormalizedScore?: number;
|
|
2684
2704
|
/** Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID. */
|
|
2685
2705
|
averageQaQuestionNormalizedScore?: number;
|
|
@@ -2835,6 +2855,8 @@ declare namespace gapi.client {
|
|
|
2835
2855
|
pubsubNotificationSettings?: {[P in string]: string};
|
|
2836
2856
|
/** Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. */
|
|
2837
2857
|
redactionConfig?: GoogleCloudContactcenterinsightsV1RedactionConfig;
|
|
2858
|
+
/** Optional. The path to a Cloud Storage bucket containing conversation screen recordings. If provided, Insights will search in the bucket for a screen recording file matching the conversation data source object name prefix. If matches are found, these file URIs will be stored in the conversation screen recordings field. */
|
|
2859
|
+
screenRecordingBucketUri?: string;
|
|
2838
2860
|
/** Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. */
|
|
2839
2861
|
speechConfig?: GoogleCloudContactcenterinsightsV1SpeechConfig;
|
|
2840
2862
|
/** Output only. The time at which the settings were last updated. */
|
|
@@ -2996,6 +3018,8 @@ declare namespace gapi.client {
|
|
|
2996
3018
|
nextPageToken?: string;
|
|
2997
3019
|
/** A list of operations that matches the specified filter in the request. */
|
|
2998
3020
|
operations?: GoogleLongrunningOperation[];
|
|
3021
|
+
/** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. */
|
|
3022
|
+
unreachable?: string[];
|
|
2999
3023
|
}
|
|
3000
3024
|
interface GoogleLongrunningOperation {
|
|
3001
3025
|
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
@@ -4586,6 +4610,8 @@ declare namespace gapi.client {
|
|
|
4586
4610
|
prettyPrint?: boolean;
|
|
4587
4611
|
/** 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. */
|
|
4588
4612
|
quotaUser?: string;
|
|
4613
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
4614
|
+
returnPartialSuccess?: boolean;
|
|
4589
4615
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4590
4616
|
upload_protocol?: string;
|
|
4591
4617
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -6516,7 +6542,7 @@ declare namespace gapi.client {
|
|
|
6516
6542
|
prettyPrint?: boolean;
|
|
6517
6543
|
/** 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. */
|
|
6518
6544
|
quotaUser?: string;
|
|
6519
|
-
/** The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri` */
|
|
6545
|
+
/** The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings` */
|
|
6520
6546
|
updateMask?: string;
|
|
6521
6547
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6522
6548
|
upload_protocol?: string;
|
|
@@ -6549,7 +6575,7 @@ declare namespace gapi.client {
|
|
|
6549
6575
|
prettyPrint?: boolean;
|
|
6550
6576
|
/** 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. */
|
|
6551
6577
|
quotaUser?: string;
|
|
6552
|
-
/** The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri` */
|
|
6578
|
+
/** The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings` */
|
|
6553
6579
|
updateMask?: string;
|
|
6554
6580
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6555
6581
|
upload_protocol?: string;
|
|
@@ -8778,6 +8804,8 @@ declare namespace gapi.client {
|
|
|
8778
8804
|
prettyPrint?: boolean;
|
|
8779
8805
|
/** 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. */
|
|
8780
8806
|
quotaUser?: string;
|
|
8807
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
8808
|
+
returnPartialSuccess?: boolean;
|
|
8781
8809
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8782
8810
|
upload_protocol?: string;
|
|
8783
8811
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|