@maxim_mazurok/gapi.client.dialogflow-v2beta1 0.0.20230821 → 0.0.20230906

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 +511 -2
  2. package/package.json +1 -1
  3. package/tests.ts +89 -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://dialogflow.googleapis.com/$discovery/rest?version=v2beta1
12
- // Revision: 20230821
12
+ // Revision: 20230906
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: "v2beta1", 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
@@ -282,6 +350,9 @@ declare namespace gapi.client {
282
350
  GoogleCloudDialogflowCxV3beta1FormParameter[];
283
351
  }
284
352
  interface GoogleCloudDialogflowCxV3beta1FormParameter {
353
+ /** Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. */
354
+ advancedSettings?:
355
+ GoogleCloudDialogflowCxV3beta1AdvancedSettings;
285
356
  /** The default value of an optional parameter. If the parameter is required, the default value will be ignored. */
286
357
  defaultValue?:
287
358
  any;
@@ -332,9 +403,18 @@ declare namespace gapi.client {
332
403
  GoogleCloudDialogflowCxV3beta1EventHandler[];
333
404
  }
334
405
  interface GoogleCloudDialogflowCxV3beta1Fulfillment {
406
+ /** Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. */
407
+ advancedSettings?:
408
+ GoogleCloudDialogflowCxV3beta1AdvancedSettings;
335
409
  /** Conditional cases for this fulfillment. */
336
410
  conditionalCases?:
337
411
  GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases[];
412
+ /**
413
+ * 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
414
+ * useful for fulfillments associated with no-match event handlers.
415
+ */
416
+ enableGenerativeFallback?:
417
+ boolean;
338
418
  /** The list of rich message responses to present to the user. */
339
419
  messages?:
340
420
  GoogleCloudDialogflowCxV3beta1ResponseMessage[];
@@ -390,6 +470,14 @@ declare namespace gapi.client {
390
470
  value?:
391
471
  any;
392
472
  }
473
+ interface GoogleCloudDialogflowCxV3beta1GcsDestination {
474
+ /**
475
+ * 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
476
+ * depends on the Dialogflow operation.
477
+ */
478
+ uri?:
479
+ string;
480
+ }
393
481
  interface GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata {
394
482
  /** Required. Output only. The current state of this operation. */
395
483
  state?:
@@ -570,6 +658,9 @@ declare namespace gapi.client {
570
658
  GoogleCloudDialogflowCxV3beta1Fulfillment;
571
659
  }
572
660
  interface GoogleCloudDialogflowCxV3beta1Page {
661
+ /** Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. */
662
+ advancedSettings?:
663
+ GoogleCloudDialogflowCxV3beta1AdvancedSettings;
573
664
  /** Required. The human-readable name of the page, unique within the flow. */
574
665
  displayName?:
575
666
  string;
@@ -1380,6 +1471,9 @@ declare namespace gapi.client {
1380
1471
  GoogleCloudDialogflowCxV3FormParameter[];
1381
1472
  }
1382
1473
  interface GoogleCloudDialogflowCxV3FormParameter {
1474
+ /** Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. */
1475
+ advancedSettings?:
1476
+ GoogleCloudDialogflowCxV3AdvancedSettings;
1383
1477
  /** The default value of an optional parameter. If the parameter is required, the default value will be ignored. */
1384
1478
  defaultValue?:
1385
1479
  any;
@@ -1430,9 +1524,18 @@ declare namespace gapi.client {
1430
1524
  GoogleCloudDialogflowCxV3EventHandler[];
1431
1525
  }
1432
1526
  interface GoogleCloudDialogflowCxV3Fulfillment {
1527
+ /** Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. */
1528
+ advancedSettings?:
1529
+ GoogleCloudDialogflowCxV3AdvancedSettings;
1433
1530
  /** Conditional cases for this fulfillment. */
1434
1531
  conditionalCases?:
1435
1532
  GoogleCloudDialogflowCxV3FulfillmentConditionalCases[];
1533
+ /**
1534
+ * 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
1535
+ * useful for fulfillments associated with no-match event handlers.
1536
+ */
1537
+ enableGenerativeFallback?:
1538
+ boolean;
1436
1539
  /** The list of rich message responses to present to the user. */
1437
1540
  messages?:
1438
1541
  GoogleCloudDialogflowCxV3ResponseMessage[];
@@ -1488,6 +1591,14 @@ declare namespace gapi.client {
1488
1591
  value?:
1489
1592
  any;
1490
1593
  }
1594
+ interface GoogleCloudDialogflowCxV3GcsDestination {
1595
+ /**
1596
+ * 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
1597
+ * depends on the Dialogflow operation.
1598
+ */
1599
+ uri?:
1600
+ string;
1601
+ }
1491
1602
  interface GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata {
1492
1603
  /** Required. Output only. The current state of this operation. */
1493
1604
  state?:
@@ -1668,6 +1779,9 @@ declare namespace gapi.client {
1668
1779
  GoogleCloudDialogflowCxV3Fulfillment;
1669
1780
  }
1670
1781
  interface GoogleCloudDialogflowCxV3Page {
1782
+ /** Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. */
1783
+ advancedSettings?:
1784
+ GoogleCloudDialogflowCxV3AdvancedSettings;
1671
1785
  /** Required. The human-readable name of the page, unique within the flow. */
1672
1786
  displayName?:
1673
1787
  string;
@@ -2390,10 +2504,21 @@ declare namespace gapi.client {
2390
2504
  */
2391
2505
  documentEfficiency?:
2392
2506
  string;
2507
+ /** Optional. Feedback for knowledge search. */
2508
+ knowledgeSearchFeedback?:
2509
+ GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeSearchFeedback;
2393
2510
  /** Feedback for conversation summarization. */
2394
2511
  summarizationFeedback?:
2395
2512
  GoogleCloudDialogflowV2beta1AgentAssistantFeedbackSummarizationFeedback;
2396
2513
  }
2514
+ interface GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeSearchFeedback {
2515
+ /** 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. */
2516
+ answerCopied?:
2517
+ boolean;
2518
+ /** 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. */
2519
+ clickedUris?:
2520
+ string[];
2521
+ }
2397
2522
  interface GoogleCloudDialogflowV2beta1AgentAssistantFeedbackSummarizationFeedback {
2398
2523
  /** Timestamp when composing of the summary starts. */
2399
2524
  startTimestamp?:
@@ -3411,7 +3536,10 @@ declare namespace gapi.client {
3411
3536
  /** Configs for processing conversation. */
3412
3537
  conversationProcessConfig?:
3413
3538
  GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigConversationProcessConfig;
3414
- /** Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. */
3539
+ /** 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. */
3540
+ disableAgentQueryLogging?:
3541
+ boolean;
3542
+ /** Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. */
3415
3543
  enableEventBasedSuggestion?:
3416
3544
  boolean;
3417
3545
  /** Configs of query. */
@@ -4840,6 +4968,60 @@ declare namespace gapi.client {
4840
4968
  nextPageToken?:
4841
4969
  string;
4842
4970
  }
4971
+ interface GoogleCloudDialogflowV2beta1SearchKnowledgeAnswer {
4972
+ /** The piece of text from the knowledge base documents that answers the search query */
4973
+ answer?:
4974
+ string;
4975
+ /** The name of the answer record. Format: `projects//locations//answer Records/` */
4976
+ answerRecord?:
4977
+ string;
4978
+ /** All sources used to generate the answer. */
4979
+ answerSources?:
4980
+ GoogleCloudDialogflowV2beta1SearchKnowledgeAnswerAnswerSource[];
4981
+ /** The type of the answer. */
4982
+ answerType?:
4983
+ string;
4984
+ }
4985
+ interface GoogleCloudDialogflowV2beta1SearchKnowledgeAnswerAnswerSource {
4986
+ /** The relevant snippet of the article. */
4987
+ snippet?:
4988
+ string;
4989
+ /** The title of the article. */
4990
+ title?:
4991
+ string;
4992
+ /** The URI of the article. */
4993
+ uri?:
4994
+ string;
4995
+ }
4996
+ interface GoogleCloudDialogflowV2beta1SearchKnowledgeRequest {
4997
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
4998
+ conversation?:
4999
+ string;
5000
+ /** Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. */
5001
+ conversationProfile?:
5002
+ string;
5003
+ /** The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. */
5004
+ latestMessage?:
5005
+ string;
5006
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
5007
+ parent?:
5008
+ string;
5009
+ /** Required. The natural language text query for knowledge search. */
5010
+ query?:
5011
+ GoogleCloudDialogflowV2beta1TextInput;
5012
+ /**
5013
+ * 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
5014
+ * 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
5015
+ * identifiers (preferably hashed). The length must not exceed 36 characters.
5016
+ */
5017
+ sessionId?:
5018
+ string;
5019
+ }
5020
+ interface GoogleCloudDialogflowV2beta1SearchKnowledgeResponse {
5021
+ /** Most relevant snippets extracted from articles in the given knowledge base, ordered by confidence. */
5022
+ answers?:
5023
+ GoogleCloudDialogflowV2beta1SearchKnowledgeAnswer[];
5024
+ }
4843
5025
  interface GoogleCloudDialogflowV2beta1Sentiment {
4844
5026
  /** A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */
4845
5027
  magnitude?:
@@ -4937,6 +5119,9 @@ declare namespace gapi.client {
4937
5119
  */
4938
5120
  speechModelVariant?:
4939
5121
  string;
5122
+ /** Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. */
5123
+ useTimeoutBasedEndpointing?:
5124
+ boolean;
4940
5125
  }
4941
5126
  interface GoogleCloudDialogflowV2beta1SubAgent {
4942
5127
  /** Optional. The unique identifier (`environment name` in dialogflow console) of this sub-agent environment. Assumes draft environment if `environment` is not set. */
@@ -13102,6 +13287,87 @@ declare namespace gapi.client {
13102
13287
  SuggestionsResource;
13103
13288
  }
13104
13289
  interface SuggestionsResource {
13290
+ /** Get answers for the given query based on knowledge documents. */
13291
+ searchKnowledge(request: {
13292
+ /** V1 error format. */
13293
+ "$.xgafv"?:
13294
+ string;
13295
+ /** OAuth access token. */
13296
+ access_token?:
13297
+ string;
13298
+ /** Data format for response. */
13299
+ alt?:
13300
+ string;
13301
+ /** JSONP */
13302
+ callback?:
13303
+ string;
13304
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
13305
+ conversation:
13306
+ string;
13307
+ /** Selector specifying which fields to include in a partial response. */
13308
+ fields?:
13309
+ string;
13310
+ /** 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. */
13311
+ key?:
13312
+ string;
13313
+ /** OAuth 2.0 token for the current user. */
13314
+ oauth_token?:
13315
+ string;
13316
+ /** Returns response with indentations and line breaks. */
13317
+ prettyPrint?:
13318
+ boolean;
13319
+ /** 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. */
13320
+ quotaUser?:
13321
+ string;
13322
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
13323
+ upload_protocol?:
13324
+ string;
13325
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13326
+ uploadType?:
13327
+ string;
13328
+ /** Request body */
13329
+ resource:
13330
+ GoogleCloudDialogflowV2beta1SearchKnowledgeRequest;
13331
+ }): Request<GoogleCloudDialogflowV2beta1SearchKnowledgeResponse>;
13332
+ searchKnowledge(request: {
13333
+ /** V1 error format. */
13334
+ "$.xgafv"?:
13335
+ string;
13336
+ /** OAuth access token. */
13337
+ access_token?:
13338
+ string;
13339
+ /** Data format for response. */
13340
+ alt?:
13341
+ string;
13342
+ /** JSONP */
13343
+ callback?:
13344
+ string;
13345
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
13346
+ conversation:
13347
+ string;
13348
+ /** Selector specifying which fields to include in a partial response. */
13349
+ fields?:
13350
+ string;
13351
+ /** 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. */
13352
+ key?:
13353
+ string;
13354
+ /** OAuth 2.0 token for the current user. */
13355
+ oauth_token?:
13356
+ string;
13357
+ /** Returns response with indentations and line breaks. */
13358
+ prettyPrint?:
13359
+ boolean;
13360
+ /** 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. */
13361
+ quotaUser?:
13362
+ string;
13363
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
13364
+ upload_protocol?:
13365
+ string;
13366
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13367
+ uploadType?:
13368
+ string;
13369
+ },
13370
+ body: GoogleCloudDialogflowV2beta1SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2beta1SearchKnowledgeResponse>;
13105
13371
  /** Suggest 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. */
13106
13372
  suggestConversationSummary(request: {
13107
13373
  /** V1 error format. */
@@ -19900,6 +20166,87 @@ declare namespace gapi.client {
19900
20166
  SuggestionsResource;
19901
20167
  }
19902
20168
  interface SuggestionsResource {
20169
+ /** Get answers for the given query based on knowledge documents. */
20170
+ searchKnowledge(request: {
20171
+ /** V1 error format. */
20172
+ "$.xgafv"?:
20173
+ string;
20174
+ /** OAuth access token. */
20175
+ access_token?:
20176
+ string;
20177
+ /** Data format for response. */
20178
+ alt?:
20179
+ string;
20180
+ /** JSONP */
20181
+ callback?:
20182
+ string;
20183
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
20184
+ conversation:
20185
+ string;
20186
+ /** Selector specifying which fields to include in a partial response. */
20187
+ fields?:
20188
+ string;
20189
+ /** 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. */
20190
+ key?:
20191
+ string;
20192
+ /** OAuth 2.0 token for the current user. */
20193
+ oauth_token?:
20194
+ string;
20195
+ /** Returns response with indentations and line breaks. */
20196
+ prettyPrint?:
20197
+ boolean;
20198
+ /** 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. */
20199
+ quotaUser?:
20200
+ string;
20201
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20202
+ upload_protocol?:
20203
+ string;
20204
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20205
+ uploadType?:
20206
+ string;
20207
+ /** Request body */
20208
+ resource:
20209
+ GoogleCloudDialogflowV2beta1SearchKnowledgeRequest;
20210
+ }): Request<GoogleCloudDialogflowV2beta1SearchKnowledgeResponse>;
20211
+ searchKnowledge(request: {
20212
+ /** V1 error format. */
20213
+ "$.xgafv"?:
20214
+ string;
20215
+ /** OAuth access token. */
20216
+ access_token?:
20217
+ string;
20218
+ /** Data format for response. */
20219
+ alt?:
20220
+ string;
20221
+ /** JSONP */
20222
+ callback?:
20223
+ string;
20224
+ /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
20225
+ conversation:
20226
+ string;
20227
+ /** Selector specifying which fields to include in a partial response. */
20228
+ fields?:
20229
+ string;
20230
+ /** 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. */
20231
+ key?:
20232
+ string;
20233
+ /** OAuth 2.0 token for the current user. */
20234
+ oauth_token?:
20235
+ string;
20236
+ /** Returns response with indentations and line breaks. */
20237
+ prettyPrint?:
20238
+ boolean;
20239
+ /** 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. */
20240
+ quotaUser?:
20241
+ string;
20242
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20243
+ upload_protocol?:
20244
+ string;
20245
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20246
+ uploadType?:
20247
+ string;
20248
+ },
20249
+ body: GoogleCloudDialogflowV2beta1SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2beta1SearchKnowledgeResponse>;
19903
20250
  /** Suggest 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. */
19904
20251
  suggestConversationSummary(request: {
19905
20252
  /** V1 error format. */
@@ -21279,6 +21626,87 @@ declare namespace gapi.client {
21279
21626
  string;
21280
21627
  },
21281
21628
  body: GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest): Request<GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse>;
21629
+ /** Get answers for the given query based on knowledge documents. */
21630
+ searchKnowledge(request: {
21631
+ /** V1 error format. */
21632
+ "$.xgafv"?:
21633
+ string;
21634
+ /** OAuth access token. */
21635
+ access_token?:
21636
+ string;
21637
+ /** Data format for response. */
21638
+ alt?:
21639
+ string;
21640
+ /** JSONP */
21641
+ callback?:
21642
+ string;
21643
+ /** Selector specifying which fields to include in a partial response. */
21644
+ fields?:
21645
+ string;
21646
+ /** 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. */
21647
+ key?:
21648
+ string;
21649
+ /** OAuth 2.0 token for the current user. */
21650
+ oauth_token?:
21651
+ string;
21652
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
21653
+ parent:
21654
+ string;
21655
+ /** Returns response with indentations and line breaks. */
21656
+ prettyPrint?:
21657
+ boolean;
21658
+ /** 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. */
21659
+ quotaUser?:
21660
+ string;
21661
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
21662
+ upload_protocol?:
21663
+ string;
21664
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
21665
+ uploadType?:
21666
+ string;
21667
+ /** Request body */
21668
+ resource:
21669
+ GoogleCloudDialogflowV2beta1SearchKnowledgeRequest;
21670
+ }): Request<GoogleCloudDialogflowV2beta1SearchKnowledgeResponse>;
21671
+ searchKnowledge(request: {
21672
+ /** V1 error format. */
21673
+ "$.xgafv"?:
21674
+ string;
21675
+ /** OAuth access token. */
21676
+ access_token?:
21677
+ string;
21678
+ /** Data format for response. */
21679
+ alt?:
21680
+ string;
21681
+ /** JSONP */
21682
+ callback?:
21683
+ string;
21684
+ /** Selector specifying which fields to include in a partial response. */
21685
+ fields?:
21686
+ string;
21687
+ /** 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. */
21688
+ key?:
21689
+ string;
21690
+ /** OAuth 2.0 token for the current user. */
21691
+ oauth_token?:
21692
+ string;
21693
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
21694
+ parent:
21695
+ string;
21696
+ /** Returns response with indentations and line breaks. */
21697
+ prettyPrint?:
21698
+ boolean;
21699
+ /** 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. */
21700
+ quotaUser?:
21701
+ string;
21702
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
21703
+ upload_protocol?:
21704
+ string;
21705
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
21706
+ uploadType?:
21707
+ string;
21708
+ },
21709
+ body: GoogleCloudDialogflowV2beta1SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2beta1SearchKnowledgeResponse>;
21282
21710
  }
21283
21711
  interface LocationsResource {
21284
21712
  /** Deletes the specified agent. */
@@ -21769,6 +22197,87 @@ declare namespace gapi.client {
21769
22197
  string;
21770
22198
  },
21771
22199
  body: GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest): Request<GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse>;
22200
+ /** Get answers for the given query based on knowledge documents. */
22201
+ searchKnowledge(request: {
22202
+ /** V1 error format. */
22203
+ "$.xgafv"?:
22204
+ string;
22205
+ /** OAuth access token. */
22206
+ access_token?:
22207
+ string;
22208
+ /** Data format for response. */
22209
+ alt?:
22210
+ string;
22211
+ /** JSONP */
22212
+ callback?:
22213
+ string;
22214
+ /** Selector specifying which fields to include in a partial response. */
22215
+ fields?:
22216
+ string;
22217
+ /** 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. */
22218
+ key?:
22219
+ string;
22220
+ /** OAuth 2.0 token for the current user. */
22221
+ oauth_token?:
22222
+ string;
22223
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
22224
+ parent:
22225
+ string;
22226
+ /** Returns response with indentations and line breaks. */
22227
+ prettyPrint?:
22228
+ boolean;
22229
+ /** 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. */
22230
+ quotaUser?:
22231
+ string;
22232
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
22233
+ upload_protocol?:
22234
+ string;
22235
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
22236
+ uploadType?:
22237
+ string;
22238
+ /** Request body */
22239
+ resource:
22240
+ GoogleCloudDialogflowV2beta1SearchKnowledgeRequest;
22241
+ }): Request<GoogleCloudDialogflowV2beta1SearchKnowledgeResponse>;
22242
+ searchKnowledge(request: {
22243
+ /** V1 error format. */
22244
+ "$.xgafv"?:
22245
+ string;
22246
+ /** OAuth access token. */
22247
+ access_token?:
22248
+ string;
22249
+ /** Data format for response. */
22250
+ alt?:
22251
+ string;
22252
+ /** JSONP */
22253
+ callback?:
22254
+ string;
22255
+ /** Selector specifying which fields to include in a partial response. */
22256
+ fields?:
22257
+ string;
22258
+ /** 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. */
22259
+ key?:
22260
+ string;
22261
+ /** OAuth 2.0 token for the current user. */
22262
+ oauth_token?:
22263
+ string;
22264
+ /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
22265
+ parent:
22266
+ string;
22267
+ /** Returns response with indentations and line breaks. */
22268
+ prettyPrint?:
22269
+ boolean;
22270
+ /** 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. */
22271
+ quotaUser?:
22272
+ string;
22273
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
22274
+ upload_protocol?:
22275
+ string;
22276
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
22277
+ uploadType?:
22278
+ string;
22279
+ },
22280
+ body: GoogleCloudDialogflowV2beta1SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2beta1SearchKnowledgeResponse>;
21772
22281
  }
21773
22282
  interface ProjectsResource {
21774
22283
  /** Deletes the specified agent. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.dialogflow-v2beta1",
3
- "version": "0.0.20230821",
3
+ "version": "0.0.20230906",
4
4
  "description": "TypeScript typings for Dialogflow API v2beta1",
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: 20230821
6
+ // Revision: 20230906
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -3234,6 +3234,12 @@ gapi.load('client', async () => {
3234
3234
  answerRelevance: "Test string",
3235
3235
  documentCorrectness: "Test string",
3236
3236
  documentEfficiency: "Test string",
3237
+ knowledgeSearchFeedback: {
3238
+ answerCopied: true,
3239
+ clickedUris: [
3240
+ "Test string"
3241
+ ],
3242
+ },
3237
3243
  summarizationFeedback: {
3238
3244
  startTimestamp: "Test string",
3239
3245
  submitTimestamp: "Test string",
@@ -3283,6 +3289,7 @@ gapi.load('client', async () => {
3283
3289
  conversationProcessConfig: {
3284
3290
  recentSentencesCount: 42,
3285
3291
  },
3292
+ disableAgentQueryLogging: true,
3286
3293
  enableEventBasedSuggestion: true,
3287
3294
  queryConfig: {
3288
3295
  confidenceThreshold: 42,
@@ -3330,6 +3337,7 @@ gapi.load('client', async () => {
3330
3337
  conversationProcessConfig: {
3331
3338
  recentSentencesCount: 42,
3332
3339
  },
3340
+ disableAgentQueryLogging: true,
3333
3341
  enableEventBasedSuggestion: true,
3334
3342
  queryConfig: {
3335
3343
  confidenceThreshold: 42,
@@ -3404,6 +3412,7 @@ gapi.load('client', async () => {
3404
3412
  sttConfig: {
3405
3413
  model: "Test string",
3406
3414
  speechModelVariant: "Test string",
3415
+ useTimeoutBasedEndpointing: true,
3407
3416
  },
3408
3417
  timeZone: "Test string",
3409
3418
  ttsConfig: {
@@ -3459,6 +3468,7 @@ gapi.load('client', async () => {
3459
3468
  conversationProcessConfig: {
3460
3469
  recentSentencesCount: 42,
3461
3470
  },
3471
+ disableAgentQueryLogging: true,
3462
3472
  enableEventBasedSuggestion: true,
3463
3473
  queryConfig: {
3464
3474
  confidenceThreshold: 42,
@@ -3506,6 +3516,7 @@ gapi.load('client', async () => {
3506
3516
  conversationProcessConfig: {
3507
3517
  recentSentencesCount: 42,
3508
3518
  },
3519
+ disableAgentQueryLogging: true,
3509
3520
  enableEventBasedSuggestion: true,
3510
3521
  queryConfig: {
3511
3522
  confidenceThreshold: 42,
@@ -3580,6 +3591,7 @@ gapi.load('client', async () => {
3580
3591
  sttConfig: {
3581
3592
  model: "Test string",
3582
3593
  speechModelVariant: "Test string",
3594
+ useTimeoutBasedEndpointing: true,
3583
3595
  },
3584
3596
  timeZone: "Test string",
3585
3597
  ttsConfig: {
@@ -3615,6 +3627,7 @@ gapi.load('client', async () => {
3615
3627
  conversationProcessConfig: {
3616
3628
  recentSentencesCount: 42,
3617
3629
  },
3630
+ disableAgentQueryLogging: true,
3618
3631
  enableEventBasedSuggestion: true,
3619
3632
  queryConfig: {
3620
3633
  confidenceThreshold: 42,
@@ -3964,6 +3977,20 @@ gapi.load('client', async () => {
3964
3977
  },
3965
3978
  latestMessage: "Test string",
3966
3979
  });
3980
+ /** Get answers for the given query based on knowledge documents. */
3981
+ await gapi.client.dialogflow.projects.conversations.suggestions.searchKnowledge({
3982
+ conversation: "Test string",
3983
+ }, {
3984
+ conversation: "Test string",
3985
+ conversationProfile: "Test string",
3986
+ latestMessage: "Test string",
3987
+ parent: "Test string",
3988
+ query: {
3989
+ languageCode: "Test string",
3990
+ text: "Test string",
3991
+ },
3992
+ sessionId: "Test string",
3993
+ });
3967
3994
  /** Suggest 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. */
3968
3995
  await gapi.client.dialogflow.projects.conversations.suggestions.suggestConversationSummary({
3969
3996
  conversation: "Test string",
@@ -7214,6 +7241,12 @@ gapi.load('client', async () => {
7214
7241
  answerRelevance: "Test string",
7215
7242
  documentCorrectness: "Test string",
7216
7243
  documentEfficiency: "Test string",
7244
+ knowledgeSearchFeedback: {
7245
+ answerCopied: true,
7246
+ clickedUris: [
7247
+ "Test string"
7248
+ ],
7249
+ },
7217
7250
  summarizationFeedback: {
7218
7251
  startTimestamp: "Test string",
7219
7252
  submitTimestamp: "Test string",
@@ -7263,6 +7296,7 @@ gapi.load('client', async () => {
7263
7296
  conversationProcessConfig: {
7264
7297
  recentSentencesCount: 42,
7265
7298
  },
7299
+ disableAgentQueryLogging: true,
7266
7300
  enableEventBasedSuggestion: true,
7267
7301
  queryConfig: {
7268
7302
  confidenceThreshold: 42,
@@ -7310,6 +7344,7 @@ gapi.load('client', async () => {
7310
7344
  conversationProcessConfig: {
7311
7345
  recentSentencesCount: 42,
7312
7346
  },
7347
+ disableAgentQueryLogging: true,
7313
7348
  enableEventBasedSuggestion: true,
7314
7349
  queryConfig: {
7315
7350
  confidenceThreshold: 42,
@@ -7384,6 +7419,7 @@ gapi.load('client', async () => {
7384
7419
  sttConfig: {
7385
7420
  model: "Test string",
7386
7421
  speechModelVariant: "Test string",
7422
+ useTimeoutBasedEndpointing: true,
7387
7423
  },
7388
7424
  timeZone: "Test string",
7389
7425
  ttsConfig: {
@@ -7439,6 +7475,7 @@ gapi.load('client', async () => {
7439
7475
  conversationProcessConfig: {
7440
7476
  recentSentencesCount: 42,
7441
7477
  },
7478
+ disableAgentQueryLogging: true,
7442
7479
  enableEventBasedSuggestion: true,
7443
7480
  queryConfig: {
7444
7481
  confidenceThreshold: 42,
@@ -7486,6 +7523,7 @@ gapi.load('client', async () => {
7486
7523
  conversationProcessConfig: {
7487
7524
  recentSentencesCount: 42,
7488
7525
  },
7526
+ disableAgentQueryLogging: true,
7489
7527
  enableEventBasedSuggestion: true,
7490
7528
  queryConfig: {
7491
7529
  confidenceThreshold: 42,
@@ -7560,6 +7598,7 @@ gapi.load('client', async () => {
7560
7598
  sttConfig: {
7561
7599
  model: "Test string",
7562
7600
  speechModelVariant: "Test string",
7601
+ useTimeoutBasedEndpointing: true,
7563
7602
  },
7564
7603
  timeZone: "Test string",
7565
7604
  ttsConfig: {
@@ -7595,6 +7634,7 @@ gapi.load('client', async () => {
7595
7634
  conversationProcessConfig: {
7596
7635
  recentSentencesCount: 42,
7597
7636
  },
7637
+ disableAgentQueryLogging: true,
7598
7638
  enableEventBasedSuggestion: true,
7599
7639
  queryConfig: {
7600
7640
  confidenceThreshold: 42,
@@ -7921,6 +7961,20 @@ gapi.load('client', async () => {
7921
7961
  },
7922
7962
  latestMessage: "Test string",
7923
7963
  });
7964
+ /** Get answers for the given query based on knowledge documents. */
7965
+ await gapi.client.dialogflow.projects.locations.conversations.suggestions.searchKnowledge({
7966
+ conversation: "Test string",
7967
+ }, {
7968
+ conversation: "Test string",
7969
+ conversationProfile: "Test string",
7970
+ latestMessage: "Test string",
7971
+ parent: "Test string",
7972
+ query: {
7973
+ languageCode: "Test string",
7974
+ text: "Test string",
7975
+ },
7976
+ sessionId: "Test string",
7977
+ });
7924
7978
  /** Suggest 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. */
7925
7979
  await gapi.client.dialogflow.projects.locations.conversations.suggestions.suggestConversationSummary({
7926
7980
  conversation: "Test string",
@@ -8139,6 +8193,7 @@ gapi.load('client', async () => {
8139
8193
  conversationProcessConfig: {
8140
8194
  recentSentencesCount: 42,
8141
8195
  },
8196
+ disableAgentQueryLogging: true,
8142
8197
  enableEventBasedSuggestion: true,
8143
8198
  queryConfig: {
8144
8199
  confidenceThreshold: 42,
@@ -8186,6 +8241,7 @@ gapi.load('client', async () => {
8186
8241
  conversationProcessConfig: {
8187
8242
  recentSentencesCount: 42,
8188
8243
  },
8244
+ disableAgentQueryLogging: true,
8189
8245
  enableEventBasedSuggestion: true,
8190
8246
  queryConfig: {
8191
8247
  confidenceThreshold: 42,
@@ -8260,6 +8316,7 @@ gapi.load('client', async () => {
8260
8316
  sttConfig: {
8261
8317
  model: "Test string",
8262
8318
  speechModelVariant: "Test string",
8319
+ useTimeoutBasedEndpointing: true,
8263
8320
  },
8264
8321
  timeZone: "Test string",
8265
8322
  ttsConfig: {
@@ -8308,6 +8365,20 @@ gapi.load('client', async () => {
8308
8365
  ],
8309
8366
  },
8310
8367
  });
8368
+ /** Get answers for the given query based on knowledge documents. */
8369
+ await gapi.client.dialogflow.projects.locations.suggestions.searchKnowledge({
8370
+ parent: "Test string",
8371
+ }, {
8372
+ conversation: "Test string",
8373
+ conversationProfile: "Test string",
8374
+ latestMessage: "Test string",
8375
+ parent: "Test string",
8376
+ query: {
8377
+ languageCode: "Test string",
8378
+ text: "Test string",
8379
+ },
8380
+ sessionId: "Test string",
8381
+ });
8311
8382
  /**
8312
8383
  * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this
8313
8384
  * method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation
@@ -8350,6 +8421,7 @@ gapi.load('client', async () => {
8350
8421
  conversationProcessConfig: {
8351
8422
  recentSentencesCount: 42,
8352
8423
  },
8424
+ disableAgentQueryLogging: true,
8353
8425
  enableEventBasedSuggestion: true,
8354
8426
  queryConfig: {
8355
8427
  confidenceThreshold: 42,
@@ -8397,6 +8469,7 @@ gapi.load('client', async () => {
8397
8469
  conversationProcessConfig: {
8398
8470
  recentSentencesCount: 42,
8399
8471
  },
8472
+ disableAgentQueryLogging: true,
8400
8473
  enableEventBasedSuggestion: true,
8401
8474
  queryConfig: {
8402
8475
  confidenceThreshold: 42,
@@ -8471,6 +8544,7 @@ gapi.load('client', async () => {
8471
8544
  sttConfig: {
8472
8545
  model: "Test string",
8473
8546
  speechModelVariant: "Test string",
8547
+ useTimeoutBasedEndpointing: true,
8474
8548
  },
8475
8549
  timeZone: "Test string",
8476
8550
  ttsConfig: {
@@ -8519,5 +8593,19 @@ gapi.load('client', async () => {
8519
8593
  ],
8520
8594
  },
8521
8595
  });
8596
+ /** Get answers for the given query based on knowledge documents. */
8597
+ await gapi.client.dialogflow.projects.suggestions.searchKnowledge({
8598
+ parent: "Test string",
8599
+ }, {
8600
+ conversation: "Test string",
8601
+ conversationProfile: "Test string",
8602
+ latestMessage: "Test string",
8603
+ parent: "Test string",
8604
+ query: {
8605
+ languageCode: "Test string",
8606
+ text: "Test string",
8607
+ },
8608
+ sessionId: "Test string",
8609
+ });
8522
8610
  }
8523
8611
  });