v2beta1.d.ts
283 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace dialogflow_v2beta1 {
export interface Options extends GlobalOptions {
version: 'v2beta1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Dialogflow API
*
* Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).
*
* @example
* const {google} = require('googleapis');
* const dialogflow = google.dialogflow('v2beta1');
*
* @namespace dialogflow
* @type {Function}
* @version v2beta1
* @variation v2beta1
* @param {object=} options Options for Dialogflow
*/
export class Dialogflow {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* The response message for EntityTypes.BatchUpdateEntityTypes.
*/
export interface Schema$GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse {
/**
* The collection of updated or created entity types.
*/
entityTypes?: Schema$GoogleCloudDialogflowV2EntityType[];
}
/**
* The response message for Intents.BatchUpdateIntents.
*/
export interface Schema$GoogleCloudDialogflowV2BatchUpdateIntentsResponse {
/**
* The collection of updated or created intents.
*/
intents?: Schema$GoogleCloudDialogflowV2Intent[];
}
/**
* Represents a conversational agent.
*/
export interface Schema$GoogleCloudDialogflowV2beta1Agent {
/**
* Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo) integration.
*/
avatarUri?: string;
/**
* Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
*/
classificationThreshold?: number;
/**
* Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
*/
defaultLanguageCode?: string;
/**
* Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
*/
description?: string;
/**
* Required. The name of this agent.
*/
displayName?: string;
/**
* Optional. Determines whether this agent should log conversation queries.
*/
enableLogging?: boolean;
/**
* Optional. Determines how intents are detected from user queries.
*/
matchMode?: string;
/**
* Required. The project of this agent. Format: `projects/<Project ID>`.
*/
parent?: string;
/**
* Optional. The list of all languages supported by this agent (except for the `default_language_code`).
*/
supportedLanguageCodes?: string[];
/**
* Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
*/
timeZone?: string;
}
/**
* The request message for EntityTypes.BatchCreateEntities.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest {
/**
* Required. The entities to create.
*/
entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[];
/**
* Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
}
/**
* The request message for EntityTypes.BatchDeleteEntities.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest {
/**
* Required. The canonical `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/<Project ID>`.
*/
entityValues?: string[];
/**
* Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
}
/**
* The request message for EntityTypes.BatchDeleteEntityTypes.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest {
/**
* Required. The names entity types to delete. All names must point to the same agent as `parent`.
*/
entityTypeNames?: string[];
}
/**
* The request message for Intents.BatchDeleteIntents.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest {
/**
* Required. The collection of intents to delete. Only intent `name` must be filled in.
*/
intents?: Schema$GoogleCloudDialogflowV2beta1Intent[];
}
/**
* The request message for EntityTypes.BatchUpdateEntities.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest {
/**
* Required. The entities to update or create.
*/
entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[];
/**
* Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
}
/**
* The request message for EntityTypes.BatchUpdateEntityTypes.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest {
/**
* The collection of entity types to update or create.
*/
entityTypeBatchInline?: Schema$GoogleCloudDialogflowV2beta1EntityTypeBatch;
/**
* The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://".
*/
entityTypeBatchUri?: string;
/**
* Optional. The language of entity synonyms defined in `entity_types`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
}
/**
* The response message for EntityTypes.BatchUpdateEntityTypes.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse {
/**
* The collection of updated or created entity types.
*/
entityTypes?: Schema$GoogleCloudDialogflowV2beta1EntityType[];
}
/**
* The request message for Intents.BatchUpdateIntents.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest {
/**
* The collection of intents to update or create.
*/
intentBatchInline?: Schema$GoogleCloudDialogflowV2beta1IntentBatch;
/**
* The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".
*/
intentBatchUri?: string;
/**
* Optional. The resource view to apply to the returned intent.
*/
intentView?: string;
/**
* Optional. The language of training phrases, parameters and rich messages defined in `intents`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
}
/**
* The response message for Intents.BatchUpdateIntents.
*/
export interface Schema$GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse {
/**
* The collection of updated or created intents.
*/
intents?: Schema$GoogleCloudDialogflowV2beta1Intent[];
}
/**
* Represents a context.
*/
export interface Schema$GoogleCloudDialogflowV2beta1Context {
/**
* Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.
*/
lifespanCount?: number;
/**
* Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
/**
* Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) for syntax.
*/
parameters?: {
[key: string]: any;
};
}
/**
* The request to detect user's intent.
*/
export interface Schema$GoogleCloudDialogflowV2beta1DetectIntentRequest {
/**
* Optional. The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data.
*/
inputAudio?: string;
/**
* Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.
*/
outputAudioConfig?: Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig;
/**
* Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger.
*/
queryInput?: Schema$GoogleCloudDialogflowV2beta1QueryInput;
/**
* Optional. The parameters of this query.
*/
queryParams?: Schema$GoogleCloudDialogflowV2beta1QueryParameters;
}
/**
* The message returned from the DetectIntent method.
*/
export interface Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse {
/**
* If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing `QueryResult.intent_detection_confidence`. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.
*/
alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[];
/**
* The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.fulfillment_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty.
*/
outputAudio?: string;
/**
* Instructs the speech synthesizer how to generate the output audio. This field is populated from the agent-level speech synthesizer configuration, if enabled.
*/
outputAudioConfig?: Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig;
/**
* The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results.
*/
queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult;
/**
* The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
*/
responseId?: string;
/**
* Specifies the status of the webhook request.
*/
webhookStatus?: Schema$GoogleRpcStatus;
}
/**
* A document resource. Note: resource `projects.agent.knowledgeBases.documents` is deprecated, please use `projects.knowledgeBases.documents` instead.
*/
export interface Schema$GoogleCloudDialogflowV2beta1Document {
/**
* The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.
*/
content?: string;
/**
* The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form `gs://<bucket-name>/<object-name>`. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the `gs://` format URI described above.
*/
contentUri?: string;
/**
* Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
*/
displayName?: string;
/**
* Required. The knowledge type of document content.
*/
knowledgeTypes?: string[];
/**
* Required. The MIME type of this document.
*/
mimeType?: string;
/**
* The document resource name. The name must be empty when creating a document. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
*/
name?: string;
/**
* The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
*/
rawContent?: string;
}
/**
* Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.
*/
export interface Schema$GoogleCloudDialogflowV2beta1EntityType {
/**
* Optional. Indicates whether the entity type can be automatically expanded.
*/
autoExpansionMode?: string;
/**
* Required. The name of the entity type.
*/
displayName?: string;
/**
* Optional. The collection of entity entries associated with the entity type.
*/
entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[];
/**
* Required. Indicates the kind of entity type.
*/
kind?: string;
/**
* The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
*/
name?: string;
}
/**
* This message is a wrapper around a collection of entity types.
*/
export interface Schema$GoogleCloudDialogflowV2beta1EntityTypeBatch {
/**
* A collection of entity types.
*/
entityTypes?: Schema$GoogleCloudDialogflowV2beta1EntityType[];
}
/**
* An **entity entry** for an associated entity type.
*/
export interface Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity {
/**
* Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.
*/
synonyms?: string[];
/**
* Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).
*/
value?: string;
}
/**
* Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`.
*/
export interface Schema$GoogleCloudDialogflowV2beta1EventInput {
/**
* Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
*/
languageCode?: string;
/**
* Required. The unique identifier of the event.
*/
name?: string;
/**
* Optional. The collection of parameters associated with the event.
*/
parameters?: {
[key: string]: any;
};
}
/**
* The request message for Agents.ExportAgent.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ExportAgentRequest {
/**
* Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized agent is returned inline.
*/
agentUri?: string;
}
/**
* The response message for Agents.ExportAgent.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ExportAgentResponse {
/**
* The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".x/\1/' \ | base64 --decode > &lt;agent zip file&gt;</pre>
*/
agentContent?: string;
/**
* The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.
*/
agentUri?: string;
}
/**
* The request message for Agents.ImportAgent.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ImportAgentRequest {
/**
* The agent to import. Example for how to import an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:import\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)' }"</pre>
*/
agentContent?: string;
/**
* The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://".
*/
agentUri?: string;
}
/**
* Instructs the speech recognizer on how to process the audio content.
*/
export interface Schema$GoogleCloudDialogflowV2beta1InputAudioConfig {
/**
* Required. Audio encoding of the audio content to process.
*/
audioEncoding?: string;
/**
* Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
*/
languageCode?: string;
/**
* Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details.
*/
model?: string;
/**
* Optional. Which variant of the Speech model to use.
*/
modelVariant?: string;
/**
* Optional. The collection of phrase hints which are used to boost accuracy of speech recognition. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
*/
phraseHints?: string[];
/**
* Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
*/
sampleRateHertz?: number;
}
/**
* Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics.
*/
export interface Schema$GoogleCloudDialogflowV2beta1Intent {
/**
* Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
*/
action?: string;
/**
* Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM.
*/
defaultResponsePlatforms?: string[];
/**
* Required. The name of this intent.
*/
displayName?: string;
/**
* Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
*/
endInteraction?: boolean;
/**
* Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent.
*/
events?: string[];
/**
* Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
*/
followupIntentInfo?: Schema$GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo[];
/**
* Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*/
inputContextNames?: string[];
/**
* Optional. Indicates whether this is a fallback intent.
*/
isFallback?: boolean;
/**
* Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.
*/
messages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[];
/**
* Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.
*/
mlDisabled?: boolean;
/**
* Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.
*/
mlEnabled?: boolean;
/**
* The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
name?: string;
/**
* Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*/
outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[];
/**
* Optional. The collection of parameters associated with the intent.
*/
parameters?: Schema$GoogleCloudDialogflowV2beta1IntentParameter[];
/**
* Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
parentFollowupIntentName?: string;
/**
* Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled.
*/
priority?: number;
/**
* Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
*/
resetContexts?: boolean;
/**
* Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
rootFollowupIntentName?: string;
/**
* Optional. The collection of examples that the agent is trained on.
*/
trainingPhrases?: Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrase[];
/**
* Optional. Indicates whether webhooks are enabled for the intent.
*/
webhookState?: string;
}
/**
* This message is a wrapper around a collection of intents.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentBatch {
/**
* A collection of intents.
*/
intents?: Schema$GoogleCloudDialogflowV2beta1Intent[];
}
/**
* Represents a single followup intent in the chain.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo {
/**
* The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
followupIntentName?: string;
/**
* The unique identifier of the followup intent's parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
parentFollowupIntentName?: string;
}
/**
* Corresponds to the `Response` field in the Dialogflow console.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessage {
/**
* Displays a basic card for Actions on Google.
*/
basicCard?: Schema$GoogleCloudDialogflowV2beta1IntentMessageBasicCard;
/**
* Displays a card.
*/
card?: Schema$GoogleCloudDialogflowV2beta1IntentMessageCard;
/**
* Displays a carousel card for Actions on Google.
*/
carouselSelect?: Schema$GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect;
/**
* Displays an image.
*/
image?: Schema$GoogleCloudDialogflowV2beta1IntentMessageImage;
/**
* Displays a link out suggestion chip for Actions on Google.
*/
linkOutSuggestion?: Schema$GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion;
/**
* Displays a list card for Actions on Google.
*/
listSelect?: Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelect;
/**
* Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform.
*/
payload?: {
[key: string]: any;
};
/**
* Optional. The platform that this message is intended for.
*/
platform?: string;
/**
* Displays quick replies.
*/
quickReplies?: Schema$GoogleCloudDialogflowV2beta1IntentMessageQuickReplies;
/**
* Returns a voice or text-only response for Actions on Google.
*/
simpleResponses?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses;
/**
* Displays suggestion chips for Actions on Google.
*/
suggestions?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSuggestions;
/**
* Plays audio from a file in Telephony Gateway.
*/
telephonyPlayAudio?: Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio;
/**
* Synthesizes speech in Telephony Gateway.
*/
telephonySynthesizeSpeech?: Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech;
/**
* Transfers the call in Telephony Gateway.
*/
telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall;
/**
* Returns a text response.
*/
text?: Schema$GoogleCloudDialogflowV2beta1IntentMessageText;
}
/**
* The basic card message. Useful for displaying information.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageBasicCard {
/**
* Optional. The collection of card buttons.
*/
buttons?: Schema$GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton[];
/**
* Required, unless image is present. The body text of the card.
*/
formattedText?: string;
/**
* Optional. The image for the card.
*/
image?: Schema$GoogleCloudDialogflowV2beta1IntentMessageImage;
/**
* Optional. The subtitle of the card.
*/
subtitle?: string;
/**
* Optional. The title of the card.
*/
title?: string;
}
/**
* The button object that appears at the bottom of a card.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton {
/**
* Required. Action to take when a user taps on the button.
*/
openUriAction?: Schema$GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction;
/**
* Required. The title of the button.
*/
title?: string;
}
/**
* Opens the given URI.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction {
/**
* Required. The HTTP or HTTPS scheme URI.
*/
uri?: string;
}
/**
* The card response message.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageCard {
/**
* Optional. The collection of card buttons.
*/
buttons?: Schema$GoogleCloudDialogflowV2beta1IntentMessageCardButton[];
/**
* Optional. The public URI to an image file for the card.
*/
imageUri?: string;
/**
* Optional. The subtitle of the card.
*/
subtitle?: string;
/**
* Optional. The title of the card.
*/
title?: string;
}
/**
* Optional. Contains information about a button.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageCardButton {
/**
* Optional. The text to send back to the Dialogflow API or a URI to open.
*/
postback?: string;
/**
* Optional. The text to show on the button.
*/
text?: string;
}
/**
* The card for presenting a carousel of options to select from.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect {
/**
* Required. Carousel items.
*/
items?: Schema$GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem[];
}
/**
* An item in the carousel.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem {
/**
* Optional. The body text of the card.
*/
description?: string;
/**
* Optional. The image to display.
*/
image?: Schema$GoogleCloudDialogflowV2beta1IntentMessageImage;
/**
* Required. Additional info about the option item.
*/
info?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo;
/**
* Required. Title of the carousel item.
*/
title?: string;
}
/**
* The image response message.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageImage {
/**
* A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.
*/
accessibilityText?: string;
/**
* Optional. The public URI to an image file.
*/
imageUri?: string;
}
/**
* The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion {
/**
* Required. The name of the app or site this chip is linking to.
*/
destinationName?: string;
/**
* Required. The URI of the app or site to open when the user taps the suggestion chip.
*/
uri?: string;
}
/**
* The card for presenting a list of options to select from.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelect {
/**
* Required. List items.
*/
items?: Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelectItem[];
/**
* Optional. The overall title of the list.
*/
title?: string;
}
/**
* An item in the list.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelectItem {
/**
* Optional. The main text describing the item.
*/
description?: string;
/**
* Optional. The image to display.
*/
image?: Schema$GoogleCloudDialogflowV2beta1IntentMessageImage;
/**
* Required. Additional information about this option.
*/
info?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo;
/**
* Required. The title of the list item.
*/
title?: string;
}
/**
* The quick replies response message.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageQuickReplies {
/**
* Optional. The collection of quick replies.
*/
quickReplies?: string[];
/**
* Optional. The title of the collection of quick replies.
*/
title?: string;
}
/**
* Additional info about the select item for when it is triggered in a dialog.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo {
/**
* Required. A unique key that will be sent back to the agent if this response is given.
*/
key?: string;
/**
* Optional. A list of synonyms that can also be used to trigger this item in dialog.
*/
synonyms?: string[];
}
/**
* The simple response message containing speech or text.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse {
/**
* Optional. The text to display.
*/
displayText?: string;
/**
* One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.
*/
ssml?: string;
/**
* One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.
*/
textToSpeech?: string;
}
/**
* The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses {
/**
* Required. The list of simple responses.
*/
simpleResponses?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse[];
}
/**
* The suggestion chip message that the user can tap to quickly post a reply to the conversation.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSuggestion {
/**
* Required. The text shown the in the suggestion chip.
*/
title?: string;
}
/**
* The collection of suggestions.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSuggestions {
/**
* Required. The list of suggested replies.
*/
suggestions?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSuggestion[];
}
/**
* Plays audio from a file in Telephony Gateway.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio {
/**
* Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-<Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where <Project Number> is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.
*/
audioUri?: string;
}
/**
* Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech {
/**
* The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).
*/
ssml?: string;
/**
* The raw text to be synthesized.
*/
text?: string;
}
/**
* Transfers the call in Telephony Gateway.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall {
/**
* Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).
*/
phoneNumber?: string;
}
/**
* The text response message.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageText {
/**
* Optional. The collection of the agent's responses.
*/
text?: string[];
}
/**
* Represents intent parameters.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentParameter {
/**
* Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.
*/
defaultValue?: string;
/**
* Required. The name of the parameter.
*/
displayName?: string;
/**
* Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.
*/
entityTypeDisplayName?: string;
/**
* Optional. Indicates whether the parameter represents a list of values.
*/
isList?: boolean;
/**
* Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
*/
mandatory?: boolean;
/**
* The unique identifier of this parameter.
*/
name?: string;
/**
* Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter.
*/
prompts?: string[];
/**
* Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.
*/
value?: string;
}
/**
* Represents an example that the agent is trained on.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrase {
/**
* Output only. The unique identifier of this training phrase.
*/
name?: string;
/**
* Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.
*/
parts?: Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart[];
/**
* Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.
*/
timesAddedCount?: number;
/**
* Required. The type of the training phrase.
*/
type?: string;
}
/**
* Represents a part of a training phrase.
*/
export interface Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart {
/**
* Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.
*/
alias?: string;
/**
* Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.
*/
entityType?: string;
/**
* Required. The text for this part.
*/
text?: string;
/**
* Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.
*/
userDefined?: boolean;
}
/**
* Represents the result of querying a Knowledge base.
*/
export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswers {
/**
* A list of answers from Knowledge Connector.
*/
answers?: Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer[];
}
/**
* An answer from Knowledge Connector.
*/
export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer {
/**
* The piece of text from the `source` knowledge base document that answers this conversational query.
*/
answer?: string;
/**
* The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.
*/
faqQuestion?: string;
/**
* The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using `match_confidence_level` which should be generally more stable.
*/
matchConfidence?: number;
/**
* The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `<query, answer>` pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.
*/
matchConfidenceLevel?: string;
/**
* Indicates which Knowledge Document this answer was extracted from. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
*/
source?: string;
}
/**
* Represents knowledge base resource. Note: resource `projects.agent.knowledgeBases` is deprecated, please use `projects.knowledgeBases` instead.
*/
export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeBase {
/**
* Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
*/
displayName?: string;
/**
* The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
name?: string;
}
/**
* Metadata in google::longrunning::Operation for Knowledge operations.
*/
export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata {
/**
* Required. The current state of this operation.
*/
state?: string;
}
/**
* The response message for Contexts.ListContexts.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ListContextsResponse {
/**
* The list of contexts. There will be a maximum number of items returned based on the page_size field in the request.
*/
contexts?: Schema$GoogleCloudDialogflowV2beta1Context[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string;
}
/**
* Response message for Documents.ListDocuments.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse {
/**
* The list of documents.
*/
documents?: Schema$GoogleCloudDialogflowV2beta1Document[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string;
}
/**
* The response message for EntityTypes.ListEntityTypes.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ListEntityTypesResponse {
/**
* The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request.
*/
entityTypes?: Schema$GoogleCloudDialogflowV2beta1EntityType[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string;
}
/**
* The response message for Intents.ListIntents.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ListIntentsResponse {
/**
* The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request.
*/
intents?: Schema$GoogleCloudDialogflowV2beta1Intent[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string;
}
/**
* Response message for KnowledgeBases.ListKnowledgeBases.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse {
/**
* The list of knowledge bases.
*/
knowledgeBases?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string;
}
/**
* The response message for SessionEntityTypes.ListSessionEntityTypes.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse {
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string;
/**
* The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.
*/
sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[];
}
/**
* Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.
*/
export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest {
/**
* Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be redacted for Standard Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents.
*/
payload?: {
[key: string]: any;
};
/**
* The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.
*/
source?: string;
/**
* Optional. The version of the protocol used for this request. This field is AoG-specific.
*/
version?: string;
}
/**
* Instructs the speech synthesizer how to generate the output audio content.
*/
export interface Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig {
/**
* Required. Audio encoding of the synthesized audio content.
*/
audioEncoding?: string;
/**
* Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
*/
sampleRateHertz?: number;
/**
* Optional. Configuration of how speech should be synthesized.
*/
synthesizeSpeechConfig?: Schema$GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig;
}
/**
* Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text,. 3. An event that specifies which intent to trigger.
*/
export interface Schema$GoogleCloudDialogflowV2beta1QueryInput {
/**
* Instructs the speech recognizer how to process the speech audio.
*/
audioConfig?: Schema$GoogleCloudDialogflowV2beta1InputAudioConfig;
/**
* The event to be processed.
*/
event?: Schema$GoogleCloudDialogflowV2beta1EventInput;
/**
* The natural language text to be processed.
*/
text?: Schema$GoogleCloudDialogflowV2beta1TextInput;
}
/**
* Represents the parameters of the conversational query.
*/
export interface Schema$GoogleCloudDialogflowV2beta1QueryParameters {
/**
* Optional. The collection of contexts to be activated before this query is executed.
*/
contexts?: Schema$GoogleCloudDialogflowV2beta1Context[];
/**
* Optional. The geo location of this conversational query.
*/
geoLocation?: Schema$GoogleTypeLatLng;
/**
* Optional. KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
knowledgeBaseNames?: string[];
/**
* Optional. This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.
*/
payload?: {
[key: string]: any;
};
/**
* Optional. Specifies whether to delete all contexts in the current session before the new ones are activated.
*/
resetContexts?: boolean;
/**
* Optional. Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Enterprise Edition agents.
*/
sentimentAnalysisRequestConfig?: Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig;
/**
* Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.
*/
sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[];
/**
* Optional. The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.
*/
timeZone?: string;
}
/**
* Represents the result of conversational query or event processing.
*/
export interface Schema$GoogleCloudDialogflowV2beta1QueryResult {
/**
* The action name from the matched intent.
*/
action?: string;
/**
* This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.
*/
allRequiredParamsPresent?: boolean;
/**
* The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice.
*/
diagnosticInfo?: {
[key: string]: any;
};
/**
* The collection of rich messages to present to the user.
*/
fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[];
/**
* The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.
*/
fulfillmentText?: string;
/**
* The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`.
*/
intent?: Schema$GoogleCloudDialogflowV2beta1Intent;
/**
* The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.
*/
intentDetectionConfidence?: number;
/**
* The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`.
*/
knowledgeAnswers?: Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswers;
/**
* The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes.
*/
languageCode?: string;
/**
* The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `<parameter name>.original` containing the original parameter values before the query.
*/
outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[];
/**
* The collection of extracted parameters.
*/
parameters?: {
[key: string]: any;
};
/**
* The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set.
*/
queryText?: string;
/**
* The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request.
*/
sentimentAnalysisResult?: Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisResult;
/**
* The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.
*/
speechRecognitionConfidence?: number;
/**
* If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response.
*/
webhookPayload?: {
[key: string]: any;
};
/**
* If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response.
*/
webhookSource?: string;
}
/**
* Request message for Documents.ReloadDocument.
*/
export interface Schema$GoogleCloudDialogflowV2beta1ReloadDocumentRequest {
}
/**
* The request message for Agents.RestoreAgent.
*/
export interface Schema$GoogleCloudDialogflowV2beta1RestoreAgentRequest {
/**
* The agent to restore. Example for how to restore an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:restore\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)' }"</pre>
*/
agentContent?: string;
/**
* The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://".
*/
agentUri?: string;
}
/**
* The response message for Agents.SearchAgents.
*/
export interface Schema$GoogleCloudDialogflowV2beta1SearchAgentsResponse {
/**
* The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
*/
agents?: Schema$GoogleCloudDialogflowV2beta1Agent[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string;
}
/**
* The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.
*/
export interface Schema$GoogleCloudDialogflowV2beta1Sentiment {
/**
* A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).
*/
magnitude?: number;
/**
* Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
*/
score?: number;
}
/**
* Configures the types of sentiment analysis to perform.
*/
export interface Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig {
/**
* Optional. Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`.
*/
analyzeQueryTextSentiment?: boolean;
}
/**
* The result of sentiment analysis as configured by `sentiment_analysis_request_config`.
*/
export interface Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisResult {
/**
* The sentiment analysis result for `query_text`.
*/
queryTextSentiment?: Schema$GoogleCloudDialogflowV2beta1Sentiment;
}
/**
* Represents a session entity type. Extends or replaces a developer entity type at the user session level (we refer to the entity types defined at the agent level as "developer entity types"). Note: session entity types apply to all queries, regardless of the language.
*/
export interface Schema$GoogleCloudDialogflowV2beta1SessionEntityType {
/**
* Required. The collection of entities associated with this session entity type.
*/
entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[];
/**
* Required. Indicates whether the additional data should override or supplement the developer entity type definition.
*/
entityOverrideMode?: string;
/**
* Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.
*/
name?: string;
}
/**
* Configuration of how speech should be synthesized.
*/
export interface Schema$GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig {
/**
* Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
*/
effectsProfileId?: string[];
/**
* Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
*/
pitch?: number;
/**
* Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
*/
speakingRate?: number;
/**
* Optional. The desired voice of the synthesized audio.
*/
voice?: Schema$GoogleCloudDialogflowV2beta1VoiceSelectionParams;
/**
* Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
*/
volumeGainDb?: number;
}
/**
* Represents the natural language text to be processed.
*/
export interface Schema$GoogleCloudDialogflowV2beta1TextInput {
/**
* Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
*/
languageCode?: string;
/**
* Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
*/
text?: string;
}
/**
* The request message for Agents.TrainAgent.
*/
export interface Schema$GoogleCloudDialogflowV2beta1TrainAgentRequest {
}
/**
* Description of which voice to use for speech synthesis.
*/
export interface Schema$GoogleCloudDialogflowV2beta1VoiceSelectionParams {
/**
* Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and gender.
*/
name?: string;
/**
* Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
*/
ssmlGender?: string;
}
/**
* The request message for a webhook call.
*/
export interface Schema$GoogleCloudDialogflowV2beta1WebhookRequest {
/**
* Alternative query results from KnowledgeService.
*/
alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[];
/**
* Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call.
*/
originalDetectIntentRequest?: Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest;
/**
* The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`.
*/
queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult;
/**
* The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.
*/
responseId?: string;
/**
* The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`.
*/
session?: string;
}
/**
* The response message for a webhook call.
*/
export interface Schema$GoogleCloudDialogflowV2beta1WebhookResponse {
/**
* Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
*/
endInteraction?: boolean;
/**
* Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input.
*/
followupEventInput?: Schema$GoogleCloudDialogflowV2beta1EventInput;
/**
* Optional. The collection of rich messages to present to the user. This value is passed directly to `QueryResult.fulfillment_messages`.
*/
fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[];
/**
* Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`.
*/
fulfillmentText?: string;
/**
* Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`.
*/
outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[];
/**
* Optional. This value is passed directly to `QueryResult.webhook_payload`. See the related `fulfillment_messages[i].payload field`, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre>
*/
payload?: {
[key: string]: any;
};
/**
* Optional. This value is passed directly to `QueryResult.webhook_source`.
*/
source?: string;
}
/**
* Represents a context.
*/
export interface Schema$GoogleCloudDialogflowV2Context {
/**
* Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.
*/
lifespanCount?: number;
/**
* Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
*/
name?: string;
/**
* Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) for syntax.
*/
parameters?: {
[key: string]: any;
};
}
/**
* Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.
*/
export interface Schema$GoogleCloudDialogflowV2EntityType {
/**
* Optional. Indicates whether the entity type can be automatically expanded.
*/
autoExpansionMode?: string;
/**
* Required. The name of the entity type.
*/
displayName?: string;
/**
* Optional. The collection of entity entries associated with the entity type.
*/
entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[];
/**
* Required. Indicates the kind of entity type.
*/
kind?: string;
/**
* The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
*/
name?: string;
}
/**
* An **entity entry** for an associated entity type.
*/
export interface Schema$GoogleCloudDialogflowV2EntityTypeEntity {
/**
* Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.
*/
synonyms?: string[];
/**
* Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).
*/
value?: string;
}
/**
* Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`.
*/
export interface Schema$GoogleCloudDialogflowV2EventInput {
/**
* Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
*/
languageCode?: string;
/**
* Required. The unique identifier of the event.
*/
name?: string;
/**
* Optional. The collection of parameters associated with the event.
*/
parameters?: {
[key: string]: any;
};
}
/**
* The response message for Agents.ExportAgent.
*/
export interface Schema$GoogleCloudDialogflowV2ExportAgentResponse {
/**
* The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".x/\1/' \ | base64 --decode > &lt;agent zip file&gt;</pre>
*/
agentContent?: string;
/**
* The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.
*/
agentUri?: string;
}
/**
* Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics.
*/
export interface Schema$GoogleCloudDialogflowV2Intent {
/**
* Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
*/
action?: string;
/**
* Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM.
*/
defaultResponsePlatforms?: string[];
/**
* Required. The name of this intent.
*/
displayName?: string;
/**
* Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent.
*/
events?: string[];
/**
* Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
*/
followupIntentInfo?: Schema$GoogleCloudDialogflowV2IntentFollowupIntentInfo[];
/**
* Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*/
inputContextNames?: string[];
/**
* Optional. Indicates whether this is a fallback intent.
*/
isFallback?: boolean;
/**
* Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.
*/
messages?: Schema$GoogleCloudDialogflowV2IntentMessage[];
/**
* Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_diabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.
*/
mlDisabled?: boolean;
/**
* The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
name?: string;
/**
* Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*/
outputContexts?: Schema$GoogleCloudDialogflowV2Context[];
/**
* Optional. The collection of parameters associated with the intent.
*/
parameters?: Schema$GoogleCloudDialogflowV2IntentParameter[];
/**
* Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
parentFollowupIntentName?: string;
/**
* Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled.
*/
priority?: number;
/**
* Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
*/
resetContexts?: boolean;
/**
* Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
rootFollowupIntentName?: string;
/**
* Optional. The collection of examples that the agent is trained on.
*/
trainingPhrases?: Schema$GoogleCloudDialogflowV2IntentTrainingPhrase[];
/**
* Optional. Indicates whether webhooks are enabled for the intent.
*/
webhookState?: string;
}
/**
* Represents a single followup intent in the chain.
*/
export interface Schema$GoogleCloudDialogflowV2IntentFollowupIntentInfo {
/**
* The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
followupIntentName?: string;
/**
* The unique identifier of the followup intent's parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
parentFollowupIntentName?: string;
}
/**
* Corresponds to the `Response` field in the Dialogflow console.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessage {
/**
* The basic card response for Actions on Google.
*/
basicCard?: Schema$GoogleCloudDialogflowV2IntentMessageBasicCard;
/**
* The card response.
*/
card?: Schema$GoogleCloudDialogflowV2IntentMessageCard;
/**
* The carousel card response for Actions on Google.
*/
carouselSelect?: Schema$GoogleCloudDialogflowV2IntentMessageCarouselSelect;
/**
* The image response.
*/
image?: Schema$GoogleCloudDialogflowV2IntentMessageImage;
/**
* The link out suggestion chip for Actions on Google.
*/
linkOutSuggestion?: Schema$GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion;
/**
* The list card response for Actions on Google.
*/
listSelect?: Schema$GoogleCloudDialogflowV2IntentMessageListSelect;
/**
* Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform.
*/
payload?: {
[key: string]: any;
};
/**
* Optional. The platform that this message is intended for.
*/
platform?: string;
/**
* The quick replies response.
*/
quickReplies?: Schema$GoogleCloudDialogflowV2IntentMessageQuickReplies;
/**
* The voice and text-only responses for Actions on Google.
*/
simpleResponses?: Schema$GoogleCloudDialogflowV2IntentMessageSimpleResponses;
/**
* The suggestion chips for Actions on Google.
*/
suggestions?: Schema$GoogleCloudDialogflowV2IntentMessageSuggestions;
/**
* The text response.
*/
text?: Schema$GoogleCloudDialogflowV2IntentMessageText;
}
/**
* The basic card message. Useful for displaying information.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageBasicCard {
/**
* Optional. The collection of card buttons.
*/
buttons?: Schema$GoogleCloudDialogflowV2IntentMessageBasicCardButton[];
/**
* Required, unless image is present. The body text of the card.
*/
formattedText?: string;
/**
* Optional. The image for the card.
*/
image?: Schema$GoogleCloudDialogflowV2IntentMessageImage;
/**
* Optional. The subtitle of the card.
*/
subtitle?: string;
/**
* Optional. The title of the card.
*/
title?: string;
}
/**
* The button object that appears at the bottom of a card.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageBasicCardButton {
/**
* Required. Action to take when a user taps on the button.
*/
openUriAction?: Schema$GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction;
/**
* Required. The title of the button.
*/
title?: string;
}
/**
* Opens the given URI.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction {
/**
* Required. The HTTP or HTTPS scheme URI.
*/
uri?: string;
}
/**
* The card response message.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageCard {
/**
* Optional. The collection of card buttons.
*/
buttons?: Schema$GoogleCloudDialogflowV2IntentMessageCardButton[];
/**
* Optional. The public URI to an image file for the card.
*/
imageUri?: string;
/**
* Optional. The subtitle of the card.
*/
subtitle?: string;
/**
* Optional. The title of the card.
*/
title?: string;
}
/**
* Optional. Contains information about a button.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageCardButton {
/**
* Optional. The text to send back to the Dialogflow API or a URI to open.
*/
postback?: string;
/**
* Optional. The text to show on the button.
*/
text?: string;
}
/**
* The card for presenting a carousel of options to select from.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageCarouselSelect {
/**
* Required. Carousel items.
*/
items?: Schema$GoogleCloudDialogflowV2IntentMessageCarouselSelectItem[];
}
/**
* An item in the carousel.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageCarouselSelectItem {
/**
* Optional. The body text of the card.
*/
description?: string;
/**
* Optional. The image to display.
*/
image?: Schema$GoogleCloudDialogflowV2IntentMessageImage;
/**
* Required. Additional info about the option item.
*/
info?: Schema$GoogleCloudDialogflowV2IntentMessageSelectItemInfo;
/**
* Required. Title of the carousel item.
*/
title?: string;
}
/**
* The image response message.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageImage {
/**
* Optional. A text description of the image to be used for accessibility, e.g., screen readers.
*/
accessibilityText?: string;
/**
* Optional. The public URI to an image file.
*/
imageUri?: string;
}
/**
* The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion {
/**
* Required. The name of the app or site this chip is linking to.
*/
destinationName?: string;
/**
* Required. The URI of the app or site to open when the user taps the suggestion chip.
*/
uri?: string;
}
/**
* The card for presenting a list of options to select from.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageListSelect {
/**
* Required. List items.
*/
items?: Schema$GoogleCloudDialogflowV2IntentMessageListSelectItem[];
/**
* Optional. The overall title of the list.
*/
title?: string;
}
/**
* An item in the list.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageListSelectItem {
/**
* Optional. The main text describing the item.
*/
description?: string;
/**
* Optional. The image to display.
*/
image?: Schema$GoogleCloudDialogflowV2IntentMessageImage;
/**
* Required. Additional information about this option.
*/
info?: Schema$GoogleCloudDialogflowV2IntentMessageSelectItemInfo;
/**
* Required. The title of the list item.
*/
title?: string;
}
/**
* The quick replies response message.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageQuickReplies {
/**
* Optional. The collection of quick replies.
*/
quickReplies?: string[];
/**
* Optional. The title of the collection of quick replies.
*/
title?: string;
}
/**
* Additional info about the select item for when it is triggered in a dialog.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageSelectItemInfo {
/**
* Required. A unique key that will be sent back to the agent if this response is given.
*/
key?: string;
/**
* Optional. A list of synonyms that can also be used to trigger this item in dialog.
*/
synonyms?: string[];
}
/**
* The simple response message containing speech or text.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageSimpleResponse {
/**
* Optional. The text to display.
*/
displayText?: string;
/**
* One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.
*/
ssml?: string;
/**
* One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.
*/
textToSpeech?: string;
}
/**
* The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageSimpleResponses {
/**
* Required. The list of simple responses.
*/
simpleResponses?: Schema$GoogleCloudDialogflowV2IntentMessageSimpleResponse[];
}
/**
* The suggestion chip message that the user can tap to quickly post a reply to the conversation.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageSuggestion {
/**
* Required. The text shown the in the suggestion chip.
*/
title?: string;
}
/**
* The collection of suggestions.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageSuggestions {
/**
* Required. The list of suggested replies.
*/
suggestions?: Schema$GoogleCloudDialogflowV2IntentMessageSuggestion[];
}
/**
* The text response message.
*/
export interface Schema$GoogleCloudDialogflowV2IntentMessageText {
/**
* Optional. The collection of the agent's responses.
*/
text?: string[];
}
/**
* Represents intent parameters.
*/
export interface Schema$GoogleCloudDialogflowV2IntentParameter {
/**
* Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.
*/
defaultValue?: string;
/**
* Required. The name of the parameter.
*/
displayName?: string;
/**
* Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.
*/
entityTypeDisplayName?: string;
/**
* Optional. Indicates whether the parameter represents a list of values.
*/
isList?: boolean;
/**
* Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
*/
mandatory?: boolean;
/**
* The unique identifier of this parameter.
*/
name?: string;
/**
* Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter.
*/
prompts?: string[];
/**
* Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.
*/
value?: string;
}
/**
* Represents an example that the agent is trained on.
*/
export interface Schema$GoogleCloudDialogflowV2IntentTrainingPhrase {
/**
* Output only. The unique identifier of this training phrase.
*/
name?: string;
/**
* Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.
*/
parts?: Schema$GoogleCloudDialogflowV2IntentTrainingPhrasePart[];
/**
* Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.
*/
timesAddedCount?: number;
/**
* Required. The type of the training phrase.
*/
type?: string;
}
/**
* Represents a part of a training phrase.
*/
export interface Schema$GoogleCloudDialogflowV2IntentTrainingPhrasePart {
/**
* Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.
*/
alias?: string;
/**
* Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.
*/
entityType?: string;
/**
* Required. The text for this part.
*/
text?: string;
/**
* Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.
*/
userDefined?: boolean;
}
/**
* Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.
*/
export interface Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest {
/**
* Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be redacted for Standard Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents.
*/
payload?: {
[key: string]: any;
};
/**
* The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.
*/
source?: string;
/**
* Optional. The version of the protocol used for this request. This field is AoG-specific.
*/
version?: string;
}
/**
* Represents the result of conversational query or event processing.
*/
export interface Schema$GoogleCloudDialogflowV2QueryResult {
/**
* The action name from the matched intent.
*/
action?: string;
/**
* This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.
*/
allRequiredParamsPresent?: boolean;
/**
* The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice.
*/
diagnosticInfo?: {
[key: string]: any;
};
/**
* The collection of rich messages to present to the user.
*/
fulfillmentMessages?: Schema$GoogleCloudDialogflowV2IntentMessage[];
/**
* The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.
*/
fulfillmentText?: string;
/**
* The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`.
*/
intent?: Schema$GoogleCloudDialogflowV2Intent;
/**
* The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.
*/
intentDetectionConfidence?: number;
/**
* The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes.
*/
languageCode?: string;
/**
* The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `<parameter name>.original` containing the original parameter values before the query.
*/
outputContexts?: Schema$GoogleCloudDialogflowV2Context[];
/**
* The collection of extracted parameters.
*/
parameters?: {
[key: string]: any;
};
/**
* The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set.
*/
queryText?: string;
/**
* The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request.
*/
sentimentAnalysisResult?: Schema$GoogleCloudDialogflowV2SentimentAnalysisResult;
/**
* The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.
*/
speechRecognitionConfidence?: number;
/**
* If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response.
*/
webhookPayload?: {
[key: string]: any;
};
/**
* If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response.
*/
webhookSource?: string;
}
/**
* The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.
*/
export interface Schema$GoogleCloudDialogflowV2Sentiment {
/**
* A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).
*/
magnitude?: number;
/**
* Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
*/
score?: number;
}
/**
* The result of sentiment analysis as configured by `sentiment_analysis_request_config`.
*/
export interface Schema$GoogleCloudDialogflowV2SentimentAnalysisResult {
/**
* The sentiment analysis result for `query_text`.
*/
queryTextSentiment?: Schema$GoogleCloudDialogflowV2Sentiment;
}
/**
* The request message for a webhook call.
*/
export interface Schema$GoogleCloudDialogflowV2WebhookRequest {
/**
* Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call.
*/
originalDetectIntentRequest?: Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest;
/**
* The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`.
*/
queryResult?: Schema$GoogleCloudDialogflowV2QueryResult;
/**
* The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.
*/
responseId?: string;
/**
* The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`.
*/
session?: string;
}
/**
* The response message for a webhook call.
*/
export interface Schema$GoogleCloudDialogflowV2WebhookResponse {
/**
* Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input.
*/
followupEventInput?: Schema$GoogleCloudDialogflowV2EventInput;
/**
* Optional. The collection of rich messages to present to the user. This value is passed directly to `QueryResult.fulfillment_messages`.
*/
fulfillmentMessages?: Schema$GoogleCloudDialogflowV2IntentMessage[];
/**
* Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`.
*/
fulfillmentText?: string;
/**
* Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`.
*/
outputContexts?: Schema$GoogleCloudDialogflowV2Context[];
/**
* Optional. This value is passed directly to `QueryResult.webhook_payload`. See the related `fulfillment_messages[i].payload field`, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre>
*/
payload?: {
[key: string]: any;
};
/**
* Optional. This value is passed directly to `QueryResult.webhook_source`.
*/
source?: string;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$GoogleLongrunningOperation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$GoogleRpcStatus;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
};
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
*/
name?: string;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
};
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$GoogleProtobufEmpty {
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
*/
export interface Schema$GoogleRpcStatus {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}>;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
* An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.
*/
export interface Schema$GoogleTypeLatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number;
}
export class Resource$Projects {
context: APIRequestContext;
agent: Resource$Projects$Agent;
knowledgeBases: Resource$Projects$Knowledgebases;
operations: Resource$Projects$Operations;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.getAgent
* @desc Retrieves the specified agent.
* @alias dialogflow.projects.getAgent
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The project that the agent to fetch is associated with. Format: `projects/<Project ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getAgent(params?: Params$Resource$Projects$Getagent, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Agent>;
getAgent(params: Params$Resource$Projects$Getagent, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Agent>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Agent>): void;
getAgent(params: Params$Resource$Projects$Getagent, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Agent>): void;
getAgent(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Agent>): void;
}
export interface Params$Resource$Projects$Getagent extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The project that the agent to fetch is associated with. Format: `projects/<Project ID>`.
*/
parent?: string;
}
export class Resource$Projects$Agent {
context: APIRequestContext;
entityTypes: Resource$Projects$Agent$Entitytypes;
environments: Resource$Projects$Agent$Environments;
intents: Resource$Projects$Agent$Intents;
knowledgeBases: Resource$Projects$Agent$Knowledgebases;
sessions: Resource$Projects$Agent$Sessions;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.export
* @desc Exports the specified agent to a ZIP file. Operation <response: ExportAgentResponse>
* @alias dialogflow.projects.agent.export
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The project that the agent to export is associated with. Format: `projects/<Project ID>`.
* @param {().GoogleCloudDialogflowV2beta1ExportAgentRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
export(params?: Params$Resource$Projects$Agent$Export, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
export(params: Params$Resource$Projects$Agent$Export, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
export(params: Params$Resource$Projects$Agent$Export, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
export(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.import
* @desc Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. Operation <response: google.protobuf.Empty>
* @alias dialogflow.projects.agent.import
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The project that the agent to import is associated with. Format: `projects/<Project ID>`.
* @param {().GoogleCloudDialogflowV2beta1ImportAgentRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
import(params?: Params$Resource$Projects$Agent$Import, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
import(params: Params$Resource$Projects$Agent$Import, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
import(params: Params$Resource$Projects$Agent$Import, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
import(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.restore
* @desc Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. Operation <response: google.protobuf.Empty>
* @alias dialogflow.projects.agent.restore
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The project that the agent to restore is associated with. Format: `projects/<Project ID>`.
* @param {().GoogleCloudDialogflowV2beta1RestoreAgentRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
restore(params?: Params$Resource$Projects$Agent$Restore, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
restore(params: Params$Resource$Projects$Agent$Restore, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
restore(params: Params$Resource$Projects$Agent$Restore, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
restore(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.search
* @desc Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
* @alias dialogflow.projects.agent.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Projects$Agent$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1SearchAgentsResponse>;
search(params: Params$Resource$Projects$Agent$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SearchAgentsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SearchAgentsResponse>): void;
search(params: Params$Resource$Projects$Agent$Search, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SearchAgentsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SearchAgentsResponse>): void;
/**
* dialogflow.projects.agent.train
* @desc Trains the specified agent. Operation <response: google.protobuf.Empty>
* @alias dialogflow.projects.agent.train
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The project that the agent to train is associated with. Format: `projects/<Project ID>`.
* @param {().GoogleCloudDialogflowV2beta1TrainAgentRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
train(params?: Params$Resource$Projects$Agent$Train, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
train(params: Params$Resource$Projects$Agent$Train, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
train(params: Params$Resource$Projects$Agent$Train, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
train(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Projects$Agent$Export extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The project that the agent to export is associated with. Format: `projects/<Project ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1ExportAgentRequest;
}
export interface Params$Resource$Projects$Agent$Import extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The project that the agent to import is associated with. Format: `projects/<Project ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1ImportAgentRequest;
}
export interface Params$Resource$Projects$Agent$Restore extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The project that the agent to restore is associated with. Format: `projects/<Project ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1RestoreAgentRequest;
}
export interface Params$Resource$Projects$Agent$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Train extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The project that the agent to train is associated with. Format: `projects/<Project ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1TrainAgentRequest;
}
export class Resource$Projects$Agent$Entitytypes {
context: APIRequestContext;
entities: Resource$Projects$Agent$Entitytypes$Entities;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.entityTypes.batchDelete
* @desc Deletes entity types in the specified agent. Operation <response: google.protobuf.Empty>
* @alias dialogflow.projects.agent.entityTypes.batchDelete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.
* @param {().GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchDelete(params?: Params$Resource$Projects$Agent$Entitytypes$Batchdelete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
batchDelete(params: Params$Resource$Projects$Agent$Entitytypes$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchDelete(params: Params$Resource$Projects$Agent$Entitytypes$Batchdelete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchDelete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.entityTypes.batchUpdate
* @desc Updates/Creates multiple entity types in the specified agent. Operation <response: BatchUpdateEntityTypesResponse>
* @alias dialogflow.projects.agent.entityTypes.batchUpdate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the agent to update or create entity types in. Format: `projects/<Project ID>/agent`.
* @param {().GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdate(params?: Params$Resource$Projects$Agent$Entitytypes$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
batchUpdate(params: Params$Resource$Projects$Agent$Entitytypes$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchUpdate(params: Params$Resource$Projects$Agent$Entitytypes$Batchupdate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchUpdate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.entityTypes.create
* @desc Creates an entity type in the specified agent.
* @alias dialogflow.projects.agent.entityTypes.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.languageCode Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
* @param {string} params.parent Required. The agent to create a entity type for. Format: `projects/<Project ID>/agent`.
* @param {().GoogleCloudDialogflowV2beta1EntityType} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Agent$Entitytypes$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1EntityType>;
create(params: Params$Resource$Projects$Agent$Entitytypes$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
create(params: Params$Resource$Projects$Agent$Entitytypes$Create, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
/**
* dialogflow.projects.agent.entityTypes.delete
* @desc Deletes the specified entity type.
* @alias dialogflow.projects.agent.entityTypes.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Agent$Entitytypes$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Projects$Agent$Entitytypes$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Projects$Agent$Entitytypes$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.entityTypes.get
* @desc Retrieves the specified entity type.
* @alias dialogflow.projects.agent.entityTypes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.languageCode Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
* @param {string} params.name Required. The name of the entity type. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Agent$Entitytypes$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1EntityType>;
get(params: Params$Resource$Projects$Agent$Entitytypes$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
get(params: Params$Resource$Projects$Agent$Entitytypes$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
/**
* dialogflow.projects.agent.entityTypes.list
* @desc Returns the list of all entity types in the specified agent.
* @alias dialogflow.projects.agent.entityTypes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.languageCode Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The agent to list all entity types from. Format: `projects/<Project ID>/agent`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Agent$Entitytypes$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListEntityTypesResponse>;
list(params: Params$Resource$Projects$Agent$Entitytypes$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListEntityTypesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListEntityTypesResponse>): void;
list(params: Params$Resource$Projects$Agent$Entitytypes$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListEntityTypesResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListEntityTypesResponse>): void;
/**
* dialogflow.projects.agent.entityTypes.patch
* @desc Updates the specified entity type.
* @alias dialogflow.projects.agent.entityTypes.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.languageCode Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
* @param {string} params.name The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
* @param {string=} params.updateMask Optional. The mask to control which fields get updated.
* @param {().GoogleCloudDialogflowV2beta1EntityType} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Agent$Entitytypes$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1EntityType>;
patch(params: Params$Resource$Projects$Agent$Entitytypes$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
patch(params: Params$Resource$Projects$Agent$Entitytypes$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1EntityType>): void;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Batchdelete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Batchupdate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the agent to update or create entity types in. Format: `projects/<Project ID>/agent`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Required. The agent to create a entity type for. Format: `projects/<Project ID>/agent`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1EntityType;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Required. The name of the entity type. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Entitytypes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The agent to list all entity types from. Format: `projects/<Project ID>/agent`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
*/
name?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1EntityType;
}
export class Resource$Projects$Agent$Entitytypes$Entities {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.entityTypes.entities.batchCreate
* @desc Creates multiple new entities in the specified entity type. Operation <response: google.protobuf.Empty>
* @alias dialogflow.projects.agent.entityTypes.entities.batchCreate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the entity type to create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
* @param {().GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchCreate(params?: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchcreate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
batchCreate(params: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchCreate(params: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchcreate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchCreate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.entityTypes.entities.batchDelete
* @desc Deletes entities in the specified entity type. Operation <response: google.protobuf.Empty>
* @alias dialogflow.projects.agent.entityTypes.entities.batchDelete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the entity type to delete entries for. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
* @param {().GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchDelete(params?: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchdelete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
batchDelete(params: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchDelete(params: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchdelete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchDelete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.entityTypes.entities.batchUpdate
* @desc Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation <response: google.protobuf.Empty>
* @alias dialogflow.projects.agent.entityTypes.entities.batchUpdate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the entity type to update or create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
* @param {().GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdate(params?: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
batchUpdate(params: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchUpdate(params: Params$Resource$Projects$Agent$Entitytypes$Entities$Batchupdate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchUpdate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchcreate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the entity type to create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchdelete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the entity type to delete entries for. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest;
}
export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchupdate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the entity type to update or create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest;
}
export class Resource$Projects$Agent$Environments {
context: APIRequestContext;
users: Resource$Projects$Agent$Environments$Users;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Agent$Environments$Users {
context: APIRequestContext;
sessions: Resource$Projects$Agent$Environments$Users$Sessions;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Agent$Environments$Users$Sessions {
context: APIRequestContext;
contexts: Resource$Projects$Agent$Environments$Users$Sessions$Contexts;
entityTypes: Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.environments.users.sessions.deleteContexts
* @desc Deletes all active contexts in the specified session.
* @alias dialogflow.projects.agent.environments.users.sessions.deleteContexts
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the session to delete all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
deleteContexts(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Deletecontexts, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
deleteContexts(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Deletecontexts, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
deleteContexts(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Deletecontexts, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
deleteContexts(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.detectIntent
* @desc Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
* @alias dialogflow.projects.agent.environments.users.sessions.detectIntent
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.session Required. The name of the session this query is sent to. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters.
* @param {().GoogleCloudDialogflowV2beta1DetectIntentRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
detectIntent(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Detectintent, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>;
detectIntent(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Detectintent, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>): void;
detectIntent(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Detectintent, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>): void;
detectIntent(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>): void;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Deletecontexts extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the session to delete all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Detectintent extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the session this query is sent to. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters.
*/
session?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1DetectIntentRequest;
}
export class Resource$Projects$Agent$Environments$Users$Sessions$Contexts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.environments.users.sessions.contexts.create
* @desc Creates a context. If the specified context already exists, overrides the context.
* @alias dialogflow.projects.agent.environments.users.sessions.contexts.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The session to create a context for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Context>;
create(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
create(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Create, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.contexts.delete
* @desc Deletes the specified context.
* @alias dialogflow.projects.agent.environments.users.sessions.contexts.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the context to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.contexts.get
* @desc Retrieves the specified context.
* @alias dialogflow.projects.agent.environments.users.sessions.contexts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Context>;
get(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
get(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.contexts.list
* @desc Returns the list of all contexts in the specified session.
* @alias dialogflow.projects.agent.environments.users.sessions.contexts.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The session to list all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>;
list(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void;
list(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.contexts.patch
* @desc Updates the specified context.
* @alias dialogflow.projects.agent.environments.users.sessions.contexts.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {string=} params.updateMask Optional. The mask to control which fields get updated.
* @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Context>;
patch(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
patch(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The session to create a context for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Context;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the context to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The session to list all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Context;
}
export class Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.environments.users.sessions.entityTypes.create
* @desc Creates a session entity type. If the specified session entity type already exists, overrides the session entity type.
* @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The session to create a session entity type for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {().GoogleCloudDialogflowV2beta1SessionEntityType} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>;
create(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
create(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Create, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.entityTypes.delete
* @desc Deletes the specified session entity type.
* @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.entityTypes.get
* @desc Retrieves the specified session entity type.
* @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>;
get(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
get(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.entityTypes.list
* @desc Returns the list of all session entity types in the specified session.
* @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The session to list all session entity types from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>;
list(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>): void;
list(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>): void;
/**
* dialogflow.projects.agent.environments.users.sessions.entityTypes.patch
* @desc Updates the specified session entity type.
* @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.
* @param {string=} params.updateMask Optional. The mask to control which fields get updated.
* @param {().GoogleCloudDialogflowV2beta1SessionEntityType} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>;
patch(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
patch(params: Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The session to create a session entity type for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The session to list all session entity types from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.
*/
name?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType;
}
export class Resource$Projects$Agent$Intents {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.intents.batchDelete
* @desc Deletes intents in the specified agent. Operation <response: google.protobuf.Empty>
* @alias dialogflow.projects.agent.intents.batchDelete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.
* @param {().GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchDelete(params?: Params$Resource$Projects$Agent$Intents$Batchdelete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
batchDelete(params: Params$Resource$Projects$Agent$Intents$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchDelete(params: Params$Resource$Projects$Agent$Intents$Batchdelete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchDelete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.intents.batchUpdate
* @desc Updates/Creates multiple intents in the specified agent. Operation <response: BatchUpdateIntentsResponse>
* @alias dialogflow.projects.agent.intents.batchUpdate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the agent to update or create intents in. Format: `projects/<Project ID>/agent`.
* @param {().GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdate(params?: Params$Resource$Projects$Agent$Intents$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
batchUpdate(params: Params$Resource$Projects$Agent$Intents$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchUpdate(params: Params$Resource$Projects$Agent$Intents$Batchupdate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
batchUpdate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.intents.create
* @desc Creates an intent in the specified agent.
* @alias dialogflow.projects.agent.intents.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.intentView Optional. The resource view to apply to the returned intent.
* @param {string=} params.languageCode Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
* @param {string} params.parent Required. The agent to create a intent for. Format: `projects/<Project ID>/agent`.
* @param {().GoogleCloudDialogflowV2beta1Intent} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Agent$Intents$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Intent>;
create(params: Params$Resource$Projects$Agent$Intents$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
create(params: Params$Resource$Projects$Agent$Intents$Create, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
/**
* dialogflow.projects.agent.intents.delete
* @desc Deletes the specified intent and its direct or indirect followup intents.
* @alias dialogflow.projects.agent.intents.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Agent$Intents$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Projects$Agent$Intents$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Projects$Agent$Intents$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.intents.get
* @desc Retrieves the specified intent.
* @alias dialogflow.projects.agent.intents.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.intentView Optional. The resource view to apply to the returned intent.
* @param {string=} params.languageCode Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
* @param {string} params.name Required. The name of the intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Agent$Intents$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Intent>;
get(params: Params$Resource$Projects$Agent$Intents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
get(params: Params$Resource$Projects$Agent$Intents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
/**
* dialogflow.projects.agent.intents.list
* @desc Returns the list of all intents in the specified agent.
* @alias dialogflow.projects.agent.intents.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.intentView Optional. The resource view to apply to the returned intent.
* @param {string=} params.languageCode Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The agent to list all intents from. Format: `projects/<Project ID>/agent`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Agent$Intents$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListIntentsResponse>;
list(params: Params$Resource$Projects$Agent$Intents$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListIntentsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListIntentsResponse>): void;
list(params: Params$Resource$Projects$Agent$Intents$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListIntentsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListIntentsResponse>): void;
/**
* dialogflow.projects.agent.intents.patch
* @desc Updates the specified intent.
* @alias dialogflow.projects.agent.intents.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.intentView Optional. The resource view to apply to the returned intent.
* @param {string=} params.languageCode Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
* @param {string} params.name The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
* @param {string=} params.updateMask Optional. The mask to control which fields get updated.
* @param {().GoogleCloudDialogflowV2beta1Intent} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Agent$Intents$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Intent>;
patch(params: Params$Resource$Projects$Agent$Intents$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
patch(params: Params$Resource$Projects$Agent$Intents$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Intent>): void;
}
export interface Params$Resource$Projects$Agent$Intents$Batchdelete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest;
}
export interface Params$Resource$Projects$Agent$Intents$Batchupdate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the agent to update or create intents in. Format: `projects/<Project ID>/agent`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest;
}
export interface Params$Resource$Projects$Agent$Intents$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The resource view to apply to the returned intent.
*/
intentView?: string;
/**
* Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Required. The agent to create a intent for. Format: `projects/<Project ID>/agent`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Intent;
}
export interface Params$Resource$Projects$Agent$Intents$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Intents$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The resource view to apply to the returned intent.
*/
intentView?: string;
/**
* Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Required. The name of the intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Intents$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The resource view to apply to the returned intent.
*/
intentView?: string;
/**
* Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The agent to list all intents from. Format: `projects/<Project ID>/agent`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Intents$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The resource view to apply to the returned intent.
*/
intentView?: string;
/**
* Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
*/
languageCode?: string;
/**
* The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*/
name?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Intent;
}
export class Resource$Projects$Agent$Knowledgebases {
context: APIRequestContext;
documents: Resource$Projects$Agent$Knowledgebases$Documents;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.knowledgeBases.create
* @desc Creates a knowledge base.
* @alias dialogflow.projects.agent.knowledgeBases.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The project to create a knowledge base for. Format: `projects/<Project ID>`.
* @param {().GoogleCloudDialogflowV2beta1KnowledgeBase} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Agent$Knowledgebases$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>;
create(params: Params$Resource$Projects$Agent$Knowledgebases$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
create(params: Params$Resource$Projects$Agent$Knowledgebases$Create, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
/**
* dialogflow.projects.agent.knowledgeBases.delete
* @desc Deletes the specified knowledge base.
* @alias dialogflow.projects.agent.knowledgeBases.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.force Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
* @param {string} params.name Required. The name of the knowledge base to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Agent$Knowledgebases$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Projects$Agent$Knowledgebases$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Projects$Agent$Knowledgebases$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.knowledgeBases.get
* @desc Retrieves the specified knowledge base.
* @alias dialogflow.projects.agent.knowledgeBases.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the knowledge base to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Agent$Knowledgebases$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>;
get(params: Params$Resource$Projects$Agent$Knowledgebases$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
get(params: Params$Resource$Projects$Agent$Knowledgebases$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
/**
* dialogflow.projects.agent.knowledgeBases.list
* @desc Returns the list of all knowledge bases of the specified agent.
* @alias dialogflow.projects.agent.knowledgeBases.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The project to list of knowledge bases for. Format: `projects/<Project ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Agent$Knowledgebases$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>;
list(params: Params$Resource$Projects$Agent$Knowledgebases$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void;
list(params: Params$Resource$Projects$Agent$Knowledgebases$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void;
/**
* dialogflow.projects.agent.knowledgeBases.patch
* @desc Updates the specified knowledge base.
* @alias dialogflow.projects.agent.knowledgeBases.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
* @param {().GoogleCloudDialogflowV2beta1KnowledgeBase} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Agent$Knowledgebases$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>;
patch(params: Params$Resource$Projects$Agent$Knowledgebases$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
patch(params: Params$Resource$Projects$Agent$Knowledgebases$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The project to create a knowledge base for. Format: `projects/<Project ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
*/
force?: boolean;
/**
* Required. The name of the knowledge base to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the knowledge base to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The project to list of knowledge bases for. Format: `projects/<Project ID>`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
name?: string;
/**
* Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase;
}
export class Resource$Projects$Agent$Knowledgebases$Documents {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.knowledgeBases.documents.create
* @desc Creates a new document. Operation <response: Document, metadata: KnowledgeOperationMetadata>
* @alias dialogflow.projects.agent.knowledgeBases.documents.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The knoweldge base to create a document for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {().GoogleCloudDialogflowV2beta1Document} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Agent$Knowledgebases$Documents$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
create(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
create(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.knowledgeBases.documents.delete
* @desc Deletes the specified document. Operation <response: google.protobuf.Empty, metadata: KnowledgeOperationMetadata>
* @alias dialogflow.projects.agent.knowledgeBases.documents.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the document to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Agent$Knowledgebases$Documents$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
delete(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
delete(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.knowledgeBases.documents.get
* @desc Retrieves the specified document.
* @alias dialogflow.projects.agent.knowledgeBases.documents.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the document to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Agent$Knowledgebases$Documents$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Document>;
get(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Document>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Document>): void;
get(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Document>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Document>): void;
/**
* dialogflow.projects.agent.knowledgeBases.documents.list
* @desc Returns the list of all documents of the knowledge base.
* @alias dialogflow.projects.agent.knowledgeBases.documents.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Agent$Knowledgebases$Documents$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>;
list(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void;
list(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void;
/**
* dialogflow.projects.agent.knowledgeBases.documents.patch
* @desc Updates the specified document. Operation <response: Document, metadata: KnowledgeOperationMetadata>
* @alias dialogflow.projects.agent.knowledgeBases.documents.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The document resource name. The name must be empty when creating a document. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
* @param {().GoogleCloudDialogflowV2beta1Document} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
patch(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
patch(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.agent.knowledgeBases.documents.reload
* @desc Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Operation <response: Document, metadata: KnowledgeOperationMetadata>
* @alias dialogflow.projects.agent.knowledgeBases.documents.reload
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the document to reload. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
* @param {().GoogleCloudDialogflowV2beta1ReloadDocumentRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
reload(params?: Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
reload(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
reload(params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
reload(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The knoweldge base to create a document for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Document;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the document to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the document to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The document resource name. The name must be empty when creating a document. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
*/
name?: string;
/**
* Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Document;
}
export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the document to reload. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1ReloadDocumentRequest;
}
export class Resource$Projects$Agent$Sessions {
context: APIRequestContext;
contexts: Resource$Projects$Agent$Sessions$Contexts;
entityTypes: Resource$Projects$Agent$Sessions$Entitytypes;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.sessions.deleteContexts
* @desc Deletes all active contexts in the specified session.
* @alias dialogflow.projects.agent.sessions.deleteContexts
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The name of the session to delete all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
deleteContexts(params?: Params$Resource$Projects$Agent$Sessions$Deletecontexts, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
deleteContexts(params: Params$Resource$Projects$Agent$Sessions$Deletecontexts, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
deleteContexts(params: Params$Resource$Projects$Agent$Sessions$Deletecontexts, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
deleteContexts(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.sessions.detectIntent
* @desc Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
* @alias dialogflow.projects.agent.sessions.detectIntent
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.session Required. The name of the session this query is sent to. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters.
* @param {().GoogleCloudDialogflowV2beta1DetectIntentRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
detectIntent(params?: Params$Resource$Projects$Agent$Sessions$Detectintent, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>;
detectIntent(params: Params$Resource$Projects$Agent$Sessions$Detectintent, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>): void;
detectIntent(params: Params$Resource$Projects$Agent$Sessions$Detectintent, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>): void;
detectIntent(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse>): void;
}
export interface Params$Resource$Projects$Agent$Sessions$Deletecontexts extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the session to delete all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Sessions$Detectintent extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the session this query is sent to. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters.
*/
session?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1DetectIntentRequest;
}
export class Resource$Projects$Agent$Sessions$Contexts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.sessions.contexts.create
* @desc Creates a context. If the specified context already exists, overrides the context.
* @alias dialogflow.projects.agent.sessions.contexts.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The session to create a context for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Agent$Sessions$Contexts$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Context>;
create(params: Params$Resource$Projects$Agent$Sessions$Contexts$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
create(params: Params$Resource$Projects$Agent$Sessions$Contexts$Create, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
/**
* dialogflow.projects.agent.sessions.contexts.delete
* @desc Deletes the specified context.
* @alias dialogflow.projects.agent.sessions.contexts.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the context to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Agent$Sessions$Contexts$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Projects$Agent$Sessions$Contexts$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Projects$Agent$Sessions$Contexts$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.sessions.contexts.get
* @desc Retrieves the specified context.
* @alias dialogflow.projects.agent.sessions.contexts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Agent$Sessions$Contexts$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Context>;
get(params: Params$Resource$Projects$Agent$Sessions$Contexts$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
get(params: Params$Resource$Projects$Agent$Sessions$Contexts$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
/**
* dialogflow.projects.agent.sessions.contexts.list
* @desc Returns the list of all contexts in the specified session.
* @alias dialogflow.projects.agent.sessions.contexts.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The session to list all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Agent$Sessions$Contexts$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>;
list(params: Params$Resource$Projects$Agent$Sessions$Contexts$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void;
list(params: Params$Resource$Projects$Agent$Sessions$Contexts$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void;
/**
* dialogflow.projects.agent.sessions.contexts.patch
* @desc Updates the specified context.
* @alias dialogflow.projects.agent.sessions.contexts.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {string=} params.updateMask Optional. The mask to control which fields get updated.
* @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Agent$Sessions$Contexts$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Context>;
patch(params: Params$Resource$Projects$Agent$Sessions$Contexts$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
patch(params: Params$Resource$Projects$Agent$Sessions$Contexts$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Context>): void;
}
export interface Params$Resource$Projects$Agent$Sessions$Contexts$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The session to create a context for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Context;
}
export interface Params$Resource$Projects$Agent$Sessions$Contexts$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the context to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Sessions$Contexts$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Sessions$Contexts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The session to list all contexts from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Sessions$Contexts$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Context;
}
export class Resource$Projects$Agent$Sessions$Entitytypes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.agent.sessions.entityTypes.create
* @desc Creates a session entity type. If the specified session entity type already exists, overrides the session entity type.
* @alias dialogflow.projects.agent.sessions.entityTypes.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The session to create a session entity type for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {().GoogleCloudDialogflowV2beta1SessionEntityType} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Agent$Sessions$Entitytypes$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>;
create(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
create(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$Create, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
/**
* dialogflow.projects.agent.sessions.entityTypes.delete
* @desc Deletes the specified session entity type.
* @alias dialogflow.projects.agent.sessions.entityTypes.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Agent$Sessions$Entitytypes$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.agent.sessions.entityTypes.get
* @desc Retrieves the specified session entity type.
* @alias dialogflow.projects.agent.sessions.entityTypes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Agent$Sessions$Entitytypes$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>;
get(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
get(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
/**
* dialogflow.projects.agent.sessions.entityTypes.list
* @desc Returns the list of all session entity types in the specified session.
* @alias dialogflow.projects.agent.sessions.entityTypes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The session to list all session entity types from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Agent$Sessions$Entitytypes$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>;
list(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>): void;
list(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse>): void;
/**
* dialogflow.projects.agent.sessions.entityTypes.patch
* @desc Updates the specified session entity type.
* @alias dialogflow.projects.agent.sessions.entityTypes.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.
* @param {string=} params.updateMask Optional. The mask to control which fields get updated.
* @param {().GoogleCloudDialogflowV2beta1SessionEntityType} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Agent$Sessions$Entitytypes$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>;
patch(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
patch(params: Params$Resource$Projects$Agent$Sessions$Entitytypes$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1SessionEntityType>): void;
}
export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The session to create a session entity type for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType;
}
export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
name?: string;
}
export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The session to list all session entity types from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
*/
parent?: string;
}
export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.
*/
name?: string;
/**
* Optional. The mask to control which fields get updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType;
}
export class Resource$Projects$Knowledgebases {
context: APIRequestContext;
documents: Resource$Projects$Knowledgebases$Documents;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.knowledgeBases.create
* @desc Creates a knowledge base.
* @alias dialogflow.projects.knowledgeBases.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The project to create a knowledge base for. Format: `projects/<Project ID>`.
* @param {().GoogleCloudDialogflowV2beta1KnowledgeBase} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Knowledgebases$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>;
create(params: Params$Resource$Projects$Knowledgebases$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
create(params: Params$Resource$Projects$Knowledgebases$Create, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
/**
* dialogflow.projects.knowledgeBases.delete
* @desc Deletes the specified knowledge base.
* @alias dialogflow.projects.knowledgeBases.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.force Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
* @param {string} params.name Required. The name of the knowledge base to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Knowledgebases$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Projects$Knowledgebases$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Projects$Knowledgebases$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* dialogflow.projects.knowledgeBases.get
* @desc Retrieves the specified knowledge base.
* @alias dialogflow.projects.knowledgeBases.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the knowledge base to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Knowledgebases$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>;
get(params: Params$Resource$Projects$Knowledgebases$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
get(params: Params$Resource$Projects$Knowledgebases$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
/**
* dialogflow.projects.knowledgeBases.list
* @desc Returns the list of all knowledge bases of the specified agent.
* @alias dialogflow.projects.knowledgeBases.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The project to list of knowledge bases for. Format: `projects/<Project ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Knowledgebases$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>;
list(params: Params$Resource$Projects$Knowledgebases$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void;
list(params: Params$Resource$Projects$Knowledgebases$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void;
/**
* dialogflow.projects.knowledgeBases.patch
* @desc Updates the specified knowledge base.
* @alias dialogflow.projects.knowledgeBases.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
* @param {().GoogleCloudDialogflowV2beta1KnowledgeBase} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Knowledgebases$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>;
patch(params: Params$Resource$Projects$Knowledgebases$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
patch(params: Params$Resource$Projects$Knowledgebases$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void;
}
export interface Params$Resource$Projects$Knowledgebases$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The project to create a knowledge base for. Format: `projects/<Project ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase;
}
export interface Params$Resource$Projects$Knowledgebases$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
*/
force?: boolean;
/**
* Required. The name of the knowledge base to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Knowledgebases$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the knowledge base to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Knowledgebases$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The project to list of knowledge bases for. Format: `projects/<Project ID>`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Knowledgebases$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
name?: string;
/**
* Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase;
}
export class Resource$Projects$Knowledgebases$Documents {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.knowledgeBases.documents.create
* @desc Creates a new document. Operation <response: Document, metadata: KnowledgeOperationMetadata>
* @alias dialogflow.projects.knowledgeBases.documents.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The knoweldge base to create a document for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {().GoogleCloudDialogflowV2beta1Document} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Knowledgebases$Documents$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
create(params: Params$Resource$Projects$Knowledgebases$Documents$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
create(params: Params$Resource$Projects$Knowledgebases$Documents$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.knowledgeBases.documents.delete
* @desc Deletes the specified document. Operation <response: google.protobuf.Empty, metadata: KnowledgeOperationMetadata>
* @alias dialogflow.projects.knowledgeBases.documents.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the document to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Knowledgebases$Documents$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
delete(params: Params$Resource$Projects$Knowledgebases$Documents$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
delete(params: Params$Resource$Projects$Knowledgebases$Documents$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.knowledgeBases.documents.get
* @desc Retrieves the specified document.
* @alias dialogflow.projects.knowledgeBases.documents.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the document to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Knowledgebases$Documents$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1Document>;
get(params: Params$Resource$Projects$Knowledgebases$Documents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Document>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Document>): void;
get(params: Params$Resource$Projects$Knowledgebases$Documents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Document>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1Document>): void;
/**
* dialogflow.projects.knowledgeBases.documents.list
* @desc Returns the list of all documents of the knowledge base.
* @alias dialogflow.projects.knowledgeBases.documents.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
* @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request.
* @param {string} params.parent Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Knowledgebases$Documents$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>;
list(params: Params$Resource$Projects$Knowledgebases$Documents$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void;
list(params: Params$Resource$Projects$Knowledgebases$Documents$List, callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void;
/**
* dialogflow.projects.knowledgeBases.documents.patch
* @desc Updates the specified document. Operation <response: Document, metadata: KnowledgeOperationMetadata>
* @alias dialogflow.projects.knowledgeBases.documents.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The document resource name. The name must be empty when creating a document. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
* @param {().GoogleCloudDialogflowV2beta1Document} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Knowledgebases$Documents$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
patch(params: Params$Resource$Projects$Knowledgebases$Documents$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
patch(params: Params$Resource$Projects$Knowledgebases$Documents$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* dialogflow.projects.knowledgeBases.documents.reload
* @desc Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Operation <response: Document, metadata: KnowledgeOperationMetadata>
* @alias dialogflow.projects.knowledgeBases.documents.reload
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the document to reload. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
* @param {().GoogleCloudDialogflowV2beta1ReloadDocumentRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
reload(params?: Params$Resource$Projects$Knowledgebases$Documents$Reload, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
reload(params: Params$Resource$Projects$Knowledgebases$Documents$Reload, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
reload(params: Params$Resource$Projects$Knowledgebases$Documents$Reload, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
reload(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Projects$Knowledgebases$Documents$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The knoweldge base to create a document for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Document;
}
export interface Params$Resource$Projects$Knowledgebases$Documents$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the document to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Knowledgebases$Documents$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the document to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
*/
name?: string;
}
export interface Params$Resource$Projects$Knowledgebases$Documents$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous list request.
*/
pageToken?: string;
/**
* Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Knowledgebases$Documents$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The document resource name. The name must be empty when creating a document. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
*/
name?: string;
/**
* Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1Document;
}
export interface Params$Resource$Projects$Knowledgebases$Documents$Reload extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the document to reload. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudDialogflowV2beta1ReloadDocumentRequest;
}
export class Resource$Projects$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dialogflow.projects.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @alias dialogflow.projects.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
get(params: Params$Resource$Projects$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
get(params: Params$Resource$Projects$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Projects$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
export {};
}