@maxim_mazurok/gapi.client.dialogflow-v2 0.0.20230821 → 0.0.20230919

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 +625 -2
  2. package/package.json +1 -1
  3. package/tests.ts +3176 -2112
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://dialogflow.googleapis.com/$discovery/rest?version=v2
12
- // Revision: 20230821
12
+ // Revision: 20230919
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -22,6 +22,40 @@ declare namespace gapi.client {
22
22
  function load(name: "dialogflow", version: "v2", callback: () => any): void;
23
23
 
24
24
  namespace dialogflow {
25
+ interface GoogleCloudDialogflowCxV3AdvancedSettings {
26
+ /** If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level */
27
+ audioExportGcsDestination?:
28
+ GoogleCloudDialogflowCxV3GcsDestination;
29
+ /** Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. */
30
+ dtmfSettings?:
31
+ GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings;
32
+ /** Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */
33
+ loggingSettings?:
34
+ GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings;
35
+ }
36
+ interface GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings {
37
+ /**
38
+ * If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is
39
+ * enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the
40
+ * account balance).
41
+ */
42
+ enabled?:
43
+ boolean;
44
+ /** The digit that terminates a DTMF digit sequence. */
45
+ finishDigit?:
46
+ string;
47
+ /** Max length of DTMF digits. */
48
+ maxDigits?:
49
+ number;
50
+ }
51
+ interface GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings {
52
+ /** If true, DF Interaction logging is currently enabled. */
53
+ enableInteractionLogging?:
54
+ boolean;
55
+ /** If true, StackDriver logging is currently enabled. */
56
+ enableStackdriverLogging?:
57
+ boolean;
58
+ }
25
59
  interface GoogleCloudDialogflowCxV3AudioInput {
26
60
  /**
27
61
  * The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For
@@ -44,6 +78,40 @@ declare namespace gapi.client {
44
78
  results?:
45
79
  GoogleCloudDialogflowCxV3TestCaseResult[];
46
80
  }
81
+ interface GoogleCloudDialogflowCxV3beta1AdvancedSettings {
82
+ /** If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level */
83
+ audioExportGcsDestination?:
84
+ GoogleCloudDialogflowCxV3beta1GcsDestination;
85
+ /** Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. */
86
+ dtmfSettings?:
87
+ GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings;
88
+ /** Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. */
89
+ loggingSettings?:
90
+ GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings;
91
+ }
92
+ interface GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings {
93
+ /**
94
+ * If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is
95
+ * enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the
96
+ * account balance).
97
+ */
98
+ enabled?:
99
+ boolean;
100
+ /** The digit that terminates a DTMF digit sequence. */
101
+ finishDigit?:
102
+ string;
103
+ /** Max length of DTMF digits. */
104
+ maxDigits?:
105
+ number;
106
+ }
107
+ interface GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings {
108
+ /** If true, DF Interaction logging is currently enabled. */
109
+ enableInteractionLogging?:
110
+ boolean;
111
+ /** If true, StackDriver logging is currently enabled. */
112
+ enableStackdriverLogging?:
113
+ boolean;
114
+ }
47
115
  interface GoogleCloudDialogflowCxV3beta1AudioInput {
48
116
  /**
49
117
  * The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For
@@ -266,6 +334,17 @@ declare namespace gapi.client {
266
334
  string;
267
335
  }
268
336
  // tslint:disable-next-line:no-empty-interface
337
+ interface GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata {
338
+ }
339
+ interface GoogleCloudDialogflowCxV3beta1ExportIntentsResponse {
340
+ /** Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. */
341
+ intentsContent?:
342
+ GoogleCloudDialogflowCxV3beta1InlineDestination;
343
+ /** The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. */
344
+ intentsUri?:
345
+ string;
346
+ }
347
+ // tslint:disable-next-line:no-empty-interface
269
348
  interface GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata {
270
349
  }
271
350
  interface GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse {
@@ -282,6 +361,9 @@ declare namespace gapi.client {
282
361
  GoogleCloudDialogflowCxV3beta1FormParameter[];
283
362
  }
284
363
  interface GoogleCloudDialogflowCxV3beta1FormParameter {
364
+ /** Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. */
365
+ advancedSettings?:
366
+ GoogleCloudDialogflowCxV3beta1AdvancedSettings;
285
367
  /** The default value of an optional parameter. If the parameter is required, the default value will be ignored. */
286
368
  defaultValue?:
287
369
  any;
@@ -332,9 +414,18 @@ declare namespace gapi.client {
332
414
  GoogleCloudDialogflowCxV3beta1EventHandler[];
333
415
  }
334
416
  interface GoogleCloudDialogflowCxV3beta1Fulfillment {
417
+ /** Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. */
418
+ advancedSettings?:
419
+ GoogleCloudDialogflowCxV3beta1AdvancedSettings;
335
420
  /** Conditional cases for this fulfillment. */
336
421
  conditionalCases?:
337
422
  GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases[];
423
+ /**
424
+ * If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only
425
+ * useful for fulfillments associated with no-match event handlers.
426
+ */
427
+ enableGenerativeFallback?:
428
+ boolean;
338
429
  /** The list of rich message responses to present to the user. */
339
430
  messages?:
340
431
  GoogleCloudDialogflowCxV3beta1ResponseMessage[];
@@ -390,6 +481,14 @@ declare namespace gapi.client {
390
481
  value?:
391
482
  any;
392
483
  }
484
+ interface GoogleCloudDialogflowCxV3beta1GcsDestination {
485
+ /**
486
+ * Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage
487
+ * depends on the Dialogflow operation.
488
+ */
489
+ uri?:
490
+ string;
491
+ }
393
492
  interface GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata {
394
493
  /** Required. Output only. The current state of this operation. */
395
494
  state?:
@@ -410,6 +509,25 @@ declare namespace gapi.client {
410
509
  flow?:
411
510
  string;
412
511
  }
512
+ // tslint:disable-next-line:no-empty-interface
513
+ interface GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata {
514
+ }
515
+ interface GoogleCloudDialogflowCxV3beta1ImportIntentsResponse {
516
+ /** Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. */
517
+ conflictingResources?:
518
+ GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources;
519
+ /** The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. */
520
+ intents?:
521
+ string[];
522
+ }
523
+ interface GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources {
524
+ /** Display names of conflicting entities. */
525
+ entityDisplayNames?:
526
+ string[];
527
+ /** Display names of conflicting intents. */
528
+ intentDisplayNames?:
529
+ string[];
530
+ }
413
531
  interface GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata {
414
532
  /** Errors for failed test cases. */
415
533
  errors?:
@@ -420,6 +538,11 @@ declare namespace gapi.client {
420
538
  names?:
421
539
  string[];
422
540
  }
541
+ interface GoogleCloudDialogflowCxV3beta1InlineDestination {
542
+ /** Output only. The uncompressed byte content for the objects. Only populated in responses. */
543
+ content?:
544
+ string;
545
+ }
423
546
  interface GoogleCloudDialogflowCxV3beta1InputAudioConfig {
424
547
  /** Required. Audio encoding of the audio content to process. */
425
548
  audioEncoding?:
@@ -570,6 +693,9 @@ declare namespace gapi.client {
570
693
  GoogleCloudDialogflowCxV3beta1Fulfillment;
571
694
  }
572
695
  interface GoogleCloudDialogflowCxV3beta1Page {
696
+ /** Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. */
697
+ advancedSettings?:
698
+ GoogleCloudDialogflowCxV3beta1AdvancedSettings;
573
699
  /** Required. The human-readable name of the page, unique within the flow. */
574
700
  displayName?:
575
701
  string;
@@ -1364,6 +1490,17 @@ declare namespace gapi.client {
1364
1490
  string;
1365
1491
  }
1366
1492
  // tslint:disable-next-line:no-empty-interface
1493
+ interface GoogleCloudDialogflowCxV3ExportIntentsMetadata {
1494
+ }
1495
+ interface GoogleCloudDialogflowCxV3ExportIntentsResponse {
1496
+ /** Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. */
1497
+ intentsContent?:
1498
+ GoogleCloudDialogflowCxV3InlineDestination;
1499
+ /** The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. */
1500
+ intentsUri?:
1501
+ string;
1502
+ }
1503
+ // tslint:disable-next-line:no-empty-interface
1367
1504
  interface GoogleCloudDialogflowCxV3ExportTestCasesMetadata {
1368
1505
  }
1369
1506
  interface GoogleCloudDialogflowCxV3ExportTestCasesResponse {
@@ -1380,6 +1517,9 @@ declare namespace gapi.client {
1380
1517
  GoogleCloudDialogflowCxV3FormParameter[];
1381
1518
  }
1382
1519
  interface GoogleCloudDialogflowCxV3FormParameter {
1520
+ /** Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. */
1521
+ advancedSettings?:
1522
+ GoogleCloudDialogflowCxV3AdvancedSettings;
1383
1523
  /** The default value of an optional parameter. If the parameter is required, the default value will be ignored. */
1384
1524
  defaultValue?:
1385
1525
  any;
@@ -1430,9 +1570,18 @@ declare namespace gapi.client {
1430
1570
  GoogleCloudDialogflowCxV3EventHandler[];
1431
1571
  }
1432
1572
  interface GoogleCloudDialogflowCxV3Fulfillment {
1573
+ /** Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. */
1574
+ advancedSettings?:
1575
+ GoogleCloudDialogflowCxV3AdvancedSettings;
1433
1576
  /** Conditional cases for this fulfillment. */
1434
1577
  conditionalCases?:
1435
1578
  GoogleCloudDialogflowCxV3FulfillmentConditionalCases[];
1579
+ /**
1580
+ * If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only
1581
+ * useful for fulfillments associated with no-match event handlers.
1582
+ */
1583
+ enableGenerativeFallback?:
1584
+ boolean;
1436
1585
  /** The list of rich message responses to present to the user. */
1437
1586
  messages?:
1438
1587
  GoogleCloudDialogflowCxV3ResponseMessage[];
@@ -1488,6 +1637,14 @@ declare namespace gapi.client {
1488
1637
  value?:
1489
1638
  any;
1490
1639
  }
1640
+ interface GoogleCloudDialogflowCxV3GcsDestination {
1641
+ /**
1642
+ * Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage
1643
+ * depends on the Dialogflow operation.
1644
+ */
1645
+ uri?:
1646
+ string;
1647
+ }
1491
1648
  interface GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata {
1492
1649
  /** Required. Output only. The current state of this operation. */
1493
1650
  state?:
@@ -1508,6 +1665,25 @@ declare namespace gapi.client {
1508
1665
  flow?:
1509
1666
  string;
1510
1667
  }
1668
+ // tslint:disable-next-line:no-empty-interface
1669
+ interface GoogleCloudDialogflowCxV3ImportIntentsMetadata {
1670
+ }
1671
+ interface GoogleCloudDialogflowCxV3ImportIntentsResponse {
1672
+ /** Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. */
1673
+ conflictingResources?:
1674
+ GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources;
1675
+ /** The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. */
1676
+ intents?:
1677
+ string[];
1678
+ }
1679
+ interface GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources {
1680
+ /** Display names of conflicting entities. */
1681
+ entityDisplayNames?:
1682
+ string[];
1683
+ /** Display names of conflicting intents. */
1684
+ intentDisplayNames?:
1685
+ string[];
1686
+ }
1511
1687
  interface GoogleCloudDialogflowCxV3ImportTestCasesMetadata {
1512
1688
  /** Errors for failed test cases. */
1513
1689
  errors?:
@@ -1518,6 +1694,11 @@ declare namespace gapi.client {
1518
1694
  names?:
1519
1695
  string[];
1520
1696
  }
1697
+ interface GoogleCloudDialogflowCxV3InlineDestination {
1698
+ /** Output only. The uncompressed byte content for the objects. Only populated in responses. */
1699
+ content?:
1700
+ string;
1701
+ }
1521
1702
  interface GoogleCloudDialogflowCxV3InputAudioConfig {
1522
1703
  /** Required. Audio encoding of the audio content to process. */
1523
1704
  audioEncoding?:
@@ -1668,6 +1849,9 @@ declare namespace gapi.client {
1668
1849
  GoogleCloudDialogflowCxV3Fulfillment;
1669
1850
  }
1670
1851
  interface GoogleCloudDialogflowCxV3Page {
1852
+ /** Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. */
1853
+ advancedSettings?:
1854
+ GoogleCloudDialogflowCxV3AdvancedSettings;
1671
1855
  /** Required. The human-readable name of the page, unique within the flow. */
1672
1856
  displayName?:
1673
1857
  string;
@@ -2335,10 +2519,21 @@ declare namespace gapi.client {
2335
2519
  */
2336
2520
  documentEfficiency?:
2337
2521
  string;
2522
+ /** Optional. Feedback for knowledge search. */
2523
+ knowledgeSearchFeedback?:
2524
+ GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback;
2338
2525
  /** Optional. Feedback for conversation summarization. */
2339
2526
  summarizationFeedback?:
2340
2527
  GoogleCloudDialogflowV2AgentAssistantFeedbackSummarizationFeedback;
2341
2528
  }
2529
+ interface GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback {
2530
+ /** Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. */
2531
+ answerCopied?:
2532
+ boolean;
2533
+ /** The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. */
2534
+ clickedUris?:
2535
+ string[];
2536
+ }
2342
2537
  interface GoogleCloudDialogflowV2AgentAssistantFeedbackSummarizationFeedback {
2343
2538
  /** Timestamp when composing of the summary starts. */
2344
2539
  startTime?:
@@ -2354,6 +2549,9 @@ declare namespace gapi.client {
2354
2549
  /** Output only. The article suggestion answer. */
2355
2550
  articleSuggestionAnswer?:
2356
2551
  GoogleCloudDialogflowV2ArticleAnswer;
2552
+ /** Output only. Dialogflow assist answer. */
2553
+ dialogflowAssistAnswer?:
2554
+ GoogleCloudDialogflowV2DialogflowAssistAnswer;
2357
2555
  /** Output only. The FAQ answer. */
2358
2556
  faqAnswer?:
2359
2557
  GoogleCloudDialogflowV2FaqAnswer;
@@ -2383,6 +2581,9 @@ declare namespace gapi.client {
2383
2581
  /** A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided. */
2384
2582
  requestId?:
2385
2583
  string;
2584
+ /** An input representing the selection of a suggestion. */
2585
+ suggestionInput?:
2586
+ GoogleCloudDialogflowV2SuggestionInput;
2386
2587
  /** The natural language text to be processed. */
2387
2588
  textInput?:
2388
2589
  GoogleCloudDialogflowV2TextInput;
@@ -4246,6 +4447,17 @@ declare namespace gapi.client {
4246
4447
  webhookStatus?:
4247
4448
  GoogleRpcStatus;
4248
4449
  }
4450
+ interface GoogleCloudDialogflowV2DialogflowAssistAnswer {
4451
+ /** The name of answer record, in the format of "projects//locations//answerRecords/" */
4452
+ answerRecord?:
4453
+ string;
4454
+ /** An intent suggestion generated from conversation. */
4455
+ intentSuggestion?:
4456
+ GoogleCloudDialogflowV2IntentSuggestion;
4457
+ /** Result from v2 agent. */
4458
+ queryResult?:
4459
+ GoogleCloudDialogflowV2QueryResult;
4460
+ }
4249
4461
  interface GoogleCloudDialogflowV2Document {
4250
4462
  /**
4251
4463
  * The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form `gs:///`. NOTE: External URLs must correspond to public
@@ -4676,7 +4888,10 @@ declare namespace gapi.client {
4676
4888
  /** Configs for processing conversation. */
4677
4889
  conversationProcessConfig?:
4678
4890
  GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig;
4679
- /** Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. */
4891
+ /** Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. */
4892
+ disableAgentQueryLogging?:
4893
+ boolean;
4894
+ /** Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. */
4680
4895
  enableEventBasedSuggestion?:
4681
4896
  boolean;
4682
4897
  /** Configs of query. */
@@ -4733,6 +4948,14 @@ declare namespace gapi.client {
4733
4948
  */
4734
4949
  agent?:
4735
4950
  string;
4951
+ /** Optional. The Dialogflow assist configuration for human agent. */
4952
+ humanAgentSideConfig?:
4953
+ GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig;
4954
+ }
4955
+ interface GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig {
4956
+ /** Optional. The name of a dialogflow virtual agent used for intent detection and suggestion triggered by human agent. Format: `projects//locations//agent`. */
4957
+ agent?:
4958
+ string;
4736
4959
  }
4737
4960
  interface GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource {
4738
4961
  /** Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, at most 5 documents are supported. */
@@ -5367,6 +5590,17 @@ declare namespace gapi.client {
5367
5590
  value?:
5368
5591
  string;
5369
5592
  }
5593
+ interface GoogleCloudDialogflowV2IntentSuggestion {
5594
+ /** Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. */
5595
+ description?:
5596
+ string;
5597
+ /** The display name of the intent. */
5598
+ displayName?:
5599
+ string;
5600
+ /** The unique identifier of this intent. Format: `projects//locations//agent/intents/`. */
5601
+ intentV2?:
5602
+ string;
5603
+ }
5370
5604
  interface GoogleCloudDialogflowV2IntentTrainingPhrase {
5371
5605
  /** Output only. The unique identifier of this training phrase. */
5372
5606
  name?:
@@ -5852,6 +6086,60 @@ declare namespace gapi.client {
5852
6086
  nextPageToken?:
5853
6087
  string;
5854
6088
  }
6089
+ interface GoogleCloudDialogflowV2SearchKnowledgeAnswer {
6090
+ /** The piece of text from the knowledge base documents that answers the search query */
6091
+ answer?:
6092
+ string;
6093
+ /** The name of the answer record. Format: `projects//locations//answer Records/` */
6094
+ answerRecord?:
6095
+ string;
6096
+ /** All sources used to generate the answer. */
6097
+ answerSources?:
6098
+ GoogleCloudDialogflowV2SearchKnowledgeAnswerAnswerSource[];
6099
+ /** The type of the answer. */
6100
+ answerType?:
6101
+ string;
6102
+ }
6103
+ interface GoogleCloudDialogflowV2SearchKnowledgeAnswerAnswerSource {
6104
+ /** The relevant snippet of the article. */
6105
+ snippet?:
6106
+ string;
6107
+ /** The title of the article. */
6108
+ title?:
6109
+ string;
6110
+ /** The URI of the article. */
6111
+ uri?:
6112
+ string;
6113
+ }
6114
+ interface GoogleCloudDialogflowV2SearchKnowledgeRequest {
6115
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
6116
+ conversation?:
6117
+ string;
6118
+ /** Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. */
6119
+ conversationProfile?:
6120
+ string;
6121
+ /** The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. */
6122
+ latestMessage?:
6123
+ string;
6124
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
6125
+ parent?:
6126
+ string;
6127
+ /** Required. The natural language text query for knowledge search. */
6128
+ query?:
6129
+ GoogleCloudDialogflowV2TextInput;
6130
+ /**
6131
+ * The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search
6132
+ * history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session
6133
+ * identifiers (preferably hashed). The length must not exceed 36 characters.
6134
+ */
6135
+ sessionId?:
6136
+ string;
6137
+ }
6138
+ interface GoogleCloudDialogflowV2SearchKnowledgeResponse {
6139
+ /** Most relevant snippets extracted from articles in the given knowledge base, ordered by confidence. */
6140
+ answers?:
6141
+ GoogleCloudDialogflowV2SearchKnowledgeAnswer[];
6142
+ }
5855
6143
  interface GoogleCloudDialogflowV2Sentiment {
5856
6144
  /** A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */
5857
6145
  magnitude?:
@@ -5975,6 +6263,9 @@ declare namespace gapi.client {
5975
6263
  */
5976
6264
  speechModelVariant?:
5977
6265
  string;
6266
+ /** Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. */
6267
+ useTimeoutBasedEndpointing?:
6268
+ boolean;
5978
6269
  }
5979
6270
  interface GoogleCloudDialogflowV2SuggestArticlesRequest {
5980
6271
  /** Parameters for a human assist query. */
@@ -6079,6 +6370,14 @@ declare namespace gapi.client {
6079
6370
  type?:
6080
6371
  string;
6081
6372
  }
6373
+ interface GoogleCloudDialogflowV2SuggestionInput {
6374
+ /**
6375
+ * Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is:
6376
+ * `projects//locations//answerRecords/` where is an alphanumeric string.
6377
+ */
6378
+ answerRecord?:
6379
+ string;
6380
+ }
6082
6381
  interface GoogleCloudDialogflowV2SuggestionResult {
6083
6382
  /** Error status if the request failed. */
6084
6383
  error?:
@@ -13297,6 +13596,87 @@ declare namespace gapi.client {
13297
13596
  SuggestionsResource;
13298
13597
  }
13299
13598
  interface SuggestionsResource {
13599
+ /** Get answers for the given query based on knowledge documents. */
13600
+ searchKnowledge(request: {
13601
+ /** V1 error format. */
13602
+ "$.xgafv"?:
13603
+ string;
13604
+ /** OAuth access token. */
13605
+ access_token?:
13606
+ string;
13607
+ /** Data format for response. */
13608
+ alt?:
13609
+ string;
13610
+ /** JSONP */
13611
+ callback?:
13612
+ string;
13613
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
13614
+ conversation:
13615
+ string;
13616
+ /** Selector specifying which fields to include in a partial response. */
13617
+ fields?:
13618
+ string;
13619
+ /** 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. */
13620
+ key?:
13621
+ string;
13622
+ /** OAuth 2.0 token for the current user. */
13623
+ oauth_token?:
13624
+ string;
13625
+ /** Returns response with indentations and line breaks. */
13626
+ prettyPrint?:
13627
+ boolean;
13628
+ /** 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. */
13629
+ quotaUser?:
13630
+ string;
13631
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
13632
+ upload_protocol?:
13633
+ string;
13634
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13635
+ uploadType?:
13636
+ string;
13637
+ /** Request body */
13638
+ resource:
13639
+ GoogleCloudDialogflowV2SearchKnowledgeRequest;
13640
+ }): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
13641
+ searchKnowledge(request: {
13642
+ /** V1 error format. */
13643
+ "$.xgafv"?:
13644
+ string;
13645
+ /** OAuth access token. */
13646
+ access_token?:
13647
+ string;
13648
+ /** Data format for response. */
13649
+ alt?:
13650
+ string;
13651
+ /** JSONP */
13652
+ callback?:
13653
+ string;
13654
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
13655
+ conversation:
13656
+ string;
13657
+ /** Selector specifying which fields to include in a partial response. */
13658
+ fields?:
13659
+ string;
13660
+ /** 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. */
13661
+ key?:
13662
+ string;
13663
+ /** OAuth 2.0 token for the current user. */
13664
+ oauth_token?:
13665
+ string;
13666
+ /** Returns response with indentations and line breaks. */
13667
+ prettyPrint?:
13668
+ boolean;
13669
+ /** 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. */
13670
+ quotaUser?:
13671
+ string;
13672
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
13673
+ upload_protocol?:
13674
+ string;
13675
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13676
+ uploadType?:
13677
+ string;
13678
+ },
13679
+ body: GoogleCloudDialogflowV2SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
13300
13680
  /** Suggests summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request. */
13301
13681
  suggestConversationSummary(request: {
13302
13682
  /** V1 error format. */
@@ -20869,6 +21249,87 @@ declare namespace gapi.client {
20869
21249
  SuggestionsResource;
20870
21250
  }
20871
21251
  interface SuggestionsResource {
21252
+ /** Get answers for the given query based on knowledge documents. */
21253
+ searchKnowledge(request: {
21254
+ /** V1 error format. */
21255
+ "$.xgafv"?:
21256
+ string;
21257
+ /** OAuth access token. */
21258
+ access_token?:
21259
+ string;
21260
+ /** Data format for response. */
21261
+ alt?:
21262
+ string;
21263
+ /** JSONP */
21264
+ callback?:
21265
+ string;
21266
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
21267
+ conversation:
21268
+ string;
21269
+ /** Selector specifying which fields to include in a partial response. */
21270
+ fields?:
21271
+ string;
21272
+ /** 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. */
21273
+ key?:
21274
+ string;
21275
+ /** OAuth 2.0 token for the current user. */
21276
+ oauth_token?:
21277
+ string;
21278
+ /** Returns response with indentations and line breaks. */
21279
+ prettyPrint?:
21280
+ boolean;
21281
+ /** 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. */
21282
+ quotaUser?:
21283
+ string;
21284
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
21285
+ upload_protocol?:
21286
+ string;
21287
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
21288
+ uploadType?:
21289
+ string;
21290
+ /** Request body */
21291
+ resource:
21292
+ GoogleCloudDialogflowV2SearchKnowledgeRequest;
21293
+ }): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
21294
+ searchKnowledge(request: {
21295
+ /** V1 error format. */
21296
+ "$.xgafv"?:
21297
+ string;
21298
+ /** OAuth access token. */
21299
+ access_token?:
21300
+ string;
21301
+ /** Data format for response. */
21302
+ alt?:
21303
+ string;
21304
+ /** JSONP */
21305
+ callback?:
21306
+ string;
21307
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
21308
+ conversation:
21309
+ string;
21310
+ /** Selector specifying which fields to include in a partial response. */
21311
+ fields?:
21312
+ string;
21313
+ /** 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. */
21314
+ key?:
21315
+ string;
21316
+ /** OAuth 2.0 token for the current user. */
21317
+ oauth_token?:
21318
+ string;
21319
+ /** Returns response with indentations and line breaks. */
21320
+ prettyPrint?:
21321
+ boolean;
21322
+ /** 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. */
21323
+ quotaUser?:
21324
+ string;
21325
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
21326
+ upload_protocol?:
21327
+ string;
21328
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
21329
+ uploadType?:
21330
+ string;
21331
+ },
21332
+ body: GoogleCloudDialogflowV2SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
20872
21333
  /** Suggests summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request. */
20873
21334
  suggestConversationSummary(request: {
20874
21335
  /** V1 error format. */
@@ -22323,6 +22784,87 @@ declare namespace gapi.client {
22323
22784
  string;
22324
22785
  },
22325
22786
  body: GoogleCloudDialogflowV2GenerateStatelessSummaryRequest): Request<GoogleCloudDialogflowV2GenerateStatelessSummaryResponse>;
22787
+ /** Get answers for the given query based on knowledge documents. */
22788
+ searchKnowledge(request: {
22789
+ /** V1 error format. */
22790
+ "$.xgafv"?:
22791
+ string;
22792
+ /** OAuth access token. */
22793
+ access_token?:
22794
+ string;
22795
+ /** Data format for response. */
22796
+ alt?:
22797
+ string;
22798
+ /** JSONP */
22799
+ callback?:
22800
+ string;
22801
+ /** Selector specifying which fields to include in a partial response. */
22802
+ fields?:
22803
+ string;
22804
+ /** 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. */
22805
+ key?:
22806
+ string;
22807
+ /** OAuth 2.0 token for the current user. */
22808
+ oauth_token?:
22809
+ string;
22810
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
22811
+ parent:
22812
+ string;
22813
+ /** Returns response with indentations and line breaks. */
22814
+ prettyPrint?:
22815
+ boolean;
22816
+ /** 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. */
22817
+ quotaUser?:
22818
+ string;
22819
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
22820
+ upload_protocol?:
22821
+ string;
22822
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
22823
+ uploadType?:
22824
+ string;
22825
+ /** Request body */
22826
+ resource:
22827
+ GoogleCloudDialogflowV2SearchKnowledgeRequest;
22828
+ }): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
22829
+ searchKnowledge(request: {
22830
+ /** V1 error format. */
22831
+ "$.xgafv"?:
22832
+ string;
22833
+ /** OAuth access token. */
22834
+ access_token?:
22835
+ string;
22836
+ /** Data format for response. */
22837
+ alt?:
22838
+ string;
22839
+ /** JSONP */
22840
+ callback?:
22841
+ string;
22842
+ /** Selector specifying which fields to include in a partial response. */
22843
+ fields?:
22844
+ string;
22845
+ /** 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. */
22846
+ key?:
22847
+ string;
22848
+ /** OAuth 2.0 token for the current user. */
22849
+ oauth_token?:
22850
+ string;
22851
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
22852
+ parent:
22853
+ string;
22854
+ /** Returns response with indentations and line breaks. */
22855
+ prettyPrint?:
22856
+ boolean;
22857
+ /** 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. */
22858
+ quotaUser?:
22859
+ string;
22860
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
22861
+ upload_protocol?:
22862
+ string;
22863
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
22864
+ uploadType?:
22865
+ string;
22866
+ },
22867
+ body: GoogleCloudDialogflowV2SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
22326
22868
  }
22327
22869
  interface LocationsResource {
22328
22870
  /** Deletes the specified agent. */
@@ -22817,6 +23359,87 @@ declare namespace gapi.client {
22817
23359
  string;
22818
23360
  },
22819
23361
  body: GoogleCloudDialogflowV2GenerateStatelessSummaryRequest): Request<GoogleCloudDialogflowV2GenerateStatelessSummaryResponse>;
23362
+ /** Get answers for the given query based on knowledge documents. */
23363
+ searchKnowledge(request: {
23364
+ /** V1 error format. */
23365
+ "$.xgafv"?:
23366
+ string;
23367
+ /** OAuth access token. */
23368
+ access_token?:
23369
+ string;
23370
+ /** Data format for response. */
23371
+ alt?:
23372
+ string;
23373
+ /** JSONP */
23374
+ callback?:
23375
+ string;
23376
+ /** Selector specifying which fields to include in a partial response. */
23377
+ fields?:
23378
+ string;
23379
+ /** 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. */
23380
+ key?:
23381
+ string;
23382
+ /** OAuth 2.0 token for the current user. */
23383
+ oauth_token?:
23384
+ string;
23385
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
23386
+ parent:
23387
+ string;
23388
+ /** Returns response with indentations and line breaks. */
23389
+ prettyPrint?:
23390
+ boolean;
23391
+ /** 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. */
23392
+ quotaUser?:
23393
+ string;
23394
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
23395
+ upload_protocol?:
23396
+ string;
23397
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
23398
+ uploadType?:
23399
+ string;
23400
+ /** Request body */
23401
+ resource:
23402
+ GoogleCloudDialogflowV2SearchKnowledgeRequest;
23403
+ }): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
23404
+ searchKnowledge(request: {
23405
+ /** V1 error format. */
23406
+ "$.xgafv"?:
23407
+ string;
23408
+ /** OAuth access token. */
23409
+ access_token?:
23410
+ string;
23411
+ /** Data format for response. */
23412
+ alt?:
23413
+ string;
23414
+ /** JSONP */
23415
+ callback?:
23416
+ string;
23417
+ /** Selector specifying which fields to include in a partial response. */
23418
+ fields?:
23419
+ string;
23420
+ /** 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. */
23421
+ key?:
23422
+ string;
23423
+ /** OAuth 2.0 token for the current user. */
23424
+ oauth_token?:
23425
+ string;
23426
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
23427
+ parent:
23428
+ string;
23429
+ /** Returns response with indentations and line breaks. */
23430
+ prettyPrint?:
23431
+ boolean;
23432
+ /** 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. */
23433
+ quotaUser?:
23434
+ string;
23435
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
23436
+ upload_protocol?:
23437
+ string;
23438
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
23439
+ uploadType?:
23440
+ string;
23441
+ },
23442
+ body: GoogleCloudDialogflowV2SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
22820
23443
  }
22821
23444
  interface ProjectsResource {
22822
23445
  /** Deletes the specified agent. */