@maxim_mazurok/gapi.client.dialogflow-v2 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.
- package/index.d.ts +555 -2
- package/package.json +1 -1
- 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:
|
|
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: "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
|
|
@@ -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;
|
|
@@ -2335,10 +2449,21 @@ declare namespace gapi.client {
|
|
|
2335
2449
|
*/
|
|
2336
2450
|
documentEfficiency?:
|
|
2337
2451
|
string;
|
|
2452
|
+
/** Optional. Feedback for knowledge search. */
|
|
2453
|
+
knowledgeSearchFeedback?:
|
|
2454
|
+
GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback;
|
|
2338
2455
|
/** Optional. Feedback for conversation summarization. */
|
|
2339
2456
|
summarizationFeedback?:
|
|
2340
2457
|
GoogleCloudDialogflowV2AgentAssistantFeedbackSummarizationFeedback;
|
|
2341
2458
|
}
|
|
2459
|
+
interface GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback {
|
|
2460
|
+
/** 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. */
|
|
2461
|
+
answerCopied?:
|
|
2462
|
+
boolean;
|
|
2463
|
+
/** 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. */
|
|
2464
|
+
clickedUris?:
|
|
2465
|
+
string[];
|
|
2466
|
+
}
|
|
2342
2467
|
interface GoogleCloudDialogflowV2AgentAssistantFeedbackSummarizationFeedback {
|
|
2343
2468
|
/** Timestamp when composing of the summary starts. */
|
|
2344
2469
|
startTime?:
|
|
@@ -2354,6 +2479,9 @@ declare namespace gapi.client {
|
|
|
2354
2479
|
/** Output only. The article suggestion answer. */
|
|
2355
2480
|
articleSuggestionAnswer?:
|
|
2356
2481
|
GoogleCloudDialogflowV2ArticleAnswer;
|
|
2482
|
+
/** Output only. Dialogflow assist answer. */
|
|
2483
|
+
dialogflowAssistAnswer?:
|
|
2484
|
+
GoogleCloudDialogflowV2DialogflowAssistAnswer;
|
|
2357
2485
|
/** Output only. The FAQ answer. */
|
|
2358
2486
|
faqAnswer?:
|
|
2359
2487
|
GoogleCloudDialogflowV2FaqAnswer;
|
|
@@ -2383,6 +2511,9 @@ declare namespace gapi.client {
|
|
|
2383
2511
|
/** 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
2512
|
requestId?:
|
|
2385
2513
|
string;
|
|
2514
|
+
/** An input representing the selection of a suggestion. */
|
|
2515
|
+
suggestionInput?:
|
|
2516
|
+
GoogleCloudDialogflowV2SuggestionInput;
|
|
2386
2517
|
/** The natural language text to be processed. */
|
|
2387
2518
|
textInput?:
|
|
2388
2519
|
GoogleCloudDialogflowV2TextInput;
|
|
@@ -4246,6 +4377,17 @@ declare namespace gapi.client {
|
|
|
4246
4377
|
webhookStatus?:
|
|
4247
4378
|
GoogleRpcStatus;
|
|
4248
4379
|
}
|
|
4380
|
+
interface GoogleCloudDialogflowV2DialogflowAssistAnswer {
|
|
4381
|
+
/** The name of answer record, in the format of "projects//locations//answerRecords/" */
|
|
4382
|
+
answerRecord?:
|
|
4383
|
+
string;
|
|
4384
|
+
/** An intent suggestion generated from conversation. */
|
|
4385
|
+
intentSuggestion?:
|
|
4386
|
+
GoogleCloudDialogflowV2IntentSuggestion;
|
|
4387
|
+
/** Result from v2 agent. */
|
|
4388
|
+
queryResult?:
|
|
4389
|
+
GoogleCloudDialogflowV2QueryResult;
|
|
4390
|
+
}
|
|
4249
4391
|
interface GoogleCloudDialogflowV2Document {
|
|
4250
4392
|
/**
|
|
4251
4393
|
* 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 +4818,10 @@ declare namespace gapi.client {
|
|
|
4676
4818
|
/** Configs for processing conversation. */
|
|
4677
4819
|
conversationProcessConfig?:
|
|
4678
4820
|
GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig;
|
|
4679
|
-
/**
|
|
4821
|
+
/** 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. */
|
|
4822
|
+
disableAgentQueryLogging?:
|
|
4823
|
+
boolean;
|
|
4824
|
+
/** Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. */
|
|
4680
4825
|
enableEventBasedSuggestion?:
|
|
4681
4826
|
boolean;
|
|
4682
4827
|
/** Configs of query. */
|
|
@@ -4733,6 +4878,14 @@ declare namespace gapi.client {
|
|
|
4733
4878
|
*/
|
|
4734
4879
|
agent?:
|
|
4735
4880
|
string;
|
|
4881
|
+
/** Optional. The Dialogflow assist configuration for human agent. */
|
|
4882
|
+
humanAgentSideConfig?:
|
|
4883
|
+
GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig;
|
|
4884
|
+
}
|
|
4885
|
+
interface GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig {
|
|
4886
|
+
/** Optional. The name of a dialogflow virtual agent used for intent detection and suggestion triggered by human agent. Format: `projects//locations//agent`. */
|
|
4887
|
+
agent?:
|
|
4888
|
+
string;
|
|
4736
4889
|
}
|
|
4737
4890
|
interface GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource {
|
|
4738
4891
|
/** Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, at most 5 documents are supported. */
|
|
@@ -5367,6 +5520,17 @@ declare namespace gapi.client {
|
|
|
5367
5520
|
value?:
|
|
5368
5521
|
string;
|
|
5369
5522
|
}
|
|
5523
|
+
interface GoogleCloudDialogflowV2IntentSuggestion {
|
|
5524
|
+
/** Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. */
|
|
5525
|
+
description?:
|
|
5526
|
+
string;
|
|
5527
|
+
/** The display name of the intent. */
|
|
5528
|
+
displayName?:
|
|
5529
|
+
string;
|
|
5530
|
+
/** The unique identifier of this intent. Format: `projects//locations//agent/intents/`. */
|
|
5531
|
+
intentV2?:
|
|
5532
|
+
string;
|
|
5533
|
+
}
|
|
5370
5534
|
interface GoogleCloudDialogflowV2IntentTrainingPhrase {
|
|
5371
5535
|
/** Output only. The unique identifier of this training phrase. */
|
|
5372
5536
|
name?:
|
|
@@ -5852,6 +6016,60 @@ declare namespace gapi.client {
|
|
|
5852
6016
|
nextPageToken?:
|
|
5853
6017
|
string;
|
|
5854
6018
|
}
|
|
6019
|
+
interface GoogleCloudDialogflowV2SearchKnowledgeAnswer {
|
|
6020
|
+
/** The piece of text from the knowledge base documents that answers the search query */
|
|
6021
|
+
answer?:
|
|
6022
|
+
string;
|
|
6023
|
+
/** The name of the answer record. Format: `projects//locations//answer Records/` */
|
|
6024
|
+
answerRecord?:
|
|
6025
|
+
string;
|
|
6026
|
+
/** All sources used to generate the answer. */
|
|
6027
|
+
answerSources?:
|
|
6028
|
+
GoogleCloudDialogflowV2SearchKnowledgeAnswerAnswerSource[];
|
|
6029
|
+
/** The type of the answer. */
|
|
6030
|
+
answerType?:
|
|
6031
|
+
string;
|
|
6032
|
+
}
|
|
6033
|
+
interface GoogleCloudDialogflowV2SearchKnowledgeAnswerAnswerSource {
|
|
6034
|
+
/** The relevant snippet of the article. */
|
|
6035
|
+
snippet?:
|
|
6036
|
+
string;
|
|
6037
|
+
/** The title of the article. */
|
|
6038
|
+
title?:
|
|
6039
|
+
string;
|
|
6040
|
+
/** The URI of the article. */
|
|
6041
|
+
uri?:
|
|
6042
|
+
string;
|
|
6043
|
+
}
|
|
6044
|
+
interface GoogleCloudDialogflowV2SearchKnowledgeRequest {
|
|
6045
|
+
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
6046
|
+
conversation?:
|
|
6047
|
+
string;
|
|
6048
|
+
/** Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. */
|
|
6049
|
+
conversationProfile?:
|
|
6050
|
+
string;
|
|
6051
|
+
/** The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. */
|
|
6052
|
+
latestMessage?:
|
|
6053
|
+
string;
|
|
6054
|
+
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
6055
|
+
parent?:
|
|
6056
|
+
string;
|
|
6057
|
+
/** Required. The natural language text query for knowledge search. */
|
|
6058
|
+
query?:
|
|
6059
|
+
GoogleCloudDialogflowV2TextInput;
|
|
6060
|
+
/**
|
|
6061
|
+
* 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
|
|
6062
|
+
* 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
|
|
6063
|
+
* identifiers (preferably hashed). The length must not exceed 36 characters.
|
|
6064
|
+
*/
|
|
6065
|
+
sessionId?:
|
|
6066
|
+
string;
|
|
6067
|
+
}
|
|
6068
|
+
interface GoogleCloudDialogflowV2SearchKnowledgeResponse {
|
|
6069
|
+
/** Most relevant snippets extracted from articles in the given knowledge base, ordered by confidence. */
|
|
6070
|
+
answers?:
|
|
6071
|
+
GoogleCloudDialogflowV2SearchKnowledgeAnswer[];
|
|
6072
|
+
}
|
|
5855
6073
|
interface GoogleCloudDialogflowV2Sentiment {
|
|
5856
6074
|
/** A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */
|
|
5857
6075
|
magnitude?:
|
|
@@ -5975,6 +6193,9 @@ declare namespace gapi.client {
|
|
|
5975
6193
|
*/
|
|
5976
6194
|
speechModelVariant?:
|
|
5977
6195
|
string;
|
|
6196
|
+
/** Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. */
|
|
6197
|
+
useTimeoutBasedEndpointing?:
|
|
6198
|
+
boolean;
|
|
5978
6199
|
}
|
|
5979
6200
|
interface GoogleCloudDialogflowV2SuggestArticlesRequest {
|
|
5980
6201
|
/** Parameters for a human assist query. */
|
|
@@ -6079,6 +6300,14 @@ declare namespace gapi.client {
|
|
|
6079
6300
|
type?:
|
|
6080
6301
|
string;
|
|
6081
6302
|
}
|
|
6303
|
+
interface GoogleCloudDialogflowV2SuggestionInput {
|
|
6304
|
+
/**
|
|
6305
|
+
* 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:
|
|
6306
|
+
* `projects//locations//answerRecords/` where is an alphanumeric string.
|
|
6307
|
+
*/
|
|
6308
|
+
answerRecord?:
|
|
6309
|
+
string;
|
|
6310
|
+
}
|
|
6082
6311
|
interface GoogleCloudDialogflowV2SuggestionResult {
|
|
6083
6312
|
/** Error status if the request failed. */
|
|
6084
6313
|
error?:
|
|
@@ -13297,6 +13526,87 @@ declare namespace gapi.client {
|
|
|
13297
13526
|
SuggestionsResource;
|
|
13298
13527
|
}
|
|
13299
13528
|
interface SuggestionsResource {
|
|
13529
|
+
/** Get answers for the given query based on knowledge documents. */
|
|
13530
|
+
searchKnowledge(request: {
|
|
13531
|
+
/** V1 error format. */
|
|
13532
|
+
"$.xgafv"?:
|
|
13533
|
+
string;
|
|
13534
|
+
/** OAuth access token. */
|
|
13535
|
+
access_token?:
|
|
13536
|
+
string;
|
|
13537
|
+
/** Data format for response. */
|
|
13538
|
+
alt?:
|
|
13539
|
+
string;
|
|
13540
|
+
/** JSONP */
|
|
13541
|
+
callback?:
|
|
13542
|
+
string;
|
|
13543
|
+
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
13544
|
+
conversation:
|
|
13545
|
+
string;
|
|
13546
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13547
|
+
fields?:
|
|
13548
|
+
string;
|
|
13549
|
+
/** 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. */
|
|
13550
|
+
key?:
|
|
13551
|
+
string;
|
|
13552
|
+
/** OAuth 2.0 token for the current user. */
|
|
13553
|
+
oauth_token?:
|
|
13554
|
+
string;
|
|
13555
|
+
/** Returns response with indentations and line breaks. */
|
|
13556
|
+
prettyPrint?:
|
|
13557
|
+
boolean;
|
|
13558
|
+
/** 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. */
|
|
13559
|
+
quotaUser?:
|
|
13560
|
+
string;
|
|
13561
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13562
|
+
upload_protocol?:
|
|
13563
|
+
string;
|
|
13564
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13565
|
+
uploadType?:
|
|
13566
|
+
string;
|
|
13567
|
+
/** Request body */
|
|
13568
|
+
resource:
|
|
13569
|
+
GoogleCloudDialogflowV2SearchKnowledgeRequest;
|
|
13570
|
+
}): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
|
|
13571
|
+
searchKnowledge(request: {
|
|
13572
|
+
/** V1 error format. */
|
|
13573
|
+
"$.xgafv"?:
|
|
13574
|
+
string;
|
|
13575
|
+
/** OAuth access token. */
|
|
13576
|
+
access_token?:
|
|
13577
|
+
string;
|
|
13578
|
+
/** Data format for response. */
|
|
13579
|
+
alt?:
|
|
13580
|
+
string;
|
|
13581
|
+
/** JSONP */
|
|
13582
|
+
callback?:
|
|
13583
|
+
string;
|
|
13584
|
+
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
13585
|
+
conversation:
|
|
13586
|
+
string;
|
|
13587
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13588
|
+
fields?:
|
|
13589
|
+
string;
|
|
13590
|
+
/** 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. */
|
|
13591
|
+
key?:
|
|
13592
|
+
string;
|
|
13593
|
+
/** OAuth 2.0 token for the current user. */
|
|
13594
|
+
oauth_token?:
|
|
13595
|
+
string;
|
|
13596
|
+
/** Returns response with indentations and line breaks. */
|
|
13597
|
+
prettyPrint?:
|
|
13598
|
+
boolean;
|
|
13599
|
+
/** 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. */
|
|
13600
|
+
quotaUser?:
|
|
13601
|
+
string;
|
|
13602
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13603
|
+
upload_protocol?:
|
|
13604
|
+
string;
|
|
13605
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13606
|
+
uploadType?:
|
|
13607
|
+
string;
|
|
13608
|
+
},
|
|
13609
|
+
body: GoogleCloudDialogflowV2SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
|
|
13300
13610
|
/** 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
13611
|
suggestConversationSummary(request: {
|
|
13302
13612
|
/** V1 error format. */
|
|
@@ -20869,6 +21179,87 @@ declare namespace gapi.client {
|
|
|
20869
21179
|
SuggestionsResource;
|
|
20870
21180
|
}
|
|
20871
21181
|
interface SuggestionsResource {
|
|
21182
|
+
/** Get answers for the given query based on knowledge documents. */
|
|
21183
|
+
searchKnowledge(request: {
|
|
21184
|
+
/** V1 error format. */
|
|
21185
|
+
"$.xgafv"?:
|
|
21186
|
+
string;
|
|
21187
|
+
/** OAuth access token. */
|
|
21188
|
+
access_token?:
|
|
21189
|
+
string;
|
|
21190
|
+
/** Data format for response. */
|
|
21191
|
+
alt?:
|
|
21192
|
+
string;
|
|
21193
|
+
/** JSONP */
|
|
21194
|
+
callback?:
|
|
21195
|
+
string;
|
|
21196
|
+
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
21197
|
+
conversation:
|
|
21198
|
+
string;
|
|
21199
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
21200
|
+
fields?:
|
|
21201
|
+
string;
|
|
21202
|
+
/** 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. */
|
|
21203
|
+
key?:
|
|
21204
|
+
string;
|
|
21205
|
+
/** OAuth 2.0 token for the current user. */
|
|
21206
|
+
oauth_token?:
|
|
21207
|
+
string;
|
|
21208
|
+
/** Returns response with indentations and line breaks. */
|
|
21209
|
+
prettyPrint?:
|
|
21210
|
+
boolean;
|
|
21211
|
+
/** 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. */
|
|
21212
|
+
quotaUser?:
|
|
21213
|
+
string;
|
|
21214
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
21215
|
+
upload_protocol?:
|
|
21216
|
+
string;
|
|
21217
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
21218
|
+
uploadType?:
|
|
21219
|
+
string;
|
|
21220
|
+
/** Request body */
|
|
21221
|
+
resource:
|
|
21222
|
+
GoogleCloudDialogflowV2SearchKnowledgeRequest;
|
|
21223
|
+
}): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
|
|
21224
|
+
searchKnowledge(request: {
|
|
21225
|
+
/** V1 error format. */
|
|
21226
|
+
"$.xgafv"?:
|
|
21227
|
+
string;
|
|
21228
|
+
/** OAuth access token. */
|
|
21229
|
+
access_token?:
|
|
21230
|
+
string;
|
|
21231
|
+
/** Data format for response. */
|
|
21232
|
+
alt?:
|
|
21233
|
+
string;
|
|
21234
|
+
/** JSONP */
|
|
21235
|
+
callback?:
|
|
21236
|
+
string;
|
|
21237
|
+
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
21238
|
+
conversation:
|
|
21239
|
+
string;
|
|
21240
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
21241
|
+
fields?:
|
|
21242
|
+
string;
|
|
21243
|
+
/** 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. */
|
|
21244
|
+
key?:
|
|
21245
|
+
string;
|
|
21246
|
+
/** OAuth 2.0 token for the current user. */
|
|
21247
|
+
oauth_token?:
|
|
21248
|
+
string;
|
|
21249
|
+
/** Returns response with indentations and line breaks. */
|
|
21250
|
+
prettyPrint?:
|
|
21251
|
+
boolean;
|
|
21252
|
+
/** 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. */
|
|
21253
|
+
quotaUser?:
|
|
21254
|
+
string;
|
|
21255
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
21256
|
+
upload_protocol?:
|
|
21257
|
+
string;
|
|
21258
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
21259
|
+
uploadType?:
|
|
21260
|
+
string;
|
|
21261
|
+
},
|
|
21262
|
+
body: GoogleCloudDialogflowV2SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
|
|
20872
21263
|
/** 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
21264
|
suggestConversationSummary(request: {
|
|
20874
21265
|
/** V1 error format. */
|
|
@@ -22323,6 +22714,87 @@ declare namespace gapi.client {
|
|
|
22323
22714
|
string;
|
|
22324
22715
|
},
|
|
22325
22716
|
body: GoogleCloudDialogflowV2GenerateStatelessSummaryRequest): Request<GoogleCloudDialogflowV2GenerateStatelessSummaryResponse>;
|
|
22717
|
+
/** Get answers for the given query based on knowledge documents. */
|
|
22718
|
+
searchKnowledge(request: {
|
|
22719
|
+
/** V1 error format. */
|
|
22720
|
+
"$.xgafv"?:
|
|
22721
|
+
string;
|
|
22722
|
+
/** OAuth access token. */
|
|
22723
|
+
access_token?:
|
|
22724
|
+
string;
|
|
22725
|
+
/** Data format for response. */
|
|
22726
|
+
alt?:
|
|
22727
|
+
string;
|
|
22728
|
+
/** JSONP */
|
|
22729
|
+
callback?:
|
|
22730
|
+
string;
|
|
22731
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
22732
|
+
fields?:
|
|
22733
|
+
string;
|
|
22734
|
+
/** 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. */
|
|
22735
|
+
key?:
|
|
22736
|
+
string;
|
|
22737
|
+
/** OAuth 2.0 token for the current user. */
|
|
22738
|
+
oauth_token?:
|
|
22739
|
+
string;
|
|
22740
|
+
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
22741
|
+
parent:
|
|
22742
|
+
string;
|
|
22743
|
+
/** Returns response with indentations and line breaks. */
|
|
22744
|
+
prettyPrint?:
|
|
22745
|
+
boolean;
|
|
22746
|
+
/** 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. */
|
|
22747
|
+
quotaUser?:
|
|
22748
|
+
string;
|
|
22749
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
22750
|
+
upload_protocol?:
|
|
22751
|
+
string;
|
|
22752
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
22753
|
+
uploadType?:
|
|
22754
|
+
string;
|
|
22755
|
+
/** Request body */
|
|
22756
|
+
resource:
|
|
22757
|
+
GoogleCloudDialogflowV2SearchKnowledgeRequest;
|
|
22758
|
+
}): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
|
|
22759
|
+
searchKnowledge(request: {
|
|
22760
|
+
/** V1 error format. */
|
|
22761
|
+
"$.xgafv"?:
|
|
22762
|
+
string;
|
|
22763
|
+
/** OAuth access token. */
|
|
22764
|
+
access_token?:
|
|
22765
|
+
string;
|
|
22766
|
+
/** Data format for response. */
|
|
22767
|
+
alt?:
|
|
22768
|
+
string;
|
|
22769
|
+
/** JSONP */
|
|
22770
|
+
callback?:
|
|
22771
|
+
string;
|
|
22772
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
22773
|
+
fields?:
|
|
22774
|
+
string;
|
|
22775
|
+
/** 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. */
|
|
22776
|
+
key?:
|
|
22777
|
+
string;
|
|
22778
|
+
/** OAuth 2.0 token for the current user. */
|
|
22779
|
+
oauth_token?:
|
|
22780
|
+
string;
|
|
22781
|
+
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
22782
|
+
parent:
|
|
22783
|
+
string;
|
|
22784
|
+
/** Returns response with indentations and line breaks. */
|
|
22785
|
+
prettyPrint?:
|
|
22786
|
+
boolean;
|
|
22787
|
+
/** 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. */
|
|
22788
|
+
quotaUser?:
|
|
22789
|
+
string;
|
|
22790
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
22791
|
+
upload_protocol?:
|
|
22792
|
+
string;
|
|
22793
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
22794
|
+
uploadType?:
|
|
22795
|
+
string;
|
|
22796
|
+
},
|
|
22797
|
+
body: GoogleCloudDialogflowV2SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
|
|
22326
22798
|
}
|
|
22327
22799
|
interface LocationsResource {
|
|
22328
22800
|
/** Deletes the specified agent. */
|
|
@@ -22817,6 +23289,87 @@ declare namespace gapi.client {
|
|
|
22817
23289
|
string;
|
|
22818
23290
|
},
|
|
22819
23291
|
body: GoogleCloudDialogflowV2GenerateStatelessSummaryRequest): Request<GoogleCloudDialogflowV2GenerateStatelessSummaryResponse>;
|
|
23292
|
+
/** Get answers for the given query based on knowledge documents. */
|
|
23293
|
+
searchKnowledge(request: {
|
|
23294
|
+
/** V1 error format. */
|
|
23295
|
+
"$.xgafv"?:
|
|
23296
|
+
string;
|
|
23297
|
+
/** OAuth access token. */
|
|
23298
|
+
access_token?:
|
|
23299
|
+
string;
|
|
23300
|
+
/** Data format for response. */
|
|
23301
|
+
alt?:
|
|
23302
|
+
string;
|
|
23303
|
+
/** JSONP */
|
|
23304
|
+
callback?:
|
|
23305
|
+
string;
|
|
23306
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
23307
|
+
fields?:
|
|
23308
|
+
string;
|
|
23309
|
+
/** 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. */
|
|
23310
|
+
key?:
|
|
23311
|
+
string;
|
|
23312
|
+
/** OAuth 2.0 token for the current user. */
|
|
23313
|
+
oauth_token?:
|
|
23314
|
+
string;
|
|
23315
|
+
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
23316
|
+
parent:
|
|
23317
|
+
string;
|
|
23318
|
+
/** Returns response with indentations and line breaks. */
|
|
23319
|
+
prettyPrint?:
|
|
23320
|
+
boolean;
|
|
23321
|
+
/** 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. */
|
|
23322
|
+
quotaUser?:
|
|
23323
|
+
string;
|
|
23324
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
23325
|
+
upload_protocol?:
|
|
23326
|
+
string;
|
|
23327
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
23328
|
+
uploadType?:
|
|
23329
|
+
string;
|
|
23330
|
+
/** Request body */
|
|
23331
|
+
resource:
|
|
23332
|
+
GoogleCloudDialogflowV2SearchKnowledgeRequest;
|
|
23333
|
+
}): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
|
|
23334
|
+
searchKnowledge(request: {
|
|
23335
|
+
/** V1 error format. */
|
|
23336
|
+
"$.xgafv"?:
|
|
23337
|
+
string;
|
|
23338
|
+
/** OAuth access token. */
|
|
23339
|
+
access_token?:
|
|
23340
|
+
string;
|
|
23341
|
+
/** Data format for response. */
|
|
23342
|
+
alt?:
|
|
23343
|
+
string;
|
|
23344
|
+
/** JSONP */
|
|
23345
|
+
callback?:
|
|
23346
|
+
string;
|
|
23347
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
23348
|
+
fields?:
|
|
23349
|
+
string;
|
|
23350
|
+
/** 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. */
|
|
23351
|
+
key?:
|
|
23352
|
+
string;
|
|
23353
|
+
/** OAuth 2.0 token for the current user. */
|
|
23354
|
+
oauth_token?:
|
|
23355
|
+
string;
|
|
23356
|
+
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
23357
|
+
parent:
|
|
23358
|
+
string;
|
|
23359
|
+
/** Returns response with indentations and line breaks. */
|
|
23360
|
+
prettyPrint?:
|
|
23361
|
+
boolean;
|
|
23362
|
+
/** 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. */
|
|
23363
|
+
quotaUser?:
|
|
23364
|
+
string;
|
|
23365
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
23366
|
+
upload_protocol?:
|
|
23367
|
+
string;
|
|
23368
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
23369
|
+
uploadType?:
|
|
23370
|
+
string;
|
|
23371
|
+
},
|
|
23372
|
+
body: GoogleCloudDialogflowV2SearchKnowledgeRequest): Request<GoogleCloudDialogflowV2SearchKnowledgeResponse>;
|
|
22820
23373
|
}
|
|
22821
23374
|
interface ProjectsResource {
|
|
22822
23375
|
/** Deletes the specified agent. */
|