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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.projects.html">projects</a> . <a href="aiplatform_v1beta1.projects.locations.html">locations</a> . <a href="aiplatform_v1beta1.projects.locations.schedules.html">schedules</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="aiplatform_v1beta1.projects.locations.schedules.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Schedule.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Schedule.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Schedule.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Schedules in a Location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.</p>
<p class="toc_element">
<code><a href="#pause">pause(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.</p>
<p class="toc_element">
<code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a Schedule.
Args:
parent: string, Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"kernelName": "A String", # The name of the kernel to use during notebook execution. If unset, the default kernel is used.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
"workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution.
},
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
"taskUniqueName": "A String", # Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task".
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
"domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
"targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
"targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
},
],
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"kernelName": "A String", # The name of the kernel to use during notebook execution. If unset, the default kernel is used.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
"workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution.
},
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
"taskUniqueName": "A String", # Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task".
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
"domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
"targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
"targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
},
],
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a Schedule.
Args:
name: string, Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a Schedule.
Args:
name: string, Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"kernelName": "A String", # The name of the kernel to use during notebook execution. If unset, the default kernel is used.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
"workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution.
},
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
"taskUniqueName": "A String", # Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task".
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
"domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
"targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
"targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
},
],
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Schedules in a Location.
Args:
parent: string, Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}` (required)
filter: string, Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time>"2021-05-18T00:00:00Z"` * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*`
orderBy: string, A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`
pageSize: integer, The standard list page size. Default to 100 if not specified.
pageToken: string, The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ScheduleService.ListSchedules
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListSchedulesRequest.page_token to obtain that page.
"schedules": [ # List of Schedules in the requested page.
{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"kernelName": "A String", # The name of the kernel to use during notebook execution. If unset, the default kernel is used.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
"workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution.
},
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
"taskUniqueName": "A String", # Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task".
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
"domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
"targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
"targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
},
],
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.
Args:
name: string, Immutable. The resource name of the Schedule. (required)
body: object, The request body.
The object takes the form of:
{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"kernelName": "A String", # The name of the kernel to use during notebook execution. If unset, the default kernel is used.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
"workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution.
},
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
"taskUniqueName": "A String", # Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task".
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
"domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
"targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
"targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
},
],
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}
updateMask: string, Required. The update mask applies to the resource. See google.protobuf.FieldMask.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"kernelName": "A String", # The name of the kernel to use during notebook execution. If unset, the default kernel is used.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
"workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution.
},
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
"taskUniqueName": "A String", # Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named "child_task" has a parent task named "parent_task_1" and parent task 1 has a parent task named "parent_task_2", the task unique name will be "parent_task_2.parent_task_1.child_task".
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
{ # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
"domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
"targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
"targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
},
],
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}</pre>
</div>
<div class="method">
<code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code>
<pre>Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.
Args:
name: string, Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ScheduleService.PauseSchedule.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code>
<pre>Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.
Args:
name: string, Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ScheduleService.ResumeSchedule.
"catchUp": True or False, # Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
</body></html>
|